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

vw_ciam_tenants

Name	Datatype	Description
id	text	An identifier that represents the Azure AD for customers tenant resource.
name	text	The name of the Azure AD for customers tenant resource.
billing_config	text	field from the properties object
create_tenant_properties	text	field from the properties object
domain_name	text	field from the properties object
location	text	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.
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
resourceName	text	field from the properties object
sku	text	SKU properties of the Azure AD for customers tenant. Learn more about Azure AD for customers billing at https://aka.ms/ciambilling.
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Resource Tags
tenant_id	text	field from the properties object
type	text	The type of the Azure AD for customers tenant resource.

ciam_tenants

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	Properties of the Azure AD for customers tenant Azure resource.
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

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, resourceName, subscriptionId	Get the Azure AD for customers tenant resource.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	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	resourceGroupName, resourceName, subscriptionId, data__location, data__properties, data__sku	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
delete	DELETE	resourceGroupName, resourceName, subscriptionId	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.
update	UPDATE	resourceGroupName, resourceName, subscriptionId	Update the Azure AD for customers tenant resource.

SELECT examples

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

vw_ciam_tenants

SELECT
id,
name,
billing_config,
create_tenant_properties,
domain_name,
location,
provisioning_state,
resourceGroupName,
resourceName,
sku,
subscriptionId,
system_data,
tags,
tenant_id,
type
FROM azure.aad_b2c.vw_ciam_tenants
WHERE subscriptionId = '{{ subscriptionId }}';

ciam_tenants

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

INSERT example

Use the following StackQL query and manifest file to create a new ciam_tenants resource.

All Properties

/*+ create */
INSERT INTO azure.aad_b2c.ciam_tenants (
resourceGroupName,
resourceName,
subscriptionId,
data__location,
data__properties,
data__sku,
location,
sku,
properties,
tags
)
SELECT 
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ subscriptionId }}',
'{{ data__location }}',
'{{ data__properties }}',
'{{ data__sku }}',
'{{ location }}',
'{{ sku }}',
'{{ properties }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: string
    - name: properties
      value:
        - name: provisioningState
          value: []
        - name: createTenantProperties
          value:
            - name: displayName
              value: string
            - name: countryCode
              value: string
        - name: domainName
          value: string
        - name: billingConfig
          value:
            - name: billingType
              value: string
            - name: effectiveStartDateUtc
              value: string
        - name: tenantId
          value: string
    - name: tags
      value: object
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string

UPDATE example

Updates a ciam_tenants resource.

/*+ update */
UPDATE azure.aad_b2c.ciam_tenants
SET 
sku = '{{ sku }}',
tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified ciam_tenants resource.

/*+ delete */
DELETE FROM azure.aad_b2c.ciam_tenants
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';