Skip to main content

billing_requests

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

Overview​

Namebilling_requests
TypeResource
Idazure.billing.billing_requests

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
namestringThe name of the resource.
additionalInformationobjectAdditional information for the billing request.
billingAccountDisplayNamestringThe name of the billing account.
billingAccountIdstringThe fully qualified ID that uniquely identifies a billing account.
billingAccountNamestringThe ID that uniquely identifies a billing account.
billingAccountPrimaryBillingTenantIdstringThe primary tenant ID of the billing account for which the billing request was submitted.
billingProfileDisplayNamestringThe name of the billing profile.
billingProfileIdstringThe fully qualified ID that uniquely identifies a billing profile.
billingProfileNamestringThe ID that uniquely identifies a billing profile.
billingScopestringThe billing scope for which the request will be applied. This is a read only property derived by the service.
createdByobjectThe principal of the entity who created the request.
creationDatestring (date-time)The date and time when the request was created.
customerDisplayNamestringThe name of the customer.
customerIdstringThe fully qualified ID that uniquely identifies a customer.
customerNamestringThe ID that uniquely identifies a customer.
decisionReasonstringThe reason to approve or decline the request.
expirationDatestring (date-time)The date and time when the request expires.
invoiceSectionDisplayNamestringThe name of the invoice section.
invoiceSectionIdstringThe fully qualified ID that uniquely identifies an invoice section.
invoiceSectionNamestringThe ID that uniquely identifies an invoice section.
justificationstringJustification for submitting request.
lastUpdatedByobjectThe principal of the entity who last updated the request.
lastUpdatedDatestring (date-time)Date and time of last update.
provisioningStatestringThe provisioning state of the resource during a long-running operation. Known values are: "Succeeded", "Canceled", "Failed", "New", "Pending", "Provisioning", "PendingBilling", "ConfirmedBilling", "Creating", "Created", and "Expired". (Succeeded, Canceled, Failed, New, Pending, Provisioning, PendingBilling, ConfirmedBilling, Creating, Created, Expired)
recipientsarrayThe recipients of the billing request.
requestScopestringThe billing scope for which the request was submitted (ex. '/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}').
reviewalDatestring (date-time)The date and time when the request was reviewed.
reviewedByobjectThe principal of the request reviewer. Will only be set if request is approved.
statusstringStatus of billing request. Known values are: "Other", "Pending", "Approved", "Declined", "Cancelled", "Completed", and "Expired". (Other, Pending, Approved, Declined, Cancelled, Completed, Expired)
subscriptionDisplayNamestringThe name of the billing subscription.
subscriptionIdstringThe fully qualified ID that uniquely identifies a billing subscription.
subscriptionNamestringThe ID that uniquely identifies a billing subscription.
systemDataobjectAzure Resource Manager metadata containing createdBy and modifiedBy information.
tagsobjectDictionary 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 < > % & \ ? /.
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_by_customerselectbilling_account_name, billing_profile_name, customer_namefilter, orderBy, top, skip, count, searchThe list of billing requests submitted for the customer.
list_by_invoice_sectionselectbilling_account_name, billing_profile_name, invoice_section_namefilter, orderBy, top, skip, count, searchThe list of billing requests submitted for the invoice section.
list_by_billing_profileselectbilling_account_name, billing_profile_namefilter, orderBy, top, skip, count, searchThe list of billing requests submitted for the billing profile.
getselectbilling_request_nameGets a billing request by its ID.
list_by_billing_accountselectbilling_account_namefilter, orderBy, top, skip, count, searchThe list of billing requests submitted for the billing account.
list_by_userselectfilter, orderBy, top, skip, count, searchThe list of billing requests submitted by a user.
create_or_updateinsertbilling_request_nameCreate or update a billing request.
create_or_updatereplacebilling_request_nameCreate or update a billing request.

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.

NameDatatypeDescription
billing_account_namestringThe ID that uniquely identifies a billing account. Required.
billing_profile_namestringThe ID that uniquely identifies a billing profile. Required.
billing_request_namestringThe ID that uniquely identifies a billing request. Required.
customer_namestringThe ID that uniquely identifies a customer. Required.
invoice_section_namestringThe ID that uniquely identifies an invoice section. Required.
countbooleanThe count query option allows clients to request a count of the matching resources included with the resources in the response. Default value is None.
filterstringThe filter query option allows clients to filter a collection of resources that are addressed by a request URL. Default value is None.
orderBystringThe orderby query option allows clients to request resources in a particular order. Default value is None.
skipintegerThe 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.
topintegerThe 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​

The list of billing requests submitted for the customer.

SELECT
id,
name,
additionalInformation,
billingAccountDisplayName,
billingAccountId,
billingAccountName,
billingAccountPrimaryBillingTenantId,
billingProfileDisplayName,
billingProfileId,
billingProfileName,
billingScope,
createdBy,
creationDate,
customerDisplayName,
customerId,
customerName,
decisionReason,
expirationDate,
invoiceSectionDisplayName,
invoiceSectionId,
invoiceSectionName,
justification,
lastUpdatedBy,
lastUpdatedDate,
provisioningState,
recipients,
requestScope,
reviewalDate,
reviewedBy,
status,
subscriptionDisplayName,
subscriptionId,
subscriptionName,
systemData,
tags,
type
FROM azure.billing.billing_requests
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND billing_profile_name = '{{ billing_profile_name }}' -- required
AND customer_name = '{{ customer_name }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND count = '{{ count }}'
AND search = '{{ search }}'
;

INSERT examples​

Create or update a billing request.

INSERT INTO azure.billing.billing_requests (
properties,
tags,
billing_request_name
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ billing_request_name }}'
RETURNING
id,
name,
properties,
systemData,
tags,
type
;

REPLACE examples​

Create or update a billing request.

REPLACE azure.billing.billing_requests
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
billing_request_name = '{{ billing_request_name }}' --required
RETURNING
id,
name,
properties,
systemData,
tags,
type;