domain_services

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

Overview

Name	domain_services
Type	Resource
Id	azure.aad_domain_services.domain_services

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	Domain service properties
systemData	object	The system meta data relating to this resource.
tags	object	Resource tags
type	string	Resource type

list_by_resource_group

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	Domain service 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	Domain service 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		The Get Domain Service operation retrieves a json representation of the Domain Service.
list_by_resource_group	select	subscriptionId, resourceGroupName		The List Domain Services in Resource Group operation lists all the domain services available under the given resource group.
list	select	subscriptionId		The List Domain Services in Subscription operation lists all the domain services available under the given subscription (and across all resource groups within that subscription).
create_or_update	insert	subscriptionId, resourceGroupName, domainServiceName		The Create Domain Service operation creates a new domain service with the specified parameters. If the specific service already exists, then any patchable properties will be updated and any immutable properties will remain unchanged.
update	update	subscriptionId, resourceGroupName, domainServiceName		The Update Domain Service operation can be used to update the existing deployment. The update call only supports the properties listed in the PATCH body.
delete	delete	subscriptionId, resourceGroupName, domainServiceName		The Delete Domain Service operation deletes an existing Domain Service.

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.
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

The Get Domain Service operation retrieves a json representation of the Domain Service.

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

list_by_resource_group

The List Domain Services in Resource Group operation lists all the domain services available under the given resource group.

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

list

The List Domain Services in Subscription operation lists all the domain services available under the given subscription (and across all resource groups within that subscription).

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

INSERT examples

create_or_update

The Create Domain Service operation creates a new domain service with the specified parameters. If the specific service already exists, then any patchable properties will be updated and any immutable properties will remain unchanged.

INSERT INTO azure.aad_domain_services.domain_services (
data__properties,
data__location,
data__tags,
data__etag,
subscriptionId,
resourceGroupName,
domainServiceName
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ tags }}',
'{{ etag }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ domainServiceName }}'
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: domain_services
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the domain_services resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the domain_services resource.
    - name: domainServiceName
      value: string
      description: Required parameter for the domain_services resource.
    - name: properties
      value: object
      description: |
        Domain service properties
    - name: location
      value: string
      description: |
        Resource location
    - name: tags
      value: object
      description: |
        Resource tags
    - name: etag
      value: string
      description: |
        Resource etag

UPDATE examples

update

The Update Domain Service operation can be used to update the existing deployment. The update call only supports the properties listed in the PATCH body.

UPDATE azure.aad_domain_services.domain_services
SET 
data__properties = '{{ properties }}',
data__location = '{{ location }}',
data__tags = '{{ tags }}',
data__etag = '{{ etag }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND domainServiceName = '{{ domainServiceName }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

The Delete Domain Service operation deletes an existing Domain Service.

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