Microsoft.Network (stable:2025-05-01)

2025/08/28 • 58 new, 58 deleted methods

DnsForwardingRulesets_List (new)
Description :  Lists DNS forwarding rulesets in all resource groups of a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/dnsForwardingRulesets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The DnsForwardingRuleset items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid for the DNS forwarding ruleset. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsResolverDomainLists_List (new)
Description :  Lists DNS resolver domain lists in all resource groups of a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/dnsResolverDomainLists
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The DnsResolverDomainList items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the DNS resolver domain list. ,
Required: False ,
}
{
domains:
{
Description: The domains in the domain list. Will be null if user is using large domain list. ,
Required: False ,
}
[
string ,
]
,
domainsUrl:
{
Description: The URL for bulk upload or download for domain lists containing larger set of domains. This will be populated if domains is empty or null. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the DNS resolver domain list. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver domain list resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsResolverPolicies_List (new)
Description :  Lists DNS resolver policies in all resource groups of a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/dnsResolverPolicies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The DnsResolverPolicy items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the DNS resolver policy. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state of the DNS resolver policy. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver policy resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsResolvers_List (new)
Description :  Lists DNS resolvers in all resource groups of a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/dnsResolvers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The DnsResolver items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the DNS resolver. ,
Required: True ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
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. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsForwardingRulesets_ListByResourceGroup (new)
Description :  Lists DNS forwarding rulesets within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The DnsForwardingRuleset items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid for the DNS forwarding ruleset. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsForwardingRulesets_Get (new)
Description :  Gets a DNS forwarding ruleset properties.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsForwardingRulesetName:
{
Description: The name of the DNS forwarding ruleset. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid for the DNS forwarding ruleset. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsForwardingRulesets_CreateOrUpdate (new)
Description :  Creates or updates a DNS forwarding ruleset.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsForwardingRulesetName:
{
Description: The name of the DNS forwarding ruleset. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
if-none-match:
{
Description: Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid for the DNS forwarding ruleset. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid for the DNS forwarding ruleset. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Describes a DNS forwarding ruleset. ,
}
{
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid for the DNS forwarding ruleset. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsForwardingRulesets_Update (new)
Description :  Updates a DNS forwarding ruleset.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsForwardingRulesetName:
{
Description: The name of the DNS forwarding ruleset. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
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. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
tags:
{
Description: Tags for DNS Resolver. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid for the DNS forwarding ruleset. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsForwardingRulesets_Delete (new)
Description :  Deletes a DNS forwarding ruleset. WARNING: This operation cannot be undone. All forwarding rules within the ruleset will be deleted.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsForwardingRulesetName:
{
Description: The name of the DNS forwarding ruleset. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
ForwardingRules_List (new)
Description :  Lists forwarding rules in a DNS forwarding ruleset.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/forwardingRules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsForwardingRulesetName:
{
Description: The name of the DNS forwarding ruleset. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The ForwardingRule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the forwarding rule. ,
Required: True ,
}
{
domainName:
{
Description: The domain name for the forwarding rule. ,
Required: True ,
}
string ,
targetDnsServers:
{
Description: DNS servers to forward the DNS query to. ,
Required: True ,
}
[
{
ipAddress:
{
Description: DNS server IP address. ,
Required: True ,
}
string ,
port:
{
Description: DNS server port. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
metadata:
{
Description: Metadata attached to the forwarding rule. ,
Required: False ,
}
object ,
forwardingRuleState:
{
Description: The state of forwarding rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
ForwardingRules_Get (new)
Description :  Gets properties of a forwarding rule in a DNS forwarding ruleset.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/forwardingRules/{forwardingRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsForwardingRulesetName:
{
Description: The name of the DNS forwarding ruleset. ,
Required: True ,
}
string ,
forwardingRuleName:
{
Description: The name of the forwarding rule. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the forwarding rule. ,
Required: True ,
}
{
domainName:
{
Description: The domain name for the forwarding rule. ,
Required: True ,
}
string ,
targetDnsServers:
{
Description: DNS servers to forward the DNS query to. ,
Required: True ,
}
[
{
ipAddress:
{
Description: DNS server IP address. ,
Required: True ,
}
string ,
port:
{
Description: DNS server port. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
metadata:
{
Description: Metadata attached to the forwarding rule. ,
Required: False ,
}
object ,
forwardingRuleState:
{
Description: The state of forwarding rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
ForwardingRules_CreateOrUpdate (new)
Description :  Creates or updates a forwarding rule in a DNS forwarding ruleset.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/forwardingRules/{forwardingRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsForwardingRulesetName:
{
Description: The name of the DNS forwarding ruleset. ,
Required: True ,
}
string ,
forwardingRuleName:
{
Description: The name of the forwarding rule. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
if-none-match:
{
Description: Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the forwarding rule. ,
Required: True ,
}
{
domainName:
{
Description: The domain name for the forwarding rule. ,
Required: True ,
}
string ,
targetDnsServers:
{
Description: DNS servers to forward the DNS query to. ,
Required: True ,
}
[
{
ipAddress:
{
Description: DNS server IP address. ,
Required: True ,
}
string ,
port:
{
Description: DNS server port. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
metadata:
{
Description: Metadata attached to the forwarding rule. ,
Required: False ,
}
object ,
forwardingRuleState:
{
Description: The state of forwarding rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the forwarding rule. ,
Required: True ,
}
{
domainName:
{
Description: The domain name for the forwarding rule. ,
Required: True ,
}
string ,
targetDnsServers:
{
Description: DNS servers to forward the DNS query to. ,
Required: True ,
}
[
{
ipAddress:
{
Description: DNS server IP address. ,
Required: True ,
}
string ,
port:
{
Description: DNS server port. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
metadata:
{
Description: Metadata attached to the forwarding rule. ,
Required: False ,
}
object ,
forwardingRuleState:
{
Description: The state of forwarding rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the forwarding rule. ,
Required: True ,
}
{
domainName:
{
Description: The domain name for the forwarding rule. ,
Required: True ,
}
string ,
targetDnsServers:
{
Description: DNS servers to forward the DNS query to. ,
Required: True ,
}
[
{
ipAddress:
{
Description: DNS server IP address. ,
Required: True ,
}
string ,
port:
{
Description: DNS server port. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
metadata:
{
Description: Metadata attached to the forwarding rule. ,
Required: False ,
}
object ,
forwardingRuleState:
{
Description: The state of forwarding rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
ForwardingRules_Update (new)
Description :  Updates a forwarding rule in a DNS forwarding ruleset.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/forwardingRules/{forwardingRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsForwardingRulesetName:
{
Description: The name of the DNS forwarding ruleset. ,
Required: True ,
}
string ,
forwardingRuleName:
{
Description: The name of the forwarding rule. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
properties:
{
Description: Updatable properties of the forwarding rule. ,
Required: False ,
}
{
targetDnsServers:
{
Description: DNS servers to forward the DNS query to. ,
Required: False ,
}
[
{
ipAddress:
{
Description: DNS server IP address. ,
Required: True ,
}
string ,
port:
{
Description: DNS server port. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
metadata:
{
Description: Metadata attached to the forwarding rule. ,
Required: False ,
}
object ,
forwardingRuleState:
{
Description: The state of forwarding rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the forwarding rule. ,
Required: True ,
}
{
domainName:
{
Description: The domain name for the forwarding rule. ,
Required: True ,
}
string ,
targetDnsServers:
{
Description: DNS servers to forward the DNS query to. ,
Required: True ,
}
[
{
ipAddress:
{
Description: DNS server IP address. ,
Required: True ,
}
string ,
port:
{
Description: DNS server port. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
metadata:
{
Description: Metadata attached to the forwarding rule. ,
Required: False ,
}
object ,
forwardingRuleState:
{
Description: The state of forwarding rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
ForwardingRules_Delete (new)
Description :  Deletes a forwarding rule in a DNS forwarding ruleset. WARNING: This operation cannot be undone.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/forwardingRules/{forwardingRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsForwardingRulesetName:
{
Description: The name of the DNS forwarding ruleset. ,
Required: True ,
}
string ,
forwardingRuleName:
{
Description: The name of the forwarding rule. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsResolverDomainLists_ListByResourceGroup (new)
Description :  Lists DNS resolver domain lists within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverDomainLists
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The DnsResolverDomainList items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the DNS resolver domain list. ,
Required: False ,
}
{
domains:
{
Description: The domains in the domain list. Will be null if user is using large domain list. ,
Required: False ,
}
[
string ,
]
,
domainsUrl:
{
Description: The URL for bulk upload or download for domain lists containing larger set of domains. This will be populated if domains is empty or null. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the DNS resolver domain list. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver domain list resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsResolverDomainLists_Get (new)
Description :  Gets properties of a DNS resolver domain list.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverDomainLists/{dnsResolverDomainListName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverDomainListName:
{
Description: The name of the DNS resolver domain list. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS resolver domain list. ,
Required: False ,
}
{
domains:
{
Description: The domains in the domain list. Will be null if user is using large domain list. ,
Required: False ,
}
[
string ,
]
,
domainsUrl:
{
Description: The URL for bulk upload or download for domain lists containing larger set of domains. This will be populated if domains is empty or null. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the DNS resolver domain list. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver domain list resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsResolverDomainLists_CreateOrUpdate (new)
Description :  Creates or updates a DNS resolver domain list.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverDomainLists/{dnsResolverDomainListName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverDomainListName:
{
Description: The name of the DNS resolver domain list. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
if-none-match:
{
Description: Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the DNS resolver domain list. ,
Required: False ,
}
{
domains:
{
Description: The domains in the domain list. Will be null if user is using large domain list. ,
Required: False ,
}
[
string ,
]
,
domainsUrl:
{
Description: The URL for bulk upload or download for domain lists containing larger set of domains. This will be populated if domains is empty or null. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the DNS resolver domain list. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver domain list resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS resolver domain list. ,
Required: False ,
}
{
domains:
{
Description: The domains in the domain list. Will be null if user is using large domain list. ,
Required: False ,
}
[
string ,
]
,
domainsUrl:
{
Description: The URL for bulk upload or download for domain lists containing larger set of domains. This will be populated if domains is empty or null. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the DNS resolver domain list. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver domain list resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Describes a DNS resolver domain list. ,
}
{
properties:
{
Description: Properties of the DNS resolver domain list. ,
Required: False ,
}
{
domains:
{
Description: The domains in the domain list. Will be null if user is using large domain list. ,
Required: False ,
}
[
string ,
]
,
domainsUrl:
{
Description: The URL for bulk upload or download for domain lists containing larger set of domains. This will be populated if domains is empty or null. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the DNS resolver domain list. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver domain list resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsResolverDomainLists_Update (new)
Description :  Updates a DNS resolver domain list.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverDomainLists/{dnsResolverDomainListName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverDomainListName:
{
Description: The name of the DNS resolver domain list. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
properties:
{
Description: Updatable properties of the DNS resolver domain list. ,
Required: False ,
}
{
domains:
{
Description: The domains in the domain list. ,
Required: False ,
}
[
string ,
]
,
}
,
tags:
{
Description: Tags for DNS resolver domain list. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS resolver domain list. ,
Required: False ,
}
{
domains:
{
Description: The domains in the domain list. Will be null if user is using large domain list. ,
Required: False ,
}
[
string ,
]
,
domainsUrl:
{
Description: The URL for bulk upload or download for domain lists containing larger set of domains. This will be populated if domains is empty or null. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the DNS resolver domain list. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver domain list resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsResolverDomainLists_Delete (new)
Description :  Deletes a DNS resolver domain list. WARNING: This operation cannot be undone.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverDomainLists/{dnsResolverDomainListName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverDomainListName:
{
Description: The name of the DNS resolver domain list. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsResolverDomainLists_Bulk (new)
Description :  Uploads or downloads the list of domains for a DNS Resolver Domain List from a storage link.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverDomainLists/{dnsResolverDomainListName}/bulk
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverDomainListName:
{
Description: The name of the DNS resolver domain list. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
if-none-match:
{
Description: Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the bulk domain list operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the DNS resolver domain list upload or download request. ,
Required: True ,
}
{
storageUrl:
{
Description: The storage account blob file URL to be used in the bulk upload or download request of DNS resolver domain list. ,
Required: True ,
}
string ,
action:
{
Description: The action to take in the request, Upload or Download. ,
Enum:
{
Upload: No description available. ,
Download: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS resolver domain list. ,
Required: False ,
}
{
domains:
{
Description: The domains in the domain list. Will be null if user is using large domain list. ,
Required: False ,
}
[
string ,
]
,
domainsUrl:
{
Description: The URL for bulk upload or download for domain lists containing larger set of domains. This will be populated if domains is empty or null. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the DNS resolver domain list. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver domain list resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsResolverPolicies_ListByResourceGroup (new)
Description :  Lists DNS resolver policies within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The DnsResolverPolicy items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the DNS resolver policy. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state of the DNS resolver policy. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver policy resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsResolverPolicies_Get (new)
Description :  Gets properties of a DNS resolver policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverPolicyName:
{
Description: The name of the DNS resolver policy. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS resolver policy. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state of the DNS resolver policy. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver policy resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsResolverPolicies_CreateOrUpdate (new)
Description :  Creates or updates a DNS resolver policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverPolicyName:
{
Description: The name of the DNS resolver policy. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
if-none-match:
{
Description: Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the DNS resolver policy. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state of the DNS resolver policy. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver policy resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS resolver policy. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state of the DNS resolver policy. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver policy resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Describes a DNS resolver policy. ,
}
{
properties:
{
Description: Properties of the DNS resolver policy. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state of the DNS resolver policy. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver policy resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsResolverPolicies_Update (new)
Description :  Updates a DNS resolver policy.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverPolicyName:
{
Description: The name of the DNS resolver policy. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
tags:
{
Description: Tags for DNS resolver policy. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS resolver policy. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state of the DNS resolver policy. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver policy resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsResolverPolicies_Delete (new)
Description :  Deletes a DNS resolver policy. WARNING: This operation cannot be undone.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverPolicyName:
{
Description: The name of the DNS resolver policy. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsSecurityRules_List (new)
Description :  Lists DNS security rules for a DNS resolver policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}/dnsSecurityRules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverPolicyName:
{
Description: The name of the DNS resolver policy. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The DnsSecurityRule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the DNS security rule. ,
Required: True ,
}
{
priority:
{
Description: The priority of the DNS security rule. ,
Format: int32 ,
Required: True ,
}
integer ,
action:
{
Description: The action to take on DNS requests that match the DNS security rule. ,
Required: True ,
}
{
actionType:
{
Description: The type of action to take. ,
Enum:
{
Allow: No description available. ,
Alert: No description available. ,
Block: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dnsResolverDomainLists:
{
Description: DNS resolver policy domains lists that the DNS security rule applies to. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
dnsSecurityRuleState:
{
Description: The state of DNS security rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current provisioning state of the DNS security rule. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsSecurityRules_Get (new)
Description :  Gets properties of a DNS security rule for a DNS resolver policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}/dnsSecurityRules/{dnsSecurityRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverPolicyName:
{
Description: The name of the DNS resolver policy. ,
Required: True ,
}
string ,
dnsSecurityRuleName:
{
Description: The name of the DNS security rule. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS security rule. ,
Required: True ,
}
{
priority:
{
Description: The priority of the DNS security rule. ,
Format: int32 ,
Required: True ,
}
integer ,
action:
{
Description: The action to take on DNS requests that match the DNS security rule. ,
Required: True ,
}
{
actionType:
{
Description: The type of action to take. ,
Enum:
{
Allow: No description available. ,
Alert: No description available. ,
Block: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dnsResolverDomainLists:
{
Description: DNS resolver policy domains lists that the DNS security rule applies to. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
dnsSecurityRuleState:
{
Description: The state of DNS security rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current provisioning state of the DNS security rule. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsSecurityRules_CreateOrUpdate (new)
Description :  Creates or updates a DNS security rule for a DNS resolver policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}/dnsSecurityRules/{dnsSecurityRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverPolicyName:
{
Description: The name of the DNS resolver policy. ,
Required: True ,
}
string ,
dnsSecurityRuleName:
{
Description: The name of the DNS security rule. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
if-none-match:
{
Description: Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the DNS security rule. ,
Required: True ,
}
{
priority:
{
Description: The priority of the DNS security rule. ,
Format: int32 ,
Required: True ,
}
integer ,
action:
{
Description: The action to take on DNS requests that match the DNS security rule. ,
Required: True ,
}
{
actionType:
{
Description: The type of action to take. ,
Enum:
{
Allow: No description available. ,
Alert: No description available. ,
Block: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dnsResolverDomainLists:
{
Description: DNS resolver policy domains lists that the DNS security rule applies to. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
dnsSecurityRuleState:
{
Description: The state of DNS security rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current provisioning state of the DNS security rule. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS security rule. ,
Required: True ,
}
{
priority:
{
Description: The priority of the DNS security rule. ,
Format: int32 ,
Required: True ,
}
integer ,
action:
{
Description: The action to take on DNS requests that match the DNS security rule. ,
Required: True ,
}
{
actionType:
{
Description: The type of action to take. ,
Enum:
{
Allow: No description available. ,
Alert: No description available. ,
Block: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dnsResolverDomainLists:
{
Description: DNS resolver policy domains lists that the DNS security rule applies to. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
dnsSecurityRuleState:
{
Description: The state of DNS security rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current provisioning state of the DNS security rule. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Describes a DNS security rule. ,
}
{
properties:
{
Description: Properties of the DNS security rule. ,
Required: True ,
}
{
priority:
{
Description: The priority of the DNS security rule. ,
Format: int32 ,
Required: True ,
}
integer ,
action:
{
Description: The action to take on DNS requests that match the DNS security rule. ,
Required: True ,
}
{
actionType:
{
Description: The type of action to take. ,
Enum:
{
Allow: No description available. ,
Alert: No description available. ,
Block: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dnsResolverDomainLists:
{
Description: DNS resolver policy domains lists that the DNS security rule applies to. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
dnsSecurityRuleState:
{
Description: The state of DNS security rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current provisioning state of the DNS security rule. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsSecurityRules_Update (new)
Description :  Updates a DNS security rule.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}/dnsSecurityRules/{dnsSecurityRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverPolicyName:
{
Description: The name of the DNS resolver policy. ,
Required: True ,
}
string ,
dnsSecurityRuleName:
{
Description: The name of the DNS security rule. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
properties:
{
Description: Updatable properties of the DNS security rule. ,
Required: False ,
}
{
action:
{
Description: The action to take on DNS requests that match the DNS security rule. ,
Required: False ,
}
{
actionType:
{
Description: The type of action to take. ,
Enum:
{
Allow: No description available. ,
Alert: No description available. ,
Block: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dnsResolverDomainLists:
{
Description: DNS resolver policy domains lists that the DNS security rule applies to. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
dnsSecurityRuleState:
{
Description: The state of DNS security rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: The priority of the DNS security rule. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tags:
{
Description: Tags for DNS security rule. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS security rule. ,
Required: True ,
}
{
priority:
{
Description: The priority of the DNS security rule. ,
Format: int32 ,
Required: True ,
}
integer ,
action:
{
Description: The action to take on DNS requests that match the DNS security rule. ,
Required: True ,
}
{
actionType:
{
Description: The type of action to take. ,
Enum:
{
Allow: No description available. ,
Alert: No description available. ,
Block: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dnsResolverDomainLists:
{
Description: DNS resolver policy domains lists that the DNS security rule applies to. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
dnsSecurityRuleState:
{
Description: The state of DNS security rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current provisioning state of the DNS security rule. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsSecurityRules_Delete (new)
Description :  Deletes a DNS security rule for a DNS resolver policy. WARNING: This operation cannot be undone.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}/dnsSecurityRules/{dnsSecurityRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverPolicyName:
{
Description: The name of the DNS resolver policy. ,
Required: True ,
}
string ,
dnsSecurityRuleName:
{
Description: The name of the DNS security rule. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsResolvers_ListByResourceGroup (new)
Description :  Lists DNS resolvers within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The DnsResolver items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the DNS resolver. ,
Required: True ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
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. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsResolvers_Get (new)
Description :  Gets properties of a DNS resolver.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS resolver. ,
Required: True ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
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. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsResolvers_CreateOrUpdate (new)
Description :  Creates or updates a DNS resolver.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
if-none-match:
{
Description: Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the DNS resolver. ,
Required: True ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
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. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS resolver. ,
Required: True ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
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. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Describes a DNS resolver. ,
}
{
properties:
{
Description: Properties of the DNS resolver. ,
Required: True ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
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. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsResolvers_Update (new)
Description :  Updates a DNS resolver.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
tags:
{
Description: Tags for DNS Resolver. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS resolver. ,
Required: True ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
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. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsResolvers_Delete (new)
Description :  Deletes a DNS resolver. WARNING: This operation cannot be undone.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
InboundEndpoints_List (new)
Description :  Lists inbound endpoints for a DNS resolver.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/inboundEndpoints
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The InboundEndpoint items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the inbound endpoint. ,
Required: True ,
}
{
ipConfigurations:
{
Description: IP configurations for the inbound endpoint. ,
Required: True ,
}
[
{
subnet:
{
Description: The reference to the subnet bound to the IP configuration. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
privateIpAddress:
{
Description: Private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIpAllocationMethod:
{
Description: Private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the inbound endpoint resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
InboundEndpoints_Get (new)
Description :  Gets properties of an inbound endpoint for a DNS resolver.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/inboundEndpoints/{inboundEndpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
inboundEndpointName:
{
Description: The name of the inbound endpoint for the DNS resolver. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the inbound endpoint. ,
Required: True ,
}
{
ipConfigurations:
{
Description: IP configurations for the inbound endpoint. ,
Required: True ,
}
[
{
subnet:
{
Description: The reference to the subnet bound to the IP configuration. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
privateIpAddress:
{
Description: Private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIpAllocationMethod:
{
Description: Private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the inbound endpoint resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
InboundEndpoints_CreateOrUpdate (new)
Description :  Creates or updates an inbound endpoint for a DNS resolver.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/inboundEndpoints/{inboundEndpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
inboundEndpointName:
{
Description: The name of the inbound endpoint for the DNS resolver. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
if-none-match:
{
Description: Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the inbound endpoint. ,
Required: True ,
}
{
ipConfigurations:
{
Description: IP configurations for the inbound endpoint. ,
Required: True ,
}
[
{
subnet:
{
Description: The reference to the subnet bound to the IP configuration. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
privateIpAddress:
{
Description: Private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIpAllocationMethod:
{
Description: Private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the inbound endpoint resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the inbound endpoint. ,
Required: True ,
}
{
ipConfigurations:
{
Description: IP configurations for the inbound endpoint. ,
Required: True ,
}
[
{
subnet:
{
Description: The reference to the subnet bound to the IP configuration. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
privateIpAddress:
{
Description: Private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIpAllocationMethod:
{
Description: Private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the inbound endpoint resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Describes an inbound endpoint for a DNS resolver. ,
}
{
properties:
{
Description: Properties of the inbound endpoint. ,
Required: True ,
}
{
ipConfigurations:
{
Description: IP configurations for the inbound endpoint. ,
Required: True ,
}
[
{
subnet:
{
Description: The reference to the subnet bound to the IP configuration. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
privateIpAddress:
{
Description: Private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIpAllocationMethod:
{
Description: Private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the inbound endpoint resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
InboundEndpoints_Update (new)
Description :  Updates an inbound endpoint for a DNS resolver.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/inboundEndpoints/{inboundEndpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
inboundEndpointName:
{
Description: The name of the inbound endpoint for the DNS resolver. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
tags:
{
Description: Tags for inbound endpoint. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the inbound endpoint. ,
Required: True ,
}
{
ipConfigurations:
{
Description: IP configurations for the inbound endpoint. ,
Required: True ,
}
[
{
subnet:
{
Description: The reference to the subnet bound to the IP configuration. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
privateIpAddress:
{
Description: Private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIpAllocationMethod:
{
Description: Private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the inbound endpoint resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
InboundEndpoints_Delete (new)
Description :  Deletes an inbound endpoint for a DNS resolver. WARNING: This operation cannot be undone.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/inboundEndpoints/{inboundEndpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
inboundEndpointName:
{
Description: The name of the inbound endpoint for the DNS resolver. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
OutboundEndpoints_List (new)
Description :  Lists outbound endpoints for a DNS resolver.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/outboundEndpoints
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The OutboundEndpoint items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the outbound endpoint. ,
Required: True ,
}
{
subnet:
{
Description: The reference to the subnet used for the outbound endpoint. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the outbound endpoint resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
OutboundEndpoints_Get (new)
Description :  Gets properties of an outbound endpoint for a DNS resolver.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/outboundEndpoints/{outboundEndpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
outboundEndpointName:
{
Description: The name of the outbound endpoint for the DNS resolver. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the outbound endpoint. ,
Required: True ,
}
{
subnet:
{
Description: The reference to the subnet used for the outbound endpoint. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the outbound endpoint resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
OutboundEndpoints_CreateOrUpdate (new)
Description :  Creates or updates an outbound endpoint for a DNS resolver.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/outboundEndpoints/{outboundEndpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
outboundEndpointName:
{
Description: The name of the outbound endpoint for the DNS resolver. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
if-none-match:
{
Description: Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the outbound endpoint. ,
Required: True ,
}
{
subnet:
{
Description: The reference to the subnet used for the outbound endpoint. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the outbound endpoint resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the outbound endpoint. ,
Required: True ,
}
{
subnet:
{
Description: The reference to the subnet used for the outbound endpoint. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the outbound endpoint resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Describes an outbound endpoint for a DNS resolver. ,
}
{
properties:
{
Description: Properties of the outbound endpoint. ,
Required: True ,
}
{
subnet:
{
Description: The reference to the subnet used for the outbound endpoint. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the outbound endpoint resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
OutboundEndpoints_Update (new)
Description :  Updates an outbound endpoint for a DNS resolver.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/outboundEndpoints/{outboundEndpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
outboundEndpointName:
{
Description: The name of the outbound endpoint for the DNS resolver. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
tags:
{
Description: Tags for outbound endpoint. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the outbound endpoint. ,
Required: True ,
}
{
subnet:
{
Description: The reference to the subnet used for the outbound endpoint. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the outbound endpoint resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
OutboundEndpoints_Delete (new)
Description :  Deletes an outbound endpoint for a DNS resolver. WARNING: This operation cannot be undone.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/outboundEndpoints/{outboundEndpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
outboundEndpointName:
{
Description: The name of the outbound endpoint for the DNS resolver. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsForwardingRulesets_ListByVirtualNetwork (new)
Description :  Lists DNS forwarding ruleset resource IDs attached to a virtual network.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/listDnsForwardingRulesets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualNetworkName:
{
Description: The name of the VirtualNetwork ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The VirtualNetworkDnsForwardingRuleset items on this page ,
Required: True ,
}
[
{
id:
{
Description: DNS Forwarding Ruleset Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the virtual network link sub-resource reference. ,
Required: False ,
}
{
virtualNetworkLink:
{
Description: The reference to the virtual network link. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsResolverPolicies_ListByVirtualNetwork (new)
Description :  Lists DNS resolver policy resource IDs linked to a virtual network.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/listDnsResolverPolicies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualNetworkName:
{
Description: The name of the VirtualNetwork ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SubResource items on this page ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsResolvers_ListByVirtualNetwork (new)
Description :  Lists DNS resolver resource IDs linked to a virtual network.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/listDnsResolvers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualNetworkName:
{
Description: The name of the VirtualNetwork ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The SubResource items on this page ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsResolvers_CreateOrUpdate (removed)
Description :  Creates or updates a DNS resolver.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
if-none-match:
{
Description: Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the DNS resolver. ,
Required: True ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
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. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS resolver. ,
Required: True ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
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. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Describes a DNS resolver. ,
}
{
properties:
{
Description: Properties of the DNS resolver. ,
Required: True ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
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. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsResolvers_Update (removed)
Description :  Updates a DNS resolver.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
tags:
{
Description: Tags for DNS Resolver. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS resolver. ,
Required: True ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
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. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsResolvers_Delete (removed)
Description :  Deletes a DNS resolver. WARNING: This operation cannot be undone.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsResolvers_Get (removed)
Description :  Gets properties of a DNS resolver.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS resolver. ,
Required: True ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
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. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsResolvers_ListByResourceGroup (removed)
Description :  Lists DNS resolvers within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The DnsResolver items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the DNS resolver. ,
Required: True ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
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. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsResolvers_List (removed)
Description :  Lists DNS resolvers in all resource groups of a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/dnsResolvers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The DnsResolver items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the DNS resolver. ,
Required: True ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
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. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
InboundEndpoints_CreateOrUpdate (removed)
Description :  Creates or updates an inbound endpoint for a DNS resolver.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/inboundEndpoints/{inboundEndpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
inboundEndpointName:
{
Description: The name of the inbound endpoint for the DNS resolver. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
if-none-match:
{
Description: Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the inbound endpoint. ,
Required: True ,
}
{
ipConfigurations:
{
Description: IP configurations for the inbound endpoint. ,
Required: True ,
}
[
{
subnet:
{
Description: The reference to the subnet bound to the IP configuration. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
privateIpAddress:
{
Description: Private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIpAllocationMethod:
{
Description: Private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the inbound endpoint resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the inbound endpoint. ,
Required: True ,
}
{
ipConfigurations:
{
Description: IP configurations for the inbound endpoint. ,
Required: True ,
}
[
{
subnet:
{
Description: The reference to the subnet bound to the IP configuration. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
privateIpAddress:
{
Description: Private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIpAllocationMethod:
{
Description: Private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the inbound endpoint resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Describes an inbound endpoint for a DNS resolver. ,
}
{
properties:
{
Description: Properties of the inbound endpoint. ,
Required: True ,
}
{
ipConfigurations:
{
Description: IP configurations for the inbound endpoint. ,
Required: True ,
}
[
{
subnet:
{
Description: The reference to the subnet bound to the IP configuration. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
privateIpAddress:
{
Description: Private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIpAllocationMethod:
{
Description: Private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the inbound endpoint resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
InboundEndpoints_Update (removed)
Description :  Updates an inbound endpoint for a DNS resolver.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/inboundEndpoints/{inboundEndpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
inboundEndpointName:
{
Description: The name of the inbound endpoint for the DNS resolver. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
tags:
{
Description: Tags for inbound endpoint. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the inbound endpoint. ,
Required: True ,
}
{
ipConfigurations:
{
Description: IP configurations for the inbound endpoint. ,
Required: True ,
}
[
{
subnet:
{
Description: The reference to the subnet bound to the IP configuration. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
privateIpAddress:
{
Description: Private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIpAllocationMethod:
{
Description: Private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the inbound endpoint resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
InboundEndpoints_Delete (removed)
Description :  Deletes an inbound endpoint for a DNS resolver. WARNING: This operation cannot be undone.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/inboundEndpoints/{inboundEndpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
inboundEndpointName:
{
Description: The name of the inbound endpoint for the DNS resolver. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
InboundEndpoints_Get (removed)
Description :  Gets properties of an inbound endpoint for a DNS resolver.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/inboundEndpoints/{inboundEndpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
inboundEndpointName:
{
Description: The name of the inbound endpoint for the DNS resolver. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the inbound endpoint. ,
Required: True ,
}
{
ipConfigurations:
{
Description: IP configurations for the inbound endpoint. ,
Required: True ,
}
[
{
subnet:
{
Description: The reference to the subnet bound to the IP configuration. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
privateIpAddress:
{
Description: Private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIpAllocationMethod:
{
Description: Private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the inbound endpoint resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
InboundEndpoints_List (removed)
Description :  Lists inbound endpoints for a DNS resolver.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/inboundEndpoints
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The InboundEndpoint items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the inbound endpoint. ,
Required: True ,
}
{
ipConfigurations:
{
Description: IP configurations for the inbound endpoint. ,
Required: True ,
}
[
{
subnet:
{
Description: The reference to the subnet bound to the IP configuration. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
privateIpAddress:
{
Description: Private IP address of the IP configuration. ,
Required: False ,
}
string ,
privateIpAllocationMethod:
{
Description: Private IP address allocation method. ,
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the inbound endpoint resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
OutboundEndpoints_CreateOrUpdate (removed)
Description :  Creates or updates an outbound endpoint for a DNS resolver.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/outboundEndpoints/{outboundEndpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
outboundEndpointName:
{
Description: The name of the outbound endpoint for the DNS resolver. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
if-none-match:
{
Description: Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the outbound endpoint. ,
Required: True ,
}
{
subnet:
{
Description: The reference to the subnet used for the outbound endpoint. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the outbound endpoint resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the outbound endpoint. ,
Required: True ,
}
{
subnet:
{
Description: The reference to the subnet used for the outbound endpoint. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the outbound endpoint resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Describes an outbound endpoint for a DNS resolver. ,
}
{
properties:
{
Description: Properties of the outbound endpoint. ,
Required: True ,
}
{
subnet:
{
Description: The reference to the subnet used for the outbound endpoint. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the outbound endpoint resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
OutboundEndpoints_Update (removed)
Description :  Updates an outbound endpoint for a DNS resolver.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/outboundEndpoints/{outboundEndpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
outboundEndpointName:
{
Description: The name of the outbound endpoint for the DNS resolver. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
tags:
{
Description: Tags for outbound endpoint. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the outbound endpoint. ,
Required: True ,
}
{
subnet:
{
Description: The reference to the subnet used for the outbound endpoint. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the outbound endpoint resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
OutboundEndpoints_Delete (removed)
Description :  Deletes an outbound endpoint for a DNS resolver. WARNING: This operation cannot be undone.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/outboundEndpoints/{outboundEndpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
outboundEndpointName:
{
Description: The name of the outbound endpoint for the DNS resolver. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
OutboundEndpoints_Get (removed)
Description :  Gets properties of an outbound endpoint for a DNS resolver.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/outboundEndpoints/{outboundEndpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
outboundEndpointName:
{
Description: The name of the outbound endpoint for the DNS resolver. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the outbound endpoint. ,
Required: True ,
}
{
subnet:
{
Description: The reference to the subnet used for the outbound endpoint. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the outbound endpoint resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
OutboundEndpoints_List (removed)
Description :  Lists outbound endpoints for a DNS resolver.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/outboundEndpoints
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverName:
{
Description: The name of the DNS resolver. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The OutboundEndpoint items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the outbound endpoint. ,
Required: True ,
}
{
subnet:
{
Description: The reference to the subnet used for the outbound endpoint. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the outbound endpoint resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsForwardingRulesets_CreateOrUpdate (removed)
Description :  Creates or updates a DNS forwarding ruleset.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsForwardingRulesetName:
{
Description: The name of the DNS forwarding ruleset. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
if-none-match:
{
Description: Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid for the DNS forwarding ruleset. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid for the DNS forwarding ruleset. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Describes a DNS forwarding ruleset. ,
}
{
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid for the DNS forwarding ruleset. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsForwardingRulesets_Update (removed)
Description :  Updates a DNS forwarding ruleset.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsForwardingRulesetName:
{
Description: The name of the DNS forwarding ruleset. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
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. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
tags:
{
Description: Tags for DNS Resolver. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid for the DNS forwarding ruleset. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsForwardingRulesets_Delete (removed)
Description :  Deletes a DNS forwarding ruleset. WARNING: This operation cannot be undone. All forwarding rules within the ruleset will be deleted.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsForwardingRulesetName:
{
Description: The name of the DNS forwarding ruleset. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsForwardingRulesets_Get (removed)
Description :  Gets a DNS forwarding ruleset properties.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsForwardingRulesetName:
{
Description: The name of the DNS forwarding ruleset. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid for the DNS forwarding ruleset. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsForwardingRulesets_ListByResourceGroup (removed)
Description :  Lists DNS forwarding rulesets within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The DnsForwardingRuleset items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid for the DNS forwarding ruleset. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsForwardingRulesets_List (removed)
Description :  Lists DNS forwarding rulesets in all resource groups of a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/dnsForwardingRulesets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The DnsForwardingRuleset items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid for the DNS forwarding ruleset. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
ForwardingRules_CreateOrUpdate (removed)
Description :  Creates or updates a forwarding rule in a DNS forwarding ruleset.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/forwardingRules/{forwardingRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsForwardingRulesetName:
{
Description: The name of the DNS forwarding ruleset. ,
Required: True ,
}
string ,
forwardingRuleName:
{
Description: The name of the forwarding rule. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
if-none-match:
{
Description: Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the forwarding rule. ,
Required: True ,
}
{
domainName:
{
Description: The domain name for the forwarding rule. ,
Required: True ,
}
string ,
targetDnsServers:
{
Description: DNS servers to forward the DNS query to. ,
Required: True ,
}
[
{
ipAddress:
{
Description: DNS server IP address. ,
Required: True ,
}
string ,
port:
{
Description: DNS server port. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
metadata:
{
Description: Metadata attached to the forwarding rule. ,
Required: False ,
}
object ,
forwardingRuleState:
{
Description: The state of forwarding rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the forwarding rule. ,
Required: True ,
}
{
domainName:
{
Description: The domain name for the forwarding rule. ,
Required: True ,
}
string ,
targetDnsServers:
{
Description: DNS servers to forward the DNS query to. ,
Required: True ,
}
[
{
ipAddress:
{
Description: DNS server IP address. ,
Required: True ,
}
string ,
port:
{
Description: DNS server port. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
metadata:
{
Description: Metadata attached to the forwarding rule. ,
Required: False ,
}
object ,
forwardingRuleState:
{
Description: The state of forwarding rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the forwarding rule. ,
Required: True ,
}
{
domainName:
{
Description: The domain name for the forwarding rule. ,
Required: True ,
}
string ,
targetDnsServers:
{
Description: DNS servers to forward the DNS query to. ,
Required: True ,
}
[
{
ipAddress:
{
Description: DNS server IP address. ,
Required: True ,
}
string ,
port:
{
Description: DNS server port. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
metadata:
{
Description: Metadata attached to the forwarding rule. ,
Required: False ,
}
object ,
forwardingRuleState:
{
Description: The state of forwarding rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
ForwardingRules_Update (removed)
Description :  Updates a forwarding rule in a DNS forwarding ruleset.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/forwardingRules/{forwardingRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsForwardingRulesetName:
{
Description: The name of the DNS forwarding ruleset. ,
Required: True ,
}
string ,
forwardingRuleName:
{
Description: The name of the forwarding rule. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
properties:
{
Description: Updatable properties of the forwarding rule. ,
Required: False ,
}
{
targetDnsServers:
{
Description: DNS servers to forward the DNS query to. ,
Required: False ,
}
[
{
ipAddress:
{
Description: DNS server IP address. ,
Required: True ,
}
string ,
port:
{
Description: DNS server port. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
metadata:
{
Description: Metadata attached to the forwarding rule. ,
Required: False ,
}
object ,
forwardingRuleState:
{
Description: The state of forwarding rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the forwarding rule. ,
Required: True ,
}
{
domainName:
{
Description: The domain name for the forwarding rule. ,
Required: True ,
}
string ,
targetDnsServers:
{
Description: DNS servers to forward the DNS query to. ,
Required: True ,
}
[
{
ipAddress:
{
Description: DNS server IP address. ,
Required: True ,
}
string ,
port:
{
Description: DNS server port. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
metadata:
{
Description: Metadata attached to the forwarding rule. ,
Required: False ,
}
object ,
forwardingRuleState:
{
Description: The state of forwarding rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
ForwardingRules_Delete (removed)
Description :  Deletes a forwarding rule in a DNS forwarding ruleset. WARNING: This operation cannot be undone.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/forwardingRules/{forwardingRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsForwardingRulesetName:
{
Description: The name of the DNS forwarding ruleset. ,
Required: True ,
}
string ,
forwardingRuleName:
{
Description: The name of the forwarding rule. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
ForwardingRules_Get (removed)
Description :  Gets properties of a forwarding rule in a DNS forwarding ruleset.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/forwardingRules/{forwardingRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsForwardingRulesetName:
{
Description: The name of the DNS forwarding ruleset. ,
Required: True ,
}
string ,
forwardingRuleName:
{
Description: The name of the forwarding rule. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the forwarding rule. ,
Required: True ,
}
{
domainName:
{
Description: The domain name for the forwarding rule. ,
Required: True ,
}
string ,
targetDnsServers:
{
Description: DNS servers to forward the DNS query to. ,
Required: True ,
}
[
{
ipAddress:
{
Description: DNS server IP address. ,
Required: True ,
}
string ,
port:
{
Description: DNS server port. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
metadata:
{
Description: Metadata attached to the forwarding rule. ,
Required: False ,
}
object ,
forwardingRuleState:
{
Description: The state of forwarding rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
ForwardingRules_List (removed)
Description :  Lists forwarding rules in a DNS forwarding ruleset.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/forwardingRules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsForwardingRulesetName:
{
Description: The name of the DNS forwarding ruleset. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The ForwardingRule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the forwarding rule. ,
Required: True ,
}
{
domainName:
{
Description: The domain name for the forwarding rule. ,
Required: True ,
}
string ,
targetDnsServers:
{
Description: DNS servers to forward the DNS query to. ,
Required: True ,
}
[
{
ipAddress:
{
Description: DNS server IP address. ,
Required: True ,
}
string ,
port:
{
Description: DNS server port. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
metadata:
{
Description: Metadata attached to the forwarding rule. ,
Required: False ,
}
object ,
forwardingRuleState:
{
Description: The state of forwarding rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsResolvers_ListByVirtualNetwork (removed)
Description :  Lists DNS resolver resource IDs linked to a virtual network.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/listDnsResolvers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualNetworkName:
{
Description: The name of the VirtualNetwork ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The SubResource items on this page ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsForwardingRulesets_ListByVirtualNetwork (removed)
Description :  Lists DNS forwarding ruleset resource IDs attached to a virtual network.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/listDnsForwardingRulesets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualNetworkName:
{
Description: The name of the VirtualNetwork ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The VirtualNetworkDnsForwardingRuleset items on this page ,
Required: True ,
}
[
{
id:
{
Description: DNS Forwarding Ruleset Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the virtual network link sub-resource reference. ,
Required: False ,
}
{
virtualNetworkLink:
{
Description: The reference to the virtual network link. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error message body ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: A description of what caused the error ,
Required: False ,
}
string ,
target:
{
Description: The target resource of the error message ,
Required: False ,
}
string ,
details:
{
Description: Extra error information ,
Required: False ,
}
[
string ,
]
,
}
,
}
DnsResolverPolicies_CreateOrUpdate (removed)
Description :  Creates or updates a DNS resolver policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverPolicyName:
{
Description: The name of the DNS resolver policy. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
if-none-match:
{
Description: Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the DNS resolver policy. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state of the DNS resolver policy. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver policy resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS resolver policy. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state of the DNS resolver policy. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver policy resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Describes a DNS resolver policy. ,
}
{
properties:
{
Description: Properties of the DNS resolver policy. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state of the DNS resolver policy. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver policy resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsResolverPolicies_Update (removed)
Description :  Updates a DNS resolver policy.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverPolicyName:
{
Description: The name of the DNS resolver policy. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
tags:
{
Description: Tags for DNS resolver policy. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS resolver policy. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state of the DNS resolver policy. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver policy resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsResolverPolicies_Delete (removed)
Description :  Deletes a DNS resolver policy. WARNING: This operation cannot be undone.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverPolicyName:
{
Description: The name of the DNS resolver policy. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsResolverPolicies_Get (removed)
Description :  Gets properties of a DNS resolver policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverPolicyName:
{
Description: The name of the DNS resolver policy. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS resolver policy. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state of the DNS resolver policy. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver policy resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsResolverPolicies_ListByResourceGroup (removed)
Description :  Lists DNS resolver policies within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The DnsResolverPolicy items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the DNS resolver policy. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state of the DNS resolver policy. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver policy resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsResolverPolicies_List (removed)
Description :  Lists DNS resolver policies in all resource groups of a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/dnsResolverPolicies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The DnsResolverPolicy items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the DNS resolver policy. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state of the DNS resolver policy. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver policy resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsSecurityRules_CreateOrUpdate (removed)
Description :  Creates or updates a DNS security rule for a DNS resolver policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}/dnsSecurityRules/{dnsSecurityRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverPolicyName:
{
Description: The name of the DNS resolver policy. ,
Required: True ,
}
string ,
dnsSecurityRuleName:
{
Description: The name of the DNS security rule. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
if-none-match:
{
Description: Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the DNS security rule. ,
Required: True ,
}
{
priority:
{
Description: The priority of the DNS security rule. ,
Format: int32 ,
Required: True ,
}
integer ,
action:
{
Description: The action to take on DNS requests that match the DNS security rule. ,
Required: True ,
}
{
actionType:
{
Description: The type of action to take. ,
Enum:
{
Allow: No description available. ,
Alert: No description available. ,
Block: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dnsResolverDomainLists:
{
Description: DNS resolver policy domains lists that the DNS security rule applies to. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
dnsSecurityRuleState:
{
Description: The state of DNS security rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current provisioning state of the DNS security rule. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS security rule. ,
Required: True ,
}
{
priority:
{
Description: The priority of the DNS security rule. ,
Format: int32 ,
Required: True ,
}
integer ,
action:
{
Description: The action to take on DNS requests that match the DNS security rule. ,
Required: True ,
}
{
actionType:
{
Description: The type of action to take. ,
Enum:
{
Allow: No description available. ,
Alert: No description available. ,
Block: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dnsResolverDomainLists:
{
Description: DNS resolver policy domains lists that the DNS security rule applies to. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
dnsSecurityRuleState:
{
Description: The state of DNS security rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current provisioning state of the DNS security rule. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Describes a DNS security rule. ,
}
{
properties:
{
Description: Properties of the DNS security rule. ,
Required: True ,
}
{
priority:
{
Description: The priority of the DNS security rule. ,
Format: int32 ,
Required: True ,
}
integer ,
action:
{
Description: The action to take on DNS requests that match the DNS security rule. ,
Required: True ,
}
{
actionType:
{
Description: The type of action to take. ,
Enum:
{
Allow: No description available. ,
Alert: No description available. ,
Block: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dnsResolverDomainLists:
{
Description: DNS resolver policy domains lists that the DNS security rule applies to. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
dnsSecurityRuleState:
{
Description: The state of DNS security rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current provisioning state of the DNS security rule. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsSecurityRules_Update (removed)
Description :  Updates a DNS security rule.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}/dnsSecurityRules/{dnsSecurityRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverPolicyName:
{
Description: The name of the DNS resolver policy. ,
Required: True ,
}
string ,
dnsSecurityRuleName:
{
Description: The name of the DNS security rule. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
properties:
{
Description: Updatable properties of the DNS security rule. ,
Required: False ,
}
{
action:
{
Description: The action to take on DNS requests that match the DNS security rule. ,
Required: False ,
}
{
actionType:
{
Description: The type of action to take. ,
Enum:
{
Allow: No description available. ,
Alert: No description available. ,
Block: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dnsResolverDomainLists:
{
Description: DNS resolver policy domains lists that the DNS security rule applies to. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
dnsSecurityRuleState:
{
Description: The state of DNS security rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: The priority of the DNS security rule. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tags:
{
Description: Tags for DNS security rule. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS security rule. ,
Required: True ,
}
{
priority:
{
Description: The priority of the DNS security rule. ,
Format: int32 ,
Required: True ,
}
integer ,
action:
{
Description: The action to take on DNS requests that match the DNS security rule. ,
Required: True ,
}
{
actionType:
{
Description: The type of action to take. ,
Enum:
{
Allow: No description available. ,
Alert: No description available. ,
Block: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dnsResolverDomainLists:
{
Description: DNS resolver policy domains lists that the DNS security rule applies to. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
dnsSecurityRuleState:
{
Description: The state of DNS security rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current provisioning state of the DNS security rule. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsSecurityRules_Delete (removed)
Description :  Deletes a DNS security rule for a DNS resolver policy. WARNING: This operation cannot be undone.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}/dnsSecurityRules/{dnsSecurityRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverPolicyName:
{
Description: The name of the DNS resolver policy. ,
Required: True ,
}
string ,
dnsSecurityRuleName:
{
Description: The name of the DNS security rule. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsSecurityRules_Get (removed)
Description :  Gets properties of a DNS security rule for a DNS resolver policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}/dnsSecurityRules/{dnsSecurityRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverPolicyName:
{
Description: The name of the DNS resolver policy. ,
Required: True ,
}
string ,
dnsSecurityRuleName:
{
Description: The name of the DNS security rule. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS security rule. ,
Required: True ,
}
{
priority:
{
Description: The priority of the DNS security rule. ,
Format: int32 ,
Required: True ,
}
integer ,
action:
{
Description: The action to take on DNS requests that match the DNS security rule. ,
Required: True ,
}
{
actionType:
{
Description: The type of action to take. ,
Enum:
{
Allow: No description available. ,
Alert: No description available. ,
Block: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dnsResolverDomainLists:
{
Description: DNS resolver policy domains lists that the DNS security rule applies to. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
dnsSecurityRuleState:
{
Description: The state of DNS security rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current provisioning state of the DNS security rule. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsSecurityRules_List (removed)
Description :  Lists DNS security rules for a DNS resolver policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}/dnsSecurityRules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverPolicyName:
{
Description: The name of the DNS resolver policy. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The DnsSecurityRule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the DNS security rule. ,
Required: True ,
}
{
priority:
{
Description: The priority of the DNS security rule. ,
Format: int32 ,
Required: True ,
}
integer ,
action:
{
Description: The action to take on DNS requests that match the DNS security rule. ,
Required: True ,
}
{
actionType:
{
Description: The type of action to take. ,
Enum:
{
Allow: No description available. ,
Alert: No description available. ,
Block: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dnsResolverDomainLists:
{
Description: DNS resolver policy domains lists that the DNS security rule applies to. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
dnsSecurityRuleState:
{
Description: The state of DNS security rule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current provisioning state of the DNS security rule. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsResolverDomainLists_CreateOrUpdate (removed)
Description :  Creates or updates a DNS resolver domain list.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverDomainLists/{dnsResolverDomainListName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverDomainListName:
{
Description: The name of the DNS resolver domain list. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
if-none-match:
{
Description: Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the DNS resolver domain list. ,
Required: False ,
}
{
domains:
{
Description: The domains in the domain list. Will be null if user is using large domain list. ,
Required: False ,
}
[
string ,
]
,
domainsUrl:
{
Description: The URL for bulk upload or download for domain lists containing larger set of domains. This will be populated if domains is empty or null. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the DNS resolver domain list. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver domain list resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS resolver domain list. ,
Required: False ,
}
{
domains:
{
Description: The domains in the domain list. Will be null if user is using large domain list. ,
Required: False ,
}
[
string ,
]
,
domainsUrl:
{
Description: The URL for bulk upload or download for domain lists containing larger set of domains. This will be populated if domains is empty or null. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the DNS resolver domain list. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver domain list resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Describes a DNS resolver domain list. ,
}
{
properties:
{
Description: Properties of the DNS resolver domain list. ,
Required: False ,
}
{
domains:
{
Description: The domains in the domain list. Will be null if user is using large domain list. ,
Required: False ,
}
[
string ,
]
,
domainsUrl:
{
Description: The URL for bulk upload or download for domain lists containing larger set of domains. This will be populated if domains is empty or null. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the DNS resolver domain list. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver domain list resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsResolverDomainLists_Update (removed)
Description :  Updates a DNS resolver domain list.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverDomainLists/{dnsResolverDomainListName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverDomainListName:
{
Description: The name of the DNS resolver domain list. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
properties:
{
Description: Updatable properties of the DNS resolver domain list. ,
Required: False ,
}
{
domains:
{
Description: The domains in the domain list. ,
Required: False ,
}
[
string ,
]
,
}
,
tags:
{
Description: Tags for DNS resolver domain list. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS resolver domain list. ,
Required: False ,
}
{
domains:
{
Description: The domains in the domain list. Will be null if user is using large domain list. ,
Required: False ,
}
[
string ,
]
,
domainsUrl:
{
Description: The URL for bulk upload or download for domain lists containing larger set of domains. This will be populated if domains is empty or null. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the DNS resolver domain list. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver domain list resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsResolverDomainLists_Delete (removed)
Description :  Deletes a DNS resolver domain list. WARNING: This operation cannot be undone.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverDomainLists/{dnsResolverDomainListName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverDomainListName:
{
Description: The name of the DNS resolver domain list. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsResolverDomainLists_Get (removed)
Description :  Gets properties of a DNS resolver domain list.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverDomainLists/{dnsResolverDomainListName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverDomainListName:
{
Description: The name of the DNS resolver domain list. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS resolver domain list. ,
Required: False ,
}
{
domains:
{
Description: The domains in the domain list. Will be null if user is using large domain list. ,
Required: False ,
}
[
string ,
]
,
domainsUrl:
{
Description: The URL for bulk upload or download for domain lists containing larger set of domains. This will be populated if domains is empty or null. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the DNS resolver domain list. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver domain list resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsResolverDomainLists_ListByResourceGroup (removed)
Description :  Lists DNS resolver domain lists within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverDomainLists
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The DnsResolverDomainList items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the DNS resolver domain list. ,
Required: False ,
}
{
domains:
{
Description: The domains in the domain list. Will be null if user is using large domain list. ,
Required: False ,
}
[
string ,
]
,
domainsUrl:
{
Description: The URL for bulk upload or download for domain lists containing larger set of domains. This will be populated if domains is empty or null. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the DNS resolver domain list. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver domain list resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsResolverDomainLists_List (removed)
Description :  Lists DNS resolver domain lists in all resource groups of a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/dnsResolverDomainLists
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of results to return. If not specified, returns up to 100 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The DnsResolverDomainList items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the DNS resolver domain list. ,
Required: False ,
}
{
domains:
{
Description: The domains in the domain list. Will be null if user is using large domain list. ,
Required: False ,
}
[
string ,
]
,
domainsUrl:
{
Description: The URL for bulk upload or download for domain lists containing larger set of domains. This will be populated if domains is empty or null. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the DNS resolver domain list. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver domain list resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsResolverDomainLists_Bulk (removed)
Description :  Uploads or downloads the list of domains for a DNS Resolver Domain List from a storage link.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverDomainLists/{dnsResolverDomainListName}/bulk
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsResolverDomainListName:
{
Description: The name of the DNS resolver domain list. ,
Required: True ,
}
string ,
if-match:
{
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. ,
Required: False ,
}
string ,
if-none-match:
{
Description: Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the bulk domain list operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the DNS resolver domain list upload or download request. ,
Required: True ,
}
{
storageUrl:
{
Description: The storage account blob file URL to be used in the bulk upload or download request of DNS resolver domain list. ,
Required: True ,
}
string ,
action:
{
Description: The action to take in the request, Upload or Download. ,
Enum:
{
Upload: No description available. ,
Download: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the DNS resolver domain list. ,
Required: False ,
}
{
domains:
{
Description: The domains in the domain list. Will be null if user is using large domain list. ,
Required: False ,
}
[
string ,
]
,
domainsUrl:
{
Description: The URL for bulk upload or download for domain lists containing larger set of domains. This will be populated if domains is empty or null. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the DNS resolver domain list. This is a read-only property and any attempt to set this value will be ignored. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: The resourceGuid property of the DNS resolver domain list resource. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsResolverPolicies_ListByVirtualNetwork (removed)
Description :  Lists DNS resolver policy resource IDs linked to a virtual network.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/listDnsResolverPolicies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualNetworkName:
{
Description: The name of the VirtualNetwork ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SubResource items on this page ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}