Private Zones - Get

Service:

DNS

API Version:

2018-09-01

Gets a Private DNS zone. Retrieves the zone properties, but not the virtual networks links or the record sets within the zone.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}?api-version=2018-09-01

URI Parameters

Name	In	Required	Type	Description
privateZoneName	path	True	string	The name of the Private DNS zone (without a terminating dot).
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client Api Version.

Responses

Name	Type	Description
200 OK	PrivateZone	Success.
Other Status Codes	CloudError	Default response. It will be deserialized as per the Error definition.

Examples

GET Private DNS Zone

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com?api-version=2018-09-01

Sample Response

Status code:

200

{
  "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com",
  "name": "privatezone1.com",
  "type": "Microsoft.Network/privateDnsZones",
  "location": "global",
  "etag": "00000000-0000-0000-0000-000000000000",
  "properties": {
    "maxNumberOfRecordSets": 5000,
    "numberOfRecordSets": 1,
    "maxNumberOfVirtualNetworkLinks": 100,
    "numberOfVirtualNetworkLinks": 0,
    "maxNumberOfVirtualNetworkLinksWithRegistration": 50,
    "numberOfVirtualNetworkLinksWithRegistration": 0,
    "provisioningState": "Succeeded"
  },
  "tags": {
    "key1": "value1"
  }
}

Definitions

Name	Description
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
PrivateZone	Describes a Private DNS zone.
ProvisioningState	The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored.

CloudError

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

An error response from the service.

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

PrivateZone

Describes a Private DNS zone.

Name	Type	Description
etag	string	The ETag of the zone.
id	string	Fully qualified resource Id for the resource. Example - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}'.
location	string	The Azure Region where the resource lives
name	string	The name of the resource
properties.maxNumberOfRecordSets	integer	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.
properties.maxNumberOfVirtualNetworkLinks	integer	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.
properties.maxNumberOfVirtualNetworkLinksWithRegistration	integer	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.
properties.numberOfRecordSets	integer	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.
properties.numberOfVirtualNetworkLinks	integer	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.
properties.numberOfVirtualNetworkLinksWithRegistration	integer	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.
properties.provisioningState	ProvisioningState	The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored.
tags	object	Resource tags.
type	string	The type of the resource. Example - 'Microsoft.Network/privateDnsZones'.

ProvisioningState

The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored.

Name	Type	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string