grants

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

Overview

Name	grants
Type	Resource
Id	azure_extras.education.grants

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.
allocatedBudget	object	allocated budget.
effectiveDate	string (date-time)	Grant Effective Date.
expirationDate	string (date-time)	Expiration Date.
offerCap	object	Offer Cap.
offerType	string	Grant Offer Type. Known values are: "Student" and "Academic". (Student, Academic)
status	string	Grant status. Known values are: "Active" and "Inactive". (Active, Inactive)
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_all

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.
allocatedBudget	object	allocated budget.
effectiveDate	string (date-time)	Grant Effective Date.
expirationDate	string (date-time)	Expiration Date.
offerCap	object	Offer Cap.
offerType	string	Grant Offer Type. Known values are: "Student" and "Academic". (Student, Academic)
status	string	Grant status. Known values are: "Active" and "Inactive". (Active, Inactive)
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	includeAllocatedBudget	Get details for a specific grant linked to the provided billing account and billing profile.
list_all	select		includeAllocatedBudget	Get a list of grants that Microsoft has provided.
list_raw	exec	billing_account_name, billing_profile_name	includeAllocatedBudget	Get details for a specific grant linked to the provided billing account and billing profile.

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.
includeAllocatedBudget	boolean	May be used to include information about budget that has been allocated. Default value is None.

SELECT examples

get

Get details for a specific grant linked to the provided billing account and billing profile.

SELECT
id,
name,
allocatedBudget,
effectiveDate,
expirationDate,
offerCap,
offerType,
status,
systemData,
type
FROM azure_extras.education.grants
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND billing_profile_name = '{{ billing_profile_name }}' -- required
AND includeAllocatedBudget = '{{ includeAllocatedBudget }}'
;

list_all

Get a list of grants that Microsoft has provided.

SELECT
id,
name,
allocatedBudget,
effectiveDate,
expirationDate,
offerCap,
offerType,
status,
systemData,
type
FROM azure_extras.education.grants
WHERE includeAllocatedBudget = '{{ includeAllocatedBudget }}'
;

Lifecycle Methods

list_raw

Get details for a specific grant linked to the provided billing account and billing profile.

EXEC azure_extras.education.grants.list_raw 
@billing_account_name='{{ billing_account_name }}' --required, 
@billing_profile_name='{{ billing_profile_name }}' --required, 
@includeAllocatedBudget={{ includeAllocatedBudget }}
;