{ "swagger": "2.0", "info": { "title": "DnsResolverManagementClient", "description": "The DNS Resolver Management Client.", "version": "2022-07-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}": { "put": { "tags": [ "DnsResolvers" ], "operationId": "DnsResolvers_CreateOrUpdate", "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": { "201": { "description": "The DNS resolver has been created.", "schema": { "$ref": "#/definitions/DnsResolver" } }, "200": { "description": "The DNS resolver has been updated.", "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" } } }, "patch": { "tags": [ "DnsResolvers" ], "operationId": "DnsResolvers_Update", "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" } } }, "delete": { "tags": [ "DnsResolvers" ], "operationId": "DnsResolvers_Delete", "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" } } }, "get": { "tags": [ "DnsResolvers" ], "operationId": "DnsResolvers_Get", "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" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers": { "get": { "tags": [ "DnsResolvers" ], "operationId": "DnsResolvers_ListByResourceGroup", "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" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/dnsResolvers": { "get": { "tags": [ "DnsResolvers" ], "operationId": "DnsResolvers_List", "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" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/inboundEndpoints/{inboundEndpointName}": { "put": { "tags": [ "InboundEndpoints" ], "operationId": "InboundEndpoints_CreateOrUpdate", "description": "Creates or updates an inbound endpoint for 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": "#/parameters/InboundEndpointNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InboundEndpoint" }, "description": "Parameters supplied to the CreateOrUpdate operation." }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/IfMatchParameter" }, { "$ref": "#/parameters/IfNoneMatchParameter" } ], "responses": { "201": { "description": "The inbound endpoint for the DNS resolver has been created.", "schema": { "$ref": "#/definitions/InboundEndpoint" } }, "200": { "description": "The inbound endpoint for the DNS resolver has been updated.", "schema": { "$ref": "#/definitions/InboundEndpoint" } }, "202": { "description": "The operation to upsert inbound endpoint for the 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 inbound endpoint for DNS resolver": { "$ref": "./examples/InboundEndpoint_Put.json" } } }, "patch": { "tags": [ "InboundEndpoints" ], "operationId": "InboundEndpoints_Update", "description": "Updates an inbound endpoint for 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": "#/parameters/InboundEndpointNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InboundEndpointPatch" }, "description": "Parameters supplied to the Update operation." }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/IfMatchParameter" } ], "responses": { "200": { "description": "The inbound endpoint for the DNS resolver has been updated.", "schema": { "$ref": "#/definitions/InboundEndpoint" } }, "202": { "description": "The operation to update inbound endpoint for the 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 inbound endpoint for DNS resolver": { "$ref": "./examples/InboundEndpoint_Patch.json" } } }, "delete": { "tags": [ "InboundEndpoints" ], "operationId": "InboundEndpoints_Delete", "description": "Deletes an inbound endpoint for 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": "#/parameters/InboundEndpointNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/IfMatchParameter" } ], "responses": { "200": { "description": "The inbound endpoint for the DNS resolver has been deleted." }, "202": { "description": "The operation to delete inbound endpoint for the DNS resolver has been accepted and will complete asynchronously." }, "204": { "description": "The inbound endpoint for 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 inbound endpoint for DNS resolver": { "$ref": "./examples/InboundEndpoint_Delete.json" } } }, "get": { "tags": [ "InboundEndpoints" ], "operationId": "InboundEndpoints_Get", "description": "Gets properties of an inbound endpoint for 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": "#/parameters/InboundEndpointNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "The inbound endpoint for the DNS resolver was found.", "schema": { "$ref": "#/definitions/InboundEndpoint" } }, "default": { "description": "Default response. It will be deserialized as per the Error definition.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Retrieve inbound endpoint for DNS resolver": { "$ref": "./examples/InboundEndpoint_Get.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/inboundEndpoints": { "get": { "tags": [ "InboundEndpoints" ], "operationId": "InboundEndpoints_List", "description": "Lists inbound endpoints for 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" }, { "$ref": "#/parameters/TopParameter" } ], "responses": { "200": { "description": "List of inbound endpoints for the DNS resolver.", "schema": { "$ref": "#/definitions/InboundEndpointListResult" } }, "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 inbound endpoints by DNS resolver": { "$ref": "./examples/InboundEndpoint_List.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/outboundEndpoints/{outboundEndpointName}": { "put": { "tags": [ "OutboundEndpoints" ], "operationId": "OutboundEndpoints_CreateOrUpdate", "description": "Creates or updates an outbound endpoint for 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": "#/parameters/OutboundEndpointNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OutboundEndpoint" }, "description": "Parameters supplied to the CreateOrUpdate operation." }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/IfMatchParameter" }, { "$ref": "#/parameters/IfNoneMatchParameter" } ], "responses": { "201": { "description": "The outbound endpoint for the DNS resolver has been created.", "schema": { "$ref": "#/definitions/OutboundEndpoint" } }, "200": { "description": "The outbound endpoint for the DNS resolver has been updated.", "schema": { "$ref": "#/definitions/OutboundEndpoint" } }, "202": { "description": "The operation to upsert outbound endpoint for the 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 outbound endpoint for DNS resolver": { "$ref": "./examples/OutboundEndpoint_Put.json" } } }, "patch": { "tags": [ "OutboundEndpoints" ], "operationId": "OutboundEndpoints_Update", "description": "Updates an outbound endpoint for 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": "#/parameters/OutboundEndpointNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OutboundEndpointPatch" }, "description": "Parameters supplied to the Update operation." }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/IfMatchParameter" } ], "responses": { "200": { "description": "The outbound endpoint for the DNS resolver has been updated.", "schema": { "$ref": "#/definitions/OutboundEndpoint" } }, "202": { "description": "The operation to update outbound endpoint for the 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 outbound endpoint for DNS resolver": { "$ref": "./examples/OutboundEndpoint_Patch.json" } } }, "delete": { "tags": [ "OutboundEndpoints" ], "operationId": "OutboundEndpoints_Delete", "description": "Deletes an outbound endpoint for 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": "#/parameters/OutboundEndpointNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/IfMatchParameter" } ], "responses": { "200": { "description": "The outbound endpoint for the DNS resolver has been deleted." }, "202": { "description": "The operation to delete outbound endpoint for the DNS resolver has been accepted and will complete asynchronously." }, "204": { "description": "The outbound endpoint for 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 outbound endpoint for DNS resolver": { "$ref": "./examples/OutboundEndpoint_Delete.json" } } }, "get": { "tags": [ "OutboundEndpoints" ], "operationId": "OutboundEndpoints_Get", "description": "Gets properties of an outbound endpoint for 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": "#/parameters/OutboundEndpointNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "The outbound endpoint for the DNS resolver was found.", "schema": { "$ref": "#/definitions/OutboundEndpoint" } }, "default": { "description": "Default response. It will be deserialized as per the Error definition.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Retrieve outbound endpoint for DNS resolver": { "$ref": "./examples/OutboundEndpoint_Get.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/outboundEndpoints": { "get": { "tags": [ "OutboundEndpoints" ], "operationId": "OutboundEndpoints_List", "description": "Lists outbound endpoints for 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" }, { "$ref": "#/parameters/TopParameter" } ], "responses": { "200": { "description": "List of outbound endpoints for the DNS resolver.", "schema": { "$ref": "#/definitions/OutboundEndpointListResult" } }, "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 outbound endpoints by DNS resolver": { "$ref": "./examples/OutboundEndpoint_List.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}": { "put": { "tags": [ "DnsForwardingRulesets" ], "operationId": "DnsForwardingRulesets_CreateOrUpdate", "description": "Creates or updates a DNS forwarding ruleset.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DnsForwardingRulesetNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DnsForwardingRuleset" }, "description": "Parameters supplied to the CreateOrUpdate operation." }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/IfMatchParameter" }, { "$ref": "#/parameters/IfNoneMatchParameter" } ], "responses": { "201": { "description": "The DNS forwarding ruleset has been created.", "schema": { "$ref": "#/definitions/DnsForwardingRuleset" } }, "200": { "description": "The DNS forwarding ruleset has been updated.", "schema": { "$ref": "#/definitions/DnsForwardingRuleset" } }, "202": { "description": "The operation to upsert DNS forwarding ruleset 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 forwarding ruleset": { "$ref": "./examples/DnsForwardingRuleset_Put.json" } } }, "patch": { "tags": [ "DnsForwardingRulesets" ], "operationId": "DnsForwardingRulesets_Update", "description": "Updates a DNS forwarding ruleset.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DnsForwardingRulesetNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DnsForwardingRulesetPatch" }, "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 forwarding ruleset has been updated.", "schema": { "$ref": "#/definitions/DnsForwardingRuleset" } }, "202": { "description": "The operation to update DNS forwarding ruleset 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 forwarding ruleset": { "$ref": "./examples/DnsForwardingRuleset_Patch.json" } } }, "delete": { "tags": [ "DnsForwardingRulesets" ], "operationId": "DnsForwardingRulesets_Delete", "description": "Deletes a DNS forwarding ruleset. WARNING: This operation cannot be undone. All forwarding rules within the ruleset will be deleted.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DnsForwardingRulesetNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/IfMatchParameter" } ], "responses": { "200": { "description": "The DNS forwarding ruleset has been deleted." }, "202": { "description": "The operation to delete DNS forwarding ruleset has been accepted and will complete asynchronously." }, "204": { "description": "The DNS forwarding ruleset 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 forwarding ruleset": { "$ref": "./examples/DnsForwardingRuleset_Delete.json" } } }, "get": { "tags": [ "DnsForwardingRulesets" ], "operationId": "DnsForwardingRulesets_Get", "description": "Gets a DNS forwarding ruleset properties.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DnsForwardingRulesetNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "The DNS forwarding ruleset was found.", "schema": { "$ref": "#/definitions/DnsForwardingRuleset" } }, "default": { "description": "Default response. It will be deserialized as per the Error definition.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Retrieve DNS forwarding ruleset": { "$ref": "./examples/DnsForwardingRuleset_Get.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets": { "get": { "tags": [ "DnsForwardingRulesets" ], "operationId": "DnsForwardingRulesets_ListByResourceGroup", "description": "Lists DNS forwarding rulesets 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 forwarding rulesets in the resource group.", "schema": { "$ref": "#/definitions/DnsForwardingRulesetListResult" } }, "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 forwarding rulesets by resource group": { "$ref": "./examples/DnsForwardingRuleset_ListByResourceGroup.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/dnsForwardingRulesets": { "get": { "tags": [ "DnsForwardingRulesets" ], "operationId": "DnsForwardingRulesets_List", "description": "Lists DNS forwarding rulesets 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 forwarding rulesets in the subscription.", "schema": { "$ref": "#/definitions/DnsForwardingRulesetListResult" } }, "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 forwarding rulesets by subscription": { "$ref": "./examples/DnsForwardingRuleset_ListBySubscription.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/forwardingRules/{forwardingRuleName}": { "put": { "tags": [ "ForwardingRules" ], "operationId": "ForwardingRules_CreateOrUpdate", "description": "Creates or updates a forwarding rule in a DNS forwarding ruleset.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DnsForwardingRulesetNameParameter" }, { "$ref": "#/parameters/ForwardingRuleNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ForwardingRule" }, "description": "Parameters supplied to the CreateOrUpdate operation." }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/IfMatchParameter" }, { "$ref": "#/parameters/IfNoneMatchParameter" } ], "responses": { "201": { "description": "The forwarding rule has been created.", "schema": { "$ref": "#/definitions/ForwardingRule" } }, "200": { "description": "The forwarding rule has been updated.", "schema": { "$ref": "#/definitions/ForwardingRule" } }, "default": { "description": "Default response. It will be deserialized as per the Error definition.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Upsert forwarding rule in a DNS forwarding ruleset": { "$ref": "./examples/ForwardingRule_Put.json" } } }, "patch": { "tags": [ "ForwardingRules" ], "operationId": "ForwardingRules_Update", "description": "Updates a forwarding rule in a DNS forwarding ruleset.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DnsForwardingRulesetNameParameter" }, { "$ref": "#/parameters/ForwardingRuleNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ForwardingRulePatch" }, "description": "Parameters supplied to the Update operation." }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/IfMatchParameter" } ], "responses": { "200": { "description": "The forwarding rule has been updated.", "schema": { "$ref": "#/definitions/ForwardingRule" } }, "default": { "description": "Default response. It will be deserialized as per the Error definition.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Update forwarding rule in a DNS forwarding ruleset": { "$ref": "./examples/ForwardingRule_Patch.json" } } }, "delete": { "tags": [ "ForwardingRules" ], "operationId": "ForwardingRules_Delete", "description": "Deletes a forwarding rule in a DNS forwarding ruleset. 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/DnsForwardingRulesetNameParameter" }, { "$ref": "#/parameters/ForwardingRuleNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/IfMatchParameter" } ], "responses": { "200": { "description": "The forwarding rule has been deleted." }, "204": { "description": "The forwarding rule was not found." }, "default": { "description": "Default response. It will be deserialized as per the Error definition.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Delete forwarding rule in a DNS forwarding ruleset": { "$ref": "./examples/ForwardingRule_Delete.json" } } }, "get": { "tags": [ "ForwardingRules" ], "operationId": "ForwardingRules_Get", "description": "Gets properties of a forwarding rule in a DNS forwarding ruleset.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DnsForwardingRulesetNameParameter" }, { "$ref": "#/parameters/ForwardingRuleNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "The forwarding rule was found.", "schema": { "$ref": "#/definitions/ForwardingRule" } }, "default": { "description": "Default response. It will be deserialized as per the Error definition.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Retrieve forwarding rule in a DNS forwarding ruleset": { "$ref": "./examples/ForwardingRule_Get.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/forwardingRules": { "get": { "tags": [ "ForwardingRules" ], "operationId": "ForwardingRules_List", "description": "Lists forwarding rules in a DNS forwarding ruleset.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DnsForwardingRulesetNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/TopParameter" } ], "responses": { "200": { "description": "List of forwarding rules in the DNS forwarding ruleset.", "schema": { "$ref": "#/definitions/ForwardingRuleListResult" } }, "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 forwarding rules in a DNS forwarding ruleset": { "$ref": "./examples/ForwardingRule_List.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/virtualNetworkLinks/{virtualNetworkLinkName}": { "put": { "tags": [ "VirtualNetworkLinks" ], "operationId": "VirtualNetworkLinks_CreateOrUpdate", "description": "Creates or updates a virtual network link to a DNS forwarding ruleset.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DnsForwardingRulesetNameParameter" }, { "$ref": "#/parameters/VirtualNetworkLinkNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VirtualNetworkLink" }, "description": "Parameters supplied to the CreateOrUpdate operation." }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/IfMatchParameter" }, { "$ref": "#/parameters/IfNoneMatchParameter" } ], "responses": { "201": { "description": "The virtual network link to the DNS forwarding ruleset has been created.", "schema": { "$ref": "#/definitions/VirtualNetworkLink" } }, "200": { "description": "The virtual network link to the DNS forwarding ruleset has been updated.", "schema": { "$ref": "#/definitions/VirtualNetworkLink" } }, "202": { "description": "The operation to upsert virtual network link to the DNS forwarding ruleset 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 virtual network link to a DNS forwarding ruleset": { "$ref": "./examples/VirtualNetworkLink_Put.json" } } }, "patch": { "tags": [ "VirtualNetworkLinks" ], "operationId": "VirtualNetworkLinks_Update", "description": "Updates a virtual network link to a DNS forwarding ruleset.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DnsForwardingRulesetNameParameter" }, { "$ref": "#/parameters/VirtualNetworkLinkNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VirtualNetworkLinkPatch" }, "description": "Parameters supplied to the Update operation." }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/IfMatchParameter" } ], "responses": { "200": { "description": "The virtual network link to the DNS forwarding ruleset has been updated.", "schema": { "$ref": "#/definitions/VirtualNetworkLink" } }, "202": { "description": "The operation to update virtual network link to the DNS forwarding ruleset 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 virtual network link to a DNS forwarding ruleset": { "$ref": "./examples/VirtualNetworkLink_Patch.json" } } }, "delete": { "tags": [ "VirtualNetworkLinks" ], "operationId": "VirtualNetworkLinks_Delete", "description": "Deletes a virtual network link to a DNS forwarding ruleset. 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/DnsForwardingRulesetNameParameter" }, { "$ref": "#/parameters/VirtualNetworkLinkNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/IfMatchParameter" } ], "responses": { "200": { "description": "The virtual network link to the DNS forwarding ruleset has been deleted." }, "202": { "description": "The operation to delete virtual network link to the DNS forwarding ruleset has been accepted and will complete asynchronously." }, "204": { "description": "The virtual network link to the DNS forwarding ruleset 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 virtual network link to a DNS forwarding ruleset": { "$ref": "./examples/VirtualNetworkLink_Delete.json" } } }, "get": { "tags": [ "VirtualNetworkLinks" ], "operationId": "VirtualNetworkLinks_Get", "description": "Gets properties of a virtual network link to a DNS forwarding ruleset.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DnsForwardingRulesetNameParameter" }, { "$ref": "#/parameters/VirtualNetworkLinkNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "The virtual network link to DNS forwarding ruleset was found.", "schema": { "$ref": "#/definitions/VirtualNetworkLink" } }, "default": { "description": "Default response. It will be deserialized as per the Error definition.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Retrieve virtual network link to a DNS forwarding ruleset": { "$ref": "./examples/VirtualNetworkLink_Get.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/virtualNetworkLinks": { "get": { "tags": [ "VirtualNetworkLinks" ], "operationId": "VirtualNetworkLinks_List", "description": "Lists virtual network links to a DNS forwarding ruleset.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DnsForwardingRulesetNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/TopParameter" } ], "responses": { "200": { "description": "List of virtual network links to a DNS forwarding ruleset.", "schema": { "$ref": "#/definitions/VirtualNetworkLinkListResult" } }, "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 virtual network links to a DNS forwarding ruleset": { "$ref": "./examples/VirtualNetworkLink_List.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/listDnsResolvers": { "post": { "tags": [ "DnsResolvers" ], "operationId": "DnsResolvers_ListByVirtualNetwork", "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" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/listDnsForwardingRulesets": { "post": { "tags": [ "DnsForwardingRulesets" ], "operationId": "DnsForwardingRulesets_ListByVirtualNetwork", "description": "Lists DNS forwarding ruleset resource IDs attached 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 forwarding ruleset resource IDs and virtual network link resource IDs attached to the virtual network.", "schema": { "$ref": "#/definitions/VirtualNetworkDnsForwardingRulesetListResult" } }, "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 forwarding rulesets by virtual network": { "$ref": "./examples/DnsForwardingRuleset_ListByVirtualNetwork.json" } } } } }, "definitions": { "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" } } }, "DnsResolver": { "description": "Describes a DNS resolver.", "type": "object", "required": [ "properties" ], "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" } ] }, "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." } } }, "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 } } }, "InboundEndpointProperties": { "description": "Represents the properties of an inbound endpoint for a DNS resolver.", "type": "object", "required": [ "ipConfigurations" ], "properties": { "ipConfigurations": { "description": "IP configurations for the inbound endpoint.", "type": "array", "items": { "$ref": "#/definitions/IpConfiguration" }, "x-ms-identifiers": [] }, "provisioningState": { "description": "The current provisioning state of the inbound endpoint. 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 inbound endpoint resource.", "readOnly": true, "$ref": "#/definitions/ResourceGuid" } } }, "InboundEndpoint": { "description": "Describes an inbound endpoint for a DNS resolver.", "type": "object", "required": [ "properties" ], "properties": { "etag": { "description": "ETag of the inbound endpoint.", "type": "string", "readOnly": true }, "properties": { "description": "Properties of the inbound endpoint.", "$ref": "#/definitions/InboundEndpointProperties", "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" } ] }, "InboundEndpointPatch": { "description": "Describes an inbound endpoint for a DNS resolver for PATCH operation.", "type": "object", "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string" }, "x-ms-mutability": [ "read", "create", "update" ], "description": "Tags for inbound endpoint." } } }, "InboundEndpointListResult": { "description": "The response to an enumeration operation on inbound endpoints for a DNS resolver.", "type": "object", "properties": { "value": { "description": "Enumeration of the inbound endpoints for a DNS resolver.", "type": "array", "items": { "$ref": "#/definitions/InboundEndpoint" } }, "nextLink": { "description": "The continuation token for the next page of results.", "type": "string", "readOnly": true } } }, "OutboundEndpointProperties": { "description": "Represents the properties of an outbound endpoint for a DNS resolver.", "type": "object", "required": [ "subnet" ], "properties": { "subnet": { "description": "The reference to the subnet used for the outbound endpoint.", "$ref": "#/definitions/SubResource" }, "provisioningState": { "description": "The current provisioning state of the outbound endpoint. This is a read-only property and any attempt to set this value will be ignored.", "$ref": "#/definitions/ProvisioningState", "readOnly": true }, "resourceGuid": { "description": "The resourceGuid property of the outbound endpoint resource.", "readOnly": true, "$ref": "#/definitions/ResourceGuid" } } }, "OutboundEndpoint": { "description": "Describes an outbound endpoint for a DNS resolver.", "type": "object", "required": [ "properties" ], "properties": { "etag": { "description": "ETag of the outbound endpoint.", "type": "string", "readOnly": true }, "properties": { "description": "Properties of the outbound endpoint.", "$ref": "#/definitions/OutboundEndpointProperties", "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" } ] }, "OutboundEndpointPatch": { "description": "Describes an outbound endpoint for a DNS resolver for PATCH operation.", "type": "object", "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string" }, "x-ms-mutability": [ "read", "create", "update" ], "description": "Tags for outbound endpoint." } } }, "OutboundEndpointListResult": { "description": "The response to an enumeration operation on outbound endpoints for a DNS resolver.", "type": "object", "properties": { "value": { "description": "Enumeration of the outbound endpoints for a DNS resolver.", "type": "array", "items": { "$ref": "#/definitions/OutboundEndpoint" } }, "nextLink": { "description": "The continuation token for the next page of results.", "type": "string", "readOnly": true } } }, "DnsForwardingRulesetProperties": { "description": "Represents the properties of a DNS forwarding ruleset.", "type": "object", "required": [ "dnsResolverOutboundEndpoints" ], "properties": { "dnsResolverOutboundEndpoints": { "description": "The reference to the DNS resolver outbound endpoints that are used to route DNS queries matching the forwarding rules in the ruleset to the target DNS servers.", "type": "array", "items": { "$ref": "#/definitions/SubResource" } }, "provisioningState": { "description": "The current provisioning state of the DNS forwarding ruleset. This is a read-only property and any attempt to set this value will be ignored.", "$ref": "#/definitions/ProvisioningState", "readOnly": true }, "resourceGuid": { "description": "The resourceGuid for the DNS forwarding ruleset.", "type": "string", "readOnly": true } } }, "DnsForwardingRuleset": { "description": "Describes a DNS forwarding ruleset.", "type": "object", "required": [ "properties" ], "properties": { "etag": { "description": "ETag of the DNS forwarding ruleset.", "type": "string", "readOnly": true }, "properties": { "description": "Properties of the DNS forwarding ruleset.", "$ref": "#/definitions/DnsForwardingRulesetProperties", "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" } ] }, "DnsForwardingRulesetPatch": { "description": "Describes a DNS forwarding ruleset PATCH operation.", "type": "object", "properties": { "dnsResolverOutboundEndpoints": { "description": "The reference to the DNS resolver outbound endpoints that are used to route DNS queries matching the forwarding rules in the ruleset to the target DNS servers.", "type": "array", "items": { "$ref": "#/definitions/SubResource" } }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "x-ms-mutability": [ "read", "create", "update" ], "description": "Tags for DNS Resolver." } } }, "DnsForwardingRulesetListResult": { "description": "The response to an enumeration operation on DNS forwarding rulesets.", "type": "object", "properties": { "value": { "description": "Enumeration of the DNS forwarding rulesets.", "type": "array", "items": { "$ref": "#/definitions/DnsForwardingRuleset" } }, "nextLink": { "description": "The continuation token for the next page of results.", "type": "string", "readOnly": true } } }, "ForwardingRuleProperties": { "description": "Represents the properties of a forwarding rule within a DNS forwarding ruleset.", "type": "object", "required": [ "domainName", "targetDnsServers" ], "properties": { "domainName": { "description": "The domain name for the forwarding rule.", "type": "string" }, "targetDnsServers": { "description": "DNS servers to forward the DNS query to.", "type": "array", "items": { "$ref": "#/definitions/TargetDnsServer" }, "x-ms-identifiers": [] }, "metadata": { "description": "Metadata attached to the forwarding rule.", "type": "object", "additionalProperties": { "type": "string" } }, "forwardingRuleState": { "type": "string", "description": "The state of forwarding rule.", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "ForwardingRuleState", "modelAsString": true } }, "provisioningState": { "description": "The current provisioning state of the forwarding rule. This is a read-only property and any attempt to set this value will be ignored.", "$ref": "#/definitions/ProvisioningState", "readOnly": true } } }, "ForwardingRule": { "description": "Describes a forwarding rule within a DNS forwarding ruleset.", "type": "object", "required": [ "properties" ], "properties": { "etag": { "description": "ETag of the forwarding rule.", "type": "string", "readOnly": true }, "properties": { "description": "Properties of the forwarding rule.", "$ref": "#/definitions/ForwardingRuleProperties", "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/ProxyResource" } ] }, "ForwardingRulePatchProperties": { "description": "Represents the updatable properties of a forwarding rule within a DNS forwarding ruleset.", "type": "object", "properties": { "targetDnsServers": { "description": "DNS servers to forward the DNS query to.", "type": "array", "items": { "$ref": "#/definitions/TargetDnsServer" }, "x-ms-identifiers": [] }, "metadata": { "description": "Metadata attached to the forwarding rule.", "type": "object", "additionalProperties": { "type": "string" } }, "forwardingRuleState": { "type": "string", "description": "The state of forwarding rule.", "enum": [ "Enabled", "Disabled" ], "default": "Enabled", "x-ms-enum": { "name": "ForwardingRuleState", "modelAsString": true } } } }, "ForwardingRulePatch": { "description": "Describes a forwarding rule for PATCH operation.", "type": "object", "properties": { "properties": { "description": "Updatable properties of the forwarding rule.", "$ref": "#/definitions/ForwardingRulePatchProperties", "x-ms-client-flatten": true } } }, "ForwardingRuleListResult": { "description": "The response to an enumeration operation on forwarding rules within a DNS forwarding ruleset.", "type": "object", "properties": { "value": { "description": "Enumeration of the forwarding rules.", "type": "array", "items": { "$ref": "#/definitions/ForwardingRule" } }, "nextLink": { "description": "The continuation token for the next page of results.", "type": "string", "readOnly": true } } }, "VirtualNetworkLinkProperties": { "description": "Represents the properties of a virtual network link.", "type": "object", "required": [ "virtualNetwork" ], "properties": { "virtualNetwork": { "description": "The reference to the virtual network. This cannot be changed after creation.", "$ref": "#/definitions/SubResource" }, "metadata": { "description": "Metadata attached to the virtual network link.", "type": "object", "additionalProperties": { "type": "string" } }, "provisioningState": { "description": "The current provisioning state of the virtual network link. This is a read-only property and any attempt to set this value will be ignored.", "$ref": "#/definitions/ProvisioningState", "readOnly": true } } }, "VirtualNetworkLink": { "description": "Describes a virtual network link.", "type": "object", "required": [ "properties" ], "properties": { "etag": { "description": "ETag of the virtual network link.", "type": "string", "readOnly": true }, "properties": { "description": "Properties of the virtual network link.", "$ref": "#/definitions/VirtualNetworkLinkProperties", "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/ProxyResource" } ] }, "VirtualNetworkLinkPatchProperties": { "description": "Represents the updatable properties of the virtual network link.", "type": "object", "properties": { "metadata": { "description": "Metadata attached to the virtual network link.", "type": "object", "additionalProperties": { "type": "string" } } } }, "VirtualNetworkLinkPatch": { "description": "Describes a virtual network link for PATCH operation.", "type": "object", "properties": { "properties": { "description": "Updatable properties of the virtual network link.", "$ref": "#/definitions/VirtualNetworkLinkPatchProperties", "x-ms-client-flatten": true } } }, "VirtualNetworkLinkListResult": { "description": "The response to an enumeration operation on virtual network links.", "type": "object", "properties": { "value": { "description": "Enumeration of the virtual network links.", "type": "array", "items": { "$ref": "#/definitions/VirtualNetworkLink" } }, "nextLink": { "description": "The continuation token for the next page of results.", "type": "string", "readOnly": true } } }, "IpConfiguration": { "description": "IP configuration.", "type": "object", "required": [ "subnet" ], "properties": { "subnet": { "description": "The reference to the subnet bound to the IP configuration.", "$ref": "#/definitions/SubResource" }, "privateIpAddress": { "description": "Private IP address of the IP configuration.", "type": "string" }, "privateIpAllocationMethod": { "description": "Private IP address allocation method.", "type": "string", "enum": [ "Static", "Dynamic" ], "default": "Dynamic", "x-ms-enum": { "name": "IpAllocationMethod", "modelAsString": true } } } }, "TargetDnsServer": { "description": "Describes a server to forward the DNS queries to.", "type": "object", "required": [ "ipAddress" ], "properties": { "ipAddress": { "description": "DNS server IP address.", "type": "string" }, "port": { "description": "DNS server port.", "type": "integer", "format": "int32", "default": 53 } } }, "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 } }, "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 } } }, "SubResource": { "description": "Reference to another ARM resource.", "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Resource ID." } }, "x-ms-azure-resource": true }, "VirtualNetworkDnsForwardingRulesetListResult": { "description": "The response to an enumeration operation on Virtual Network DNS Forwarding Ruleset.", "type": "object", "properties": { "value": { "description": "Enumeration of the Virtual Network DNS Forwarding Ruleset.", "type": "array", "items": { "$ref": "#/definitions/VirtualNetworkDnsForwardingRuleset" } }, "nextLink": { "description": "The continuation token for the next page of results.", "type": "string", "readOnly": true } } }, "VirtualNetworkLinkSubResourceProperties": { "description": "The reference to the virtual network link that associates between the DNS forwarding ruleset and virtual network.", "type": "object", "properties": { "virtualNetworkLink": { "description": "The reference to the virtual network link.", "$ref": "#/definitions/SubResource" } } }, "VirtualNetworkDnsForwardingRuleset": { "description": "Reference to DNS forwarding ruleset and associated virtual network link.", "type": "object", "properties": { "id": { "type": "string", "description": "DNS Forwarding Ruleset Resource ID." }, "properties": { "description": "Properties of the virtual network link sub-resource reference.", "$ref": "#/definitions/VirtualNetworkLinkSubResourceProperties", "x-ms-client-flatten": true } } }, "CloudError": { "description": "An error message", "type": "object", "properties": { "error": { "description": "The error message body", "$ref": "#/definitions/CloudErrorBody" } }, "x-ms-external": true }, "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 } }, "parameters": { "DnsResolverNameParameter": { "name": "dnsResolverName", "in": "path", "required": true, "type": "string", "description": "The name of the DNS resolver.", "x-ms-parameter-location": "method" }, "InboundEndpointNameParameter": { "name": "inboundEndpointName", "in": "path", "required": true, "type": "string", "description": "The name of the inbound endpoint for 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" }, "OutboundEndpointNameParameter": { "name": "outboundEndpointName", "in": "path", "required": true, "type": "string", "description": "The name of the outbound endpoint for the DNS resolver.", "x-ms-parameter-location": "method" }, "DnsForwardingRulesetNameParameter": { "name": "dnsForwardingRulesetName", "in": "path", "required": true, "type": "string", "description": "The name of the DNS forwarding ruleset.", "x-ms-parameter-location": "method" }, "ForwardingRuleNameParameter": { "name": "forwardingRuleName", "in": "path", "required": true, "type": "string", "description": "The name of the forwarding rule.", "x-ms-parameter-location": "method" }, "VirtualNetworkLinkNameParameter": { "name": "virtualNetworkLinkName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network link.", "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" }, "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" }, "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" } } }