ciam_tenants

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

Overview

Name	ciam_tenants
Type	Resource
Id	azure.aad_b2c.ciam_tenants

Fields

The following fields are returned by SELECT queries:

get

Azure AD for customers tenant resource successfully retrieved.

Name	Datatype	Description
id	string	An identifier that represents the Azure AD for customers tenant resource.
name	string	The name of the Azure AD for customers tenant resource.
location	string	The location in which the resource is hosted and data resides. Can be one of 'United States', 'Europe', 'Asia Pacific', or 'Australia'. Refer to this documentation for more information.
properties	object	The Azure AD for customers tenant resource properties
sku	object	SKU properties of the Azure AD for customers tenant. Learn more about Azure AD for customers billing at https://aka.ms/ciambilling.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource Tags
type	string	The type of the Azure AD for customers tenant resource.

list_by_resource_group

List of Azure AD for customers tenants in resource group successfully retrieved.

Name	Datatype	Description
id	string	An identifier that represents the Azure AD for customers tenant resource.
name	string	The name of the Azure AD for customers tenant resource.
location	string	The location in which the resource is hosted and data resides. Can be one of 'United States', 'Europe', 'Asia Pacific', or 'Australia'. Refer to this documentation for more information.
properties	object	The Azure AD for customers tenant resource properties
sku	object	SKU properties of the Azure AD for customers tenant. Learn more about Azure AD for customers billing at https://aka.ms/ciambilling.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource Tags
type	string	The type of the Azure AD for customers tenant resource.

list_by_subscription

Azure AD for customers tenant resources in subscription successfully retrieved.

Name	Datatype	Description
id	string	An identifier that represents the Azure AD for customers tenant resource.
name	string	The name of the Azure AD for customers tenant resource.
location	string	The location in which the resource is hosted and data resides. Can be one of 'United States', 'Europe', 'Asia Pacific', or 'Australia'. Refer to this documentation for more information.
properties	object	The Azure AD for customers tenant resource properties
sku	object	SKU properties of the Azure AD for customers tenant. Learn more about Azure AD for customers billing at https://aka.ms/ciambilling.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource Tags
type	string	The type of the Azure AD for customers tenant resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, resourceName		Get the Azure AD for customers tenant resource.
list_by_resource_group	select	subscriptionId, resourceGroupName		Get all the Azure AD for customers tenants resources in a resource group.
list_by_subscription	select	subscriptionId		Get all the Azure AD for customers tenant resources in a subscription.
create	insert	subscriptionId, resourceGroupName, resourceName, data__location, data__sku, data__properties		Initiates an async request to create both the Azure AD for customers tenant and the corresponding Azure resource linked to a subscription. Note: Please check name availability before creating a new tenant
update	update	subscriptionId, resourceGroupName, resourceName		Update the Azure AD for customers tenant resource.
delete	delete	subscriptionId, resourceGroupName, resourceName		Initiates an async operation to delete the Azure AD for customers tenant and Azure resource. The resource deletion can only happen as the last step in the tenant deletion process.

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
resourceName	string	The initial sub domain of the tenant.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Get the Azure AD for customers tenant resource.

SELECT
id,
name,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.aad_b2c.ciam_tenants
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;

list_by_resource_group

Get all the Azure AD for customers tenants resources in a resource group.

SELECT
id,
name,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.aad_b2c.ciam_tenants
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Get all the Azure AD for customers tenant resources in a subscription.

SELECT
id,
name,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.aad_b2c.ciam_tenants
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Initiates an async request to create both the Azure AD for customers tenant and the corresponding Azure resource linked to a subscription. Note: Please check name availability before creating a new tenant

INSERT INTO azure.aad_b2c.ciam_tenants (
data__location,
data__sku,
data__properties,
data__tags,
subscriptionId,
resourceGroupName,
resourceName
)
SELECT 
'{{ location }}' /* required */,
'{{ sku }}' /* required */,
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}'
RETURNING
id,
name,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: ciam_tenants
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the ciam_tenants resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the ciam_tenants resource.
    - name: resourceName
      value: string
      description: Required parameter for the ciam_tenants resource.
    - name: location
      value: string
      description: |
        The location in which the resource is hosted and data resides. Can be one of 'United States', 'Europe', 'Asia Pacific', or 'Australia'. Refer to [this documentation](https://aka.ms/ciam-data-location) for more information.
    - name: sku
      value: object
      description: |
        SKU properties of the Azure AD for customers tenant. Learn more about Azure AD for customers billing at [https://aka.ms/ciambilling](https://aka.ms/ciambilling).
    - name: properties
      value: object
      description: |
        The Azure AD for customers tenant resource properties
    - name: tags
      value: object
      description: |
        Resource Tags

UPDATE examples

update

Update the Azure AD for customers tenant resource.

UPDATE azure.aad_b2c.ciam_tenants
SET 
data__sku = '{{ sku }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
RETURNING
id,
name,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Initiates an async operation to delete the Azure AD for customers tenant and Azure resource. The resource deletion can only happen as the last step in the tenant deletion process.

DELETE FROM azure.aad_b2c.ciam_tenants
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
;