Microsoft.Network (stable:2020-06-01)

2025/09/05 • 17 new, 17 deleted methods

PrivateZones_CreateOrUpdate (new)
Description :  Creates or updates a Private DNS zone. Does not modify Links to virtual networks or DNS records within the zone.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
privateZoneName:
{
Description: The name of the Private DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
etag:
{
Description: The ETag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Private DNS zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinks:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinks:
{
Description: The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinksWithRegistration:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinksWithRegistration:
{
Description: The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. 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 ,
internalId:
{
Description: Private zone internal Id ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: The ETag of the Private DNS zone. Omit this value to always overwrite the current zone. 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 Private DNS zone to be created, but to prevent updating an existing zone. Other values will be ignored. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
etag:
{
Description: The ETag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Private DNS zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinks:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinks:
{
Description: The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinksWithRegistration:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinksWithRegistration:
{
Description: The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. 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 ,
internalId:
{
Description: Private zone internal Id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
etag:
{
Description: The ETag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Private DNS zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinks:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinks:
{
Description: The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinksWithRegistration:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinksWithRegistration:
{
Description: The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. 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 ,
internalId:
{
Description: Private zone internal Id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateZones_Update (new)
Description :  Updates a Private DNS zone. Does not modify virtual network links or DNS records within the zone.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
privateZoneName:
{
Description: The name of the Private DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
etag:
{
Description: The ETag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Private DNS zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinks:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinks:
{
Description: The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinksWithRegistration:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinksWithRegistration:
{
Description: The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. 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 ,
internalId:
{
Description: Private zone internal Id ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: The ETag of the Private DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The ETag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Private DNS zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinks:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinks:
{
Description: The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinksWithRegistration:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinksWithRegistration:
{
Description: The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. 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 ,
internalId:
{
Description: Private zone internal Id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateZones_Delete (new)
Description :  Deletes a Private DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone. Private DNS zone cannot be deleted unless all virtual network links to it are removed.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
privateZoneName:
{
Description: The name of the Private DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
If-Match:
{
Description: The ETag of the Private DNS zone. Omit this value to always delete the current zone. Specify the last-seen ETag value to prevent accidentally deleting any concurrent changes. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateZones_Get (new)
Description :  Gets a Private DNS zone. Retrieves the zone properties, but not the virtual networks links or the record sets within the zone.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
privateZoneName:
{
Description: The name of the Private DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The ETag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Private DNS zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinks:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinks:
{
Description: The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinksWithRegistration:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinksWithRegistration:
{
Description: The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. 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 ,
internalId:
{
Description: Private zone internal Id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateZones_List (new)
Description :  Lists the Private DNS zones in all resource groups in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/privateDnsZones
{
$top:
{
Description: The maximum number of Private DNS zones to return. If not specified, returns up to 100 zones. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Information about the Private DNS zones. ,
Required: False ,
}
[
{
etag:
{
Description: The ETag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Private DNS zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinks:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinks:
{
Description: The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinksWithRegistration:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinksWithRegistration:
{
Description: The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. 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 ,
internalId:
{
Description: Private zone internal Id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateZones_ListByResourceGroup (new)
Description :  Lists the Private DNS zones within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of record sets to return. If not specified, returns up to 100 record sets. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Information about the Private DNS zones. ,
Required: False ,
}
[
{
etag:
{
Description: The ETag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Private DNS zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinks:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinks:
{
Description: The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinksWithRegistration:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinksWithRegistration:
{
Description: The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. 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 ,
internalId:
{
Description: Private zone internal Id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RecordSets_CreateOrUpdate (new)
Description :  Creates or updates a record set within a Private DNS zone.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/{recordType}/{relativeRecordSetName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
privateZoneName:
{
Description: The name of the Private DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
recordType:
{
Description: The type of DNS record in this record set. Record sets of type SOA can be updated but not created (they are created when the Private DNS zone is created). ,
Required: True ,
}
string ,
relativeRecordSetName:
{
Description: The name of the record set, relative to the name of the zone. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The ETag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
ttl:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
isAutoRegistered:
{
Description: Is the record set auto-registered in the Private DNS zone through a virtual network link? ,
Required: False ,
}
boolean ,
aRecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
aaaaRecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
cnameRecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
mxRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
ptrRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
soaRecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTtl:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
srvRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
txtRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
If-Match:
{
Description: The ETag of the record set. Omit this value to always overwrite the current record set. 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 record set to be created, but to prevent updating an existing record set. Other values will be ignored. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The ETag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
ttl:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
isAutoRegistered:
{
Description: Is the record set auto-registered in the Private DNS zone through a virtual network link? ,
Required: False ,
}
boolean ,
aRecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
aaaaRecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
cnameRecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
mxRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
ptrRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
soaRecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTtl:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
srvRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
txtRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The ETag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
ttl:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
isAutoRegistered:
{
Description: Is the record set auto-registered in the Private DNS zone through a virtual network link? ,
Required: False ,
}
boolean ,
aRecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
aaaaRecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
cnameRecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
mxRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
ptrRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
soaRecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTtl:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
srvRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
txtRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RecordSets_Update (new)
Description :  Updates a record set within a Private DNS zone.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/{recordType}/{relativeRecordSetName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
privateZoneName:
{
Description: The name of the Private DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
recordType:
{
Description: The type of DNS record in this record set. ,
Required: True ,
}
string ,
relativeRecordSetName:
{
Description: The name of the record set, relative to the name of the zone. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The ETag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
ttl:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
isAutoRegistered:
{
Description: Is the record set auto-registered in the Private DNS zone through a virtual network link? ,
Required: False ,
}
boolean ,
aRecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
aaaaRecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
cnameRecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
mxRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
ptrRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
soaRecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTtl:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
srvRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
txtRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
If-Match:
{
Description: The ETag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The ETag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
ttl:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
isAutoRegistered:
{
Description: Is the record set auto-registered in the Private DNS zone through a virtual network link? ,
Required: False ,
}
boolean ,
aRecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
aaaaRecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
cnameRecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
mxRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
ptrRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
soaRecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTtl:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
srvRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
txtRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RecordSets_Delete (new)
Description :  Deletes a record set from a Private DNS zone. This operation cannot be undone.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/{recordType}/{relativeRecordSetName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
privateZoneName:
{
Description: The name of the Private DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
recordType:
{
Description: The type of DNS record in this record set. Record sets of type SOA cannot be deleted (they are deleted when the Private DNS zone is deleted). ,
Required: True ,
}
string ,
relativeRecordSetName:
{
Description: The name of the record set, relative to the name of the zone. ,
Required: True ,
}
string ,
If-Match:
{
Description: The ETag of the record set. Omit this value to always delete the current record set. Specify the last-seen ETag value to prevent accidentally deleting any concurrent changes. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RecordSets_Get (new)
Description :  Gets a record set.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/{recordType}/{relativeRecordSetName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
privateZoneName:
{
Description: The name of the Private DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
recordType:
{
Description: The type of DNS record in this record set. ,
Required: True ,
}
string ,
relativeRecordSetName:
{
Description: The name of the record set, relative to the name of the zone. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The ETag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
ttl:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
isAutoRegistered:
{
Description: Is the record set auto-registered in the Private DNS zone through a virtual network link? ,
Required: False ,
}
boolean ,
aRecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
aaaaRecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
cnameRecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
mxRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
ptrRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
soaRecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTtl:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
srvRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
txtRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RecordSets_ListByType (new)
Description :  Lists the record sets of a specified type in a Private DNS zone.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/{recordType}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
privateZoneName:
{
Description: The name of the Private DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
recordType:
{
Description: The type of record sets to enumerate. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of record sets to return. If not specified, returns up to 100 record sets. ,
Format: int32 ,
Required: False ,
}
integer ,
$recordsetnamesuffix:
{
Description: The suffix label of the record set name to be used to filter the record set enumeration. If this parameter is specified, the returned enumeration will only contain records that end with ".". ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Information about the record sets in the response. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The ETag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
ttl:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
isAutoRegistered:
{
Description: Is the record set auto-registered in the Private DNS zone through a virtual network link? ,
Required: False ,
}
boolean ,
aRecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
aaaaRecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
cnameRecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
mxRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
ptrRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
soaRecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTtl:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
srvRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
txtRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RecordSets_List (new)
Description :  Lists all record sets in a Private DNS zone.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/ALL
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
privateZoneName:
{
Description: The name of the Private DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of record sets to return. If not specified, returns up to 100 record sets. ,
Format: int32 ,
Required: False ,
}
integer ,
$recordsetnamesuffix:
{
Description: The suffix label of the record set name to be used to filter the record set enumeration. If this parameter is specified, the returned enumeration will only contain records that end with ".". ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Information about the record sets in the response. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The ETag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
ttl:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
isAutoRegistered:
{
Description: Is the record set auto-registered in the Private DNS zone through a virtual network link? ,
Required: False ,
}
boolean ,
aRecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
aaaaRecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
cnameRecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
mxRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
ptrRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
soaRecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTtl:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
srvRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
txtRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateZones_CreateOrUpdate (removed)
Description :  Creates or updates a Private DNS zone. Does not modify Links to virtual networks or DNS records within the zone.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
privateZoneName:
{
Description: The name of the Private DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
etag:
{
Description: The ETag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Private DNS zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinks:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinks:
{
Description: The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinksWithRegistration:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinksWithRegistration:
{
Description: The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. 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 ,
internalId:
{
Description: Private zone internal Id ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: The ETag of the Private DNS zone. Omit this value to always overwrite the current zone. 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 Private DNS zone to be created, but to prevent updating an existing zone. Other values will be ignored. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
etag:
{
Description: The ETag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Private DNS zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinks:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinks:
{
Description: The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinksWithRegistration:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinksWithRegistration:
{
Description: The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. 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 ,
internalId:
{
Description: Private zone internal Id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
etag:
{
Description: The ETag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Private DNS zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinks:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinks:
{
Description: The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinksWithRegistration:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinksWithRegistration:
{
Description: The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. 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 ,
internalId:
{
Description: Private zone internal Id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateZones_Update (removed)
Description :  Updates a Private DNS zone. Does not modify virtual network links or DNS records within the zone.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
privateZoneName:
{
Description: The name of the Private DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
etag:
{
Description: The ETag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Private DNS zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinks:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinks:
{
Description: The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinksWithRegistration:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinksWithRegistration:
{
Description: The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. 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 ,
internalId:
{
Description: Private zone internal Id ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: The ETag of the Private DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The ETag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Private DNS zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinks:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinks:
{
Description: The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinksWithRegistration:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinksWithRegistration:
{
Description: The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. 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 ,
internalId:
{
Description: Private zone internal Id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateZones_Delete (removed)
Description :  Deletes a Private DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone. Private DNS zone cannot be deleted unless all virtual network links to it are removed.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
privateZoneName:
{
Description: The name of the Private DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
If-Match:
{
Description: The ETag of the Private DNS zone. Omit this value to always delete the current zone. Specify the last-seen ETag value to prevent accidentally deleting any concurrent changes. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateZones_Get (removed)
Description :  Gets a Private DNS zone. Retrieves the zone properties, but not the virtual networks links or the record sets within the zone.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
privateZoneName:
{
Description: The name of the Private DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The ETag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Private DNS zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinks:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinks:
{
Description: The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinksWithRegistration:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinksWithRegistration:
{
Description: The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. 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 ,
internalId:
{
Description: Private zone internal Id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateZones_List (removed)
Description :  Lists the Private DNS zones in all resource groups in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/privateDnsZones
{
$top:
{
Description: The maximum number of Private DNS zones to return. If not specified, returns up to 100 zones. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Information about the Private DNS zones. ,
Required: False ,
}
[
{
etag:
{
Description: The ETag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Private DNS zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinks:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinks:
{
Description: The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinksWithRegistration:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinksWithRegistration:
{
Description: The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. 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 ,
internalId:
{
Description: Private zone internal Id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateZones_ListByResourceGroup (removed)
Description :  Lists the Private DNS zones within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of record sets to return. If not specified, returns up to 100 record sets. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Information about the Private DNS zones. ,
Required: False ,
}
[
{
etag:
{
Description: The ETag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Private DNS zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinks:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinks:
{
Description: The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfVirtualNetworkLinksWithRegistration:
{
Description: The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfVirtualNetworkLinksWithRegistration:
{
Description: The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the resource. 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 ,
internalId:
{
Description: Private zone internal Id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RecordSets_CreateOrUpdate (removed)
Description :  Creates or updates a record set within a Private DNS zone.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/{recordType}/{relativeRecordSetName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
privateZoneName:
{
Description: The name of the Private DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
recordType:
{
Description: The type of DNS record in this record set. Record sets of type SOA can be updated but not created (they are created when the Private DNS zone is created). ,
Required: True ,
}
string ,
relativeRecordSetName:
{
Description: The name of the record set, relative to the name of the zone. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The ETag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
ttl:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
isAutoRegistered:
{
Description: Is the record set auto-registered in the Private DNS zone through a virtual network link? ,
Required: False ,
}
boolean ,
aRecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
aaaaRecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
cnameRecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
mxRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
ptrRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
soaRecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTtl:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
srvRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
txtRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
If-Match:
{
Description: The ETag of the record set. Omit this value to always overwrite the current record set. 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 record set to be created, but to prevent updating an existing record set. Other values will be ignored. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The ETag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
ttl:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
isAutoRegistered:
{
Description: Is the record set auto-registered in the Private DNS zone through a virtual network link? ,
Required: False ,
}
boolean ,
aRecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
aaaaRecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
cnameRecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
mxRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
ptrRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
soaRecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTtl:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
srvRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
txtRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The ETag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
ttl:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
isAutoRegistered:
{
Description: Is the record set auto-registered in the Private DNS zone through a virtual network link? ,
Required: False ,
}
boolean ,
aRecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
aaaaRecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
cnameRecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
mxRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
ptrRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
soaRecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTtl:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
srvRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
txtRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RecordSets_Update (removed)
Description :  Updates a record set within a Private DNS zone.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/{recordType}/{relativeRecordSetName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
privateZoneName:
{
Description: The name of the Private DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
recordType:
{
Description: The type of DNS record in this record set. ,
Required: True ,
}
string ,
relativeRecordSetName:
{
Description: The name of the record set, relative to the name of the zone. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The ETag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
ttl:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
isAutoRegistered:
{
Description: Is the record set auto-registered in the Private DNS zone through a virtual network link? ,
Required: False ,
}
boolean ,
aRecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
aaaaRecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
cnameRecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
mxRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
ptrRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
soaRecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTtl:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
srvRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
txtRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
If-Match:
{
Description: The ETag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The ETag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
ttl:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
isAutoRegistered:
{
Description: Is the record set auto-registered in the Private DNS zone through a virtual network link? ,
Required: False ,
}
boolean ,
aRecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
aaaaRecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
cnameRecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
mxRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
ptrRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
soaRecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTtl:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
srvRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
txtRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RecordSets_Delete (removed)
Description :  Deletes a record set from a Private DNS zone. This operation cannot be undone.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/{recordType}/{relativeRecordSetName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
privateZoneName:
{
Description: The name of the Private DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
recordType:
{
Description: The type of DNS record in this record set. Record sets of type SOA cannot be deleted (they are deleted when the Private DNS zone is deleted). ,
Required: True ,
}
string ,
relativeRecordSetName:
{
Description: The name of the record set, relative to the name of the zone. ,
Required: True ,
}
string ,
If-Match:
{
Description: The ETag of the record set. Omit this value to always delete the current record set. Specify the last-seen ETag value to prevent accidentally deleting any concurrent changes. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RecordSets_Get (removed)
Description :  Gets a record set.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/{recordType}/{relativeRecordSetName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
privateZoneName:
{
Description: The name of the Private DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
recordType:
{
Description: The type of DNS record in this record set. ,
Required: True ,
}
string ,
relativeRecordSetName:
{
Description: The name of the record set, relative to the name of the zone. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The ETag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
ttl:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
isAutoRegistered:
{
Description: Is the record set auto-registered in the Private DNS zone through a virtual network link? ,
Required: False ,
}
boolean ,
aRecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
aaaaRecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
cnameRecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
mxRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
ptrRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
soaRecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTtl:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
srvRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
txtRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RecordSets_ListByType (removed)
Description :  Lists the record sets of a specified type in a Private DNS zone.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/{recordType}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
privateZoneName:
{
Description: The name of the Private DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
recordType:
{
Description: The type of record sets to enumerate. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of record sets to return. If not specified, returns up to 100 record sets. ,
Format: int32 ,
Required: False ,
}
integer ,
$recordsetnamesuffix:
{
Description: The suffix label of the record set name to be used to filter the record set enumeration. If this parameter is specified, the returned enumeration will only contain records that end with ".". ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Information about the record sets in the response. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The ETag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
ttl:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
isAutoRegistered:
{
Description: Is the record set auto-registered in the Private DNS zone through a virtual network link? ,
Required: False ,
}
boolean ,
aRecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
aaaaRecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
cnameRecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
mxRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
ptrRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
soaRecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTtl:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
srvRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
txtRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RecordSets_List (removed)
Description :  Lists all record sets in a Private DNS zone.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/ALL
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
privateZoneName:
{
Description: The name of the Private DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of record sets to return. If not specified, returns up to 100 record sets. ,
Format: int32 ,
Required: False ,
}
integer ,
$recordsetnamesuffix:
{
Description: The suffix label of the record set name to be used to filter the record set enumeration. If this parameter is specified, the returned enumeration will only contain records that end with ".". ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Information about the record sets in the response. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The ETag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
ttl:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
isAutoRegistered:
{
Description: Is the record set auto-registered in the Private DNS zone through a virtual network link? ,
Required: False ,
}
boolean ,
aRecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
aaaaRecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
cnameRecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
mxRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
ptrRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
soaRecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTtl:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
srvRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
txtRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}