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

A partner's customer.

Name	Datatype	Description
properties	object	A partner's 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 < > % & \ ? /

list_by_billing_profile

A list of customers.

Name	Datatype	Description
properties	object	A partner's 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 < > % & \ ? /

get_by_billing_account

A partner's customer.

Name	Datatype	Description
properties	object	A partner's 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 < > % & \ ? /

list_by_billing_account

A list of customers.

Name	Datatype	Description
properties	object	A partner's 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 < > % & \ ? /

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billingAccountName, billingProfileName, customerName		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	billingAccountName, billingProfileName	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	billingAccountName, customerName		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	billingAccountName	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
billingAccountName	string	The ID that uniquely identifies a billing account.
billingProfileName	string	The ID that uniquely identifies a billing profile.
customerName	string	The ID that uniquely identifies a customer.
count	boolean	The count query option allows clients to request a count of the matching resources included with the resources in the response.
expand	string	May be used to expand enabledAzurePlans and resellers
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

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

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