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

The following fields are returned by SELECT queries:

get

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.

list

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

The following methods are available for this resource:

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

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 resource group the resource is located under.
subscriptionId	string	Subscription credentials which uniquely identify Microsoft Azure subscription.The subscription ID forms part of the URI for every service call.
tenant	string	Directory tenant name.

SELECT examples

get

Get a directory tenant by name.

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

list

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

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

INSERT examples

create_or_update

Create or updates a directory tenant.

INSERT INTO azure_stack.subscriptions_admin.directory_tenants (
data__properties,
data__location,
subscriptionId,
resourceGroupName,
tenant
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ tenant }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: directory_tenants
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the directory_tenants resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the directory_tenants resource.
    - name: tenant
      value: string
      description: Required parameter for the directory_tenants resource.
    - name: properties
      value: object
      description: |
        Directory tenant.
    - name: location
      value: string
      description: |
        Location of the resource

DELETE examples

delete

Delete a directory tenant under a resource group.

DELETE FROM azure_stack.subscriptions_admin.directory_tenants
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND tenant = '{{ tenant }}' --required
;