join_requests

Creates, updates, deletes, gets or lists a join_requests resource.

Overview

Name	join_requests
Type	Resource
Id	azure_extras.education.join_requests

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
email	string	join request email.
firstName	string	First Name.
lastName	string	Last Name.
status	string	Join request status. Known values are: "Pending" and "Denied". (Pending, Denied)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
email	string	join request email.
firstName	string	First Name.
lastName	string	Last Name.
status	string	Join request status. Known values are: "Pending" and "Denied". (Pending, Denied)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account_name, billing_profile_name, invoice_section_name, join_request_name		get student join requests.
list	select	billing_account_name, billing_profile_name, invoice_section_name	includeDenied	get student join requests.
approve	exec	billing_account_name, billing_profile_name, invoice_section_name, join_request_name		Approve student joining the redeemable lab.
deny	exec	billing_account_name, billing_profile_name, invoice_section_name, join_request_name		Deny student joining the redeemable lab.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
billing_account_name	string	The name of the billing account. Required.
billing_profile_name	string	The name of the billing profile. Required.
invoice_section_name	string	The name of the invoice section. Required.
join_request_name	string	The ID that uniquely identifies a join request. Required.
includeDenied	boolean	Include denied. Default value is None.

SELECT examples

get

get student join requests.

SELECT
id,
name,
email,
firstName,
lastName,
status,
systemData,
type
FROM azure_extras.education.join_requests
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND billing_profile_name = '{{ billing_profile_name }}' -- required
AND invoice_section_name = '{{ invoice_section_name }}' -- required
AND join_request_name = '{{ join_request_name }}' -- required
;

list

get student join requests.

SELECT
id,
name,
email,
firstName,
lastName,
status,
systemData,
type
FROM azure_extras.education.join_requests
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND billing_profile_name = '{{ billing_profile_name }}' -- required
AND invoice_section_name = '{{ invoice_section_name }}' -- required
AND includeDenied = '{{ includeDenied }}'
;

Lifecycle Methods

approve

Approve student joining the redeemable lab.

EXEC azure_extras.education.join_requests.approve 
@billing_account_name='{{ billing_account_name }}' --required, 
@billing_profile_name='{{ billing_profile_name }}' --required, 
@invoice_section_name='{{ invoice_section_name }}' --required, 
@join_request_name='{{ join_request_name }}' --required
;

deny

Deny student joining the redeemable lab.

EXEC azure_extras.education.join_requests.deny 
@billing_account_name='{{ billing_account_name }}' --required, 
@billing_profile_name='{{ billing_profile_name }}' --required, 
@invoice_section_name='{{ invoice_section_name }}' --required, 
@join_request_name='{{ join_request_name }}' --required
;