Microsoft Azure PrivateZones API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector PrivateZones API
schemes:
- https
tags:
- name: PrivateZones
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}
  : put:
      tags:
      - PrivateZones
      operationId: microsoftAzurePrivatezonesCreateorupdate
      description: Creates or updates a Private DNS zone. Does not modify Links to virtual networks or DNS records within the zone.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: privateZoneName
        in: path
        required: true
        type: string
        description: The name of the Private DNS zone (without a terminating dot).
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/PrivateZone'
        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 Private 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 Private DNS zone to be created, but to prevent updating an existing zone. Other values will be ignored.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The Private DNS zone has been updated.
          schema:
            $ref: '#/definitions/PrivateZone'
        '201':
          description: The Private DNS zone has been created.
          schema:
            $ref: '#/definitions/PrivateZone'
        '202':
          description: The Private DNS zone upsert operation has been accepted and will complete asynchronously.
        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:
        PUT Private DNS Zone:
          $ref: ./examples/PrivateZonePut.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Privatednszones Privatezonename
    patch:
      tags:
      - PrivateZones
      operationId: microsoftAzurePrivatezonesUpdate
      description: Updates a Private DNS zone. Does not modify virtual network links or DNS records within the zone.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: privateZoneName
        in: path
        required: true
        type: string
        description: The name of the Private DNS zone (without a terminating dot).
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/PrivateZone'
        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 Private 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: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The Private DNS zone has been updated.
          schema:
            $ref: '#/definitions/PrivateZone'
        '202':
          description: The Private DNS zone update operation has been accepted and will complete asynchronously.
        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:
        PATCH Private DNS Zone:
          $ref: ./examples/PrivateZonePatch.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Privatednszones Privatezonename
    delete:
      tags:
      - PrivateZones
      operationId: microsoftAzurePrivatezonesDelete
      description: 'Deletes a Private DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone. Private DNS zone cannot be deleted unless all virtual network links to it are removed.'
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: privateZoneName
        in: path
        required: true
        type: string
        description: The name of the Private DNS zone (without a terminating dot).
      - name: If-Match
        in: header
        required: false
        type: string
        x-ms-client-name: IfMatch
        description: The ETag of the Private 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: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The Private DNS zone has been deleted.
        '202':
          description: The Private DNS zone delete operation has been accepted and will complete asynchronously.
        '204':
          description: The Private 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 Private DNS Zone:
          $ref: ./examples/PrivateZoneDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Privatednszones Privatezonename
    get:
      tags:
      - PrivateZones
      operationId: microsoftAzurePrivatezonesGet
      description: Gets a Private DNS zone. Retrieves the zone properties, but not the virtual networks links or the record sets within the zone.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: privateZoneName
        in: path
        required: true
        type: string
        description: The name of the Private DNS zone (without a terminating dot).
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Success.
          schema:
            $ref: '#/definitions/PrivateZone'
        default:
          description: Default response. It will be deserialized as per the Error definition.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        GET Private DNS Zone:
          $ref: ./examples/PrivateZoneGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Privatednszones Privatezonename
  /subscriptions/{subscriptionId}/providers/Microsoft.Network/privateDnsZones:
    get:
      tags:
      - PrivateZones
      operationId: microsoftAzurePrivatezonesList
      description: Lists the Private 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 Private DNS zones to return. If not specified, returns up to 100 zones.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Success.
          schema:
            $ref: '#/definitions/PrivateZoneListResult'
        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:
        GET Private DNS Zone by Subscription:
          $ref: ./examples/PrivateZoneListInSubscription.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network Privatednszones
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones:
    get:
      tags:
      - PrivateZones
      operationId: microsoftAzurePrivatezonesListbyresourcegroup
      description: Lists the Private DNS zones within a resource group.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - 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: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Success.
          schema:
            $ref: '#/definitions/PrivateZoneListResult'
        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:
        GET Private DNS Zone by Resource Group:
          $ref: ./examples/PrivateZoneListInResourceGroup.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Privatednszones
definitions:
  Resource:
    description: The core properties of ARM resources
    properties:
      id:
        type: string
        readOnly: true
        description: Fully qualified resource Id for the resource. Example - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}'.
      name:
        type: string
        readOnly: true
        description: The name of the resource
      type:
        type: string
        readOnly: true
        description: The type of the resource. Example - 'Microsoft.Network/privateDnsZones'.
    x-ms-azure-resource: true
  PrivateZone:
    properties:
      etag:
        type: string
        description: The ETag of the zone.
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/PrivateZoneProperties'
        description: Properties of the Private DNS zone.
    allOf:
    - $ref: '#/definitions/TrackedResource'
    description: Describes a Private DNS zone.
  CloudError:
    type: object
    x-ms-external: true
    properties:
      error:
        $ref: '#/definitions/CloudErrorBody'
        description: Cloud error body.
    description: An error response from the service.
  TrackedResource:
    description: The resource model definition for a ARM tracked top level resource
    properties:
      tags:
        type: object
        additionalProperties:
          type: string
        x-ms-mutability:
        - read
        - create
        - update
        description: Resource tags.
      location:
        type: string
        x-ms-mutability:
        - read
        - create
        description: The Azure Region where the resource lives
    allOf:
    - $ref: '#/definitions/Resource'
  PrivateZoneListResult:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/PrivateZone'
        description: Information about the Private DNS zones.
      nextLink:
        type: string
        description: The continuation token for the next page of results.
        readOnly: true
    description: The response to a Private DNS zone list operation.
  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
        items:
          $ref: '#/definitions/CloudErrorBody'
        description: A list of additional details about the error.
    description: An error response from the service.
  PrivateZoneProperties:
    properties:
      maxNumberOfRecordSets:
        type: integer
        format: int64
        description: The maximum number of record sets that can be created in this Private 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 Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
        readOnly: true
      maxNumberOfVirtualNetworkLinks:
        type: integer
        format: int64
        description: The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
        readOnly: true
      numberOfVirtualNetworkLinks:
        type: integer
        format: int64
        description: The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
        readOnly: true
      maxNumberOfVirtualNetworkLinksWithRegistration:
        type: integer
        format: int64
        description: The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
        readOnly: true
      numberOfVirtualNetworkLinksWithRegistration:
        type: integer
        format: int64
        description: The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
        readOnly: true
      provisioningState:
        type: string
        enum:
        - Creating
        - Updating
        - Deleting
        - Succeeded
        - Failed
        - Canceled
        x-ms-enum:
          name: ProvisioningState
          modelAsString: true
        description: The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored.
        readOnly: true
      internalId:
        type: string
        description: Private zone internal Id
        readOnly: true
    description: Represents the properties of the Private DNS zone.
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'