swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Zones API
schemes:
- https
tags:
- name: Zones
paths:
  /parties/{partyId}/zones:
    get:
      tags:
      - Zones
      description: Returns a paginated list of zone resources under a particular party.
      operationId: microsoftAzureZonesListbypartyid
      produces:
      - application/json
      parameters:
      - in: path
        name: partyId
        description: Id of the associated party.
        required: true
        type: string
      - in: query
        name: types
        description: Types of the Zones.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: managementZoneIds
        description: ManagementZoneIds of the Zones.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: sources
        description: Sources of the Zones.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: ids
        description: Ids of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: names
        description: Names of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: propertyFilters
        description: "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\"."
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: statuses
        description: Statuses of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: minCreatedDateTime
        description: Minimum creation date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: maxCreatedDateTime
        description: Maximum creation date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: minLastModifiedDateTime
        description: Minimum last modified date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: maxLastModifiedDateTime
        description: Maximum last modified date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: maxPageSize
        description: "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50."
        type: integer
        format: int32
        default: 50
        maximum: 1000
        minimum: 10
      - in: query
        name: skipToken
        description: Skip token for getting next set of results.
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ZoneListResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Zones_ListByPartyId:
          $ref: ./examples/Zones_ListByPartyId.json
      summary: Microsoft Azure Get Parties Partyid Zones
  /parties/{partyId}/zones/{zoneId}:
    get:
      tags:
      - Zones
      description: Gets a specified zone resource under a particular party.
      operationId: microsoftAzureZonesGet
      produces:
      - application/json
      parameters:
      - in: path
        name: partyId
        description: Id of the associated party.
        required: true
        type: string
      - in: path
        name: zoneId
        description: Id of the zone.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Zone'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-examples:
        Zones_Get:
          $ref: ./examples/Zones_Get.json
      summary: Microsoft Azure Get Parties Partyid Zones Zoneid
    patch:
      tags:
      - Zones
      description: Creates or updates a Zone resource.
      operationId: microsoftAzureZonesCreateorupdate
      consumes:
      - application/merge-patch+json
      produces:
      - application/json
      parameters:
      - in: path
        name: partyId
        description: Id of the party resource.
        required: true
        type: string
      - in: path
        name: zoneId
        description: Id of the zone resource.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      - in: body
        name: zone
        description: Zone resource payload to create or update.
        required: true
        schema:
          $ref: '#/definitions/Zone'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Zone'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/Zone'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-examples:
        Zones_CreateOrUpdate:
          $ref: ./examples/Zones_CreateOrUpdate.json
      summary: Microsoft Azure Patch Parties Partyid Zones Zoneid
    delete:
      tags:
      - Zones
      description: Deletes a specified zone resource under a particular party.
      operationId: microsoftAzureZonesDelete
      produces:
      - application/json
      parameters:
      - in: path
        name: partyId
        description: Id of the party.
        required: true
        type: string
      - in: path
        name: zoneId
        description: Id of the zone.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '204':
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-examples:
        Zones_Delete:
          $ref: ./examples/Zones_Delete.json
      summary: Microsoft Azure Delete Parties Partyid Zones Zoneid
  /zones:
    get:
      tags:
      - Zones
      description: Returns a paginated list of zone resources across all parties.
      operationId: microsoftAzureZonesList
      produces:
      - application/json
      parameters:
      - in: query
        name: types
        description: Types of the Zones.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: managementZoneIds
        description: ManagementZoneIds of the Zones.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: sources
        description: Sources of the Zones.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: ids
        description: Ids of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: names
        description: Names of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: propertyFilters
        description: "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\"."
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: statuses
        description: Statuses of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: minCreatedDateTime
        description: Minimum creation date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: maxCreatedDateTime
        description: Maximum creation date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: minLastModifiedDateTime
        description: Minimum last modified date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: maxLastModifiedDateTime
        description: Maximum last modified date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: maxPageSize
        description: "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50."
        type: integer
        format: int32
        default: 50
        maximum: 1000
        minimum: 10
      - in: query
        name: skipToken
        description: Skip token for getting next set of results.
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ZoneListResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Zones_List:
          $ref: ./examples/Zones_List.json
      summary: Microsoft Azure Get Zones
  /zones/cascade-delete/{jobId}:
    get:
      tags:
      - Zones
      description: Get a cascade delete job for specified job id.
      operationId: microsoftAzureZonesGetcascadedeletejobdetails
      produces:
      - application/json
      parameters:
      - in: path
        name: jobId
        description: Id of the job.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/CascadeDeleteJob'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-examples:
        Zones_GetCascadeDeleteJobDetails:
          $ref: ./examples/Zones_GetCascadeDeleteJobDetails.json
      summary: Microsoft Azure Get Zones Cascade Delete Jobid
    put:
      tags:
      - Zones
      description: Create a cascade delete job for specified zone.
      operationId: microsoftAzureZonesCreatecascadedeletejob
      produces:
      - application/json
      parameters:
      - in: path
        name: jobId
        description: Job ID supplied by end user.
        required: true
        type: string
      - in: query
        name: partyId
        description: ID of the associated party.
        required: true
        type: string
      - in: query
        name: zoneId
        description: ID of the zone to be deleted.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '202':
          description: Accepted
          schema:
            $ref: '#/definitions/CascadeDeleteJob'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Zones_CreateCascadeDeleteJob:
          $ref: ./examples/Zones_CreateCascadeDeleteJob.json
      summary: Microsoft Azure Put Zones Cascade Delete Jobid
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}:
    put:
      tags:
      - Zones
      operationId: microsoftAzureZonesCreateorupdate
      description: Creates or updates a DNS zone. Does not modify DNS records within the zone.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/ZoneNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/Zone_2'
        description: Parameters supplied to the CreateOrUpdate operation.
      - name: If-Match
        in: header
        required: false
        type: string
        x-ms-client-name: IfMatch
        description: The etag of the DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwriting any concurrent changes.
      - name: If-None-Match
        in: header
        required: false
        type: string
        x-ms-client-name: IfNoneMatch
        description: Set to '*' to allow a new DNS zone to be created, but to prevent updating an existing zone. Other values will be ignored.
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: The DNS zone has been updated.
          schema:
            $ref: '#/definitions/Zone_2'
        '201':
          description: The DNS zone has been created.
          schema:
            $ref: '#/definitions/Zone_2'
        default:
          description: Default response. It will be deserialized as per the Error definition.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Create zone:
          $ref: ./examples/CreateOrUpdateZone.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Dnszones Zonename
    delete:
      tags:
      - Zones
      operationId: microsoftAzureZonesDelete
      description: 'Deletes a DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone.'
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/ZoneNameParameter'
      - name: If-Match
        in: header
        required: false
        type: string
        x-ms-client-name: IfMatch
        description: The etag of the DNS zone. Omit this value to always delete the current zone. Specify the last-seen etag value to prevent accidentally deleting any concurrent changes.
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: The DNS zone has been deleted.
        '202':
          headers:
            Location:
              description: Location URI to poll for result
              type: string
          description: The DNS zone delete operation has been accepted and will complete asynchronously.
        '204':
          description: The DNS zone was not found.
        default:
          description: Default response. It will be deserialized as per the Error definition.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Delete zone:
          $ref: ./examples/DeleteZone.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Dnszones Zonename
    get:
      tags:
      - Zones
      operationId: microsoftAzureZonesGet
      description: Gets a DNS zone. Retrieves the zone properties, but not the record sets within the zone.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/ZoneNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Success.
          schema:
            $ref: '#/definitions/Zone_2'
        default:
          description: Default response. It will be deserialized as per the Error definition.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Get zone:
          $ref: ./examples/GetZone.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Dnszones Zonename
    patch:
      tags:
      - Zones
      operationId: microsoftAzureZonesUpdate
      description: Updates a DNS zone. Does not modify DNS records within the zone.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/ZoneNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/ZoneUpdate'
        description: Parameters supplied to the Update operation.
      - name: If-Match
        in: header
        required: false
        type: string
        x-ms-client-name: IfMatch
        description: The etag of the DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwriting any concurrent changes.
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: The DNS zone has been updated.
          schema:
            $ref: '#/definitions/Zone_2'
        default:
          description: Default response. It will be deserialized as per the Error definition.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Patch zone:
          $ref: ./examples/PatchZone.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Dnszones Zonename
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones:
    get:
      tags:
      - Zones
      operationId: microsoftAzureZonesListbyresourcegroup
      description: Lists the DNS zones within a resource group.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - name: $top
        in: query
        required: false
        type: integer
        format: int32
        description: The maximum number of record sets to return. If not specified, returns up to 100 record sets.
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Success.
          schema:
            $ref: '#/definitions/ZoneListResult'
        default:
          description: Default response. It will be deserialized as per the Error definition.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List zones by resource group:
          $ref: ./examples/ListZonesByResourceGroup.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Dnszones
  /subscriptions/{subscriptionId}/providers/Microsoft.Network/dnszones:
    get:
      tags:
      - Zones
      operationId: microsoftAzureZonesList
      description: Lists the DNS zones in all resource groups in a subscription.
      parameters:
      - name: $top
        in: query
        required: false
        type: integer
        format: int32
        description: The maximum number of DNS zones to return. If not specified, returns up to 100 zones.
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Success.
          schema:
            $ref: '#/definitions/ZoneListResult'
        default:
          description: Default response. It will be deserialized as per the Error definition.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List zones by subscription:
          $ref: ./examples/ListZonesBySubscription.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network Dnszones
  /zone:search:
    post:
      tags:
      - Zones
      description: Search for Zones across all parties by intersecting geometry.
      operationId: microsoftAzureZonesSearch
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: query
        name: skipToken
        description: Skip token for getting next set of results.
        type: string
      - in: query
        name: maxPageSize
        description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default Value = 50.
        type: integer
        format: int32
        default: 50
        maximum: 1000
        minimum: 10
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      - in: body
        name: searchZoneQuery
        description: Query filters.
        required: true
        schema:
          $ref: '#/definitions/SearchZoneQuery'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ZoneMetaDataListResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-examples:
        Zones_Search:
          $ref: ./examples/Zones_Search.json
      summary: Microsoft Azure Post Zone:search
definitions:
  ZoneMetaData:
    description: Api Model for Zone object.
    type: object
    properties:
      partyId:
        description: Party Id associated with the Zone.
        type: string
        readOnly: true
      type:
        description: Type of the Zone.
        maxLength: 100
        minLength: 0
        type: string
      managementZoneId:
        description: Management Zone Id associated with the Zone.
        type: string
      id:
        description: Unique resource ID.
        type: string
        readOnly: true
      eTag:
        description: The ETag value to implement optimistic concurrency.
        type: string
        readOnly: true
      status:
        description: Status of the resource.
        maxLength: 100
        minLength: 0
        type: string
      createdDateTime:
        format: date-time
        description: 'Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
        example: '2020-12-31T11:10:21Z'
      modifiedDateTime:
        format: date-time
        description: 'Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
        example: '2020-12-31T11:10:21Z'
      source:
        description: Source of the resource.
        maxLength: 100
        minLength: 2
        type: string
      name:
        description: Name to identify resource.
        maxLength: 100
        minLength: 0
        type: string
      description:
        description: Textual description of the resource.
        maxLength: 500
        minLength: 0
        type: string
      createdBy:
        description: Created by user/tenant id.
        type: string
        readOnly: true
      modifiedBy:
        description: Modified by user/tenant id.
        type: string
        readOnly: true
      properties:
        description: "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported."
        type: object
        additionalProperties: {}
        example:
          key1: value1
          key2: 123.45
  ZoneProperties:
    type: object
    properties:
      maxNumberOfRecordSets:
        type: integer
        format: int64
        description: The maximum number of record sets that can be created in this DNS zone.  This is a read-only property and any attempt to set this value will be ignored.
        readOnly: true
      maxNumberOfRecordsPerRecordSet:
        type: integer
        format: int64
        description: The maximum number of records per record set that can be created in this DNS zone.  This is a read-only property and any attempt to set this value will be ignored.
        readOnly: true
      numberOfRecordSets:
        type: integer
        format: int64
        description: The current number of record sets in this DNS zone.  This is a read-only property and any attempt to set this value will be ignored.
        readOnly: true
      nameServers:
        type: array
        x-ms-identifiers: []
        items:
          type: string
        description: The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
        readOnly: true
      zoneType:
        type: string
        enum:
        - Public
        - Private
        x-ms-enum:
          name: ZoneType
          modelAsString: false
        default: Public
        description: The type of this DNS zone (Public or Private).
      registrationVirtualNetworks:
        type: array
        x-ms-identifiers: []
        items:
          $ref: '#/definitions/SubResource'
        description: A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private.
      resolutionVirtualNetworks:
        type: array
        x-ms-identifiers: []
        items:
          $ref: '#/definitions/SubResource'
        description: A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private.
      signingKeys:
        type: array
        x-ms-identifiers: []
        items:
          $ref: '#/definitions/SigningKey'
        description: The list of signing keys.
        readOnly: true
    description: Represents the properties of the zone.
  CloudErrorBody:
    type: object
    x-ms-external: true
    properties:
      code:
        type: string
        description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
      message:
        type: string
        description: A message describing the error, intended to be suitable for display in a user interface.
      target:
        type: string
        description: The target of the particular error. For example, the name of the property in error.
      details:
        type: array
        x-ms-identifiers: []
        items:
          $ref: '#/definitions/CloudErrorBody'
        description: A list of additional details about the error.
    description: An error response from the service.
  SigningKey:
    type: object
    properties:
      delegationSignerInfo:
        type: array
        x-ms-identifiers: []
        items:
          $ref: '#/definitions/DelegationSignerInfo'
        description: The delegation signer information.
        readOnly: true
      flags:
        type: integer
        format: int32
        description: The flags specifies how the key is used.
        readOnly: true
      keyTag:
        type: integer
        format: int32
        description: The key tag value of the DNSKEY Resource Record.
        readOnly: true
      protocol:
        type: integer
        format: int32
        description: The protocol value. The value is always 3.
        readOnly: true
      publicKey:
        type: string
        description: The public key, represented as a Base64 encoding.
        readOnly: true
      securityAlgorithmType:
        $ref: '#/definitions/SecurityAlgorithmType'
        readOnly: true
    description: Represents the signing key.
  Resource:
    type: object
    x-ms-azure-resource: true
    properties:
      id:
        readOnly: true
        type: string
        description: Resource ID.
      name:
        readOnly: true
        type: string
        description: Resource name.
      type:
        readOnly: true
        type: string
        description: Resource type.
      location:
        type: string
        description: Resource location.
        x-ms-mutability:
        - read
        - create
      tags:
        type: object
        additionalProperties:
          type: string
        description: Resource tags.
    required:
    - location
    description: Common properties of an Azure Resource Manager resource
  SearchZoneQuery:
    description: Get Zones query parameters.
    type: object
    properties:
      types:
        description: Types of the Zones.
        type: array
        items:
          type: string
      managementZoneIds:
        description: ManagementZoneIds of the Zones.
        type: array
        items:
          type: string
      sources:
        description: Sources of the Zones.
        type: array
        items:
          type: string
      ids:
        description: Ids of the resource.
        type: array
        items:
          type: string
      names:
        description: Names of the resource.
        type: array
        items:
          type: string
      propertyFilters:
        description: "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\"."
        type: array
        items:
          type: string
      statuses:
        description: Statuses of the resource.
        type: array
        items:
          type: string
      minCreatedDateTime:
        format: date-time
        description: Minimum creation date of resource (inclusive).
        type: string
      maxCreatedDateTime:
        format: date-time
        description: Maximum creation date of resource (inclusive).
        type: string
      minLastModifiedDateTime:
        format: date-time
        description: Minimum last modified date of resource (inclusive).
        type: string
      maxLastModifiedDateTime:
        format: date-time
        description: Maximum last modified date of resource (inclusive).
        type: string
      intersectsWithGeometry:
        $ref: '#/definitions/GeoJsonObject'
      partyId:
        description: Party ID which belongs to the operation data.
        type: string
  Zone_2:
    type: object
    properties:
      etag:
        type: string
        description: The etag of the zone.
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/ZoneProperties'
        description: The properties of the zone.
      systemData:
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
        description: Metadata pertaining to creation and last modification of the resource.
        readOnly: true
    allOf:
    - $ref: '#/definitions/Resource'
    description: Describes a DNS zone.
  ZoneListResponse:
    description: Paged response contains list of requested objects and a URL link to get the next set of results.
    required:
    - value
    type: object
    properties:
      value:
        description: List of requested objects.
        type: array
        items:
          $ref: '#/definitions/Zone'
      skipToken:
        description: Token used in retrieving the next page. If null, there are no additional pages.
        type: string
      nextLink:
        description: Continuation link (absolute URI) to the next page of results in the list.
        type: string
  CascadeDeleteJob:
    description: Schema of cascade delete job.
    required:
    - partyId
    - resourceId
    - resourceType
    type: object
    properties:
      partyId:
        description: Party Id.
        minLength: 1
        type: string
      resourceId:
        description: The id of the resource.
        minLength: 1
        type: string
      resourceType:
        description: The type of the resource.
        minLength: 1
        type: string
      id:
        description: Unique job id.
        type: string
        readOnly: true
      status:
        description: "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'."
        enum:
        - Waiting
        - Running
        - Succeeded
        - Failed
        - Cancelled
        type: string
        readOnly: true
        x-ms-enum:
          name: JobStatus
          modelAsString: true
      durationInSeconds:
        format: double
        description: Duration of the job in seconds.
        type: number
        readOnly: true
      message:
        description: Status message to capture more details of the job.
        type: string
        readOnly: true
      errorCode:
        description: Error Code when job failed.
        type: string
        readOnly: true
      createdDateTime:
        format: date-time
        description: 'Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
      lastActionDateTime:
        format: date-time
        description: 'Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
      startTime:
        format: date-time
        description: 'Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
      endTime:
        format: date-time
        description: 'Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
  GeoJsonObject:
    description: 'GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format.'
    required:
    - type
    type: object
    properties:
      type:
        $ref: '#/definitions/GeoJsonObjectType'
    discriminator: type
  Zone:
    description: Api Model for Zone object.
    type: object
    properties:
      partyId:
        description: Party Id associated with the Zone.
        type: string
        readOnly: true
      type:
        description: Type of the Zone.
        maxLength: 100
        minLength: 0
        type: string
      managementZoneId:
        description: Management Zone Id associated with the Zone.
        type: string
      id:
        description: Unique resource ID.
        type: string
        readOnly: true
      eTag:
        description: The ETag value to implement optimistic concurrency.
        type: string
        readOnly: true
      status:
        description: Status of the resource.
        maxLength: 100
        minLength: 0
        type: string
      createdDateTime:
        format: date-time
        description: 'Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
        example: '2020-12-31T11:10:21Z'
      modifiedDateTime:
        format: date-time
        description: 'Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
        example: '2020-12-31T11:10:21Z'
      source:
        description: Source of the resource.
        maxLength: 100
        minLength: 2
        type: string
      name:
        description: Name to identify resource.
        maxLength: 100
        minLength: 0
        type: string
      description:
        description: Textual description of the resource.
        maxLength: 500
        minLength: 0
        type: string
      createdBy:
        description: Created by user/tenant id.
        type: string
        readOnly: true
      modifiedBy:
        description: Modified by user/tenant id.
        type: string
        readOnly: true
      properties:
        description: "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported."
        type: object
        additionalProperties: {}
        example:
          key1: value1
          key2: 123.45
  SubResource:
    type: object
    properties:
      id:
        type: string
        description: Resource Id.
    description: A reference to a another resource
  ZoneUpdate:
    type: object
    properties:
      tags:
        type: object
        additionalProperties:
          type: string
        description: Resource tags.
    description: Describes a request to update a DNS zone.
  SecurityAlgorithmType:
    type: integer
    format: int32
    description: 'The security algorithm type represents the standard security algorithm number of the DNSKEY Resource Record. See: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml'
  Error:
    description: An error from the Azure AgPlatform service.
    required:
    - code
    - message
    type: object
    properties:
      code:
        description: Server-defined set of error codes.
        minLength: 1
        type: string
      message:
        description: Human-readable representation of the error.
        minLength: 1
        type: string
      target:
        description: Target of the error.
        type: string
      details:
        description: Array of details about specific errors that led to this reported error.
        type: array
        items:
          $ref: '#/definitions/Error'
      innererror:
        $ref: '#/definitions/InnerError'
  GeoJsonObjectType:
    description: GeoJSON object type.
    enum:
    - Point
    - Polygon
    - MultiPolygon
    type: string
    x-ms-enum:
      name: GeoJsonObjectType
      modelAsString: true
  DelegationSignerInfo:
    type: object
    properties:
      digestAlgorithmType:
        $ref: '#/definitions/DigestAlgorithmType'
        readOnly: true
      digestValue:
        type: string
        description: The digest value is a cryptographic hash value of the referenced DNSKEY Resource Record.
        readOnly: true
      record:
        type: string
        description: The record represents a delegation signer (DS) record.
        readOnly: true
    description: The delegation signer information.
  ErrorResponse:
    description: An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.
    type: object
    properties:
      error:
        $ref: '#/definitions/Error'
      traceId:
        description: Unique trace Id.
        type: string
  ZoneListResult:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/Zone_2'
        description: Information about the DNS zones.
      nextLink:
        type: string
        description: The continuation token for the next page of results.
        readOnly: true
    description: The response to a Zone List or ListAll operation.
  ZoneMetaDataListResponse:
    description: Paged response contains list of requested objects and a skipToken to get the next set of results.
    required:
    - value
    type: object
    properties:
      value:
        description: List of requested objects.
        type: array
        items:
          $ref: '#/definitions/ZoneMetaData'
      skipToken:
        description: Token used in retrieving the next page. If null, there are no additional pages.
        type: string
      nextLink:
        description: Continuation link (absolute URI) to the next page of results in the list.
        type: string
  CloudError:
    type: object
    x-ms-external: true
    properties:
      error:
        $ref: '#/definitions/CloudErrorBody'
        description: Cloud error body.
    description: An error response from the service.
  InnerError:
    description: Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.
    type: object
    properties:
      code:
        description: Specific error code than was provided by the containing error.
        type: string
      innererror:
        $ref: '#/definitions/InnerError'
  DigestAlgorithmType:
    type: integer
    format: int32
    description: 'The digest algorithm type represents the standard digest algorithm number used to construct the digest. See: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml'
parameters:
  ZoneNameParameter:
    name: zoneName
    in: path
    required: true
    type: string
    description: The name of the DNS zone (without a terminating dot).
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'