enrollment_accounts

Creates, updates, deletes, gets or lists an enrollment_accounts resource.

Overview

Name	enrollment_accounts
Type	Resource
Id	azure.billing.enrollment_accounts

Fields

The following fields are returned by SELECT queries:

get_by_department

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.
accountOwner	string	The owner of the enrollment account.
authType	string	The authorization type of the enrollment account.
costCenter	string	The cost center associated with the enrollment account.
departmentDisplayName	string	The name of the department under which the enrollment account exists.
departmentId	string	The ID that uniquely identifies the department.
displayName	string	The name of the enrollment account.
endDate	string (date-time)	The date of expiration of the enrollment account.
isDevTestEnabled	boolean	Boolean flag which enables subscribers to run development and testing workloads on Azure at special Dev/Test rates.
startDate	string (date-time)	The date from which the enrollment account became valid and functional.
status	string	The status of the enrollment account.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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.
accountOwner	string	The owner of the enrollment account.
authType	string	The authorization type of the enrollment account.
costCenter	string	The cost center associated with the enrollment account.
departmentDisplayName	string	The name of the department under which the enrollment account exists.
departmentId	string	The ID that uniquely identifies the department.
displayName	string	The name of the enrollment account.
endDate	string (date-time)	The date of expiration of the enrollment account.
isDevTestEnabled	boolean	Boolean flag which enables subscribers to run development and testing workloads on Azure at special Dev/Test rates.
startDate	string (date-time)	The date from which the enrollment account became valid and functional.
status	string	The status of the enrollment account.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_department

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.
accountOwner	string	The owner of the enrollment account.
authType	string	The authorization type of the enrollment account.
costCenter	string	The cost center associated with the enrollment account.
departmentDisplayName	string	The name of the department under which the enrollment account exists.
departmentId	string	The ID that uniquely identifies the department.
displayName	string	The name of the enrollment account.
endDate	string (date-time)	The date of expiration of the enrollment account.
isDevTestEnabled	boolean	Boolean flag which enables subscribers to run development and testing workloads on Azure at special Dev/Test rates.
startDate	string (date-time)	The date from which the enrollment account became valid and functional.
status	string	The status of the enrollment account.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_billing_account

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.
accountOwner	string	The owner of the enrollment account.
authType	string	The authorization type of the enrollment account.
costCenter	string	The cost center associated with the enrollment account.
departmentDisplayName	string	The name of the department under which the enrollment account exists.
departmentId	string	The ID that uniquely identifies the department.
displayName	string	The name of the enrollment account.
endDate	string (date-time)	The date of expiration of the enrollment account.
isDevTestEnabled	boolean	Boolean flag which enables subscribers to run development and testing workloads on Azure at special Dev/Test rates.
startDate	string (date-time)	The date from which the enrollment account became valid and functional.
status	string	The status of the enrollment account.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /.
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_by_department	select	billing_account_name, department_name, enrollment_account_name		Gets an enrollment account by department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
get	select	billing_account_name, enrollment_account_name		Gets an enrollment account by ID. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
list_by_department	select	billing_account_name, department_name	filter, orderBy, top, skip, count, search	Lists the enrollment accounts for a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
list_by_billing_account	select	billing_account_name	filter, orderBy, top, skip, count, search	Lists the enrollment accounts for a billing account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

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 ID that uniquely identifies a billing account. Required.
department_name	string	The name of the department. Required.
enrollment_account_name	string	The name of the enrollment account. Required.
count	boolean	The count query option allows clients to request a count of the matching resources included with the resources in the response. Default value is None.
filter	string	The filter query option allows clients to filter a collection of resources that are addressed by a request URL. Default value is None.
orderBy	string	The orderby query option allows clients to request resources in a particular order. Default value is None.
search	string	The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. Default value is None.
skip	integer	The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. Default value is None.
top	integer	The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. Default value is None.

SELECT examples

get_by_department

Gets an enrollment account by department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

SELECT
id,
name,
accountOwner,
authType,
costCenter,
departmentDisplayName,
departmentId,
displayName,
endDate,
isDevTestEnabled,
startDate,
status,
systemData,
tags,
type
FROM azure.billing.enrollment_accounts
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND department_name = '{{ department_name }}' -- required
AND enrollment_account_name = '{{ enrollment_account_name }}' -- required
;

get

Gets an enrollment account by ID. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

SELECT
id,
name,
accountOwner,
authType,
costCenter,
departmentDisplayName,
departmentId,
displayName,
endDate,
isDevTestEnabled,
startDate,
status,
systemData,
tags,
type
FROM azure.billing.enrollment_accounts
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND enrollment_account_name = '{{ enrollment_account_name }}' -- required
;

list_by_department

Lists the enrollment accounts for a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

SELECT
id,
name,
accountOwner,
authType,
costCenter,
departmentDisplayName,
departmentId,
displayName,
endDate,
isDevTestEnabled,
startDate,
status,
systemData,
tags,
type
FROM azure.billing.enrollment_accounts
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND department_name = '{{ department_name }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND count = '{{ count }}'
AND search = '{{ search }}'
;

list_by_billing_account

Lists the enrollment accounts for a billing account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.

SELECT
id,
name,
accountOwner,
authType,
costCenter,
departmentDisplayName,
departmentId,
displayName,
endDate,
isDevTestEnabled,
startDate,
status,
systemData,
tags,
type
FROM azure.billing.enrollment_accounts
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND count = '{{ count }}'
AND search = '{{ search }}'
;