Edit

Share via


Get-AzDnsZone

Gets a DNS zone.

Syntax

Default (Default)

Get-AzDnsZone
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ResourceGroup

Get-AzDnsZone
    -ResourceGroupName <String>
    [-Name <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

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 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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ResourceGroup
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ResourceGroup
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
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.

Inputs

String

Outputs

DnsZone