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

vw_domain_services

Name	Datatype	Description
id	text	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	text	The name of the resource
config_diagnostics	text	field from the properties object
deployment_id	text	field from the properties object
domainServiceName	text	field from the properties object
domain_configuration_type	text	field from the properties object
domain_name	text	field from the properties object
domain_security_settings	text	field from the properties object
filtered_sync	text	field from the properties object
ldaps_settings	text	field from the properties object
migration_properties	text	field from the properties object
notification_settings	text	field from the properties object
provisioning_state	text	field from the properties object
replica_sets	text	field from the properties object
resourceGroupName	text	field from the properties object
resource_forest_settings	text	field from the properties object
sku	text	field from the properties object
subscriptionId	text	field from the properties object
sync_application_id	text	field from the properties object
sync_owner	text	field from the properties object
sync_scope	text	field from the properties object
tenant_id	text	field from the properties object
type	text	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
version	text	field from the properties object

domain_services

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object	Properties of the Domain Service.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

Name	Accessible by	Required Params	Description
get	SELECT	domainServiceName, resourceGroupName, subscriptionId	The Get Domain Service operation retrieves a json representation of the Domain Service.
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).
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	The List Domain Services in Resource Group operation lists all the domain services available under the given resource group.
create_or_update	INSERT	domainServiceName, resourceGroupName, subscriptionId	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.
delete	DELETE	domainServiceName, resourceGroupName, subscriptionId	The Delete Domain Service operation deletes an existing Domain Service.
update	UPDATE	domainServiceName, resourceGroupName, subscriptionId	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.

SELECT examples

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

vw_domain_services

SELECT
id,
name,
config_diagnostics,
deployment_id,
domainServiceName,
domain_configuration_type,
domain_name,
domain_security_settings,
filtered_sync,
ldaps_settings,
migration_properties,
notification_settings,
provisioning_state,
replica_sets,
resourceGroupName,
resource_forest_settings,
sku,
subscriptionId,
sync_application_id,
sync_owner,
sync_scope,
tenant_id,
type,
version
FROM azure.aad_domain_services.vw_domain_services
WHERE subscriptionId = '{{ subscriptionId }}';

domain_services

SELECT
id,
name,
properties,
type
FROM azure.aad_domain_services.domain_services
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.aad_domain_services.domain_services (
domainServiceName,
resourceGroupName,
subscriptionId,
properties
)
SELECT 
'{{ domainServiceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: version
          value: integer
        - name: tenantId
          value: string
        - name: domainName
          value: string
        - name: deploymentId
          value: string
        - name: syncOwner
          value: string
        - name: syncApplicationId
          value: string
        - name: replicaSets
          value:
            - - name: replicaSetId
                value: string
              - name: location
                value: string
              - name: vnetSiteId
                value: string
              - name: subnetId
                value: string
              - name: domainControllerIpAddress
                value:
                  - string
              - name: externalAccessIpAddress
                value: string
              - name: serviceStatus
                value: string
              - name: healthLastEvaluated
                value: string
              - name: healthMonitors
                value:
                  - - name: id
                      value: string
                    - name: name
                      value: string
                    - name: details
                      value: string
              - name: healthAlerts
                value:
                  - - name: id
                      value: string
                    - name: name
                      value: string
                    - name: issue
                      value: string
                    - name: severity
                      value: string
                    - name: raised
                      value: string
                    - name: lastDetected
                      value: string
                    - name: resolutionUri
                      value: string
        - name: ldapsSettings
          value:
            - name: ldaps
              value: string
            - name: pfxCertificate
              value: string
            - name: pfxCertificatePassword
              value: string
            - name: publicCertificate
              value: string
            - name: certificateThumbprint
              value: string
            - name: certificateNotAfter
              value: string
            - name: externalAccess
              value: string
        - name: resourceForestSettings
          value:
            - name: settings
              value:
                - - name: trustedDomainFqdn
                    value: string
                  - name: trustDirection
                    value: string
                  - name: friendlyName
                    value: string
                  - name: remoteDnsIps
                    value: string
                  - name: trustPassword
                    value: string
            - name: resourceForest
              value: string
        - name: domainSecuritySettings
          value:
            - name: ntlmV1
              value: string
            - name: tlsV1
              value: string
            - name: syncNtlmPasswords
              value: string
            - name: syncKerberosPasswords
              value: string
            - name: syncOnPremPasswords
              value: string
            - name: kerberosRc4Encryption
              value: string
            - name: kerberosArmoring
              value: string
            - name: ldapSigning
              value: string
            - name: channelBinding
              value: string
        - name: domainConfigurationType
          value: string
        - name: sku
          value: string
        - name: filteredSync
          value: string
        - name: syncScope
          value: string
        - name: notificationSettings
          value:
            - name: notifyGlobalAdmins
              value: string
            - name: notifyDcAdmins
              value: string
            - name: additionalRecipients
              value:
                - string
        - name: migrationProperties
          value:
            - name: oldSubnetId
              value: string
            - name: oldVnetSiteId
              value: string
            - name: migrationProgress
              value:
                - name: completionPercentage
                  value: number
                - name: progressMessage
                  value: string
        - name: provisioningState
          value: string
        - name: configDiagnostics
          value:
            - name: lastExecuted
              value: string
            - name: validatorResults
              value:
                - - name: validatorId
                    value: string
                  - name: replicaSetSubnetDisplayName
                    value: string
                  - name: status
                    value: string
                  - name: issues
                    value:
                      - - name: id
                          value: string
                        - name: descriptionParams
                          value:
                            - string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string

UPDATE example

Updates a domain_services resource.

/*+ update */
UPDATE azure.aad_domain_services.domain_services
SET 
properties = '{{ properties }}'
WHERE 
domainServiceName = '{{ domainServiceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified domain_services resource.

/*+ delete */
DELETE FROM azure.aad_domain_services.domain_services
WHERE domainServiceName = '{{ domainServiceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';