profiles

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

Overview

Name	profiles
Type	Resource
Id	azure.billing.profiles

Fields

The following fields are returned by SELECT queries:

get

A billing profile.

Name	Datatype	Description
properties	object	A billing profile.
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

The list of billing profiles.

Name	Datatype	Description
properties	object	A billing profile.
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		Gets a billing profile by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.
list_by_billing_account	select	billingAccountName	includeDeleted, filter, orderBy, top, skip, count, search	Lists the billing profiles that a user has access to. The operation is supported for billing accounts with agreement of type Microsoft Customer Agreement and Microsoft Partner Agreement.
create_or_update	insert	billingAccountName, billingProfileName		Creates or updates a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. If you are a MCA Individual (Pay-as-you-go) customer, then please use the Azure portal experience to create the billing profile.
delete	delete	billingAccountName, billingProfileName		Deletes a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.
validate_delete_eligibility	exec	billingAccountName, billingProfileName		Validates if the billing profile can be deleted. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and 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.
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.
includeDeleted	boolean	Can be used to get deleted billing profiles.
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 billing profile by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.

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

list_by_billing_account

Lists the billing profiles that a user has access to. The operation is supported for billing accounts with agreement of type Microsoft Customer Agreement and Microsoft Partner Agreement.

SELECT
properties,
tags
FROM azure.billing.profiles
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND includeDeleted = '{{ includeDeleted }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND count = '{{ count }}'
AND search = '{{ search }}'
;

INSERT examples

create_or_update

Creates or updates a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. If you are a MCA Individual (Pay-as-you-go) customer, then please use the Azure portal experience to create the billing profile.

INSERT INTO azure.billing.profiles (
data__tags,
data__properties,
billingAccountName,
billingProfileName
)
SELECT 
'{{ tags }}',
'{{ properties }}',
'{{ billingAccountName }}',
'{{ billingProfileName }}'
RETURNING
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: profiles
  props:
    - name: billingAccountName
      value: string
      description: Required parameter for the profiles resource.
    - name: billingProfileName
      value: string
      description: Required parameter for the profiles resource.
    - name: tags
      value: object
      description: |
        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 < > % & \ ? /
    - name: properties
      value: object
      description: |
        A billing profile.

DELETE examples

delete

Deletes a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.

DELETE FROM azure.billing.profiles
WHERE billingAccountName = '{{ billingAccountName }}' --required
AND billingProfileName = '{{ billingProfileName }}' --required
;

Lifecycle Methods

validate_delete_eligibility

Validates if the billing profile can be deleted. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.

EXEC azure.billing.profiles.validate_delete_eligibility 
@billingAccountName='{{ billingAccountName }}' --required, 
@billingProfileName='{{ billingProfileName }}' --required
;