Get-AzDnsZone

  • Reference
Module:
Az.Dns

Gets a DNS zone.

Syntax

Get-AzDnsZone
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzDnsZone
   [-Name <String>]
   -ResourceGroupName <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzDnsZone cmdlet gets a Domain Name System (DNS) zone from the specified resource group. If you specify the Name parameter, a single DnsZone 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 DnsZone object to update the zone, for example you can add RecordSet objects to it.

Examples

Example 1: Get a zone

$Zone = Get-AzDnsZone -ResourceGroupName "MyResourceGroup" -Name "myzone.com"

This example gets the 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-AzDnsZone -ResourceGroupName "MyResourceGroup"

This example gets all of the 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-AzDnsZone

This example gets all of the 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

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the name of the DNS zone to get. If you do not specify a value for the Name parameter, this cmdlet gets all DNS zones in the specified resource group. If you also omit the ResourceGroupName parameter, this cmdlet gets all DNS zones in the current Azure subscription.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

Specifies the name of the resource group that contains the 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 DNS zones in the current Azure subscription.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String

Outputs

DnsZone