b2c_tenants

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

Overview

Name	b2c_tenants
Type	Resource
Id	azure.aad_b2c.b2c_tenants

Fields

vw_b2c_tenants

Name	Datatype	Description
id	text	An identifier that represents the Azure AD B2C tenant resource.
name	text	The name of the Azure AD B2C tenant resource.
billing_config	text	field from the properties object
is_go_local_tenant	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.
resourceGroupName	text	field from the properties object
resourceName	text	field from the properties object
sku	text	SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.
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 B2C tenant resource.

b2c_tenants

Name	Datatype	Description
id	string	An identifier that represents the Azure AD B2C tenant resource.
name	string	The name of the Azure AD B2C 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 B2C tenant Azure resource.
sku	object	SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource Tags
type	string	The type of the B2C tenant resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, resourceName, subscriptionId	Get the Azure AD B2C tenant resource.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Get all the Azure AD B2C tenant resources in a resource group.
list_by_subscription	SELECT	subscriptionId	Get all the Azure AD B2C 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 B2C 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 B2C 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 B2C tenant resource.

SELECT examples

Get all the Azure AD B2C tenant resources in a subscription.

vw_b2c_tenants

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

b2c_tenants

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

INSERT example

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

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: location
      value: string
    - name: properties
      value:
        - name: createTenantProperties
          value:
            - name: displayName
              value: string
            - name: countryCode
              value: []
            - name: isGoLocalTenant
              value: []
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: string
    - name: tags
      value: object

UPDATE example

Updates a b2c_tenants resource.

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

DELETE example

Deletes the specified b2c_tenants resource.

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