swagger: '2.0'
info:
  version: '2023-01-01'
  title: Microsoft Azure Domains API Client
host: management.azure.com
schemes:
  - https
consumes:
  - application/json
produces:
  - application/json
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.
definitions:
  Address:
    description: Address information for domain registration.
    required:
      - address1
      - city
      - country
      - postalCode
      - state
    type: object
    properties:
      address1:
        description: First line of an Address.
        type: string
      address2:
        description: The second line of the Address. Optional.
        type: string
      city:
        description: The city for the address.
        type: string
      country:
        description: The country for the address.
        type: string
      postalCode:
        description: The postal code for the address.
        type: string
      state:
        description: The state or province for the address.
        type: string
  Contact:
    description: >-
      Contact information for domain registration. If 'Domain Privacy' option is
      not selected then the contact information is made publicly available
      through the Whois 

      directories as per ICANN requirements.
    required:
      - email
      - nameFirst
      - nameLast
      - phone
    type: object
    properties:
      addressMailing:
        $ref: '#/definitions/Address'
        description: Mailing address.
      email:
        description: Email address.
        type: string
      fax:
        description: Fax number.
        type: string
      jobTitle:
        description: Job title.
        type: string
      nameFirst:
        description: First name.
        type: string
      nameLast:
        description: Last name.
        type: string
      nameMiddle:
        description: Middle name.
        type: string
      organization:
        description: Organization contact belongs to.
        type: string
      phone:
        description: Phone number.
        type: string
  Domain:
    description: Information about a domain.
    type: object
    allOf:
      - $ref: >-
          ../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/Resource
    properties:
      properties:
        description: Domain 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
              - Transferred
              - Unknown
              - Unlocked
              - Unparked
              - Updated
              - JsonConverterFailed
            type: string
            readOnly: true
            x-ms-enum:
              name: DomainStatus
              modelAsString: false
          provisioningState:
            description: Domain provisioning state.
            enum:
              - Succeeded
              - Failed
              - Canceled
              - InProgress
              - Deleting
            type: string
            readOnly: true
            x-ms-enum:
              name: ProvisioningState
              modelAsString: false
          nameServers:
            description: Name servers.
            type: array
            items:
              type: string
            readOnly: true
          privacy:
            description: >-
              <code>true</code> if domain privacy is enabled for this domain;
              otherwise, <code>false</code>.
            type: boolean
          createdTime:
            format: date-time
            description: Domain creation timestamp.
            type: string
            readOnly: true
          expirationTime:
            format: date-time
            description: Domain expiration timestamp.
            type: string
            readOnly: true
          lastRenewedTime:
            format: date-time
            description: Timestamp when the domain was renewed last time.
            type: string
            readOnly: true
          autoRenew:
            description: >-
              <code>true</code> if the domain should be automatically renewed;
              otherwise, <code>false</code>.
            default: true
            type: boolean
          readyForDnsRecordManagement:
            description: >-
              <code>true</code> if Azure can assign this domain to App Service
              apps; otherwise, <code>false</code>. This value will be
              <code>true</code> if domain registration status is active and 
               it is hosted on name servers Azure has programmatic access to.
            type: boolean
            readOnly: true
          managedHostNames:
            description: >-
              All hostnames derived from the domain and assigned to Azure
              resources.
            type: array
            items:
              $ref: '#/definitions/HostName'
            readOnly: true
            x-ms-identifiers:
              - name
          consent:
            $ref: '#/definitions/DomainPurchaseConsent'
            description: Legal agreement consent.
            x-ms-mutability:
              - create
          domainNotRenewableReasons:
            description: Reasons why domain is not renewable.
            type: array
            items:
              enum:
                - RegistrationStatusNotSupportedForRenewal
                - ExpirationNotInRenewalTimeRange
                - SubscriptionNotActive
              type: string
              x-ms-enum:
                name: ResourceNotRenewableReason
                modelAsString: true
            readOnly: true
          dnsType:
            description: Current DNS type
            enum:
              - AzureDns
              - DefaultDomainRegistrarDns
            type: string
            x-ms-enum:
              name: DnsType
              modelAsString: false
          dnsZoneId:
            description: Azure DNS Zone to use
            type: string
          targetDnsType:
            description: Target DNS type (would be used for migration)
            enum:
              - AzureDns
              - DefaultDomainRegistrarDns
            type: string
            x-ms-enum:
              name: DnsType
              modelAsString: false
          authCode:
            type: string
            x-ms-mutability:
              - create
              - read
        x-ms-client-flatten: true
  DomainAvailabilityCheckResult:
    description: Domain availability check result.
    type: object
    properties:
      name:
        description: Name of the domain.
        type: string
      available:
        description: >-
          <code>true</code> if domain can be purchased using CreateDomain API;
          otherwise, <code>false</code>.
        type: boolean
      domainType:
        description: >-
          Valid values are Regular domain: Azure will charge the full price of
          domain registration, SoftDeleted: Purchasing this domain will simply
          restore it and this operation will not cost anything.
        enum:
          - Regular
          - SoftDeleted
        type: string
        x-ms-enum:
          name: DomainType
          modelAsString: false
  DomainCollection:
    description: Collection of domains.
    required:
      - value
    type: object
    properties:
      value:
        description: Collection of resources.
        type: array
        items:
          $ref: '#/definitions/Domain'
      nextLink:
        description: Link to next page of resources.
        type: string
        readOnly: true
  DomainControlCenterSsoRequest:
    description: Single sign-on request information for domain management.
    type: object
    properties:
      url:
        description: URL where the single sign-on request is to be made.
        type: string
        readOnly: true
      postParameterKey:
        description: Post parameter key.
        type: string
        readOnly: true
      postParameterValue:
        description: >-
          Post parameter value. Client should use
          'application/x-www-form-urlencoded' encoding for this value.
        type: string
        readOnly: true
  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
  DomainOwnershipIdentifierCollection:
    description: Collection of domain ownership identifiers.
    required:
      - value
    type: object
    properties:
      value:
        description: Collection of resources.
        type: array
        items:
          $ref: '#/definitions/DomainOwnershipIdentifier'
      nextLink:
        description: Link to next page of resources.
        type: string
        readOnly: 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
              - Transferred
              - Unknown
              - Unlocked
              - Unparked
              - Updated
              - JsonConverterFailed
            type: string
            readOnly: true
            x-ms-enum:
              name: DomainStatus
              modelAsString: false
          provisioningState:
            description: Domain provisioning state.
            enum:
              - Succeeded
              - Failed
              - Canceled
              - InProgress
              - Deleting
            type: string
            readOnly: true
            x-ms-enum:
              name: ProvisioningState
              modelAsString: false
          nameServers:
            description: Name servers.
            type: array
            items:
              type: string
            readOnly: true
          privacy:
            description: >-
              <code>true</code> if domain privacy is enabled for this domain;
              otherwise, <code>false</code>.
            type: boolean
          createdTime:
            format: date-time
            description: Domain creation timestamp.
            type: string
            readOnly: true
          expirationTime:
            format: date-time
            description: Domain expiration timestamp.
            type: string
            readOnly: true
          lastRenewedTime:
            format: date-time
            description: Timestamp when the domain was renewed last time.
            type: string
            readOnly: true
          autoRenew:
            description: >-
              <code>true</code> if the domain should be automatically renewed;
              otherwise, <code>false</code>.
            default: true
            type: boolean
          readyForDnsRecordManagement:
            description: >-
              <code>true</code> if Azure can assign this domain to App Service
              apps; otherwise, <code>false</code>. This value will be
              <code>true</code> if domain registration status is active and 
               it is hosted on name servers Azure has programmatic access to.
            type: boolean
            readOnly: true
          managedHostNames:
            description: >-
              All hostnames derived from the domain and assigned to Azure
              resources.
            type: array
            items:
              $ref: '#/definitions/HostName'
            readOnly: true
            x-ms-identifiers:
              - name
          consent:
            $ref: '#/definitions/DomainPurchaseConsent'
            description: Legal agreement consent.
            x-ms-mutability:
              - create
          domainNotRenewableReasons:
            description: Reasons why domain is not renewable.
            type: array
            items:
              enum:
                - RegistrationStatusNotSupportedForRenewal
                - ExpirationNotInRenewalTimeRange
                - SubscriptionNotActive
              type: string
              x-ms-enum:
                name: ResourceNotRenewableReason
                modelAsString: true
            readOnly: true
          dnsType:
            description: Current DNS type
            enum:
              - AzureDns
              - DefaultDomainRegistrarDns
            type: string
            x-ms-enum:
              name: DnsType
              modelAsString: false
          dnsZoneId:
            description: Azure DNS Zone to use
            type: string
          targetDnsType:
            description: Target DNS type (would be used for migration)
            enum:
              - AzureDns
              - DefaultDomainRegistrarDns
            type: string
            x-ms-enum:
              name: DnsType
              modelAsString: false
          authCode:
            type: string
            x-ms-mutability:
              - create
              - read
        x-ms-client-flatten: true
  DomainPurchaseConsent:
    description: >-
      Domain purchase consent object, representing acceptance of applicable
      legal agreements.
    type: object
    properties:
      agreementKeys:
        description: >-
          List of applicable legal agreement keys. This list can be retrieved
          using ListLegalAgreements API under <code>TopLevelDomain</code>
          resource.
        type: array
        items:
          type: string
      agreedBy:
        description: Client IP address.
        type: string
      agreedAt:
        format: date-time
        description: Timestamp when the agreements were accepted.
        type: string
  DomainRecommendationSearchParameters:
    description: Domain recommendation search parameters.
    type: object
    properties:
      keywords:
        description: Keywords to be used for generating domain recommendations.
        type: string
      maxDomainRecommendations:
        format: int32
        description: Maximum number of recommendations.
        type: integer
  HostName:
    description: Details of a hostname derived from a domain.
    type: object
    properties:
      name:
        description: Name of the hostname.
        type: string
      siteNames:
        description: >-
          List of apps the hostname is assigned to. This list will have more
          than one app only if the hostname is pointing to a Traffic Manager.
        type: array
        items:
          type: string
      azureResourceName:
        description: >-
          Name of the Azure resource the hostname is assigned to. If it is
          assigned to a Traffic Manager then it will be the Traffic Manager name
          otherwise it will be the app name.
        type: string
      azureResourceType:
        description: Type of the Azure resource the hostname is assigned to.
        enum:
          - Website
          - TrafficManager
        type: string
        x-ms-enum:
          name: AzureResourceType
          modelAsString: false
      customHostNameDnsRecordType:
        description: Type of the DNS record.
        enum:
          - CName
          - A
        type: string
        x-ms-enum:
          name: CustomHostNameDnsRecordType
          modelAsString: false
      hostNameType:
        description: Type of the hostname.
        enum:
          - Verified
          - Managed
        type: string
        x-ms-enum:
          name: HostNameType
          modelAsString: false
  NameIdentifierCollection:
    description: Collection of domain name identifiers.
    required:
      - value
    type: object
    properties:
      value:
        description: Collection of resources.
        type: array
        items:
          $ref: >-
            ../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/NameIdentifier
        x-ms-identifiers:
          - name
      nextLink:
        description: Link to next page of resources.
        type: string
        readOnly: true
parameters:
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: >-
      Your Azure subscription ID. This is a GUID-formatted string (e.g.
      00000000-0000-0000-0000-000000000000).
    required: true
    type: string
  resourceGroupNameParameter:
    name: resourceGroupName
    in: path
    description: Name of the resource group to which the resource belongs.
    required: true
    type: string
    maxLength: 90
    minLength: 1
    pattern: ^[-\w\._\(\)]+[^\.]$
    x-ms-parameter-location: method
  apiVersionParameter:
    name: api-version
    in: query
    description: API Version
    required: true
    type: string
securityDefinitions:
  azure_auth:
    type: oauth2
    description: Azure Active Directory OAuth2 Flow
    flow: implicit
    authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
    scopes:
      user_impersonation: impersonate your user account
security:
  - azure_auth:
      - user_impersonation
tags:
  - name: Domains