Microsoft Azure GlobalDomainRegistration API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Global Domain Registration API
tags:
- name: GlobalDomainRegistration
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/domains:
    get:
      tags:
      - GlobalDomainRegistration
      summary: Microsoft Azure Lists All Domains In A Subscription
      operationId: microsoftAzureGlobaldomainregistrationGetalldomains
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainCollection'
            text/json:
              schema:
                $ref: '#/components/schemas/DomainCollection'
      deprecated: false
      x-ms-pageable:
        nextLinkName: nextLink
      description: Needs a more full description created.
  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/generateSsoRequest:
    post:
      tags:
      - GlobalDomainRegistration
      summary: Microsoft Azure Generates A Single Sign On Request For Domain Management Portal
      operationId: microsoftAzureGlobaldomainregistrationGetdomaincontrolcenterssorequest
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainControlCenterSsoRequest'
            text/json:
              schema:
                $ref: '#/components/schemas/DomainControlCenterSsoRequest'
            application/xml:
              schema:
                $ref: '#/components/schemas/DomainControlCenterSsoRequest'
            text/xml:
              schema:
                $ref: '#/components/schemas/DomainControlCenterSsoRequest'
      deprecated: false
      description: Needs a more full description created.
  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/validateDomainRegistrationInformation:
    post:
      tags:
      - GlobalDomainRegistration
      summary: Microsoft Azure Validates Domain Registration Information
      operationId: microsoftAzureGlobaldomainregistrationValidatedomainpurchaseinformation
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Object'
            text/json:
              schema:
                $ref: '#/components/schemas/Object'
            application/xml:
              schema:
                $ref: '#/components/schemas/Object'
            text/xml:
              schema:
                $ref: '#/components/schemas/Object'
      deprecated: false
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainRegistrationInput'
          text/json:
            schema:
              $ref: '#/components/schemas/DomainRegistrationInput'
          application/xml:
            schema:
              $ref: '#/components/schemas/DomainRegistrationInput'
          text/xml:
            schema:
              $ref: '#/components/schemas/DomainRegistrationInput'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DomainRegistrationInput'
        description: Domain registration information
        required: true
  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/checkDomainAvailability:
    post:
      tags:
      - GlobalDomainRegistration
      summary: Microsoft Azure Checks If A Domain Is Available For Registration
      operationId: microsoftAzureGlobaldomainregistrationCheckdomainavailability
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainAvailablilityCheckResult'
            text/json:
              schema:
                $ref: '#/components/schemas/DomainAvailablilityCheckResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/DomainAvailablilityCheckResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/DomainAvailablilityCheckResult'
      deprecated: false
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NameIdentifier'
          text/json:
            schema:
              $ref: '#/components/schemas/NameIdentifier'
          application/xml:
            schema:
              $ref: '#/components/schemas/NameIdentifier'
          text/xml:
            schema:
              $ref: '#/components/schemas/NameIdentifier'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/NameIdentifier'
        description: Name of the domain
        required: true
  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/listDomainRecommendations:
    post:
      tags:
      - GlobalDomainRegistration
      summary: Microsoft Azure Lists Domain Recommendations Based On Keywords
      operationId: microsoftAzureGlobaldomainregistrationListdomainrecommendations
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NameIdentifierCollection'
            text/json:
              schema:
                $ref: '#/components/schemas/NameIdentifierCollection'
      deprecated: false
      x-ms-pageable:
        nextLinkName: nextLink
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainRecommendationSearchParameters'
          text/json:
            schema:
              $ref: '#/components/schemas/DomainRecommendationSearchParameters'
          application/xml:
            schema:
              $ref: '#/components/schemas/DomainRecommendationSearchParameters'
          text/xml:
            schema:
              $ref: '#/components/schemas/DomainRecommendationSearchParameters'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DomainRecommendationSearchParameters'
        description: Domain recommendation search parameters
        required: true
components:
  schemas:
    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 sites the hostname is assigned to. This list will have more than one site 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 website 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
    NameIdentifier:
      description: Identifies an object
      type: object
      properties:
        name:
          description: Name of the object
          type: string
    Address:
      description: Address information for domain registration
      type: object
      properties:
        address1:
          description: Address 1
          type: string
        address2:
          description: Address 2
          type: string
        city:
          description: City
          type: string
        country:
          description: Country
          type: string
        postalCode:
          description: Postal code
          type: string
        state:
          description: State
          type: string
    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
        postParameterKey:
          description: Post parameter key
          type: string
        postParameterValue:
          description: Post parameter value. Client should use 'application/x-www-form-urlencoded' encoding for this value.
          type: string
    Object:
      type: object
      properties: {}
    Domain:
      description: Represents a domain
      type: object
      allOf:
      - $ref: '#/components/schemas/Resource'
      properties:
        properties:
          properties:
            contactAdmin:
              $ref: '#/components/schemas/Contact'
              description: Admin contact information
            contactBilling:
              $ref: '#/components/schemas/Contact'
              description: Billing contact information
            contactRegistrant:
              $ref: '#/components/schemas/Contact'
              description: Registrant contact information
            contactTech:
              $ref: '#/components/schemas/Contact'
              description: Technical contact information
            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
              x-ms-enum:
                name: DomainStatus
                modelAsString: false
            provisioningState:
              description: Domain provisioning state
              enum:
              - Succeeded
              - Failed
              - Canceled
              - InProgress
              - Deleting
              type: string
              x-ms-enum:
                name: ProvisioningState
                modelAsString: false
            nameServers:
              description: Name servers
              type: array
              items:
                type: string
            privacy:
              description: If true then domain privacy is enabled for this domain
              type: boolean
            createdTime:
              format: date-time
              description: Domain creation timestamp
              type: string
            expirationTime:
              format: date-time
              description: Domain expiration timestamp
              type: string
            lastRenewedTime:
              format: date-time
              description: Timestamp when the domain was renewed last time
              type: string
            autoRenew:
              description: If true then domain will renewed automatically
              type: boolean
            readyForDnsRecordManagement:
              description: If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to
              type: boolean
            managedHostNames:
              description: All hostnames derived from the domain and assigned to Azure resources
              type: array
              items:
                $ref: '#/components/schemas/HostName'
            consent:
              $ref: '#/components/schemas/DomainPurchaseConsent'
              description: Legal agreement consent
            domainNotRenewableReasons:
              description: Reasons why domain is not renewable
              type: array
              items:
                enum:
                - RegistrationStatusNotSupportedForRenewal
                - ExpirationNotInRenewalTimeRange
                - SubscriptionNotActive
                type: string
          x-ms-client-flatten: true
    DomainAvailablilityCheckResult:
      description: Domain availablility check result
      type: object
      properties:
        name:
          description: Name of the domain
          type: string
        available:
          description: If true then domain can be purchased using CreateDomain Api
          type: boolean
        domainType:
          description: Domain type
          enum:
          - Regular
          - SoftDeleted
          type: string
          x-ms-enum:
            name: DomainType
            modelAsString: false
    DomainRegistrationInput:
      description: Domain registration input for validation Api
      type: object
      allOf:
      - $ref: '#/components/schemas/Resource'
      properties:
        properties:
          properties:
            name:
              description: Name of the domain
              type: string
            contactAdmin:
              $ref: '#/components/schemas/Contact'
              description: Admin contact information
            contactBilling:
              $ref: '#/components/schemas/Contact'
              description: Billing contact information
            contactRegistrant:
              $ref: '#/components/schemas/Contact'
              description: Registrant contact information
            contactTech:
              $ref: '#/components/schemas/Contact'
              description: Technical contact information
            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
              x-ms-enum:
                name: DomainStatus
                modelAsString: false
            provisioningState:
              description: Domain provisioning state
              enum:
              - Succeeded
              - Failed
              - Canceled
              - InProgress
              - Deleting
              type: string
              x-ms-enum:
                name: ProvisioningState
                modelAsString: false
            nameServers:
              description: Name servers
              type: array
              items:
                type: string
            privacy:
              description: If true then domain privacy is enabled for this domain
              type: boolean
            createdTime:
              format: date-time
              description: Domain creation timestamp
              type: string
            expirationTime:
              format: date-time
              description: Domain expiration timestamp
              type: string
            lastRenewedTime:
              format: date-time
              description: Timestamp when the domain was renewed last time
              type: string
            autoRenew:
              description: If true then domain will renewed automatically
              type: boolean
            readyForDnsRecordManagement:
              description: If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to
              type: boolean
            managedHostNames:
              description: All hostnames derived from the domain and assigned to Azure resources
              type: array
              items:
                $ref: '#/components/schemas/HostName'
            consent:
              $ref: '#/components/schemas/DomainPurchaseConsent'
              description: Legal agreement consent
            domainNotRenewableReasons:
              description: Reasons why domain is not renewable
              type: array
              items:
                enum:
                - RegistrationStatusNotSupportedForRenewal
                - ExpirationNotInRenewalTimeRange
                - SubscriptionNotActive
                type: string
          x-ms-client-flatten: true
    Resource:
      required:
      - location
      properties:
        id:
          description: Resource Id
          type: string
        name:
          description: Resource Name
          type: string
        kind:
          description: Kind of resource
          type: string
        location:
          description: Resource Location
          type: string
        type:
          description: Resource type
          type: string
        tags:
          description: Resource tags
          type: object
          additionalProperties:
            type: string
      x-ms-azure-resource: true
    Contact:
      description: Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information will be made publicly available through the Whois directories as per ICANN requirements.
      type: object
      properties:
        addressMailing:
          $ref: '#/components/schemas/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
          type: string
        phone:
          description: Phone number
          type: string
    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 TopLevelDomain 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
    DomainCollection:
      description: Collection of domains
      type: object
      properties:
        value:
          description: Collection of resources
          type: array
          items:
            $ref: '#/components/schemas/Domain'
        nextLink:
          description: Link to next page of resources
          type: string
    NameIdentifierCollection:
      description: Collection of domain name identifiers
      type: object
      properties:
        value:
          description: Collection of resources
          type: array
          items:
            $ref: '#/components/schemas/NameIdentifier'
        nextLink:
          description: Link to next page of resources
          type: string
  parameters:
    subscriptionIdParameter:
      name: subscriptionId
      in: path
      description: Subscription Id
      required: true
      schema:
        type: string
    apiVersionParameter:
      name: api-version
      in: query
      description: API Version
      required: true
      schema:
        type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'