Get-AzPrivateDnsZone
Gets a Private DNS zone.
Syntax
Default (Default)
Get-AzPrivateDnsZone
[-ResourceGroupName <String>]
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzPrivateDnsZone cmdlet gets a Private Domain Name System (DNS) zone from the specified resource group. If you specify the Name parameter, a single PrivateDnsZone object is returned. If you do not specify the Name parameter, an array containing all of the zones in the specified resource group is returned. You can use the PrivateDnsZone object to update the zone, for example you can add RecordSet objects to it.
Examples
Example 1: Get a zone
$Zone = Get-AzPrivateDnsZone -ResourceGroupName "MyResourceGroup" -Name "myzone.com"
Name : myzone.com
ResourceId: : "/subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/PrivateZones/myzone.com"
ResourceGroupName : MyResourceGroup
Location :
Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Tags : {}
NumberOfRecordSets : 1
MaxNumberOfRecordSets : 5000
This example gets the Private DNS zone named myzone.com from the specified resource group, and then stores it in the $Zone variable.
Example 2: Get all of the zones in a resource group
$Zones = Get-AzPrivateDnsZone -ResourceGroupName "MyResourceGroup"
Name : zone1.com
ResourceId : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Micros
oft.Network/privateDnsZones/zone1.com
ResourceGroupName : MyResourceGroup
Location :
Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Tags :
NumberOfRecordSets : 1
MaxNumberOfRecordSets : 5000
Name : zone2.com
ResourceId : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Micros
oft.Network/privateDnsZones/zone2.com
ResourceGroupName : MyResourceGroup
Location :
Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Tags :
NumberOfRecordSets : 1
MaxNumberOfRecordSets : 5000
This example gets all of the Private DNS zones in the specified resource group, and then stores it in the $Zones variable.
Example 3: Get all of the zones in a subscription
$Zones = Get-AzPrivateDnsZone
Name : zone1.com
ResourceId : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup1/providers/Micros
oft.Network/privateDnsZones/zone1.com
ResourceGroupName : MyResourceGroup1
Location :
Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Tags :
NumberOfRecordSets : 1
MaxNumberOfRecordSets : 5000
Name : zone2.com
ResourceId : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup2/providers/Micros
oft.Network/privateDnsZones/zone2.com
ResourceGroupName : MyResourceGroup2
Location :
Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Tags :
NumberOfRecordSets : 1
MaxNumberOfRecordSets : 5000
This example gets all of the Private DNS zones in the current Azure subscription, and then stores them in the $Zones variable.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies the name of the Private DNS zone to get. If you do not specify a value for the Name parameter, this cmdlet gets all Private DNS zones in the specified resource group. If you also omit the ResourceGroupName parameter, this cmdlet gets all Private DNS zones in the current Azure subscription.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResourceGroupName
Specifies the name of the resource group that contains the Private DNS zone to get. If you do not specify the ResourceGroupName, then you must also omit the Name parameter. In this case, this cmdlet gets all Private DNS zones in the current Azure subscription.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
