ou_containers

Creates, updates, deletes, gets or lists an ou_containers resource.

Overview

Name	ou_containers
Type	Resource
Id	azure.aad_domain_services.ou_containers

Fields

The following fields are returned by SELECT queries:

get

HTTP 200 (OK) if the operation was successful.

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
etag	string	Resource etag
location	string	Resource location
properties	object	OuContainer properties
systemData	object	The system meta data relating to this resource.
tags	object	Resource tags
type	string	Resource type

list

HTTP 200 (OK) if the operation was successful.

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
etag	string	Resource etag
location	string	Resource location
properties	object	OuContainer properties
systemData	object	The system meta data relating to this resource.
tags	object	Resource tags
type	string	Resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, domainServiceName, ouContainerName		Get OuContainer in DomainService instance.
list	select	subscriptionId, resourceGroupName, domainServiceName		The List of OuContainers in DomainService instance.
create	insert	subscriptionId, resourceGroupName, domainServiceName, ouContainerName		The Create OuContainer operation creates a new OuContainer under the specified Domain Service instance.
update	update	subscriptionId, resourceGroupName, domainServiceName, ouContainerName		The Update OuContainer operation can be used to update the existing OuContainers.
delete	delete	subscriptionId, resourceGroupName, domainServiceName, ouContainerName		The Delete OuContainer operation deletes specified OuContainer.

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
domainServiceName	string	The name of the domain service.
ouContainerName	string	The name of the OuContainer.
resourceGroupName	string	The name of the resource group within the user's subscription. The name is case insensitive.
subscriptionId	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Get OuContainer in DomainService instance.

SELECT
id,
name,
etag,
location,
properties,
systemData,
tags,
type
FROM azure.aad_domain_services.ou_containers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND domainServiceName = '{{ domainServiceName }}' -- required
AND ouContainerName = '{{ ouContainerName }}' -- required
;

list

The List of OuContainers in DomainService instance.

SELECT
id,
name,
etag,
location,
properties,
systemData,
tags,
type
FROM azure.aad_domain_services.ou_containers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND domainServiceName = '{{ domainServiceName }}' -- required
;

INSERT examples

create

The Create OuContainer operation creates a new OuContainer under the specified Domain Service instance.

INSERT INTO azure.aad_domain_services.ou_containers (
data__accountName,
data__spn,
data__password,
subscriptionId,
resourceGroupName,
domainServiceName,
ouContainerName
)
SELECT 
'{{ accountName }}',
'{{ spn }}',
'{{ password }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ domainServiceName }}',
'{{ ouContainerName }}'
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: ou_containers
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the ou_containers resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the ou_containers resource.
    - name: domainServiceName
      value: string
      description: Required parameter for the ou_containers resource.
    - name: ouContainerName
      value: string
      description: Required parameter for the ou_containers resource.
    - name: accountName
      value: string
      description: |
        The account name
    - name: spn
      value: string
      description: |
        The account spn
    - name: password
      value: string
      description: |
        The account password

UPDATE examples

update

The Update OuContainer operation can be used to update the existing OuContainers.

UPDATE azure.aad_domain_services.ou_containers
SET 
data__accountName = '{{ accountName }}',
data__spn = '{{ spn }}',
data__password = '{{ password }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND domainServiceName = '{{ domainServiceName }}' --required
AND ouContainerName = '{{ ouContainerName }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

The Delete OuContainer operation deletes specified OuContainer.

DELETE FROM azure.aad_domain_services.ou_containers
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND domainServiceName = '{{ domainServiceName }}' --required
AND ouContainerName = '{{ ouContainerName }}' --required
;