requests

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

Overview

Name	requests
Type	Resource
Id	azure.billing.requests

Fields

The following fields are returned by SELECT queries:

list_by_customer

The list of billing requests.

Name	Datatype	Description
properties	object	A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.
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

The list of billing requests.

Name	Datatype	Description
properties	object	A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.
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 requests.

Name	Datatype	Description
properties	object	A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.
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

A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.

Name	Datatype	Description
properties	object	A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.
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_user

The list of billing requests.

Name	Datatype	Description
properties	object	A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.
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
list_by_customer	select	billingAccountName, billingProfileName, customerName	filter, orderBy, top, skip, count, search	The list of billing requests submitted for the customer.
list_by_billing_profile	select	billingAccountName, billingProfileName	filter, orderBy, top, skip, count, search	The list of billing requests submitted for the billing profile.
list_by_billing_account	select	billingAccountName	filter, orderBy, top, skip, count, search	The list of billing requests submitted for the billing account.
get	select	billingRequestName		Gets a billing request by its ID.
list_by_user	select		filter, orderBy, top, skip, count, search	The list of billing requests submitted by a user.
create_or_update	insert	billingRequestName		Create 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.

Name	Datatype	Description
billingAccountName	string	The ID that uniquely identifies a billing account.
billingProfileName	string	The ID that uniquely identifies a billing profile.
billingRequestName	string	The ID that uniquely identifies a billing request.
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.
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

list_by_customer

The list of billing requests submitted for the customer.

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

list_by_billing_profile

The list of billing requests submitted for the billing profile.

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

list_by_billing_account

The list of billing requests submitted for the billing account.

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

get

Gets a billing request by its ID.

SELECT
properties,
tags
FROM azure.billing.requests
WHERE billingRequestName = '{{ billingRequestName }}' -- required
;

list_by_user

The list of billing requests submitted by a user.

SELECT
properties,
tags
FROM azure.billing.requests
WHERE filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND count = '{{ count }}'
AND search = '{{ search }}'
;

INSERT examples

create_or_update

Create or update a billing request.

INSERT INTO azure.billing.requests (
data__tags,
data__properties,
billingRequestName
)
SELECT 
'{{ tags }}',
'{{ properties }}',
'{{ billingRequestName }}'
RETURNING
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: requests
  props:
    - name: billingRequestName
      value: string
      description: Required parameter for the requests 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 request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.