Microsoft.Network (preview:2020-04-01)

2025/09/12 • 34 new, 34 deleted methods

DnsResolvers_CreateOrUpdate (new)
Description :  Creates or updates a DNS resolver.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
etag:
{
Description: ETag of the DNS resolver. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS resolver. ,
Required: False ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}

⚐ Response (201)

{
etag:
{
Description: ETag of the DNS resolver. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS resolver. ,
Required: False ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
etag:
{
Description: ETag of the DNS resolver. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS resolver. ,
Required: False ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ 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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
tags:
{
Description: Tags for DNS Resolver. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
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)

{
etag:
{
Description: ETag of the DNS resolver. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS resolver. ,
Required: False ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ 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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
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)

{}

⚐ 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 (new)
Description :  Gets properties of a DNS resolver.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: ETag of the DNS resolver. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS resolver. ,
Required: False ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 (new)
Description :  Lists DNS resolvers within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: Enumeration of the DNS resolvers. ,
Required: False ,
}
[
{
etag:
{
Description: ETag of the DNS resolver. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS resolver. ,
Required: False ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
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 (new)
Description :  Lists DNS resolvers in all resource groups of a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/dnsResolvers
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: Enumeration of the DNS resolvers. ,
Required: False ,
}
[
{
etag:
{
Description: ETag of the DNS resolver. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS resolver. ,
Required: False ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
etag:
{
Description: ETag of the inbound endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the inbound endpoint. ,
Required: False ,
}
{
ipConfigurations:
{
Description: IP configurations for the inbound endpoint. ,
Required: False ,
}
[
{
subnet:
{
Description: The reference to the subnet bound to the IP configuration. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}

⚐ Response (201)

{
etag:
{
Description: ETag of the inbound endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the inbound endpoint. ,
Required: False ,
}
{
ipConfigurations:
{
Description: IP configurations for the inbound endpoint. ,
Required: False ,
}
[
{
subnet:
{
Description: The reference to the subnet bound to the IP configuration. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
etag:
{
Description: ETag of the inbound endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the inbound endpoint. ,
Required: False ,
}
{
ipConfigurations:
{
Description: IP configurations for the inbound endpoint. ,
Required: False ,
}
[
{
subnet:
{
Description: The reference to the subnet bound to the IP configuration. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ 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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
tags:
{
Description: Tags for inbound endpoint. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
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)

{
etag:
{
Description: ETag of the inbound endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the inbound endpoint. ,
Required: False ,
}
{
ipConfigurations:
{
Description: IP configurations for the inbound endpoint. ,
Required: False ,
}
[
{
subnet:
{
Description: The reference to the subnet bound to the IP configuration. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ 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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
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)

{}

⚐ 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 (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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: ETag of the inbound endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the inbound endpoint. ,
Required: False ,
}
{
ipConfigurations:
{
Description: IP configurations for the inbound endpoint. ,
Required: False ,
}
[
{
subnet:
{
Description: The reference to the subnet bound to the IP configuration. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 (new)
Description :  Lists inbound endpoints for a DNS resolver.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/inboundEndpoints
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
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: Enumeration of the inbound endpoints for a DNS resolver. ,
Required: False ,
}
[
{
etag:
{
Description: ETag of the inbound endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the inbound endpoint. ,
Required: False ,
}
{
ipConfigurations:
{
Description: IP configurations for the inbound endpoint. ,
Required: False ,
}
[
{
subnet:
{
Description: The reference to the subnet bound to the IP configuration. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
etag:
{
Description: ETag of the outbound endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the outbound endpoint. ,
Required: False ,
}
{
subnet:
{
Description: The reference to the subnet used for the outbound endpoint. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}

⚐ Response (201)

{
etag:
{
Description: ETag of the outbound endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the outbound endpoint. ,
Required: False ,
}
{
subnet:
{
Description: The reference to the subnet used for the outbound endpoint. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
etag:
{
Description: ETag of the outbound endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the outbound endpoint. ,
Required: False ,
}
{
subnet:
{
Description: The reference to the subnet used for the outbound endpoint. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ 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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
tags:
{
Description: Tags for outbound endpoint. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
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)

{
etag:
{
Description: ETag of the outbound endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the outbound endpoint. ,
Required: False ,
}
{
subnet:
{
Description: The reference to the subnet used for the outbound endpoint. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ 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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
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)

{}

⚐ 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 (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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: ETag of the outbound endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the outbound endpoint. ,
Required: False ,
}
{
subnet:
{
Description: The reference to the subnet used for the outbound endpoint. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 (new)
Description :  Lists outbound endpoints for a DNS resolver.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/outboundEndpoints
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
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: Enumeration of the outbound endpoints for a DNS resolver. ,
Required: False ,
}
[
{
etag:
{
Description: ETag of the outbound endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the outbound endpoint. ,
Required: False ,
}
{
subnet:
{
Description: The reference to the subnet used for the outbound endpoint. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
etag:
{
Description: ETag of the DNS forwarding ruleset. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: False ,
}
{
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: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}

⚐ Response (201)

{
etag:
{
Description: ETag of the DNS forwarding ruleset. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: False ,
}
{
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: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
etag:
{
Description: ETag of the DNS forwarding ruleset. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: False ,
}
{
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: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ 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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
tags:
{
Description: Tags for DNS Resolver. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
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)

{
etag:
{
Description: ETag of the DNS forwarding ruleset. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: False ,
}
{
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: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ 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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
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)

{}

⚐ 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 (new)
Description :  Gets a DNS forwarding ruleset properties.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: ETag of the DNS forwarding ruleset. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: False ,
}
{
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: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: Enumeration of the DNS forwarding rulesets. ,
Required: False ,
}
[
{
etag:
{
Description: ETag of the DNS forwarding ruleset. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: False ,
}
{
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: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
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 (new)
Description :  Lists DNS forwarding rulesets in all resource groups of a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/dnsForwardingRulesets
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: Enumeration of the DNS forwarding rulesets. ,
Required: False ,
}
[
{
etag:
{
Description: ETag of the DNS forwarding ruleset. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: False ,
}
{
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: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
etag:
{
Description: ETag of the forwarding rule. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the forwarding rule. ,
Required: False ,
}
{
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: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}

⚐ Response (201)

{
etag:
{
Description: ETag of the forwarding rule. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the forwarding rule. ,
Required: False ,
}
{
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: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
etag:
{
Description: ETag of the forwarding rule. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the forwarding rule. ,
Required: False ,
}
{
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: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
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: False ,
}
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 ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
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)

{
etag:
{
Description: ETag of the forwarding rule. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the forwarding rule. ,
Required: False ,
}
{
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: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
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 (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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: ETag of the forwarding rule. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the forwarding rule. ,
Required: False ,
}
{
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: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 (new)
Description :  Lists forwarding rules in a DNS forwarding ruleset.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/forwardingRules
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
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: Enumeration of the forwarding rules. ,
Required: False ,
}
[
{
etag:
{
Description: ETag of the forwarding rule. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the forwarding rule. ,
Required: False ,
}
{
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: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
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 (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
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 virtual network. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: Enumeration of the sub-resources. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
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 (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
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 virtual network. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: Enumeration of the Virtual Network DNS Forwarding Ruleset. ,
Required: False ,
}
[
{
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: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
etag:
{
Description: ETag of the DNS resolver. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS resolver. ,
Required: False ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}

⚐ Response (201)

{
etag:
{
Description: ETag of the DNS resolver. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS resolver. ,
Required: False ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
etag:
{
Description: ETag of the DNS resolver. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS resolver. ,
Required: False ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ 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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
tags:
{
Description: Tags for DNS Resolver. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
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)

{
etag:
{
Description: ETag of the DNS resolver. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS resolver. ,
Required: False ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ 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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
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)

{}

⚐ 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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: ETag of the DNS resolver. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS resolver. ,
Required: False ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: Enumeration of the DNS resolvers. ,
Required: False ,
}
[
{
etag:
{
Description: ETag of the DNS resolver. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS resolver. ,
Required: False ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
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
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: Enumeration of the DNS resolvers. ,
Required: False ,
}
[
{
etag:
{
Description: ETag of the DNS resolver. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS resolver. ,
Required: False ,
}
{
virtualNetwork:
{
Description: The reference to the virtual network. This cannot be changed after creation. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
etag:
{
Description: ETag of the inbound endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the inbound endpoint. ,
Required: False ,
}
{
ipConfigurations:
{
Description: IP configurations for the inbound endpoint. ,
Required: False ,
}
[
{
subnet:
{
Description: The reference to the subnet bound to the IP configuration. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}

⚐ Response (201)

{
etag:
{
Description: ETag of the inbound endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the inbound endpoint. ,
Required: False ,
}
{
ipConfigurations:
{
Description: IP configurations for the inbound endpoint. ,
Required: False ,
}
[
{
subnet:
{
Description: The reference to the subnet bound to the IP configuration. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
etag:
{
Description: ETag of the inbound endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the inbound endpoint. ,
Required: False ,
}
{
ipConfigurations:
{
Description: IP configurations for the inbound endpoint. ,
Required: False ,
}
[
{
subnet:
{
Description: The reference to the subnet bound to the IP configuration. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ 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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
tags:
{
Description: Tags for inbound endpoint. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
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)

{
etag:
{
Description: ETag of the inbound endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the inbound endpoint. ,
Required: False ,
}
{
ipConfigurations:
{
Description: IP configurations for the inbound endpoint. ,
Required: False ,
}
[
{
subnet:
{
Description: The reference to the subnet bound to the IP configuration. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ 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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
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)

{}

⚐ 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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: ETag of the inbound endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the inbound endpoint. ,
Required: False ,
}
{
ipConfigurations:
{
Description: IP configurations for the inbound endpoint. ,
Required: False ,
}
[
{
subnet:
{
Description: The reference to the subnet bound to the IP configuration. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
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: Enumeration of the inbound endpoints for a DNS resolver. ,
Required: False ,
}
[
{
etag:
{
Description: ETag of the inbound endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the inbound endpoint. ,
Required: False ,
}
{
ipConfigurations:
{
Description: IP configurations for the inbound endpoint. ,
Required: False ,
}
[
{
subnet:
{
Description: The reference to the subnet bound to the IP configuration. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
etag:
{
Description: ETag of the outbound endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the outbound endpoint. ,
Required: False ,
}
{
subnet:
{
Description: The reference to the subnet used for the outbound endpoint. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}

⚐ Response (201)

{
etag:
{
Description: ETag of the outbound endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the outbound endpoint. ,
Required: False ,
}
{
subnet:
{
Description: The reference to the subnet used for the outbound endpoint. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
etag:
{
Description: ETag of the outbound endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the outbound endpoint. ,
Required: False ,
}
{
subnet:
{
Description: The reference to the subnet used for the outbound endpoint. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ 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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
tags:
{
Description: Tags for outbound endpoint. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
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)

{
etag:
{
Description: ETag of the outbound endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the outbound endpoint. ,
Required: False ,
}
{
subnet:
{
Description: The reference to the subnet used for the outbound endpoint. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ 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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
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)

{}

⚐ 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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: ETag of the outbound endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the outbound endpoint. ,
Required: False ,
}
{
subnet:
{
Description: The reference to the subnet used for the outbound endpoint. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
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: Enumeration of the outbound endpoints for a DNS resolver. ,
Required: False ,
}
[
{
etag:
{
Description: ETag of the outbound endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the outbound endpoint. ,
Required: False ,
}
{
subnet:
{
Description: The reference to the subnet used for the outbound endpoint. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
etag:
{
Description: ETag of the DNS forwarding ruleset. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: False ,
}
{
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: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}

⚐ Response (201)

{
etag:
{
Description: ETag of the DNS forwarding ruleset. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: False ,
}
{
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: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
etag:
{
Description: ETag of the DNS forwarding ruleset. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: False ,
}
{
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: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ 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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
tags:
{
Description: Tags for DNS Resolver. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
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)

{
etag:
{
Description: ETag of the DNS forwarding ruleset. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: False ,
}
{
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: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ 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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
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)

{}

⚐ 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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: ETag of the DNS forwarding ruleset. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: False ,
}
{
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: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: Enumeration of the DNS forwarding rulesets. ,
Required: False ,
}
[
{
etag:
{
Description: ETag of the DNS forwarding ruleset. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: False ,
}
{
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: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
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
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: Enumeration of the DNS forwarding rulesets. ,
Required: False ,
}
[
{
etag:
{
Description: ETag of the DNS forwarding ruleset. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DNS forwarding ruleset. ,
Required: False ,
}
{
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: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
etag:
{
Description: ETag of the forwarding rule. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the forwarding rule. ,
Required: False ,
}
{
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: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}

⚐ Response (201)

{
etag:
{
Description: ETag of the forwarding rule. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the forwarding rule. ,
Required: False ,
}
{
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: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
etag:
{
Description: ETag of the forwarding rule. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the forwarding rule. ,
Required: False ,
}
{
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: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
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: False ,
}
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 ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
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)

{
etag:
{
Description: ETag of the forwarding rule. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the forwarding rule. ,
Required: False ,
}
{
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: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
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}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: ETag of the forwarding rule. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the forwarding rule. ,
Required: False ,
}
{
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: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
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: Enumeration of the forwarding rules. ,
Required: False ,
}
[
{
etag:
{
Description: ETag of the forwarding rule. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the forwarding rule. ,
Required: False ,
}
{
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: False ,
}
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
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
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 virtual network. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: Enumeration of the sub-resources. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
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
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 virtual network. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: Enumeration of the Virtual Network DNS Forwarding Ruleset. ,
Required: False ,
}
[
{
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: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
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 ,
]
,
}
,
}