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

OK. The request has succeeded.

Name	Datatype	Description
properties	object	It is an organizational hierarchy within a billing account to administer and manage azure costs.
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 < > % & \ ? /

list_by_department

OK. The request has succeeded.

Name	Datatype	Description
properties	object	It is an organizational hierarchy within a billing account to administer and manage azure costs.
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 < > % & \ ? /

get

OK. The request has succeeded.

Name	Datatype	Description
properties	object	It is an organizational hierarchy within a billing account to administer and manage azure costs.
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 < > % & \ ? /

list_by_billing_account

OK. The request has succeeded.

Name	Datatype	Description
properties	object	It is an organizational hierarchy within a billing account to administer and manage azure costs.
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 < > % & \ ? /

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_department	select	billingAccountName, departmentName, enrollmentAccountName		Gets an enrollment account by department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
list_by_department	select	billingAccountName, departmentName	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.
get	select	billingAccountName, enrollmentAccountName		Gets an enrollment account by ID. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
list_by_billing_account	select	billingAccountName	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
billingAccountName	string	The ID that uniquely identifies a billing account.
departmentName	string	The name of the department.
enrollmentAccountName	string	The name of the enrollment account.
count	boolean	The count query option allows clients to request a count of the matching resources included with the resources in the response.
filter	string	The filter query option allows clients to filter a collection of resources that are addressed by a request URL.
orderBy	string	The orderby query option allows clients to request resources in a particular order.
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.
skip	integer (int64)	The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.
top	integer (int64)	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.

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
properties,
tags
FROM azure.billing.enrollment_accounts
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND departmentName = '{{ departmentName }}' -- required
AND enrollmentAccountName = '{{ enrollmentAccountName }}' -- 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
properties,
tags
FROM azure.billing.enrollment_accounts
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND departmentName = '{{ departmentName }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND count = '{{ count }}'
AND search = '{{ search }}'
;

get

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

SELECT
properties,
tags
FROM azure.billing.enrollment_accounts
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND enrollmentAccountName = '{{ enrollmentAccountName }}' -- required
;

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
properties,
tags
FROM azure.billing.enrollment_accounts
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND count = '{{ count }}'
AND search = '{{ search }}'
;