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

invite request.

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
properties	object	join request properties.
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

invite request 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
properties	object	join request properties.
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	billingAccountName, billingProfileName, invoiceSectionName, joinRequestName		get student join requests
list	select	billingAccountName, billingProfileName, invoiceSectionName	includeDenied	get student join requests
approve	exec	billingAccountName, billingProfileName, invoiceSectionName, joinRequestName		Approve student joining the redeemable lab
deny	exec	billingAccountName, billingProfileName, invoiceSectionName, joinRequestName		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
billingAccountName	string	The ID that uniquely identifies a billing account.
billingProfileName	string	The ID that uniquely identifies a billing profile.
invoiceSectionName	string	The ID that uniquely identifies an invoice section.
joinRequestName	string	The ID that uniquely identifies a join request.
includeDenied	boolean	Include denied

SELECT examples

get

get student join requests

SELECT
id,
name,
properties,
systemData,
type
FROM azure_extras.education.join_requests
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND billingProfileName = '{{ billingProfileName }}' -- required
AND invoiceSectionName = '{{ invoiceSectionName }}' -- required
AND joinRequestName = '{{ joinRequestName }}' -- required
;

list

get student join requests

SELECT
id,
name,
properties,
systemData,
type
FROM azure_extras.education.join_requests
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND billingProfileName = '{{ billingProfileName }}' -- required
AND invoiceSectionName = '{{ invoiceSectionName }}' -- required
AND includeDenied = '{{ includeDenied }}'
;

Lifecycle Methods

approve

Approve student joining the redeemable lab

EXEC azure_extras.education.join_requests.approve 
@billingAccountName='{{ billingAccountName }}' --required, 
@billingProfileName='{{ billingProfileName }}' --required, 
@invoiceSectionName='{{ invoiceSectionName }}' --required, 
@joinRequestName='{{ joinRequestName }}' --required
;

deny

Deny student joining the redeemable lab

EXEC azure_extras.education.join_requests.deny 
@billingAccountName='{{ billingAccountName }}' --required, 
@billingProfileName='{{ billingProfileName }}' --required, 
@invoiceSectionName='{{ invoiceSectionName }}' --required, 
@joinRequestName='{{ joinRequestName }}' --required
;