Microsoft.Aad (preview:2025-05-01)

2025/06/04 • 6 new methods

OuContainerOperations_List (new)
Description :  Lists all the available OuContainer operations.
Reference :  Link ¶

⚼ Request

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

⚐ Response (default)

{
error:
{
Description: An error response from the Domain Services. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
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 ,
}
OuContainer_List (new)
Description :  The List of OuContainers in DomainService instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Aad/domainServices/{domainServiceName}/ouContainer
{
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 (default)

{
error:
{
Description: An error response from the Domain Services. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of OuContainer. ,
Required: False ,
}
[
{
properties:
{
Description: OuContainer properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure Active Directory tenant id ,
Required: False ,
}
string ,
domainName:
{
Description: The domain name of Domain Services. ,
Required: False ,
}
string ,
deploymentId:
{
Description: The Deployment id ,
Required: False ,
}
string ,
containerId:
{
Description: The OuContainer name ,
Required: False ,
}
string ,
accounts:
{
Description: The list of container accounts ,
Required: False ,
}
[
{
accountName:
{
Description: The account name ,
Required: False ,
}
string ,
spn:
{
Description: The account spn ,
Required: False ,
}
string ,
password:
{
Description: The account password ,
Required: False ,
}
string ,
}
,
]
,
serviceStatus:
{
Description: Status of OuContainer instance ,
Required: False ,
}
string ,
distinguishedName:
{
Description: Distinguished Name of OuContainer 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 ,
}
OuContainer_Get (new)
Description :  Get OuContainer in DomainService instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Aad/domainServices/{domainServiceName}/ouContainer/{ouContainerName}
{
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 ,
ouContainerName:
{
Description: The name of the OuContainer. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Domain Services. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: OuContainer properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure Active Directory tenant id ,
Required: False ,
}
string ,
domainName:
{
Description: The domain name of Domain Services. ,
Required: False ,
}
string ,
deploymentId:
{
Description: The Deployment id ,
Required: False ,
}
string ,
containerId:
{
Description: The OuContainer name ,
Required: False ,
}
string ,
accounts:
{
Description: The list of container accounts ,
Required: False ,
}
[
{
accountName:
{
Description: The account name ,
Required: False ,
}
string ,
spn:
{
Description: The account spn ,
Required: False ,
}
string ,
password:
{
Description: The account password ,
Required: False ,
}
string ,
}
,
]
,
serviceStatus:
{
Description: Status of OuContainer instance ,
Required: False ,
}
string ,
distinguishedName:
{
Description: Distinguished Name of OuContainer instance ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
OuContainer_Create (new)
Description :  The Create OuContainer operation creates a new OuContainer under the specified Domain Service instance.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Aad/domainServices/{domainServiceName}/ouContainer/{ouContainerName}
{
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 ,
ouContainerName:
{
Description: The name of the OuContainer. ,
Required: True ,
}
string ,
containerAccount:
{
Description: Container Account Description. ,
Required: True ,
}
{
accountName:
{
Description: The account name ,
Required: False ,
}
string ,
spn:
{
Description: The account spn ,
Required: False ,
}
string ,
password:
{
Description: The account password ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Domain Services. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: OuContainer properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure Active Directory tenant id ,
Required: False ,
}
string ,
domainName:
{
Description: The domain name of Domain Services. ,
Required: False ,
}
string ,
deploymentId:
{
Description: The Deployment id ,
Required: False ,
}
string ,
containerId:
{
Description: The OuContainer name ,
Required: False ,
}
string ,
accounts:
{
Description: The list of container accounts ,
Required: False ,
}
[
{
accountName:
{
Description: The account name ,
Required: False ,
}
string ,
spn:
{
Description: The account spn ,
Required: False ,
}
string ,
password:
{
Description: The account password ,
Required: False ,
}
string ,
}
,
]
,
serviceStatus:
{
Description: Status of OuContainer instance ,
Required: False ,
}
string ,
distinguishedName:
{
Description: Distinguished Name of OuContainer 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: OuContainer properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure Active Directory tenant id ,
Required: False ,
}
string ,
domainName:
{
Description: The domain name of Domain Services. ,
Required: False ,
}
string ,
deploymentId:
{
Description: The Deployment id ,
Required: False ,
}
string ,
containerId:
{
Description: The OuContainer name ,
Required: False ,
}
string ,
accounts:
{
Description: The list of container accounts ,
Required: False ,
}
[
{
accountName:
{
Description: The account name ,
Required: False ,
}
string ,
spn:
{
Description: The account spn ,
Required: False ,
}
string ,
password:
{
Description: The account password ,
Required: False ,
}
string ,
}
,
]
,
serviceStatus:
{
Description: Status of OuContainer instance ,
Required: False ,
}
string ,
distinguishedName:
{
Description: Distinguished Name of OuContainer 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: OuContainer properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure Active Directory tenant id ,
Required: False ,
}
string ,
domainName:
{
Description: The domain name of Domain Services. ,
Required: False ,
}
string ,
deploymentId:
{
Description: The Deployment id ,
Required: False ,
}
string ,
containerId:
{
Description: The OuContainer name ,
Required: False ,
}
string ,
accounts:
{
Description: The list of container accounts ,
Required: False ,
}
[
{
accountName:
{
Description: The account name ,
Required: False ,
}
string ,
spn:
{
Description: The account spn ,
Required: False ,
}
string ,
password:
{
Description: The account password ,
Required: False ,
}
string ,
}
,
]
,
serviceStatus:
{
Description: Status of OuContainer instance ,
Required: False ,
}
string ,
distinguishedName:
{
Description: Distinguished Name of OuContainer instance ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}
OuContainer_Delete (new)
Description :  The Delete OuContainer operation deletes specified OuContainer.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Aad/domainServices/{domainServiceName}/ouContainer/{ouContainerName}
{
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 ,
ouContainerName:
{
Description: The name of the OuContainer. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Domain Services. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
OuContainer_Update (new)
Description :  The Update OuContainer operation can be used to update the existing OuContainers.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Aad/domainServices/{domainServiceName}/ouContainer/{ouContainerName}
{
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 ,
ouContainerName:
{
Description: The name of the OuContainer. ,
Required: True ,
}
string ,
containerAccount:
{
Description: Container Account Description. ,
Required: True ,
}
{
accountName:
{
Description: The account name ,
Required: False ,
}
string ,
spn:
{
Description: The account spn ,
Required: False ,
}
string ,
password:
{
Description: The account password ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Domain Services. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: OuContainer properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure Active Directory tenant id ,
Required: False ,
}
string ,
domainName:
{
Description: The domain name of Domain Services. ,
Required: False ,
}
string ,
deploymentId:
{
Description: The Deployment id ,
Required: False ,
}
string ,
containerId:
{
Description: The OuContainer name ,
Required: False ,
}
string ,
accounts:
{
Description: The list of container accounts ,
Required: False ,
}
[
{
accountName:
{
Description: The account name ,
Required: False ,
}
string ,
spn:
{
Description: The account spn ,
Required: False ,
}
string ,
password:
{
Description: The account password ,
Required: False ,
}
string ,
}
,
]
,
serviceStatus:
{
Description: Status of OuContainer instance ,
Required: False ,
}
string ,
distinguishedName:
{
Description: Distinguished Name of OuContainer 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: OuContainer properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure Active Directory tenant id ,
Required: False ,
}
string ,
domainName:
{
Description: The domain name of Domain Services. ,
Required: False ,
}
string ,
deploymentId:
{
Description: The Deployment id ,
Required: False ,
}
string ,
containerId:
{
Description: The OuContainer name ,
Required: False ,
}
string ,
accounts:
{
Description: The list of container accounts ,
Required: False ,
}
[
{
accountName:
{
Description: The account name ,
Required: False ,
}
string ,
spn:
{
Description: The account spn ,
Required: False ,
}
string ,
password:
{
Description: The account password ,
Required: False ,
}
string ,
}
,
]
,
serviceStatus:
{
Description: Status of OuContainer instance ,
Required: False ,
}
string ,
distinguishedName:
{
Description: Distinguished Name of OuContainer instance ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
}
,
}