Microsoft Azure Domains API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Domains API
schemes:
- https
tags:
- name: Domains
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/checkDomainAvailability:
    post:
      tags:
      - Domains
      summary: Microsoft Azure Check If A Domain Is Available For Registration
      description: Description for Check if a domain is available for registration.
      operationId: microsoftAzureDomainsCheckavailability
      parameters:
      - name: identifier
        in: body
        description: Name of the domain.
        required: true
        schema:
          $ref: ../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/NameIdentifier
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/DomainAvailabilityCheckResult'
        default:
          description: App Service error response.
          schema:
            $ref: ../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
      x-ms-examples:
        Check domain availability:
          $ref: ./examples/CheckDomainAvailability.json
  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/domains:
    get:
      tags:
      - Domains
      summary: Microsoft Azure Get All Domains In A Subscription
      description: Description for Get all domains in a subscription.
      operationId: microsoftAzureDomainsList
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/DomainCollection'
        default:
          description: App Service error response.
          schema:
            $ref: ../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
      x-ms-examples:
        List domains by subscription:
          $ref: ./examples/ListDomainsBySubscription.json
      x-ms-pageable:
        nextLinkName: nextLink
  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/generateSsoRequest:
    post:
      tags:
      - Domains
      summary: Microsoft Azure Generate A Single Sign On Request For The Domain Management Portal
      description: Description for Generate a single sign-on request for the domain management portal.
      operationId: microsoftAzureDomainsGetcontrolcenterssorequest
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/DomainControlCenterSsoRequest'
        default:
          description: App Service error response.
          schema:
            $ref: ../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
      x-ms-examples:
        Get Domain Control Center Sso Request:
          $ref: ./examples/GetDomainControlCenterSsoRequest.json
  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/listDomainRecommendations:
    post:
      tags:
      - Domains
      summary: Microsoft Azure Get Domain Name Recommendations Based On Keywords
      description: Description for Get domain name recommendations based on keywords.
      operationId: microsoftAzureDomainsListrecommendations
      parameters:
      - name: parameters
        in: body
        description: Search parameters for domain name recommendations.
        required: true
        schema:
          $ref: '#/definitions/DomainRecommendationSearchParameters'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/NameIdentifierCollection'
        default:
          description: App Service error response.
          schema:
            $ref: ../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
      x-ms-examples:
        List domain recommendations:
          $ref: ./examples/ListDomainRecommendations.json
      x-ms-pageable:
        nextLinkName: nextLink
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains:
    get:
      tags:
      - Domains
      summary: Microsoft Azure Get All Domains In A Resource Group
      description: Description for Get all domains in a resource group.
      operationId: microsoftAzureDomainsListbyresourcegroup
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/DomainCollection'
        default:
          description: App Service error response.
          schema:
            $ref: ../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
      x-ms-examples:
        List domains by resource group:
          $ref: ./examples/ListDomainsByResourceGroup.json
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}
  : get:
      tags:
      - Domains
      summary: Microsoft Azure Get A Domain
      description: Description for Get a domain.
      operationId: microsoftAzureDomainsGet
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: domainName
        in: path
        description: Name of the domain.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Domain'
        default:
          description: App Service error response.
          schema:
            $ref: ../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
      x-ms-examples:
        Get Domain:
          $ref: ./examples/GetDomain.json
    put:
      tags:
      - Domains
      summary: Microsoft Azure Creates Or Updates A Domain
      description: Description for Creates or updates a domain.
      operationId: microsoftAzureDomainsCreateorupdate
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: domainName
        in: path
        description: Name of the domain.
        required: true
        type: string
        pattern: '[a-zA-Z0-9][a-zA-Z0-9\.-]+'
      - name: domain
        in: body
        description: Domain registration information.
        required: true
        schema:
          $ref: '#/definitions/Domain'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Domain purchase was successful.
          schema:
            $ref: '#/definitions/Domain'
        '202':
          description: Domain purchase is in progress.
          schema:
            $ref: '#/definitions/Domain'
        default:
          description: App Service error response.
          schema:
            $ref: ../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
      x-ms-examples:
        Create App Service Domain:
          $ref: ./examples/CreateAppServiceDomain.json
      x-ms-long-running-operation: true
    delete:
      tags:
      - Domains
      summary: Microsoft Azure Delete A Domain
      description: Description for Delete a domain.
      operationId: microsoftAzureDomainsDelete
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: domainName
        in: path
        description: Name of the domain.
        required: true
        type: string
      - name: forceHardDeleteDomain
        in: query
        description: Specify <code>true</code> to delete the domain immediately. The default is <code>false</code> which deletes the domain after 24 hours.
        type: boolean
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully deleted domain.
        '204':
          description: Domain does not exist in Azure database probably because it has already been deleted
        default:
          description: App Service error response.
          schema:
            $ref: ../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
      x-ms-examples:
        Delete App Service Domain:
          $ref: ./examples/DeleteAppServiceDomain.json
    patch:
      tags:
      - Domains
      summary: Microsoft Azure Creates Or Updates A Domain
      description: Description for Creates or updates a domain.
      operationId: microsoftAzureDomainsUpdate
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: domainName
        in: path
        description: Name of the domain.
        required: true
        type: string
        pattern: '[a-zA-Z0-9][a-zA-Z0-9\.-]+'
      - name: domain
        in: body
        description: Domain registration information.
        required: true
        schema:
          $ref: '#/definitions/DomainPatchResource'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Domain purchase was successful.
          schema:
            $ref: '#/definitions/Domain'
        '202':
          description: Domain purchase is in progress.
          schema:
            $ref: '#/definitions/Domain'
        default:
          description: App Service error response.
          schema:
            $ref: ../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
      x-ms-examples:
        Update App Service Domain:
          $ref: ./examples/UpdateAppServiceDomain.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers
  : get:
      tags:
      - Domains
      summary: Microsoft Azure Lists Domain Ownership Identifiers
      description: Description for Lists domain ownership identifiers.
      operationId: microsoftAzureDomainsListownershipidentifiers
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: domainName
        in: path
        description: Name of domain.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/DomainOwnershipIdentifierCollection'
        default:
          description: App Service error response.
          schema:
            $ref: ../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
      x-ms-examples:
        List Domain Ownership Identifiers:
          $ref: ./examples/ListDomainOwnershipIdentifiers.json
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers/{name}
  : get:
      tags:
      - Domains
      summary: Microsoft Azure Get Ownership Identifier For Domain
      description: Description for Get ownership identifier for domain
      operationId: microsoftAzureDomainsGetownershipidentifier
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: domainName
        in: path
        description: Name of domain.
        required: true
        type: string
      - name: name
        in: path
        description: Name of identifier.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/DomainOwnershipIdentifier'
        default:
          description: App Service error response.
          schema:
            $ref: ../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
      x-ms-examples:
        Get Domain Ownership Identifier:
          $ref: ./examples/GetDomainOwnershipIdentifier.json
    put:
      tags:
      - Domains
      summary: Microsoft Azure Creates An Ownership Identifier For A Domain Or Updates Identifier Details For An Existing Identifier
      description: Description for Creates an ownership identifier for a domain or updates identifier details for an existing identifier
      operationId: microsoftAzureDomainsCreateorupdateownershipidentifier
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: domainName
        in: path
        description: Name of domain.
        required: true
        type: string
      - name: name
        in: path
        description: Name of identifier.
        required: true
        type: string
      - name: domainOwnershipIdentifier
        in: body
        description: A JSON representation of the domain ownership properties.
        required: true
        schema:
          $ref: '#/definitions/DomainOwnershipIdentifier'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/DomainOwnershipIdentifier'
        default:
          description: App Service error response.
          schema:
            $ref: ../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
      x-ms-examples:
        Create App Service Domain OwnershipIdentifier:
          $ref: ./examples/CreateAppServiceDomainOwnershipIdentifier.json
    delete:
      tags:
      - Domains
      summary: Microsoft Azure Delete Ownership Identifier For Domain
      description: Description for Delete ownership identifier for domain
      operationId: microsoftAzureDomainsDeleteownershipidentifier
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: domainName
        in: path
        description: Name of domain.
        required: true
        type: string
      - name: name
        in: path
        description: Name of identifier.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully deleted domain ownership identifier.
        '204':
          description: Domain ownership identifier does not exist.
        default:
          description: App Service error response.
          schema:
            $ref: ../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
      x-ms-examples:
        Delete App Service Domain Ownership Identifier:
          $ref: ./examples/DeleteAppServiceDomainOwnershipIdentifier.json
    patch:
      tags:
      - Domains
      summary: Microsoft Azure Creates An Ownership Identifier For A Domain Or Updates Identifier Details For An Existing Identifier
      description: Description for Creates an ownership identifier for a domain or updates identifier details for an existing identifier
      operationId: microsoftAzureDomainsUpdateownershipidentifier
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: domainName
        in: path
        description: Name of domain.
        required: true
        type: string
      - name: name
        in: path
        description: Name of identifier.
        required: true
        type: string
      - name: domainOwnershipIdentifier
        in: body
        description: A JSON representation of the domain ownership properties.
        required: true
        schema:
          $ref: '#/definitions/DomainOwnershipIdentifier'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/DomainOwnershipIdentifier'
        default:
          description: App Service error response.
          schema:
            $ref: ../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
      x-ms-examples:
        Update App Service Domain OwnershipIdentifier:
          $ref: ./examples/UpdateAppServiceDomainOwnershipIdentifier.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/renew
  : post:
      tags:
      - Domains
      summary: Microsoft Azure Renew A Domain
      description: Description for Renew a domain.
      operationId: microsoftAzureDomainsRenew
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: domainName
        in: path
        description: Name of the domain.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Domain renewal was successful.
        '202':
          description: Domain renewal in progress.
        '204':
          description: Domain does not exist.
        default:
          description: App Service error response.
          schema:
            $ref: ../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
      x-ms-examples:
        Renew an existing domain:
          $ref: ./examples/RenewDomain.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/transferOut
  : put:
      tags:
      - Domains
      summary: Microsoft Azure Transfer Out Domain To Another Registrar
      operationId: microsoftAzureDomainsTransferout
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: domainName
        in: path
        description: Name of domain.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully returned transfer code to transfer domain to another registrar.
          schema:
            $ref: '#/definitions/Domain'
        '400':
          description: Domain does not exist in Azure database
          x-ms-error-response: true
        default:
          description: App Service error response.
          schema:
            $ref: ../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse
      x-ms-examples:
        Transfer out domain:
          $ref: ./examples/TransferOutDomain.json
      description: Needs a more full description created.
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}:
    get:
      tags:
      - Domains
      summary: Microsoft Azure Get A Domain
      description: Get properties of a domain.
      operationId: microsoftAzureDomainsGet
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        type: string
      - name: domainName
        in: path
        description: Name of the domain.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Domain_2'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        Domains_Get:
          $ref: ./examples/Domains_Get.json
    put:
      tags:
      - Domains
      summary: Microsoft Azure Create Or Update A Domain
      description: Asynchronously creates or updates a new domain with the specified parameters.
      operationId: microsoftAzureDomainsCreateorupdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        type: string
      - name: domainName
        in: path
        description: Name of the domain.
        required: true
        type: string
      - name: domainInfo
        in: body
        description: Domain information.
        required: true
        schema:
          $ref: '#/definitions/Domain_2'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/Domain_2'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        Domains_CreateOrUpdate:
          $ref: ./examples/Domains_CreateOrUpdate.json
      x-ms-long-running-operation: true
    delete:
      tags:
      - Domains
      summary: Microsoft Azure Delete A Domain
      description: Delete existing domain.
      operationId: microsoftAzureDomainsDelete
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        type: string
      - name: domainName
        in: path
        description: Name of the domain.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
        '202':
          description: Accepted
        '204':
          description: NoContent
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error."
      x-ms-examples:
        Domains_Delete:
          $ref: ./examples/Domains_Delete.json
      x-ms-long-running-operation: true
    patch:
      tags:
      - Domains
      summary: Microsoft Azure Update A Domain
      description: Asynchronously updates a domain with the specified parameters.
      operationId: microsoftAzureDomainsUpdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        type: string
      - name: domainName
        in: path
        description: Name of the domain.
        required: true
        type: string
      - name: domainUpdateParameters
        in: body
        description: Domain update information.
        required: true
        schema:
          $ref: '#/definitions/DomainUpdateParameters'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
        '201':
          description: Domain update request accepted.
          schema:
            $ref: '#/definitions/Domain_2'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        Domains_Update:
          $ref: ./examples/Domains_Update.json
      x-ms-long-running-operation: true
  /subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/domains:
    get:
      tags:
      - Domains
      summary: Microsoft Azure List Domains Under An Azure Subscription
      description: List all the domains under an Azure subscription.
      operationId: microsoftAzureDomainsListbysubscription
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/FilterParameter'
      - $ref: '#/parameters/TopParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/DomainsListResult'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        Domains_ListBySubscription:
          $ref: ./examples/Domains_ListBySubscription.json
      x-ms-pageable:
        nextLinkName: nextLink
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains:
    get:
      tags:
      - Domains
      summary: Microsoft Azure List Domains Under A Resource Group
      description: List all the domains under a resource group.
      operationId: microsoftAzureDomainsListbyresourcegroup
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/FilterParameter'
      - $ref: '#/parameters/TopParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/DomainsListResult'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        Domains_ListByResourceGroup:
          $ref: ./examples/Domains_ListByResourceGroup.json
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/listKeys
  : post:
      tags:
      - Domains
      summary: Microsoft Azure List Keys For A Domain
      description: List the two keys used to publish to a domain.
      operationId: microsoftAzureDomainsListsharedaccesskeys
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        type: string
      - name: domainName
        in: path
        description: Name of the domain.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/DomainSharedAccessKeys'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        Domains_ListSharedAccessKeys:
          $ref: ./examples/Domains_ListSharedAccessKeys.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/regenerateKey
  : post:
      tags:
      - Domains
      summary: Microsoft Azure Regenerate Key For A Domain
      description: Regenerate a shared access key for a domain.
      operationId: microsoftAzureDomainsRegeneratekey
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        type: string
      - name: domainName
        in: path
        description: Name of the domain.
        required: true
        type: string
      - name: regenerateKeyRequest
        in: body
        description: Request body to regenerate key.
        required: true
        schema:
          $ref: '#/definitions/DomainRegenerateKeyRequest'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/DomainSharedAccessKeys'
        default:
          description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
      x-ms-examples:
        Domains_RegenerateKey:
          $ref: ./examples/Domains_RegenerateKey.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/operationresults/{operationId}
  : get:
      tags:
      - Domains
      summary: Microsoft Azure Retrieves The Latest Status Of A Domain Purchase Operation
      operationId: microsoftAzureDomainsGetdomainoperation
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Name of the resource group
        required: true
        type: string
      - name: domainName
        in: path
        description: Name of the domain
        required: true
        type: string
      - name: operationId
        in: path
        description: Domain purchase operation Id
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter_2'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Domain purchase was successful
          schema:
            $ref: '#/definitions/Domain_3'
        '202':
          description: Domain purchase is in progress
          schema:
            $ref: '#/definitions/Domain_3'
        '500':
          description: Domain purchase request failed
      deprecated: false
      description: Needs a more full description created.
definitions:
  DomainOwnershipIdentifier:
    description: Domain ownership Identifier.
    type: object
    allOf:
    - $ref: ../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/ProxyOnlyResource
    properties:
      properties:
        description: DomainOwnershipIdentifier resource specific properties
        type: object
        properties:
          ownershipId:
            description: Ownership Id.
            type: string
        x-ms-client-flatten: true
  DomainPatchResource:
    description: ARM resource for a domain.
    type: object
    allOf:
    - $ref: ../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/ProxyOnlyResource
    properties:
      properties:
        description: DomainPatchResource resource specific properties
        required:
        - contactAdmin
        - contactBilling
        - contactRegistrant
        - contactTech
        - consent
        type: object
        properties:
          contactAdmin:
            $ref: '#/definitions/Contact'
            description: Administrative contact.
            x-ms-mutability:
            - create
          contactBilling:
            $ref: '#/definitions/Contact'
            description: Billing contact.
            x-ms-mutability:
            - create
          contactRegistrant:
            $ref: '#/definitions/Contact'
            description: Registrant contact.
            x-ms-mutability:
            - create
          contactTech:
            $ref: '#/definitions/Contact'
            description: Technical contact.
            x-ms-mutability:
            - create
          registrationStatus:
            description: Domain registration status.
            enum:
            - Active
            - Awaiting
            - Cancelled
            - Confiscated
            - Disabled
            - Excluded
            - Expired
            - Failed
            - Held
            - Locked
            - Parked
            - Pending
            - Reserved
            - Reverted
            - Suspended
     

# --- truncated at 32 KB (73 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-domains-api-openapi.yml