customers

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

Overview

Name	customers
Type	Resource
Id	azure.billing.customers

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.
billingProfileDisplayName	string	The name of the billing profile.
billingProfileId	string	The fully qualified ID that uniquely identifies a billing profile.
displayName	string	The name of the customer.
enabledAzurePlans	array	Azure plans enabled for the customer.
resellers	array	The list of resellers for which an Azure plan is enabled for the customer.
status	string	Identifies the status of an customer. This is an upcoming property that will be populated in the future. Known values are: "Other", "Active", "Pending", "Disabled", "Warned", "Deleted", and "UnderReview". (Other, Active, Pending, Disabled, Warned, Deleted, UnderReview)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemId	string	The system generated unique identifier for a customer.
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_profile

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.
billingProfileDisplayName	string	The name of the billing profile.
billingProfileId	string	The fully qualified ID that uniquely identifies a billing profile.
displayName	string	The name of the customer.
enabledAzurePlans	array	Azure plans enabled for the customer.
resellers	array	The list of resellers for which an Azure plan is enabled for the customer.
status	string	Identifies the status of an customer. This is an upcoming property that will be populated in the future. Known values are: "Other", "Active", "Pending", "Disabled", "Warned", "Deleted", and "UnderReview". (Other, Active, Pending, Disabled, Warned, Deleted, UnderReview)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemId	string	The system generated unique identifier for a customer.
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_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.
billingProfileDisplayName	string	The name of the billing profile.
billingProfileId	string	The fully qualified ID that uniquely identifies a billing profile.
displayName	string	The name of the customer.
enabledAzurePlans	array	Azure plans enabled for the customer.
resellers	array	The list of resellers for which an Azure plan is enabled for the customer.
status	string	Identifies the status of an customer. This is an upcoming property that will be populated in the future. Known values are: "Other", "Active", "Pending", "Disabled", "Warned", "Deleted", and "UnderReview". (Other, Active, Pending, Disabled, Warned, Deleted, UnderReview)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemId	string	The system generated unique identifier for a customer.
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.
billingProfileDisplayName	string	The name of the billing profile.
billingProfileId	string	The fully qualified ID that uniquely identifies a billing profile.
displayName	string	The name of the customer.
enabledAzurePlans	array	Azure plans enabled for the customer.
resellers	array	The list of resellers for which an Azure plan is enabled for the customer.
status	string	Identifies the status of an customer. This is an upcoming property that will be populated in the future. Known values are: "Other", "Active", "Pending", "Disabled", "Warned", "Deleted", and "UnderReview". (Other, Active, Pending, Disabled, Warned, Deleted, UnderReview)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemId	string	The system generated unique identifier for a customer.
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	select	billing_account_name, billing_profile_name, customer_name		Gets a customer by its ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
list_by_billing_profile	select	billing_account_name, billing_profile_name	expand, filter, orderBy, top, skip, count, search	Lists the customers that are billed to a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
get_by_billing_account	select	billing_account_name, customer_name		Gets a customer by its ID at billing account level. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
list_by_billing_account	select	billing_account_name	expand, filter, orderBy, top, skip, count, search	Lists the customers that are billed to a billing account. The operation is supported only for billing accounts with agreement type Microsoft Partner 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.
billing_profile_name	string	The ID that uniquely identifies a billing profile. Required.
customer_name	string	The ID that uniquely identifies a customer. 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.
expand	string	May be used to expand enabledAzurePlans and resellers. 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

Gets a customer by its ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

SELECT
id,
name,
billingProfileDisplayName,
billingProfileId,
displayName,
enabledAzurePlans,
resellers,
status,
systemData,
systemId,
tags,
type
FROM azure.billing.customers
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND billing_profile_name = '{{ billing_profile_name }}' -- required
AND customer_name = '{{ customer_name }}' -- required
;

list_by_billing_profile

Lists the customers that are billed to a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

SELECT
id,
name,
billingProfileDisplayName,
billingProfileId,
displayName,
enabledAzurePlans,
resellers,
status,
systemData,
systemId,
tags,
type
FROM azure.billing.customers
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND billing_profile_name = '{{ billing_profile_name }}' -- required
AND expand = '{{ expand }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND count = '{{ count }}'
AND search = '{{ search }}'
;

get_by_billing_account

Gets a customer by its ID at billing account level. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

SELECT
id,
name,
billingProfileDisplayName,
billingProfileId,
displayName,
enabledAzurePlans,
resellers,
status,
systemData,
systemId,
tags,
type
FROM azure.billing.customers
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND customer_name = '{{ customer_name }}' -- required
;

list_by_billing_account

Lists the customers that are billed to a billing account. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

SELECT
id,
name,
billingProfileDisplayName,
billingProfileId,
displayName,
enabledAzurePlans,
resellers,
status,
systemData,
systemId,
tags,
type
FROM azure.billing.customers
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND expand = '{{ expand }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND count = '{{ count }}'
AND search = '{{ search }}'
;