associated_tenants

Creates, updates, deletes, gets or lists an associated_tenants resource.

Overview

Name	associated_tenants
Type	Resource
Id	azure.billing.associated_tenants

Fields

The following fields are returned by SELECT queries:

get

An associated tenant.

Name	Datatype	Description
properties	object	An associated tenant.
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 associated tenants.

Name	Datatype	Description
properties	object	An associated tenant.
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, associatedTenantName		Gets an associated tenant by ID.
list_by_billing_account	select	billingAccountName	includeRevoked, filter, orderBy, top, skip, count, search	Lists the associated tenants that can collaborate with the billing account on commerce activities like viewing and downloading invoices, managing payments, making purchases, and managing or provisioning licenses.
create_or_update	insert	billingAccountName, associatedTenantName		Create or update an associated tenant for the billing account.
delete	delete	billingAccountName, associatedTenantName		Deletes an associated tenant for a billing account.

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
associatedTenantName	string	The ID that uniquely identifies a tenant.
billingAccountName	string	The ID that uniquely identifies a billing account.
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.
includeRevoked	boolean	Can be used to get revoked associated tenants.
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 an associated tenant by ID.

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

list_by_billing_account

Lists the associated tenants that can collaborate with the billing account on commerce activities like viewing and downloading invoices, managing payments, making purchases, and managing or provisioning licenses.

SELECT
properties,
tags
FROM azure.billing.associated_tenants
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND includeRevoked = '{{ includeRevoked }}'
AND 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 an associated tenant for the billing account.

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

Manifest

# Description fields are for documentation purposes
- name: associated_tenants
  props:
    - name: billingAccountName
      value: string
      description: Required parameter for the associated_tenants resource.
    - name: associatedTenantName
      value: string
      description: Required parameter for the associated_tenants 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: |
        An associated tenant.

DELETE examples

delete

Deletes an associated tenant for a billing account.

DELETE FROM azure.billing.associated_tenants
WHERE billingAccountName = '{{ billingAccountName }}' --required
AND associatedTenantName = '{{ associatedTenantName }}' --required
;