swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector DnsResolvers API schemes: - https 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: '#/parameters/DnsResolverNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/DnsResolver' description: Parameters supplied to the CreateOrUpdate operation. - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/IfMatchParameter' - $ref: '#/parameters/IfNoneMatchParameter' responses: '200': description: The DNS resolver has been updated. schema: $ref: '#/definitions/DnsResolver' '201': description: The DNS resolver has been created. schema: $ref: '#/definitions/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. schema: $ref: '#/definitions/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 Resourcegroupname Providers Microsoft Network Dnsresolvers Dnsresolvername 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: '#/parameters/DnsResolverNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/DnsResolverPatch' description: Parameters supplied to the Update operation. - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/IfMatchParameter' responses: '200': description: The DNS resolver has been updated. schema: $ref: '#/definitions/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. schema: $ref: '#/definitions/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 Resourcegroupname Providers Microsoft Network Dnsresolvers Dnsresolvername 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: '#/parameters/DnsResolverNameParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/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. schema: $ref: '#/definitions/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 Resourcegroupname Providers Microsoft Network Dnsresolvers Dnsresolvername 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: '#/parameters/DnsResolverNameParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: The DNS resolver was found. schema: $ref: '#/definitions/DnsResolver' default: description: Default response. It will be deserialized as per the Error definition. schema: $ref: '#/definitions/CloudError' x-ms-examples: Retrieve DNS resolver: $ref: ./examples/DnsResolver_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Dnsresolvers Dnsresolvername /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: '#/parameters/TopParameter' responses: '200': description: List of DNS resolvers in the resource group. schema: $ref: '#/definitions/DnsResolverListResult' 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 DNS resolvers by resource group: $ref: ./examples/DnsResolver_ListByResourceGroup.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Dnsresolvers /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: '#/parameters/TopParameter' responses: '200': description: List of DNS resolvers in the subscription. schema: $ref: '#/definitions/DnsResolverListResult' 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 DNS resolvers by subscription: $ref: ./examples/DnsResolver_ListBySubscription.json summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network Dnsresolvers ? /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: '#/parameters/VirtualNetworkNameParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/TopParameter' responses: '200': description: List of DNS resolver resource IDs linked to the virtual network. schema: $ref: '#/definitions/SubResourceListResult' 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 DNS resolvers by virtual network: $ref: ./examples/DnsResolver_ListByVirtualNetwork.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualnetworks Virtualnetworkname Listdnsresolvers definitions: ResourceGuid: type: string description: The Guid property of the resource. 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: '#/definitions/SubResource' nextLink: description: The continuation token for the next page of results. type: string readOnly: 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: '#/definitions/DnsResolver' nextLink: description: The continuation token for the next page of results. type: string readOnly: true CloudError: description: An error message type: object properties: error: description: The error message body $ref: '#/definitions/CloudErrorBody' x-ms-external: true SubResource: description: Reference to another ARM resource. type: object properties: id: type: string description: Resource ID. x-ms-azure-resource: true 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 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: '#/definitions/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: '#/definitions/ProvisioningState' resourceGuid: description: The resourceGuid property of the DNS resolver resource. readOnly: true $ref: '#/definitions/ResourceGuid' 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: '#/definitions/CloudErrorBody' x-ms-identifiers: [] 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. 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: '#/definitions/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 parameters: IfNoneMatchParameter: name: If-None-Match in: header required: false type: string 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 IfMatchParameter: name: If-Match in: header required: false type: string 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 DnsResolverNameParameter: name: dnsResolverName in: path required: true type: string description: The name of the DNS resolver. x-ms-parameter-location: method VirtualNetworkNameParameter: name: virtualNetworkName in: path required: true type: string description: The name of the virtual network. x-ms-parameter-location: method TopParameter: name: $top in: query required: false type: integer format: int32 description: The maximum number of results to return. If not specified, returns up to 100 results. x-ms-parameter-location: method x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'