directory_tenants

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

Overview

Name	directory_tenants
Type	Resource
Id	azure_stack.subscriptions_admin.directory_tenants

Fields

vw_directory_tenants

Name	Datatype	Description
id	text	URI of the resource.
name	text	Name of the resource.
location	text	Location of the resource
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	List of key-value pairs.
tenant	text	field from the properties object
tenant_id	text	field from the properties object
type	text	Type of resource.

directory_tenants

Name	Datatype	Description
id	string	URI of the resource.
name	string	Name of the resource.
location	string	Location of the resource
properties	object	Directory tenant.
tags	object	List of key-value pairs.
type	string	Type of resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, subscriptionId, tenant	Get a directory tenant by name.
list	SELECT	resourceGroupName, subscriptionId	Lists all the directory tenants under the current subscription and given resource group name.
create_or_update	INSERT	resourceGroupName, subscriptionId, tenant	Create or updates a directory tenant.
delete	DELETE	resourceGroupName, subscriptionId, tenant	Delete a directory tenant under a resource group.

SELECT examples

Lists all the directory tenants under the current subscription and given resource group name.

vw_directory_tenants

SELECT
id,
name,
location,
resourceGroupName,
subscriptionId,
tags,
tenant,
tenant_id,
type
FROM azure_stack.subscriptions_admin.vw_directory_tenants
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

directory_tenants

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure_stack.subscriptions_admin.directory_tenants
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure_stack.subscriptions_admin.directory_tenants (
resourceGroupName,
subscriptionId,
tenant,
properties,
location
)
SELECT 
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ tenant }}',
'{{ properties }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: tenantId
          value: string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: tags
      value: object

DELETE example

Deletes the specified directory_tenants resource.

/*+ delete */
DELETE FROM azure_stack.subscriptions_admin.directory_tenants
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND tenant = '{{ tenant }}';