Microsoft.AAD (stable:2017-01-01)

2025/09/19 • 7 new, 7 deleted methods

DomainServiceOperations_List (new)
Description :  Lists all the available Domain Services operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AAD/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of operations. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The operation supported by Domain Services. ,
Required: False ,
}
{
description:
{
Description: The description of the operation. ,
Required: False ,
}
string ,
operation:
{
Description: The action that users can perform, based on their permission level. ,
Required: False ,
}
string ,
provider:
{
Description: Service provider: Domain Services. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The origin of the operation. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
Required: False ,
}
string ,
}
DomainServices_List (new)
Description :  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).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AAD/domainServices
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: the list of domain services. ,
Required: False ,
}
[
{
properties:
{
Description: Domain service properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure Active Directory tenant id ,
Required: False ,
}
string ,
domainName:
{
Description: The name of the Azure domain that the user would like to deploy Domain Services to. ,
Required: False ,
}
string ,
deploymentId:
{
Description: Deployment Id ,
Required: False ,
}
string ,
vnetSiteId:
{
Description: Virtual network site id ,
Required: False ,
}
string ,
subnetId:
{
Description: The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName. ,
Required: False ,
}
string ,
ldapsSettings:
{
Description: Secure LDAP Settings ,
Required: False ,
}
{
ldaps:
{
Description: A flag to determine whether or not Secure LDAP is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pfxCertificate:
{
Description: The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file. ,
Required: False ,
}
string ,
pfxCertificatePassword:
{
Description: The password to decrypt the provided Secure LDAP certificate pfx file. ,
Required: False ,
}
string ,
publicCertificate:
{
Description: Public certificate used to configure secure ldap. ,
Required: False ,
}
string ,
certificateThumbprint:
{
Description: Thumbprint of configure ldaps certificate. ,
Required: False ,
}
string ,
certificateNotAfter:
{
Description: NotAfter DateTime of configure ldaps certificate. ,
Format: date-time ,
Required: False ,
}
string ,
externalAccess:
{
Description: A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalAccessIpAddress:
{
Description: External access ip address. ,
Required: False ,
}
string ,
}
,
healthLastEvaluated:
{
Description: Last domain evaluation run DateTime ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
healthMonitors:
{
Description: List of Domain Health Monitors ,
Required: False ,
}
[
{
id:
{
Description: Health Monitor Id ,
Required: False ,
}
string ,
name:
{
Description: Health Monitor Name ,
Required: False ,
}
string ,
details:
{
Description: Health Monitor Details ,
Required: False ,
}
string ,
}
,
]
,
healthAlerts:
{
Description: List of Domain Health Alerts ,
Required: False ,
}
[
{
id:
{
Description: Health Alert Id ,
Required: False ,
}
string ,
name:
{
Description: Health Alert Name ,
Required: False ,
}
string ,
issue:
{
Description: Health Alert Issue ,
Required: False ,
}
string ,
severity:
{
Description: Health Alert Severity ,
Required: False ,
}
string ,
raised:
{
Description: Health Alert Raised DateTime ,
Format: date-time ,
Required: False ,
}
string ,
lastDetected:
{
Description: Health Alert Last Detected DateTime ,
Format: date-time ,
Required: False ,
}
string ,
resolutionUri:
{
Description: Health Alert TSG Link ,
Required: False ,
}
string ,
}
,
]
,
notificationSettings:
{
Description: Notification Settings ,
Required: False ,
}
{
notifyGlobalAdmins:
{
Description: Should global admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notifyDcAdmins:
{
Description: Should domain controller admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
additionalRecipients:
{
Description: The list of additional recipients ,
Required: False ,
}
[
string ,
]
,
}
,
domainSecuritySettings:
{
Description: DomainSecurity Settings ,
Required: False ,
}
{
ntlmV1:
{
Description: A flag to determine whether or not NtlmV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tlsV1:
{
Description: A flag to determine whether or not TlsV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
syncNtlmPasswords:
{
Description: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
filteredSync:
{
Description: Enabled or Disabled flag to turn on Group-based filtered sync ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
domainControllerIpAddress:
{
Description: List of Domain Controller IP Address ,
Required: False ,
}
[
string ,
]
,
serviceStatus:
{
Description: Status of Domain Service instance ,
Required: False ,
}
string ,
provisioningState:
{
Description: the current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
Required: False ,
}
string ,
}
DomainServices_ListByResourceGroup (new)
Description :  The List Domain Services in Resource Group operation lists all the domain services available under the given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AAD/domainServices
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: the list of domain services. ,
Required: False ,
}
[
{
properties:
{
Description: Domain service properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure Active Directory tenant id ,
Required: False ,
}
string ,
domainName:
{
Description: The name of the Azure domain that the user would like to deploy Domain Services to. ,
Required: False ,
}
string ,
deploymentId:
{
Description: Deployment Id ,
Required: False ,
}
string ,
vnetSiteId:
{
Description: Virtual network site id ,
Required: False ,
}
string ,
subnetId:
{
Description: The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName. ,
Required: False ,
}
string ,
ldapsSettings:
{
Description: Secure LDAP Settings ,
Required: False ,
}
{
ldaps:
{
Description: A flag to determine whether or not Secure LDAP is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pfxCertificate:
{
Description: The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file. ,
Required: False ,
}
string ,
pfxCertificatePassword:
{
Description: The password to decrypt the provided Secure LDAP certificate pfx file. ,
Required: False ,
}
string ,
publicCertificate:
{
Description: Public certificate used to configure secure ldap. ,
Required: False ,
}
string ,
certificateThumbprint:
{
Description: Thumbprint of configure ldaps certificate. ,
Required: False ,
}
string ,
certificateNotAfter:
{
Description: NotAfter DateTime of configure ldaps certificate. ,
Format: date-time ,
Required: False ,
}
string ,
externalAccess:
{
Description: A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalAccessIpAddress:
{
Description: External access ip address. ,
Required: False ,
}
string ,
}
,
healthLastEvaluated:
{
Description: Last domain evaluation run DateTime ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
healthMonitors:
{
Description: List of Domain Health Monitors ,
Required: False ,
}
[
{
id:
{
Description: Health Monitor Id ,
Required: False ,
}
string ,
name:
{
Description: Health Monitor Name ,
Required: False ,
}
string ,
details:
{
Description: Health Monitor Details ,
Required: False ,
}
string ,
}
,
]
,
healthAlerts:
{
Description: List of Domain Health Alerts ,
Required: False ,
}
[
{
id:
{
Description: Health Alert Id ,
Required: False ,
}
string ,
name:
{
Description: Health Alert Name ,
Required: False ,
}
string ,
issue:
{
Description: Health Alert Issue ,
Required: False ,
}
string ,
severity:
{
Description: Health Alert Severity ,
Required: False ,
}
string ,
raised:
{
Description: Health Alert Raised DateTime ,
Format: date-time ,
Required: False ,
}
string ,
lastDetected:
{
Description: Health Alert Last Detected DateTime ,
Format: date-time ,
Required: False ,
}
string ,
resolutionUri:
{
Description: Health Alert TSG Link ,
Required: False ,
}
string ,
}
,
]
,
notificationSettings:
{
Description: Notification Settings ,
Required: False ,
}
{
notifyGlobalAdmins:
{
Description: Should global admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notifyDcAdmins:
{
Description: Should domain controller admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
additionalRecipients:
{
Description: The list of additional recipients ,
Required: False ,
}
[
string ,
]
,
}
,
domainSecuritySettings:
{
Description: DomainSecurity Settings ,
Required: False ,
}
{
ntlmV1:
{
Description: A flag to determine whether or not NtlmV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tlsV1:
{
Description: A flag to determine whether or not TlsV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
syncNtlmPasswords:
{
Description: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
filteredSync:
{
Description: Enabled or Disabled flag to turn on Group-based filtered sync ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
domainControllerIpAddress:
{
Description: List of Domain Controller IP Address ,
Required: False ,
}
[
string ,
]
,
serviceStatus:
{
Description: Status of Domain Service instance ,
Required: False ,
}
string ,
provisioningState:
{
Description: the current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
Required: False ,
}
string ,
}
DomainServices_CreateOrUpdate (new)
Description :  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.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AAD/domainServices/{domainServiceName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
domainServiceName:
{
Description: The name of the domain service. ,
Required: True ,
}
string ,
domainService:
{
Description: Properties supplied to the Create or Update a Domain Service operation. ,
Required: True ,
}
{
properties:
{
Description: Domain service properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure Active Directory tenant id ,
Required: False ,
}
string ,
domainName:
{
Description: The name of the Azure domain that the user would like to deploy Domain Services to. ,
Required: False ,
}
string ,
deploymentId:
{
Description: Deployment Id ,
Required: False ,
}
string ,
vnetSiteId:
{
Description: Virtual network site id ,
Required: False ,
}
string ,
subnetId:
{
Description: The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName. ,
Required: False ,
}
string ,
ldapsSettings:
{
Description: Secure LDAP Settings ,
Required: False ,
}
{
ldaps:
{
Description: A flag to determine whether or not Secure LDAP is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pfxCertificate:
{
Description: The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file. ,
Required: False ,
}
string ,
pfxCertificatePassword:
{
Description: The password to decrypt the provided Secure LDAP certificate pfx file. ,
Required: False ,
}
string ,
publicCertificate:
{
Description: Public certificate used to configure secure ldap. ,
Required: False ,
}
string ,
certificateThumbprint:
{
Description: Thumbprint of configure ldaps certificate. ,
Required: False ,
}
string ,
certificateNotAfter:
{
Description: NotAfter DateTime of configure ldaps certificate. ,
Format: date-time ,
Required: False ,
}
string ,
externalAccess:
{
Description: A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalAccessIpAddress:
{
Description: External access ip address. ,
Required: False ,
}
string ,
}
,
healthLastEvaluated:
{
Description: Last domain evaluation run DateTime ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
healthMonitors:
{
Description: List of Domain Health Monitors ,
Required: False ,
}
[
{
id:
{
Description: Health Monitor Id ,
Required: False ,
}
string ,
name:
{
Description: Health Monitor Name ,
Required: False ,
}
string ,
details:
{
Description: Health Monitor Details ,
Required: False ,
}
string ,
}
,
]
,
healthAlerts:
{
Description: List of Domain Health Alerts ,
Required: False ,
}
[
{
id:
{
Description: Health Alert Id ,
Required: False ,
}
string ,
name:
{
Description: Health Alert Name ,
Required: False ,
}
string ,
issue:
{
Description: Health Alert Issue ,
Required: False ,
}
string ,
severity:
{
Description: Health Alert Severity ,
Required: False ,
}
string ,
raised:
{
Description: Health Alert Raised DateTime ,
Format: date-time ,
Required: False ,
}
string ,
lastDetected:
{
Description: Health Alert Last Detected DateTime ,
Format: date-time ,
Required: False ,
}
string ,
resolutionUri:
{
Description: Health Alert TSG Link ,
Required: False ,
}
string ,
}
,
]
,
notificationSettings:
{
Description: Notification Settings ,
Required: False ,
}
{
notifyGlobalAdmins:
{
Description: Should global admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notifyDcAdmins:
{
Description: Should domain controller admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
additionalRecipients:
{
Description: The list of additional recipients ,
Required: False ,
}
[
string ,
]
,
}
,
domainSecuritySettings:
{
Description: DomainSecurity Settings ,
Required: False ,
}
{
ntlmV1:
{
Description: A flag to determine whether or not NtlmV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tlsV1:
{
Description: A flag to determine whether or not TlsV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
syncNtlmPasswords:
{
Description: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
filteredSync:
{
Description: Enabled or Disabled flag to turn on Group-based filtered sync ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
domainControllerIpAddress:
{
Description: List of Domain Controller IP Address ,
Required: False ,
}
[
string ,
]
,
serviceStatus:
{
Description: Status of Domain Service instance ,
Required: False ,
}
string ,
provisioningState:
{
Description: the current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Domain service properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure Active Directory tenant id ,
Required: False ,
}
string ,
domainName:
{
Description: The name of the Azure domain that the user would like to deploy Domain Services to. ,
Required: False ,
}
string ,
deploymentId:
{
Description: Deployment Id ,
Required: False ,
}
string ,
vnetSiteId:
{
Description: Virtual network site id ,
Required: False ,
}
string ,
subnetId:
{
Description: The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName. ,
Required: False ,
}
string ,
ldapsSettings:
{
Description: Secure LDAP Settings ,
Required: False ,
}
{
ldaps:
{
Description: A flag to determine whether or not Secure LDAP is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pfxCertificate:
{
Description: The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file. ,
Required: False ,
}
string ,
pfxCertificatePassword:
{
Description: The password to decrypt the provided Secure LDAP certificate pfx file. ,
Required: False ,
}
string ,
publicCertificate:
{
Description: Public certificate used to configure secure ldap. ,
Required: False ,
}
string ,
certificateThumbprint:
{
Description: Thumbprint of configure ldaps certificate. ,
Required: False ,
}
string ,
certificateNotAfter:
{
Description: NotAfter DateTime of configure ldaps certificate. ,
Format: date-time ,
Required: False ,
}
string ,
externalAccess:
{
Description: A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalAccessIpAddress:
{
Description: External access ip address. ,
Required: False ,
}
string ,
}
,
healthLastEvaluated:
{
Description: Last domain evaluation run DateTime ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
healthMonitors:
{
Description: List of Domain Health Monitors ,
Required: False ,
}
[
{
id:
{
Description: Health Monitor Id ,
Required: False ,
}
string ,
name:
{
Description: Health Monitor Name ,
Required: False ,
}
string ,
details:
{
Description: Health Monitor Details ,
Required: False ,
}
string ,
}
,
]
,
healthAlerts:
{
Description: List of Domain Health Alerts ,
Required: False ,
}
[
{
id:
{
Description: Health Alert Id ,
Required: False ,
}
string ,
name:
{
Description: Health Alert Name ,
Required: False ,
}
string ,
issue:
{
Description: Health Alert Issue ,
Required: False ,
}
string ,
severity:
{
Description: Health Alert Severity ,
Required: False ,
}
string ,
raised:
{
Description: Health Alert Raised DateTime ,
Format: date-time ,
Required: False ,
}
string ,
lastDetected:
{
Description: Health Alert Last Detected DateTime ,
Format: date-time ,
Required: False ,
}
string ,
resolutionUri:
{
Description: Health Alert TSG Link ,
Required: False ,
}
string ,
}
,
]
,
notificationSettings:
{
Description: Notification Settings ,
Required: False ,
}
{
notifyGlobalAdmins:
{
Description: Should global admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notifyDcAdmins:
{
Description: Should domain controller admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
additionalRecipients:
{
Description: The list of additional recipients ,
Required: False ,
}
[
string ,
]
,
}
,
domainSecuritySettings:
{
Description: DomainSecurity Settings ,
Required: False ,
}
{
ntlmV1:
{
Description: A flag to determine whether or not NtlmV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tlsV1:
{
Description: A flag to determine whether or not TlsV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
syncNtlmPasswords:
{
Description: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
filteredSync:
{
Description: Enabled or Disabled flag to turn on Group-based filtered sync ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
domainControllerIpAddress:
{
Description: List of Domain Controller IP Address ,
Required: False ,
}
[
string ,
]
,
serviceStatus:
{
Description: Status of Domain Service instance ,
Required: False ,
}
string ,
provisioningState:
{
Description: the current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Domain service properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure Active Directory tenant id ,
Required: False ,
}
string ,
domainName:
{
Description: The name of the Azure domain that the user would like to deploy Domain Services to. ,
Required: False ,
}
string ,
deploymentId:
{
Description: Deployment Id ,
Required: False ,
}
string ,
vnetSiteId:
{
Description: Virtual network site id ,
Required: False ,
}
string ,
subnetId:
{
Description: The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName. ,
Required: False ,
}
string ,
ldapsSettings:
{
Description: Secure LDAP Settings ,
Required: False ,
}
{
ldaps:
{
Description: A flag to determine whether or not Secure LDAP is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pfxCertificate:
{
Description: The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file. ,
Required: False ,
}
string ,
pfxCertificatePassword:
{
Description: The password to decrypt the provided Secure LDAP certificate pfx file. ,
Required: False ,
}
string ,
publicCertificate:
{
Description: Public certificate used to configure secure ldap. ,
Required: False ,
}
string ,
certificateThumbprint:
{
Description: Thumbprint of configure ldaps certificate. ,
Required: False ,
}
string ,
certificateNotAfter:
{
Description: NotAfter DateTime of configure ldaps certificate. ,
Format: date-time ,
Required: False ,
}
string ,
externalAccess:
{
Description: A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalAccessIpAddress:
{
Description: External access ip address. ,
Required: False ,
}
string ,
}
,
healthLastEvaluated:
{
Description: Last domain evaluation run DateTime ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
healthMonitors:
{
Description: List of Domain Health Monitors ,
Required: False ,
}
[
{
id:
{
Description: Health Monitor Id ,
Required: False ,
}
string ,
name:
{
Description: Health Monitor Name ,
Required: False ,
}
string ,
details:
{
Description: Health Monitor Details ,
Required: False ,
}
string ,
}
,
]
,
healthAlerts:
{
Description: List of Domain Health Alerts ,
Required: False ,
}
[
{
id:
{
Description: Health Alert Id ,
Required: False ,
}
string ,
name:
{
Description: Health Alert Name ,
Required: False ,
}
string ,
issue:
{
Description: Health Alert Issue ,
Required: False ,
}
string ,
severity:
{
Description: Health Alert Severity ,
Required: False ,
}
string ,
raised:
{
Description: Health Alert Raised DateTime ,
Format: date-time ,
Required: False ,
}
string ,
lastDetected:
{
Description: Health Alert Last Detected DateTime ,
Format: date-time ,
Required: False ,
}
string ,
resolutionUri:
{
Description: Health Alert TSG Link ,
Required: False ,
}
string ,
}
,
]
,
notificationSettings:
{
Description: Notification Settings ,
Required: False ,
}
{
notifyGlobalAdmins:
{
Description: Should global admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notifyDcAdmins:
{
Description: Should domain controller admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
additionalRecipients:
{
Description: The list of additional recipients ,
Required: False ,
}
[
string ,
]
,
}
,
domainSecuritySettings:
{
Description: DomainSecurity Settings ,
Required: False ,
}
{
ntlmV1:
{
Description: A flag to determine whether or not NtlmV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tlsV1:
{
Description: A flag to determine whether or not TlsV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
syncNtlmPasswords:
{
Description: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
filteredSync:
{
Description: Enabled or Disabled flag to turn on Group-based filtered sync ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
domainControllerIpAddress:
{
Description: List of Domain Controller IP Address ,
Required: False ,
}
[
string ,
]
,
serviceStatus:
{
Description: Status of Domain Service instance ,
Required: False ,
}
string ,
provisioningState:
{
Description: the current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Domain service properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure Active Directory tenant id ,
Required: False ,
}
string ,
domainName:
{
Description: The name of the Azure domain that the user would like to deploy Domain Services to. ,
Required: False ,
}
string ,
deploymentId:
{
Description: Deployment Id ,
Required: False ,
}
string ,
vnetSiteId:
{
Description: Virtual network site id ,
Required: False ,
}
string ,
subnetId:
{
Description: The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName. ,
Required: False ,
}
string ,
ldapsSettings:
{
Description: Secure LDAP Settings ,
Required: False ,
}
{
ldaps:
{
Description: A flag to determine whether or not Secure LDAP is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pfxCertificate:
{
Description: The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file. ,
Required: False ,
}
string ,
pfxCertificatePassword:
{
Description: The password to decrypt the provided Secure LDAP certificate pfx file. ,
Required: False ,
}
string ,
publicCertificate:
{
Description: Public certificate used to configure secure ldap. ,
Required: False ,
}
string ,
certificateThumbprint:
{
Description: Thumbprint of configure ldaps certificate. ,
Required: False ,
}
string ,
certificateNotAfter:
{
Description: NotAfter DateTime of configure ldaps certificate. ,
Format: date-time ,
Required: False ,
}
string ,
externalAccess:
{
Description: A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalAccessIpAddress:
{
Description: External access ip address. ,
Required: False ,
}
string ,
}
,
healthLastEvaluated:
{
Description: Last domain evaluation run DateTime ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
healthMonitors:
{
Description: List of Domain Health Monitors ,
Required: False ,
}
[
{
id:
{
Description: Health Monitor Id ,
Required: False ,
}
string ,
name:
{
Description: Health Monitor Name ,
Required: False ,
}
string ,
details:
{
Description: Health Monitor Details ,
Required: False ,
}
string ,
}
,
]
,
healthAlerts:
{
Description: List of Domain Health Alerts ,
Required: False ,
}
[
{
id:
{
Description: Health Alert Id ,
Required: False ,
}
string ,
name:
{
Description: Health Alert Name ,
Required: False ,
}
string ,
issue:
{
Description: Health Alert Issue ,
Required: False ,
}
string ,
severity:
{
Description: Health Alert Severity ,
Required: False ,
}
string ,
raised:
{
Description: Health Alert Raised DateTime ,
Format: date-time ,
Required: False ,
}
string ,
lastDetected:
{
Description: Health Alert Last Detected DateTime ,
Format: date-time ,
Required: False ,
}
string ,
resolutionUri:
{
Description: Health Alert TSG Link ,
Required: False ,
}
string ,
}
,
]
,
notificationSettings:
{
Description: Notification Settings ,
Required: False ,
}
{
notifyGlobalAdmins:
{
Description: Should global admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notifyDcAdmins:
{
Description: Should domain controller admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
additionalRecipients:
{
Description: The list of additional recipients ,
Required: False ,
}
[
string ,
]
,
}
,
domainSecuritySettings:
{
Description: DomainSecurity Settings ,
Required: False ,
}
{
ntlmV1:
{
Description: A flag to determine whether or not NtlmV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tlsV1:
{
Description: A flag to determine whether or not TlsV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
syncNtlmPasswords:
{
Description: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
filteredSync:
{
Description: Enabled or Disabled flag to turn on Group-based filtered sync ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
domainControllerIpAddress:
{
Description: List of Domain Controller IP Address ,
Required: False ,
}
[
string ,
]
,
serviceStatus:
{
Description: Status of Domain Service instance ,
Required: False ,
}
string ,
provisioningState:
{
Description: the current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
DomainServices_Get (new)
Description :  The Get Domain Service operation retrieves a json representation of the Domain Service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AAD/domainServices/{domainServiceName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
domainServiceName:
{
Description: The name of the domain service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Domain service properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure Active Directory tenant id ,
Required: False ,
}
string ,
domainName:
{
Description: The name of the Azure domain that the user would like to deploy Domain Services to. ,
Required: False ,
}
string ,
deploymentId:
{
Description: Deployment Id ,
Required: False ,
}
string ,
vnetSiteId:
{
Description: Virtual network site id ,
Required: False ,
}
string ,
subnetId:
{
Description: The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName. ,
Required: False ,
}
string ,
ldapsSettings:
{
Description: Secure LDAP Settings ,
Required: False ,
}
{
ldaps:
{
Description: A flag to determine whether or not Secure LDAP is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pfxCertificate:
{
Description: The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file. ,
Required: False ,
}
string ,
pfxCertificatePassword:
{
Description: The password to decrypt the provided Secure LDAP certificate pfx file. ,
Required: False ,
}
string ,
publicCertificate:
{
Description: Public certificate used to configure secure ldap. ,
Required: False ,
}
string ,
certificateThumbprint:
{
Description: Thumbprint of configure ldaps certificate. ,
Required: False ,
}
string ,
certificateNotAfter:
{
Description: NotAfter DateTime of configure ldaps certificate. ,
Format: date-time ,
Required: False ,
}
string ,
externalAccess:
{
Description: A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalAccessIpAddress:
{
Description: External access ip address. ,
Required: False ,
}
string ,
}
,
healthLastEvaluated:
{
Description: Last domain evaluation run DateTime ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
healthMonitors:
{
Description: List of Domain Health Monitors ,
Required: False ,
}
[
{
id:
{
Description: Health Monitor Id ,
Required: False ,
}
string ,
name:
{
Description: Health Monitor Name ,
Required: False ,
}
string ,
details:
{
Description: Health Monitor Details ,
Required: False ,
}
string ,
}
,
]
,
healthAlerts:
{
Description: List of Domain Health Alerts ,
Required: False ,
}
[
{
id:
{
Description: Health Alert Id ,
Required: False ,
}
string ,
name:
{
Description: Health Alert Name ,
Required: False ,
}
string ,
issue:
{
Description: Health Alert Issue ,
Required: False ,
}
string ,
severity:
{
Description: Health Alert Severity ,
Required: False ,
}
string ,
raised:
{
Description: Health Alert Raised DateTime ,
Format: date-time ,
Required: False ,
}
string ,
lastDetected:
{
Description: Health Alert Last Detected DateTime ,
Format: date-time ,
Required: False ,
}
string ,
resolutionUri:
{
Description: Health Alert TSG Link ,
Required: False ,
}
string ,
}
,
]
,
notificationSettings:
{
Description: Notification Settings ,
Required: False ,
}
{
notifyGlobalAdmins:
{
Description: Should global admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notifyDcAdmins:
{
Description: Should domain controller admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
additionalRecipients:
{
Description: The list of additional recipients ,
Required: False ,
}
[
string ,
]
,
}
,
domainSecuritySettings:
{
Description: DomainSecurity Settings ,
Required: False ,
}
{
ntlmV1:
{
Description: A flag to determine whether or not NtlmV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tlsV1:
{
Description: A flag to determine whether or not TlsV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
syncNtlmPasswords:
{
Description: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
filteredSync:
{
Description: Enabled or Disabled flag to turn on Group-based filtered sync ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
domainControllerIpAddress:
{
Description: List of Domain Controller IP Address ,
Required: False ,
}
[
string ,
]
,
serviceStatus:
{
Description: Status of Domain Service instance ,
Required: False ,
}
string ,
provisioningState:
{
Description: the current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
DomainServices_Delete (new)
Description :  The Delete Domain Service operation deletes an existing Domain Service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AAD/domainServices/{domainServiceName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
domainServiceName:
{
Description: The name of the domain service. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
DomainServices_Update (new)
Description :  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.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AAD/domainServices/{domainServiceName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
domainServiceName:
{
Description: The name of the domain service. ,
Required: True ,
}
string ,
domainService:
{
Description: Properties supplied to the Update a Domain Service operation. ,
Required: True ,
}
{
properties:
{
Description: Domain service properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure Active Directory tenant id ,
Required: False ,
}
string ,
domainName:
{
Description: The name of the Azure domain that the user would like to deploy Domain Services to. ,
Required: False ,
}
string ,
deploymentId:
{
Description: Deployment Id ,
Required: False ,
}
string ,
vnetSiteId:
{
Description: Virtual network site id ,
Required: False ,
}
string ,
subnetId:
{
Description: The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName. ,
Required: False ,
}
string ,
ldapsSettings:
{
Description: Secure LDAP Settings ,
Required: False ,
}
{
ldaps:
{
Description: A flag to determine whether or not Secure LDAP is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pfxCertificate:
{
Description: The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file. ,
Required: False ,
}
string ,
pfxCertificatePassword:
{
Description: The password to decrypt the provided Secure LDAP certificate pfx file. ,
Required: False ,
}
string ,
publicCertificate:
{
Description: Public certificate used to configure secure ldap. ,
Required: False ,
}
string ,
certificateThumbprint:
{
Description: Thumbprint of configure ldaps certificate. ,
Required: False ,
}
string ,
certificateNotAfter:
{
Description: NotAfter DateTime of configure ldaps certificate. ,
Format: date-time ,
Required: False ,
}
string ,
externalAccess:
{
Description: A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalAccessIpAddress:
{
Description: External access ip address. ,
Required: False ,
}
string ,
}
,
healthLastEvaluated:
{
Description: Last domain evaluation run DateTime ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
healthMonitors:
{
Description: List of Domain Health Monitors ,
Required: False ,
}
[
{
id:
{
Description: Health Monitor Id ,
Required: False ,
}
string ,
name:
{
Description: Health Monitor Name ,
Required: False ,
}
string ,
details:
{
Description: Health Monitor Details ,
Required: False ,
}
string ,
}
,
]
,
healthAlerts:
{
Description: List of Domain Health Alerts ,
Required: False ,
}
[
{
id:
{
Description: Health Alert Id ,
Required: False ,
}
string ,
name:
{
Description: Health Alert Name ,
Required: False ,
}
string ,
issue:
{
Description: Health Alert Issue ,
Required: False ,
}
string ,
severity:
{
Description: Health Alert Severity ,
Required: False ,
}
string ,
raised:
{
Description: Health Alert Raised DateTime ,
Format: date-time ,
Required: False ,
}
string ,
lastDetected:
{
Description: Health Alert Last Detected DateTime ,
Format: date-time ,
Required: False ,
}
string ,
resolutionUri:
{
Description: Health Alert TSG Link ,
Required: False ,
}
string ,
}
,
]
,
notificationSettings:
{
Description: Notification Settings ,
Required: False ,
}
{
notifyGlobalAdmins:
{
Description: Should global admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notifyDcAdmins:
{
Description: Should domain controller admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
additionalRecipients:
{
Description: The list of additional recipients ,
Required: False ,
}
[
string ,
]
,
}
,
domainSecuritySettings:
{
Description: DomainSecurity Settings ,
Required: False ,
}
{
ntlmV1:
{
Description: A flag to determine whether or not NtlmV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tlsV1:
{
Description: A flag to determine whether or not TlsV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
syncNtlmPasswords:
{
Description: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
filteredSync:
{
Description: Enabled or Disabled flag to turn on Group-based filtered sync ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
domainControllerIpAddress:
{
Description: List of Domain Controller IP Address ,
Required: False ,
}
[
string ,
]
,
serviceStatus:
{
Description: Status of Domain Service instance ,
Required: False ,
}
string ,
provisioningState:
{
Description: the current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Domain service properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure Active Directory tenant id ,
Required: False ,
}
string ,
domainName:
{
Description: The name of the Azure domain that the user would like to deploy Domain Services to. ,
Required: False ,
}
string ,
deploymentId:
{
Description: Deployment Id ,
Required: False ,
}
string ,
vnetSiteId:
{
Description: Virtual network site id ,
Required: False ,
}
string ,
subnetId:
{
Description: The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName. ,
Required: False ,
}
string ,
ldapsSettings:
{
Description: Secure LDAP Settings ,
Required: False ,
}
{
ldaps:
{
Description: A flag to determine whether or not Secure LDAP is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pfxCertificate:
{
Description: The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file. ,
Required: False ,
}
string ,
pfxCertificatePassword:
{
Description: The password to decrypt the provided Secure LDAP certificate pfx file. ,
Required: False ,
}
string ,
publicCertificate:
{
Description: Public certificate used to configure secure ldap. ,
Required: False ,
}
string ,
certificateThumbprint:
{
Description: Thumbprint of configure ldaps certificate. ,
Required: False ,
}
string ,
certificateNotAfter:
{
Description: NotAfter DateTime of configure ldaps certificate. ,
Format: date-time ,
Required: False ,
}
string ,
externalAccess:
{
Description: A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalAccessIpAddress:
{
Description: External access ip address. ,
Required: False ,
}
string ,
}
,
healthLastEvaluated:
{
Description: Last domain evaluation run DateTime ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
healthMonitors:
{
Description: List of Domain Health Monitors ,
Required: False ,
}
[
{
id:
{
Description: Health Monitor Id ,
Required: False ,
}
string ,
name:
{
Description: Health Monitor Name ,
Required: False ,
}
string ,
details:
{
Description: Health Monitor Details ,
Required: False ,
}
string ,
}
,
]
,
healthAlerts:
{
Description: List of Domain Health Alerts ,
Required: False ,
}
[
{
id:
{
Description: Health Alert Id ,
Required: False ,
}
string ,
name:
{
Description: Health Alert Name ,
Required: False ,
}
string ,
issue:
{
Description: Health Alert Issue ,
Required: False ,
}
string ,
severity:
{
Description: Health Alert Severity ,
Required: False ,
}
string ,
raised:
{
Description: Health Alert Raised DateTime ,
Format: date-time ,
Required: False ,
}
string ,
lastDetected:
{
Description: Health Alert Last Detected DateTime ,
Format: date-time ,
Required: False ,
}
string ,
resolutionUri:
{
Description: Health Alert TSG Link ,
Required: False ,
}
string ,
}
,
]
,
notificationSettings:
{
Description: Notification Settings ,
Required: False ,
}
{
notifyGlobalAdmins:
{
Description: Should global admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notifyDcAdmins:
{
Description: Should domain controller admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
additionalRecipients:
{
Description: The list of additional recipients ,
Required: False ,
}
[
string ,
]
,
}
,
domainSecuritySettings:
{
Description: DomainSecurity Settings ,
Required: False ,
}
{
ntlmV1:
{
Description: A flag to determine whether or not NtlmV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tlsV1:
{
Description: A flag to determine whether or not TlsV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
syncNtlmPasswords:
{
Description: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
filteredSync:
{
Description: Enabled or Disabled flag to turn on Group-based filtered sync ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
domainControllerIpAddress:
{
Description: List of Domain Controller IP Address ,
Required: False ,
}
[
string ,
]
,
serviceStatus:
{
Description: Status of Domain Service instance ,
Required: False ,
}
string ,
provisioningState:
{
Description: the current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Domain service properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure Active Directory tenant id ,
Required: False ,
}
string ,
domainName:
{
Description: The name of the Azure domain that the user would like to deploy Domain Services to. ,
Required: False ,
}
string ,
deploymentId:
{
Description: Deployment Id ,
Required: False ,
}
string ,
vnetSiteId:
{
Description: Virtual network site id ,
Required: False ,
}
string ,
subnetId:
{
Description: The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName. ,
Required: False ,
}
string ,
ldapsSettings:
{
Description: Secure LDAP Settings ,
Required: False ,
}
{
ldaps:
{
Description: A flag to determine whether or not Secure LDAP is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pfxCertificate:
{
Description: The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file. ,
Required: False ,
}
string ,
pfxCertificatePassword:
{
Description: The password to decrypt the provided Secure LDAP certificate pfx file. ,
Required: False ,
}
string ,
publicCertificate:
{
Description: Public certificate used to configure secure ldap. ,
Required: False ,
}
string ,
certificateThumbprint:
{
Description: Thumbprint of configure ldaps certificate. ,
Required: False ,
}
string ,
certificateNotAfter:
{
Description: NotAfter DateTime of configure ldaps certificate. ,
Format: date-time ,
Required: False ,
}
string ,
externalAccess:
{
Description: A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalAccessIpAddress:
{
Description: External access ip address. ,
Required: False ,
}
string ,
}
,
healthLastEvaluated:
{
Description: Last domain evaluation run DateTime ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
healthMonitors:
{
Description: List of Domain Health Monitors ,
Required: False ,
}
[
{
id:
{
Description: Health Monitor Id ,
Required: False ,
}
string ,
name:
{
Description: Health Monitor Name ,
Required: False ,
}
string ,
details:
{
Description: Health Monitor Details ,
Required: False ,
}
string ,
}
,
]
,
healthAlerts:
{
Description: List of Domain Health Alerts ,
Required: False ,
}
[
{
id:
{
Description: Health Alert Id ,
Required: False ,
}
string ,
name:
{
Description: Health Alert Name ,
Required: False ,
}
string ,
issue:
{
Description: Health Alert Issue ,
Required: False ,
}
string ,
severity:
{
Description: Health Alert Severity ,
Required: False ,
}
string ,
raised:
{
Description: Health Alert Raised DateTime ,
Format: date-time ,
Required: False ,
}
string ,
lastDetected:
{
Description: Health Alert Last Detected DateTime ,
Format: date-time ,
Required: False ,
}
string ,
resolutionUri:
{
Description: Health Alert TSG Link ,
Required: False ,
}
string ,
}
,
]
,
notificationSettings:
{
Description: Notification Settings ,
Required: False ,
}
{
notifyGlobalAdmins:
{
Description: Should global admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notifyDcAdmins:
{
Description: Should domain controller admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
additionalRecipients:
{
Description: The list of additional recipients ,
Required: False ,
}
[
string ,
]
,
}
,
domainSecuritySettings:
{
Description: DomainSecurity Settings ,
Required: False ,
}
{
ntlmV1:
{
Description: A flag to determine whether or not NtlmV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tlsV1:
{
Description: A flag to determine whether or not TlsV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
syncNtlmPasswords:
{
Description: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
filteredSync:
{
Description: Enabled or Disabled flag to turn on Group-based filtered sync ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
domainControllerIpAddress:
{
Description: List of Domain Controller IP Address ,
Required: False ,
}
[
string ,
]
,
serviceStatus:
{
Description: Status of Domain Service instance ,
Required: False ,
}
string ,
provisioningState:
{
Description: the current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
DomainServiceOperations_List (removed)
Description :  Lists all the available Domain Services operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AAD/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of operations. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The operation supported by Domain Services. ,
Required: False ,
}
{
description:
{
Description: The description of the operation. ,
Required: False ,
}
string ,
operation:
{
Description: The action that users can perform, based on their permission level. ,
Required: False ,
}
string ,
provider:
{
Description: Service provider: Domain Services. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The origin of the operation. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
Required: False ,
}
string ,
}
DomainServices_List (removed)
Description :  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).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AAD/domainServices
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: the list of domain services. ,
Required: False ,
}
[
{
properties:
{
Description: Domain service properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure Active Directory tenant id ,
Required: False ,
}
string ,
domainName:
{
Description: The name of the Azure domain that the user would like to deploy Domain Services to. ,
Required: False ,
}
string ,
deploymentId:
{
Description: Deployment Id ,
Required: False ,
}
string ,
vnetSiteId:
{
Description: Virtual network site id ,
Required: False ,
}
string ,
subnetId:
{
Description: The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName. ,
Required: False ,
}
string ,
ldapsSettings:
{
Description: Secure LDAP Settings ,
Required: False ,
}
{
ldaps:
{
Description: A flag to determine whether or not Secure LDAP is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pfxCertificate:
{
Description: The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file. ,
Required: False ,
}
string ,
pfxCertificatePassword:
{
Description: The password to decrypt the provided Secure LDAP certificate pfx file. ,
Required: False ,
}
string ,
publicCertificate:
{
Description: Public certificate used to configure secure ldap. ,
Required: False ,
}
string ,
certificateThumbprint:
{
Description: Thumbprint of configure ldaps certificate. ,
Required: False ,
}
string ,
certificateNotAfter:
{
Description: NotAfter DateTime of configure ldaps certificate. ,
Format: date-time ,
Required: False ,
}
string ,
externalAccess:
{
Description: A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalAccessIpAddress:
{
Description: External access ip address. ,
Required: False ,
}
string ,
}
,
healthLastEvaluated:
{
Description: Last domain evaluation run DateTime ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
healthMonitors:
{
Description: List of Domain Health Monitors ,
Required: False ,
}
[
{
id:
{
Description: Health Monitor Id ,
Required: False ,
}
string ,
name:
{
Description: Health Monitor Name ,
Required: False ,
}
string ,
details:
{
Description: Health Monitor Details ,
Required: False ,
}
string ,
}
,
]
,
healthAlerts:
{
Description: List of Domain Health Alerts ,
Required: False ,
}
[
{
id:
{
Description: Health Alert Id ,
Required: False ,
}
string ,
name:
{
Description: Health Alert Name ,
Required: False ,
}
string ,
issue:
{
Description: Health Alert Issue ,
Required: False ,
}
string ,
severity:
{
Description: Health Alert Severity ,
Required: False ,
}
string ,
raised:
{
Description: Health Alert Raised DateTime ,
Format: date-time ,
Required: False ,
}
string ,
lastDetected:
{
Description: Health Alert Last Detected DateTime ,
Format: date-time ,
Required: False ,
}
string ,
resolutionUri:
{
Description: Health Alert TSG Link ,
Required: False ,
}
string ,
}
,
]
,
notificationSettings:
{
Description: Notification Settings ,
Required: False ,
}
{
notifyGlobalAdmins:
{
Description: Should global admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notifyDcAdmins:
{
Description: Should domain controller admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
additionalRecipients:
{
Description: The list of additional recipients ,
Required: False ,
}
[
string ,
]
,
}
,
domainSecuritySettings:
{
Description: DomainSecurity Settings ,
Required: False ,
}
{
ntlmV1:
{
Description: A flag to determine whether or not NtlmV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tlsV1:
{
Description: A flag to determine whether or not TlsV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
syncNtlmPasswords:
{
Description: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
filteredSync:
{
Description: Enabled or Disabled flag to turn on Group-based filtered sync ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
domainControllerIpAddress:
{
Description: List of Domain Controller IP Address ,
Required: False ,
}
[
string ,
]
,
serviceStatus:
{
Description: Status of Domain Service instance ,
Required: False ,
}
string ,
provisioningState:
{
Description: the current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
Required: False ,
}
string ,
}
DomainServices_ListByResourceGroup (removed)
Description :  The List Domain Services in Resource Group operation lists all the domain services available under the given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AAD/domainServices
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: the list of domain services. ,
Required: False ,
}
[
{
properties:
{
Description: Domain service properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure Active Directory tenant id ,
Required: False ,
}
string ,
domainName:
{
Description: The name of the Azure domain that the user would like to deploy Domain Services to. ,
Required: False ,
}
string ,
deploymentId:
{
Description: Deployment Id ,
Required: False ,
}
string ,
vnetSiteId:
{
Description: Virtual network site id ,
Required: False ,
}
string ,
subnetId:
{
Description: The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName. ,
Required: False ,
}
string ,
ldapsSettings:
{
Description: Secure LDAP Settings ,
Required: False ,
}
{
ldaps:
{
Description: A flag to determine whether or not Secure LDAP is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pfxCertificate:
{
Description: The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file. ,
Required: False ,
}
string ,
pfxCertificatePassword:
{
Description: The password to decrypt the provided Secure LDAP certificate pfx file. ,
Required: False ,
}
string ,
publicCertificate:
{
Description: Public certificate used to configure secure ldap. ,
Required: False ,
}
string ,
certificateThumbprint:
{
Description: Thumbprint of configure ldaps certificate. ,
Required: False ,
}
string ,
certificateNotAfter:
{
Description: NotAfter DateTime of configure ldaps certificate. ,
Format: date-time ,
Required: False ,
}
string ,
externalAccess:
{
Description: A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalAccessIpAddress:
{
Description: External access ip address. ,
Required: False ,
}
string ,
}
,
healthLastEvaluated:
{
Description: Last domain evaluation run DateTime ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
healthMonitors:
{
Description: List of Domain Health Monitors ,
Required: False ,
}
[
{
id:
{
Description: Health Monitor Id ,
Required: False ,
}
string ,
name:
{
Description: Health Monitor Name ,
Required: False ,
}
string ,
details:
{
Description: Health Monitor Details ,
Required: False ,
}
string ,
}
,
]
,
healthAlerts:
{
Description: List of Domain Health Alerts ,
Required: False ,
}
[
{
id:
{
Description: Health Alert Id ,
Required: False ,
}
string ,
name:
{
Description: Health Alert Name ,
Required: False ,
}
string ,
issue:
{
Description: Health Alert Issue ,
Required: False ,
}
string ,
severity:
{
Description: Health Alert Severity ,
Required: False ,
}
string ,
raised:
{
Description: Health Alert Raised DateTime ,
Format: date-time ,
Required: False ,
}
string ,
lastDetected:
{
Description: Health Alert Last Detected DateTime ,
Format: date-time ,
Required: False ,
}
string ,
resolutionUri:
{
Description: Health Alert TSG Link ,
Required: False ,
}
string ,
}
,
]
,
notificationSettings:
{
Description: Notification Settings ,
Required: False ,
}
{
notifyGlobalAdmins:
{
Description: Should global admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notifyDcAdmins:
{
Description: Should domain controller admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
additionalRecipients:
{
Description: The list of additional recipients ,
Required: False ,
}
[
string ,
]
,
}
,
domainSecuritySettings:
{
Description: DomainSecurity Settings ,
Required: False ,
}
{
ntlmV1:
{
Description: A flag to determine whether or not NtlmV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tlsV1:
{
Description: A flag to determine whether or not TlsV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
syncNtlmPasswords:
{
Description: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
filteredSync:
{
Description: Enabled or Disabled flag to turn on Group-based filtered sync ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
domainControllerIpAddress:
{
Description: List of Domain Controller IP Address ,
Required: False ,
}
[
string ,
]
,
serviceStatus:
{
Description: Status of Domain Service instance ,
Required: False ,
}
string ,
provisioningState:
{
Description: the current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
Required: False ,
}
string ,
}
DomainServices_CreateOrUpdate (removed)
Description :  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.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AAD/domainServices/{domainServiceName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
domainServiceName:
{
Description: The name of the domain service. ,
Required: True ,
}
string ,
domainService:
{
Description: Properties supplied to the Create or Update a Domain Service operation. ,
Required: True ,
}
{
properties:
{
Description: Domain service properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure Active Directory tenant id ,
Required: False ,
}
string ,
domainName:
{
Description: The name of the Azure domain that the user would like to deploy Domain Services to. ,
Required: False ,
}
string ,
deploymentId:
{
Description: Deployment Id ,
Required: False ,
}
string ,
vnetSiteId:
{
Description: Virtual network site id ,
Required: False ,
}
string ,
subnetId:
{
Description: The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName. ,
Required: False ,
}
string ,
ldapsSettings:
{
Description: Secure LDAP Settings ,
Required: False ,
}
{
ldaps:
{
Description: A flag to determine whether or not Secure LDAP is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pfxCertificate:
{
Description: The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file. ,
Required: False ,
}
string ,
pfxCertificatePassword:
{
Description: The password to decrypt the provided Secure LDAP certificate pfx file. ,
Required: False ,
}
string ,
publicCertificate:
{
Description: Public certificate used to configure secure ldap. ,
Required: False ,
}
string ,
certificateThumbprint:
{
Description: Thumbprint of configure ldaps certificate. ,
Required: False ,
}
string ,
certificateNotAfter:
{
Description: NotAfter DateTime of configure ldaps certificate. ,
Format: date-time ,
Required: False ,
}
string ,
externalAccess:
{
Description: A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalAccessIpAddress:
{
Description: External access ip address. ,
Required: False ,
}
string ,
}
,
healthLastEvaluated:
{
Description: Last domain evaluation run DateTime ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
healthMonitors:
{
Description: List of Domain Health Monitors ,
Required: False ,
}
[
{
id:
{
Description: Health Monitor Id ,
Required: False ,
}
string ,
name:
{
Description: Health Monitor Name ,
Required: False ,
}
string ,
details:
{
Description: Health Monitor Details ,
Required: False ,
}
string ,
}
,
]
,
healthAlerts:
{
Description: List of Domain Health Alerts ,
Required: False ,
}
[
{
id:
{
Description: Health Alert Id ,
Required: False ,
}
string ,
name:
{
Description: Health Alert Name ,
Required: False ,
}
string ,
issue:
{
Description: Health Alert Issue ,
Required: False ,
}
string ,
severity:
{
Description: Health Alert Severity ,
Required: False ,
}
string ,
raised:
{
Description: Health Alert Raised DateTime ,
Format: date-time ,
Required: False ,
}
string ,
lastDetected:
{
Description: Health Alert Last Detected DateTime ,
Format: date-time ,
Required: False ,
}
string ,
resolutionUri:
{
Description: Health Alert TSG Link ,
Required: False ,
}
string ,
}
,
]
,
notificationSettings:
{
Description: Notification Settings ,
Required: False ,
}
{
notifyGlobalAdmins:
{
Description: Should global admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notifyDcAdmins:
{
Description: Should domain controller admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
additionalRecipients:
{
Description: The list of additional recipients ,
Required: False ,
}
[
string ,
]
,
}
,
domainSecuritySettings:
{
Description: DomainSecurity Settings ,
Required: False ,
}
{
ntlmV1:
{
Description: A flag to determine whether or not NtlmV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tlsV1:
{
Description: A flag to determine whether or not TlsV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
syncNtlmPasswords:
{
Description: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
filteredSync:
{
Description: Enabled or Disabled flag to turn on Group-based filtered sync ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
domainControllerIpAddress:
{
Description: List of Domain Controller IP Address ,
Required: False ,
}
[
string ,
]
,
serviceStatus:
{
Description: Status of Domain Service instance ,
Required: False ,
}
string ,
provisioningState:
{
Description: the current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Domain service properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure Active Directory tenant id ,
Required: False ,
}
string ,
domainName:
{
Description: The name of the Azure domain that the user would like to deploy Domain Services to. ,
Required: False ,
}
string ,
deploymentId:
{
Description: Deployment Id ,
Required: False ,
}
string ,
vnetSiteId:
{
Description: Virtual network site id ,
Required: False ,
}
string ,
subnetId:
{
Description: The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName. ,
Required: False ,
}
string ,
ldapsSettings:
{
Description: Secure LDAP Settings ,
Required: False ,
}
{
ldaps:
{
Description: A flag to determine whether or not Secure LDAP is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pfxCertificate:
{
Description: The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file. ,
Required: False ,
}
string ,
pfxCertificatePassword:
{
Description: The password to decrypt the provided Secure LDAP certificate pfx file. ,
Required: False ,
}
string ,
publicCertificate:
{
Description: Public certificate used to configure secure ldap. ,
Required: False ,
}
string ,
certificateThumbprint:
{
Description: Thumbprint of configure ldaps certificate. ,
Required: False ,
}
string ,
certificateNotAfter:
{
Description: NotAfter DateTime of configure ldaps certificate. ,
Format: date-time ,
Required: False ,
}
string ,
externalAccess:
{
Description: A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalAccessIpAddress:
{
Description: External access ip address. ,
Required: False ,
}
string ,
}
,
healthLastEvaluated:
{
Description: Last domain evaluation run DateTime ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
healthMonitors:
{
Description: List of Domain Health Monitors ,
Required: False ,
}
[
{
id:
{
Description: Health Monitor Id ,
Required: False ,
}
string ,
name:
{
Description: Health Monitor Name ,
Required: False ,
}
string ,
details:
{
Description: Health Monitor Details ,
Required: False ,
}
string ,
}
,
]
,
healthAlerts:
{
Description: List of Domain Health Alerts ,
Required: False ,
}
[
{
id:
{
Description: Health Alert Id ,
Required: False ,
}
string ,
name:
{
Description: Health Alert Name ,
Required: False ,
}
string ,
issue:
{
Description: Health Alert Issue ,
Required: False ,
}
string ,
severity:
{
Description: Health Alert Severity ,
Required: False ,
}
string ,
raised:
{
Description: Health Alert Raised DateTime ,
Format: date-time ,
Required: False ,
}
string ,
lastDetected:
{
Description: Health Alert Last Detected DateTime ,
Format: date-time ,
Required: False ,
}
string ,
resolutionUri:
{
Description: Health Alert TSG Link ,
Required: False ,
}
string ,
}
,
]
,
notificationSettings:
{
Description: Notification Settings ,
Required: False ,
}
{
notifyGlobalAdmins:
{
Description: Should global admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notifyDcAdmins:
{
Description: Should domain controller admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
additionalRecipients:
{
Description: The list of additional recipients ,
Required: False ,
}
[
string ,
]
,
}
,
domainSecuritySettings:
{
Description: DomainSecurity Settings ,
Required: False ,
}
{
ntlmV1:
{
Description: A flag to determine whether or not NtlmV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tlsV1:
{
Description: A flag to determine whether or not TlsV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
syncNtlmPasswords:
{
Description: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
filteredSync:
{
Description: Enabled or Disabled flag to turn on Group-based filtered sync ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
domainControllerIpAddress:
{
Description: List of Domain Controller IP Address ,
Required: False ,
}
[
string ,
]
,
serviceStatus:
{
Description: Status of Domain Service instance ,
Required: False ,
}
string ,
provisioningState:
{
Description: the current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Domain service properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure Active Directory tenant id ,
Required: False ,
}
string ,
domainName:
{
Description: The name of the Azure domain that the user would like to deploy Domain Services to. ,
Required: False ,
}
string ,
deploymentId:
{
Description: Deployment Id ,
Required: False ,
}
string ,
vnetSiteId:
{
Description: Virtual network site id ,
Required: False ,
}
string ,
subnetId:
{
Description: The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName. ,
Required: False ,
}
string ,
ldapsSettings:
{
Description: Secure LDAP Settings ,
Required: False ,
}
{
ldaps:
{
Description: A flag to determine whether or not Secure LDAP is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pfxCertificate:
{
Description: The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file. ,
Required: False ,
}
string ,
pfxCertificatePassword:
{
Description: The password to decrypt the provided Secure LDAP certificate pfx file. ,
Required: False ,
}
string ,
publicCertificate:
{
Description: Public certificate used to configure secure ldap. ,
Required: False ,
}
string ,
certificateThumbprint:
{
Description: Thumbprint of configure ldaps certificate. ,
Required: False ,
}
string ,
certificateNotAfter:
{
Description: NotAfter DateTime of configure ldaps certificate. ,
Format: date-time ,
Required: False ,
}
string ,
externalAccess:
{
Description: A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalAccessIpAddress:
{
Description: External access ip address. ,
Required: False ,
}
string ,
}
,
healthLastEvaluated:
{
Description: Last domain evaluation run DateTime ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
healthMonitors:
{
Description: List of Domain Health Monitors ,
Required: False ,
}
[
{
id:
{
Description: Health Monitor Id ,
Required: False ,
}
string ,
name:
{
Description: Health Monitor Name ,
Required: False ,
}
string ,
details:
{
Description: Health Monitor Details ,
Required: False ,
}
string ,
}
,
]
,
healthAlerts:
{
Description: List of Domain Health Alerts ,
Required: False ,
}
[
{
id:
{
Description: Health Alert Id ,
Required: False ,
}
string ,
name:
{
Description: Health Alert Name ,
Required: False ,
}
string ,
issue:
{
Description: Health Alert Issue ,
Required: False ,
}
string ,
severity:
{
Description: Health Alert Severity ,
Required: False ,
}
string ,
raised:
{
Description: Health Alert Raised DateTime ,
Format: date-time ,
Required: False ,
}
string ,
lastDetected:
{
Description: Health Alert Last Detected DateTime ,
Format: date-time ,
Required: False ,
}
string ,
resolutionUri:
{
Description: Health Alert TSG Link ,
Required: False ,
}
string ,
}
,
]
,
notificationSettings:
{
Description: Notification Settings ,
Required: False ,
}
{
notifyGlobalAdmins:
{
Description: Should global admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notifyDcAdmins:
{
Description: Should domain controller admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
additionalRecipients:
{
Description: The list of additional recipients ,
Required: False ,
}
[
string ,
]
,
}
,
domainSecuritySettings:
{
Description: DomainSecurity Settings ,
Required: False ,
}
{
ntlmV1:
{
Description: A flag to determine whether or not NtlmV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tlsV1:
{
Description: A flag to determine whether or not TlsV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
syncNtlmPasswords:
{
Description: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
filteredSync:
{
Description: Enabled or Disabled flag to turn on Group-based filtered sync ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
domainControllerIpAddress:
{
Description: List of Domain Controller IP Address ,
Required: False ,
}
[
string ,
]
,
serviceStatus:
{
Description: Status of Domain Service instance ,
Required: False ,
}
string ,
provisioningState:
{
Description: the current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Domain service properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure Active Directory tenant id ,
Required: False ,
}
string ,
domainName:
{
Description: The name of the Azure domain that the user would like to deploy Domain Services to. ,
Required: False ,
}
string ,
deploymentId:
{
Description: Deployment Id ,
Required: False ,
}
string ,
vnetSiteId:
{
Description: Virtual network site id ,
Required: False ,
}
string ,
subnetId:
{
Description: The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName. ,
Required: False ,
}
string ,
ldapsSettings:
{
Description: Secure LDAP Settings ,
Required: False ,
}
{
ldaps:
{
Description: A flag to determine whether or not Secure LDAP is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pfxCertificate:
{
Description: The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file. ,
Required: False ,
}
string ,
pfxCertificatePassword:
{
Description: The password to decrypt the provided Secure LDAP certificate pfx file. ,
Required: False ,
}
string ,
publicCertificate:
{
Description: Public certificate used to configure secure ldap. ,
Required: False ,
}
string ,
certificateThumbprint:
{
Description: Thumbprint of configure ldaps certificate. ,
Required: False ,
}
string ,
certificateNotAfter:
{
Description: NotAfter DateTime of configure ldaps certificate. ,
Format: date-time ,
Required: False ,
}
string ,
externalAccess:
{
Description: A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalAccessIpAddress:
{
Description: External access ip address. ,
Required: False ,
}
string ,
}
,
healthLastEvaluated:
{
Description: Last domain evaluation run DateTime ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
healthMonitors:
{
Description: List of Domain Health Monitors ,
Required: False ,
}
[
{
id:
{
Description: Health Monitor Id ,
Required: False ,
}
string ,
name:
{
Description: Health Monitor Name ,
Required: False ,
}
string ,
details:
{
Description: Health Monitor Details ,
Required: False ,
}
string ,
}
,
]
,
healthAlerts:
{
Description: List of Domain Health Alerts ,
Required: False ,
}
[
{
id:
{
Description: Health Alert Id ,
Required: False ,
}
string ,
name:
{
Description: Health Alert Name ,
Required: False ,
}
string ,
issue:
{
Description: Health Alert Issue ,
Required: False ,
}
string ,
severity:
{
Description: Health Alert Severity ,
Required: False ,
}
string ,
raised:
{
Description: Health Alert Raised DateTime ,
Format: date-time ,
Required: False ,
}
string ,
lastDetected:
{
Description: Health Alert Last Detected DateTime ,
Format: date-time ,
Required: False ,
}
string ,
resolutionUri:
{
Description: Health Alert TSG Link ,
Required: False ,
}
string ,
}
,
]
,
notificationSettings:
{
Description: Notification Settings ,
Required: False ,
}
{
notifyGlobalAdmins:
{
Description: Should global admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notifyDcAdmins:
{
Description: Should domain controller admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
additionalRecipients:
{
Description: The list of additional recipients ,
Required: False ,
}
[
string ,
]
,
}
,
domainSecuritySettings:
{
Description: DomainSecurity Settings ,
Required: False ,
}
{
ntlmV1:
{
Description: A flag to determine whether or not NtlmV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tlsV1:
{
Description: A flag to determine whether or not TlsV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
syncNtlmPasswords:
{
Description: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
filteredSync:
{
Description: Enabled or Disabled flag to turn on Group-based filtered sync ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
domainControllerIpAddress:
{
Description: List of Domain Controller IP Address ,
Required: False ,
}
[
string ,
]
,
serviceStatus:
{
Description: Status of Domain Service instance ,
Required: False ,
}
string ,
provisioningState:
{
Description: the current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
DomainServices_Get (removed)
Description :  The Get Domain Service operation retrieves a json representation of the Domain Service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AAD/domainServices/{domainServiceName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
domainServiceName:
{
Description: The name of the domain service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Domain service properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure Active Directory tenant id ,
Required: False ,
}
string ,
domainName:
{
Description: The name of the Azure domain that the user would like to deploy Domain Services to. ,
Required: False ,
}
string ,
deploymentId:
{
Description: Deployment Id ,
Required: False ,
}
string ,
vnetSiteId:
{
Description: Virtual network site id ,
Required: False ,
}
string ,
subnetId:
{
Description: The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName. ,
Required: False ,
}
string ,
ldapsSettings:
{
Description: Secure LDAP Settings ,
Required: False ,
}
{
ldaps:
{
Description: A flag to determine whether or not Secure LDAP is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pfxCertificate:
{
Description: The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file. ,
Required: False ,
}
string ,
pfxCertificatePassword:
{
Description: The password to decrypt the provided Secure LDAP certificate pfx file. ,
Required: False ,
}
string ,
publicCertificate:
{
Description: Public certificate used to configure secure ldap. ,
Required: False ,
}
string ,
certificateThumbprint:
{
Description: Thumbprint of configure ldaps certificate. ,
Required: False ,
}
string ,
certificateNotAfter:
{
Description: NotAfter DateTime of configure ldaps certificate. ,
Format: date-time ,
Required: False ,
}
string ,
externalAccess:
{
Description: A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalAccessIpAddress:
{
Description: External access ip address. ,
Required: False ,
}
string ,
}
,
healthLastEvaluated:
{
Description: Last domain evaluation run DateTime ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
healthMonitors:
{
Description: List of Domain Health Monitors ,
Required: False ,
}
[
{
id:
{
Description: Health Monitor Id ,
Required: False ,
}
string ,
name:
{
Description: Health Monitor Name ,
Required: False ,
}
string ,
details:
{
Description: Health Monitor Details ,
Required: False ,
}
string ,
}
,
]
,
healthAlerts:
{
Description: List of Domain Health Alerts ,
Required: False ,
}
[
{
id:
{
Description: Health Alert Id ,
Required: False ,
}
string ,
name:
{
Description: Health Alert Name ,
Required: False ,
}
string ,
issue:
{
Description: Health Alert Issue ,
Required: False ,
}
string ,
severity:
{
Description: Health Alert Severity ,
Required: False ,
}
string ,
raised:
{
Description: Health Alert Raised DateTime ,
Format: date-time ,
Required: False ,
}
string ,
lastDetected:
{
Description: Health Alert Last Detected DateTime ,
Format: date-time ,
Required: False ,
}
string ,
resolutionUri:
{
Description: Health Alert TSG Link ,
Required: False ,
}
string ,
}
,
]
,
notificationSettings:
{
Description: Notification Settings ,
Required: False ,
}
{
notifyGlobalAdmins:
{
Description: Should global admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notifyDcAdmins:
{
Description: Should domain controller admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
additionalRecipients:
{
Description: The list of additional recipients ,
Required: False ,
}
[
string ,
]
,
}
,
domainSecuritySettings:
{
Description: DomainSecurity Settings ,
Required: False ,
}
{
ntlmV1:
{
Description: A flag to determine whether or not NtlmV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tlsV1:
{
Description: A flag to determine whether or not TlsV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
syncNtlmPasswords:
{
Description: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
filteredSync:
{
Description: Enabled or Disabled flag to turn on Group-based filtered sync ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
domainControllerIpAddress:
{
Description: List of Domain Controller IP Address ,
Required: False ,
}
[
string ,
]
,
serviceStatus:
{
Description: Status of Domain Service instance ,
Required: False ,
}
string ,
provisioningState:
{
Description: the current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
DomainServices_Delete (removed)
Description :  The Delete Domain Service operation deletes an existing Domain Service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AAD/domainServices/{domainServiceName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
domainServiceName:
{
Description: The name of the domain service. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
DomainServices_Update (removed)
Description :  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.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AAD/domainServices/{domainServiceName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
domainServiceName:
{
Description: The name of the domain service. ,
Required: True ,
}
string ,
domainService:
{
Description: Properties supplied to the Update a Domain Service operation. ,
Required: True ,
}
{
properties:
{
Description: Domain service properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure Active Directory tenant id ,
Required: False ,
}
string ,
domainName:
{
Description: The name of the Azure domain that the user would like to deploy Domain Services to. ,
Required: False ,
}
string ,
deploymentId:
{
Description: Deployment Id ,
Required: False ,
}
string ,
vnetSiteId:
{
Description: Virtual network site id ,
Required: False ,
}
string ,
subnetId:
{
Description: The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName. ,
Required: False ,
}
string ,
ldapsSettings:
{
Description: Secure LDAP Settings ,
Required: False ,
}
{
ldaps:
{
Description: A flag to determine whether or not Secure LDAP is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pfxCertificate:
{
Description: The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file. ,
Required: False ,
}
string ,
pfxCertificatePassword:
{
Description: The password to decrypt the provided Secure LDAP certificate pfx file. ,
Required: False ,
}
string ,
publicCertificate:
{
Description: Public certificate used to configure secure ldap. ,
Required: False ,
}
string ,
certificateThumbprint:
{
Description: Thumbprint of configure ldaps certificate. ,
Required: False ,
}
string ,
certificateNotAfter:
{
Description: NotAfter DateTime of configure ldaps certificate. ,
Format: date-time ,
Required: False ,
}
string ,
externalAccess:
{
Description: A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalAccessIpAddress:
{
Description: External access ip address. ,
Required: False ,
}
string ,
}
,
healthLastEvaluated:
{
Description: Last domain evaluation run DateTime ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
healthMonitors:
{
Description: List of Domain Health Monitors ,
Required: False ,
}
[
{
id:
{
Description: Health Monitor Id ,
Required: False ,
}
string ,
name:
{
Description: Health Monitor Name ,
Required: False ,
}
string ,
details:
{
Description: Health Monitor Details ,
Required: False ,
}
string ,
}
,
]
,
healthAlerts:
{
Description: List of Domain Health Alerts ,
Required: False ,
}
[
{
id:
{
Description: Health Alert Id ,
Required: False ,
}
string ,
name:
{
Description: Health Alert Name ,
Required: False ,
}
string ,
issue:
{
Description: Health Alert Issue ,
Required: False ,
}
string ,
severity:
{
Description: Health Alert Severity ,
Required: False ,
}
string ,
raised:
{
Description: Health Alert Raised DateTime ,
Format: date-time ,
Required: False ,
}
string ,
lastDetected:
{
Description: Health Alert Last Detected DateTime ,
Format: date-time ,
Required: False ,
}
string ,
resolutionUri:
{
Description: Health Alert TSG Link ,
Required: False ,
}
string ,
}
,
]
,
notificationSettings:
{
Description: Notification Settings ,
Required: False ,
}
{
notifyGlobalAdmins:
{
Description: Should global admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notifyDcAdmins:
{
Description: Should domain controller admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
additionalRecipients:
{
Description: The list of additional recipients ,
Required: False ,
}
[
string ,
]
,
}
,
domainSecuritySettings:
{
Description: DomainSecurity Settings ,
Required: False ,
}
{
ntlmV1:
{
Description: A flag to determine whether or not NtlmV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tlsV1:
{
Description: A flag to determine whether or not TlsV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
syncNtlmPasswords:
{
Description: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
filteredSync:
{
Description: Enabled or Disabled flag to turn on Group-based filtered sync ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
domainControllerIpAddress:
{
Description: List of Domain Controller IP Address ,
Required: False ,
}
[
string ,
]
,
serviceStatus:
{
Description: Status of Domain Service instance ,
Required: False ,
}
string ,
provisioningState:
{
Description: the current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Domain service properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure Active Directory tenant id ,
Required: False ,
}
string ,
domainName:
{
Description: The name of the Azure domain that the user would like to deploy Domain Services to. ,
Required: False ,
}
string ,
deploymentId:
{
Description: Deployment Id ,
Required: False ,
}
string ,
vnetSiteId:
{
Description: Virtual network site id ,
Required: False ,
}
string ,
subnetId:
{
Description: The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName. ,
Required: False ,
}
string ,
ldapsSettings:
{
Description: Secure LDAP Settings ,
Required: False ,
}
{
ldaps:
{
Description: A flag to determine whether or not Secure LDAP is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pfxCertificate:
{
Description: The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file. ,
Required: False ,
}
string ,
pfxCertificatePassword:
{
Description: The password to decrypt the provided Secure LDAP certificate pfx file. ,
Required: False ,
}
string ,
publicCertificate:
{
Description: Public certificate used to configure secure ldap. ,
Required: False ,
}
string ,
certificateThumbprint:
{
Description: Thumbprint of configure ldaps certificate. ,
Required: False ,
}
string ,
certificateNotAfter:
{
Description: NotAfter DateTime of configure ldaps certificate. ,
Format: date-time ,
Required: False ,
}
string ,
externalAccess:
{
Description: A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalAccessIpAddress:
{
Description: External access ip address. ,
Required: False ,
}
string ,
}
,
healthLastEvaluated:
{
Description: Last domain evaluation run DateTime ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
healthMonitors:
{
Description: List of Domain Health Monitors ,
Required: False ,
}
[
{
id:
{
Description: Health Monitor Id ,
Required: False ,
}
string ,
name:
{
Description: Health Monitor Name ,
Required: False ,
}
string ,
details:
{
Description: Health Monitor Details ,
Required: False ,
}
string ,
}
,
]
,
healthAlerts:
{
Description: List of Domain Health Alerts ,
Required: False ,
}
[
{
id:
{
Description: Health Alert Id ,
Required: False ,
}
string ,
name:
{
Description: Health Alert Name ,
Required: False ,
}
string ,
issue:
{
Description: Health Alert Issue ,
Required: False ,
}
string ,
severity:
{
Description: Health Alert Severity ,
Required: False ,
}
string ,
raised:
{
Description: Health Alert Raised DateTime ,
Format: date-time ,
Required: False ,
}
string ,
lastDetected:
{
Description: Health Alert Last Detected DateTime ,
Format: date-time ,
Required: False ,
}
string ,
resolutionUri:
{
Description: Health Alert TSG Link ,
Required: False ,
}
string ,
}
,
]
,
notificationSettings:
{
Description: Notification Settings ,
Required: False ,
}
{
notifyGlobalAdmins:
{
Description: Should global admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notifyDcAdmins:
{
Description: Should domain controller admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
additionalRecipients:
{
Description: The list of additional recipients ,
Required: False ,
}
[
string ,
]
,
}
,
domainSecuritySettings:
{
Description: DomainSecurity Settings ,
Required: False ,
}
{
ntlmV1:
{
Description: A flag to determine whether or not NtlmV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tlsV1:
{
Description: A flag to determine whether or not TlsV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
syncNtlmPasswords:
{
Description: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
filteredSync:
{
Description: Enabled or Disabled flag to turn on Group-based filtered sync ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
domainControllerIpAddress:
{
Description: List of Domain Controller IP Address ,
Required: False ,
}
[
string ,
]
,
serviceStatus:
{
Description: Status of Domain Service instance ,
Required: False ,
}
string ,
provisioningState:
{
Description: the current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Domain service properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure Active Directory tenant id ,
Required: False ,
}
string ,
domainName:
{
Description: The name of the Azure domain that the user would like to deploy Domain Services to. ,
Required: False ,
}
string ,
deploymentId:
{
Description: Deployment Id ,
Required: False ,
}
string ,
vnetSiteId:
{
Description: Virtual network site id ,
Required: False ,
}
string ,
subnetId:
{
Description: The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName. ,
Required: False ,
}
string ,
ldapsSettings:
{
Description: Secure LDAP Settings ,
Required: False ,
}
{
ldaps:
{
Description: A flag to determine whether or not Secure LDAP is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pfxCertificate:
{
Description: The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file. ,
Required: False ,
}
string ,
pfxCertificatePassword:
{
Description: The password to decrypt the provided Secure LDAP certificate pfx file. ,
Required: False ,
}
string ,
publicCertificate:
{
Description: Public certificate used to configure secure ldap. ,
Required: False ,
}
string ,
certificateThumbprint:
{
Description: Thumbprint of configure ldaps certificate. ,
Required: False ,
}
string ,
certificateNotAfter:
{
Description: NotAfter DateTime of configure ldaps certificate. ,
Format: date-time ,
Required: False ,
}
string ,
externalAccess:
{
Description: A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalAccessIpAddress:
{
Description: External access ip address. ,
Required: False ,
}
string ,
}
,
healthLastEvaluated:
{
Description: Last domain evaluation run DateTime ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
healthMonitors:
{
Description: List of Domain Health Monitors ,
Required: False ,
}
[
{
id:
{
Description: Health Monitor Id ,
Required: False ,
}
string ,
name:
{
Description: Health Monitor Name ,
Required: False ,
}
string ,
details:
{
Description: Health Monitor Details ,
Required: False ,
}
string ,
}
,
]
,
healthAlerts:
{
Description: List of Domain Health Alerts ,
Required: False ,
}
[
{
id:
{
Description: Health Alert Id ,
Required: False ,
}
string ,
name:
{
Description: Health Alert Name ,
Required: False ,
}
string ,
issue:
{
Description: Health Alert Issue ,
Required: False ,
}
string ,
severity:
{
Description: Health Alert Severity ,
Required: False ,
}
string ,
raised:
{
Description: Health Alert Raised DateTime ,
Format: date-time ,
Required: False ,
}
string ,
lastDetected:
{
Description: Health Alert Last Detected DateTime ,
Format: date-time ,
Required: False ,
}
string ,
resolutionUri:
{
Description: Health Alert TSG Link ,
Required: False ,
}
string ,
}
,
]
,
notificationSettings:
{
Description: Notification Settings ,
Required: False ,
}
{
notifyGlobalAdmins:
{
Description: Should global admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notifyDcAdmins:
{
Description: Should domain controller admins be notified ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
additionalRecipients:
{
Description: The list of additional recipients ,
Required: False ,
}
[
string ,
]
,
}
,
domainSecuritySettings:
{
Description: DomainSecurity Settings ,
Required: False ,
}
{
ntlmV1:
{
Description: A flag to determine whether or not NtlmV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tlsV1:
{
Description: A flag to determine whether or not TlsV1 is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
syncNtlmPasswords:
{
Description: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
filteredSync:
{
Description: Enabled or Disabled flag to turn on Group-based filtered sync ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
domainControllerIpAddress:
{
Description: List of Domain Controller IP Address ,
Required: False ,
}
[
string ,
]
,
serviceStatus:
{
Description: Status of Domain Service instance ,
Required: False ,
}
string ,
provisioningState:
{
Description: the current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}