Microsoft Azure OuContainer API

openapi: 3.2.0
info:
  title: Microsoft Azure Domain Services Resource Provider Ou…
  description: The AAD Domain Services API.
  version: '2022-12-01'
servers:
- url: https://management.azure.com
tags:
- name: OuContainer
paths:
  /providers/Microsoft.Aad/operations:
    get:
      tags:
      - OuContainer
      description: Lists all the available OuContainer operations.
      operationId: microsoftAzureOucontaineroperationsList
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: HTTP 200 (OK) if the operation was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationEntityListResult'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./domainservices.json#/definitions/CloudError
      x-ms-examples:
        Get Operations:
          $ref: ./examples/GetOperations.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Aad Operations
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Aad/domainServices/{domainServiceName}/ouContainer
  : get:
      tags:
      - OuContainer
      operationId: microsoftAzureOucontainerList
      summary: Microsoft Azure List Of Oucontainers In Domainservice Instance
      description: The List of OuContainers in DomainService instance.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/DomainServiceNameParameter'
      responses:
        '200':
          description: HTTP 200 (OK) if the operation was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OuContainerListResult'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./domainservices.json#/definitions/CloudError
      x-ms-examples:
        List of OuContainers:
          $ref: ./examples/ListOuContainers.json
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Aad/domainServices/{domainServiceName}/ouContainer/{ouContainerName}
  : get:
      tags:
      - OuContainer
      operationId: microsoftAzureOucontainerGet
      summary: Microsoft Azure Get Particular Oucontainer In Domainservice Instance
      description: Get OuContainer in DomainService instance.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/DomainServiceNameParameter'
      - $ref: '#/components/parameters/OuContainerNameParameter'
      responses:
        '200':
          description: HTTP 200 (OK) if the operation was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OuContainer'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./domainservices.json#/definitions/CloudError
      x-ms-examples:
        List of OuContainers:
          $ref: ./examples/GetOuContainer.json
    put:
      tags:
      - OuContainer
      operationId: microsoftAzureOucontainerCreate
      summary: Microsoft Azure Create Oucontainer
      description: The Create OuContainer operation creates a new OuContainer under the specified Domain Service instance.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/DomainServiceNameParameter'
      - $ref: '#/components/parameters/OuContainerNameParameter'
      responses:
        '200':
          description: HTTP 200 (OK) if the operation was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OuContainer'
        '201':
          description: HTTP 201 (Created) if the operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OuContainer'
        '202':
          description: HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OuContainer'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./domainservices.json#/definitions/CloudError
      x-ms-long-running-operation: true
      x-ms-examples:
        Create Domain Service:
          $ref: ./examples/CreateOuContainer.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContainerAccount'
        description: Container Account Description.
        required: true
    delete:
      tags:
      - OuContainer
      operationId: microsoftAzureOucontainerDelete
      summary: Microsoft Azure Delete Oucontainer
      description: The Delete OuContainer operation deletes specified OuContainer.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/DomainServiceNameParameter'
      - $ref: '#/components/parameters/OuContainerNameParameter'
      responses:
        '200':
          description: HTTP 200 (OK) if the operation was successful.
        '202':
          description: HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.
        '204':
          description: HTTP 204 (Not Content) should be used if the resource does not exist and the request is well formed.
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./domainservices.json#/definitions/CloudError
      x-ms-long-running-operation: true
      x-ms-examples:
        Delete OuContainer:
          $ref: ./examples/DeleteOuContainer.json
    patch:
      tags:
      - OuContainer
      operationId: microsoftAzureOucontainerUpdate
      summary: Microsoft Azure Update Oucontainer Patch Resource
      description: The Update OuContainer operation can be used to update the existing OuContainers.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/DomainServiceNameParameter'
      - $ref: '#/components/parameters/OuContainerNameParameter'
      responses:
        '200':
          description: HTTP 200 (OK) if the operation was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OuContainer'
        '202':
          description: HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OuContainer'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./domainservices.json#/definitions/CloudError
      x-ms-long-running-operation: true
      x-ms-examples:
        Update Domain Service:
          $ref: ./examples/UpdateOuContainer.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContainerAccount'
        description: Container Account Description.
        required: true
components:
  schemas:
    OuContainer:
      description: Resource for OuContainer.
      type: object
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/OuContainerProperties'
          description: OuContainer properties
      allOf:
      - $ref: '#/components/schemas/Resource'
    OuContainerListResult:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/OuContainer'
          description: The list of OuContainer.
        nextLink:
          type: string
          description: The continuation token for the next page of results.
          readOnly: true
      description: The response from the List OuContainer operation.
    ContainerAccount:
      description: Container Account Description
      type: object
      properties:
        accountName:
          type: string
          description: The account name
        spn:
          type: string
          description: The account spn
        password:
          type: string
          description: The account password
    OuContainerProperties:
      description: Properties of the OuContainer.
      type: object
      properties:
        tenantId:
          readOnly: true
          type: string
          description: Azure Active Directory tenant id
        domainName:
          readOnly: true
          type: string
          description: The domain name of Domain Services.
        deploymentId:
          readOnly: true
          type: string
          description: The Deployment id
        containerId:
          readOnly: true
          type: string
          description: The OuContainer name
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/ContainerAccount'
            description: Container Account
          description: The list of container accounts
        serviceStatus:
          readOnly: true
          type: string
          description: Status of OuContainer instance
        distinguishedName:
          readOnly: true
          type: string
          description: Distinguished Name of OuContainer instance
        provisioningState:
          readOnly: true
          type: string
          description: The current deployment or provisioning state, which only appears in the response.
    OperationEntityListResult:
      description: The list of domain service operation response.
      type: object
      properties:
        value:
          description: The list of operations.
          type: array
          items:
            $ref: '#/components/schemas/OperationEntity'
        nextLink:
          type: string
          description: The continuation token for the next page of results.
          readOnly: true
    OperationDisplayInfo:
      description: The operation supported by Domain Services.
      type: object
      properties:
        description:
          description: The description of the operation.
          type: string
        operation:
          description: The action that users can perform, based on their permission level.
          type: string
        provider:
          description: 'Service provider: Domain Services.'
          type: string
        resource:
          description: Resource on which the operation is performed.
          type: string
    OperationEntity:
      description: The operation supported by Domain Services.
      type: object
      properties:
        name:
          description: 'Operation name: {provider}/{resource}/{operation}.'
          type: string
        display:
          $ref: '#/components/schemas/OperationDisplayInfo'
          description: The operation supported by Domain Services.
        origin:
          description: The origin of the operation.
          type: string
    Resource:
      description: The Resource model definition.
      type: object
      properties:
        id:
          readOnly: true
          type: string
          description: Resource Id
        name:
          readOnly: true
          type: string
          description: Resource name
        type:
          readOnly: true
          type: string
          description: Resource type
        location:
          type: string
          description: Resource location
          x-ms-mutability:
          - read
          - create
        tags:
          type: object
          additionalProperties:
            type: string
          description: Resource tags
        etag:
          type: string
          description: Resource etag
        systemData:
          readOnly: true
          description: The system meta data relating to this resource.
          $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
      x-ms-azure-resource: true
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: Client Api Version.
      schema:
        type: string
    DomainServiceNameParameter:
      name: domainServiceName
      in: path
      required: true
      description: The name of the domain service.
      x-ms-parameter-location: method
      schema:
        type: string
    OuContainerNameParameter:
      name: ouContainerName
      in: path
      required: true
      description: The name of the OuContainer.
      x-ms-parameter-location: method
      schema:
        type: string
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      required: true
      description: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
      schema:
        type: string
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      required: true
      description: The name of the resource group within the user's subscription. The name is case insensitive.
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
        pattern: ^[-\w\._\(\)]+$
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow