Microsoft Azure DnsResolvers API

openapi: 3.2.0
info:
  title: Microsoft Azure DnsResolverManagementClient Dns Resolvers…
  description: The DNS Resolver Management Client.
  version: 2020-04-01-preview
servers:
- url: https://management.azure.com
tags:
- name: DnsResolvers
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}
  : put:
      tags:
      - DnsResolvers
      operationId: microsoftAzureDnsresolversCreateorupdate
      description: Creates or updates a DNS resolver.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/DnsResolverNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: '#/components/parameters/IfMatchParameter'
      - $ref: '#/components/parameters/IfNoneMatchParameter'
      responses:
        '200':
          description: The DNS resolver has been updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnsResolver'
        '201':
          description: The DNS resolver has been created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnsResolver'
        '202':
          description: The operation to upsert DNS resolver has been accepted and will complete asynchronously.
        default:
          description: Default response. It will be deserialized as per the Error definition.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Upsert DNS resolver:
          $ref: ./examples/DnsResolver_Put.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DnsResolver'
        description: Parameters supplied to the CreateOrUpdate operation.
        required: true
    patch:
      tags:
      - DnsResolvers
      operationId: microsoftAzureDnsresolversUpdate
      description: Updates a DNS resolver.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/DnsResolverNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: '#/components/parameters/IfMatchParameter'
      responses:
        '200':
          description: The DNS resolver has been updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnsResolver'
        '202':
          description: The operation to update DNS resolver has been accepted and will complete asynchronously.
        default:
          description: Default response. It will be deserialized as per the Error definition.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Update DNS resolver:
          $ref: ./examples/DnsResolver_Patch.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DnsResolverPatch'
        description: Parameters supplied to the Update operation.
        required: true
    delete:
      tags:
      - DnsResolvers
      operationId: microsoftAzureDnsresolversDelete
      description: 'Deletes a DNS resolver. WARNING: This operation cannot be undone.'
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/DnsResolverNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: '#/components/parameters/IfMatchParameter'
      responses:
        '200':
          description: The DNS resolver has been deleted.
        '202':
          description: The operation to delete DNS resolver has been accepted and will complete asynchronously.
        '204':
          description: The DNS resolver was not found.
        default:
          description: Default response. It will be deserialized as per the Error definition.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Delete DNS resolver:
          $ref: ./examples/DnsResolver_Delete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
    get:
      tags:
      - DnsResolvers
      operationId: microsoftAzureDnsresolversGet
      description: Gets properties of a DNS resolver.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/DnsResolverNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The DNS resolver was found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnsResolver'
        default:
          description: Default response. It will be deserialized as per the Error definition.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-examples:
        Retrieve DNS resolver:
          $ref: ./examples/DnsResolver_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers:
    get:
      tags:
      - DnsResolvers
      operationId: microsoftAzureDnsresolversListbyresourcegroup
      description: Lists DNS resolvers within a resource group.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: '#/components/parameters/TopParameter'
      responses:
        '200':
          description: List of DNS resolvers in the resource group.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnsResolverListResult'
        default:
          description: Default response. It will be deserialized as per the Error definition.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List DNS resolvers by resource group:
          $ref: ./examples/DnsResolver_ListByResourceGroup.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  /subscriptions/{subscriptionId}/providers/Microsoft.Network/dnsResolvers:
    get:
      tags:
      - DnsResolvers
      operationId: microsoftAzureDnsresolversList
      description: Lists DNS resolvers in all resource groups of a subscription.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: '#/components/parameters/TopParameter'
      responses:
        '200':
          description: List of DNS resolvers in the subscription.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnsResolverListResult'
        default:
          description: Default response. It will be deserialized as per the Error definition.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List DNS resolvers by subscription:
          $ref: ./examples/DnsResolver_ListBySubscription.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/listDnsResolvers
  : post:
      tags:
      - DnsResolvers
      operationId: microsoftAzureDnsresolversListbyvirtualnetwork
      description: Lists DNS resolver resource IDs linked to a virtual network.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/VirtualNetworkNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: '#/components/parameters/TopParameter'
      responses:
        '200':
          description: List of DNS resolver resource IDs linked to the virtual network.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubResourceListResult'
        default:
          description: Default response. It will be deserialized as per the Error definition.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List DNS resolvers by virtual network:
          $ref: ./examples/DnsResolver_ListByVirtualNetwork.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups…
components:
  parameters:
    IfMatchParameter:
      name: If-Match
      in: header
      required: false
      x-ms-client-name: IfMatch
      description: ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.
      x-ms-parameter-location: method
      schema:
        type: string
    DnsResolverNameParameter:
      name: dnsResolverName
      in: path
      required: true
      description: The name of the DNS resolver.
      x-ms-parameter-location: method
      schema:
        type: string
    VirtualNetworkNameParameter:
      name: virtualNetworkName
      in: path
      required: true
      description: The name of the virtual network.
      x-ms-parameter-location: method
      schema:
        type: string
    TopParameter:
      name: $top
      in: query
      required: false
      description: The maximum number of results to return. If not specified, returns up to 100 results.
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
    IfNoneMatchParameter:
      name: If-None-Match
      in: header
      required: false
      x-ms-client-name: IfNoneMatch
      description: Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored.
      x-ms-parameter-location: method
      schema:
        type: string
  schemas:
    ProvisioningState:
      description: The current provisioning state of the resource.
      type: string
      enum:
      - Creating
      - Updating
      - Deleting
      - Succeeded
      - Failed
      - Canceled
      x-ms-enum:
        name: ProvisioningState
        modelAsString: true
    SubResource:
      description: Reference to another ARM resource.
      type: object
      properties:
        id:
          type: string
          description: Resource ID.
      x-ms-azure-resource: true
    CloudError:
      description: An error message
      type: object
      properties:
        error:
          description: The error message body
          $ref: '#/components/schemas/CloudErrorBody'
      x-ms-external: true
    DnsResolverPatch:
      description: Describes a DNS resolver for PATCH operation.
      type: object
      properties:
        tags:
          type: object
          additionalProperties:
            type: string
          x-ms-mutability:
          - read
          - create
          - update
          description: Tags for DNS Resolver.
    CloudErrorBody:
      description: The body of an error message
      type: object
      properties:
        code:
          description: The error code
          type: string
        message:
          description: A description of what caused the error
          type: string
        target:
          description: The target resource of the error message
          type: string
        details:
          description: Extra error information
          type: array
          items:
            $ref: '#/components/schemas/CloudErrorBody'
          x-ms-identifiers: []
      x-ms-external: true
    DnsResolverListResult:
      description: The response to an enumeration operation on DNS resolvers.
      type: object
      properties:
        value:
          description: Enumeration of the DNS resolvers.
          type: array
          items:
            $ref: '#/components/schemas/DnsResolver'
        nextLink:
          description: The continuation token for the next page of results.
          type: string
          readOnly: true
    ResourceGuid:
      type: string
      description: The Guid property of the resource.
    DnsResolverProperties:
      description: Represents the properties of a DNS resolver.
      type: object
      required:
      - virtualNetwork
      properties:
        virtualNetwork:
          description: The reference to the virtual network. This cannot be changed after creation.
          x-ms-mutability:
          - read
          - create
          $ref: '#/components/schemas/SubResource'
        dnsResolverState:
          description: The current status of the DNS resolver. This is a read-only property and any attempt to set this value will be ignored.
          type: string
          enum:
          - Connected
          - Disconnected
          x-ms-enum:
            name: DnsResolverState
            modelAsString: true
          readOnly: true
        provisioningState:
          description: The current provisioning state of the DNS resolver. This is a read-only property and any attempt to set this value will be ignored.
          readOnly: true
          $ref: '#/components/schemas/ProvisioningState'
        resourceGuid:
          description: The resourceGuid property of the DNS resolver resource.
          readOnly: true
          $ref: '#/components/schemas/ResourceGuid'
    DnsResolver:
      description: Describes a DNS resolver.
      type: object
      properties:
        etag:
          description: ETag of the DNS resolver.
          type: string
          readOnly: true
        properties:
          description: Properties of the DNS resolver.
          $ref: '#/components/schemas/DnsResolverProperties'
          x-ms-client-flatten: true
        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: ../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource
    SubResourceListResult:
      description: The response to an enumeration operation on sub-resources.
      type: object
      properties:
        value:
          description: Enumeration of the sub-resources.
          type: array
          items:
            $ref: '#/components/schemas/SubResource'
        nextLink:
          description: The continuation token for the next page of results.
          type: string
          readOnly: true
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow