Remove-AzPrivateDnsZone

  • Reference
Module:
Az.PrivateDns

Removes a private DNS zone from a resource group.

Syntax

Remove-AzPrivateDnsZone
      -ResourceGroupName <String>
      -Name <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzPrivateDnsZone
      -PrivateZone <PSPrivateDnsZone>
      [-Overwrite]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzPrivateDnsZone
      -ResourceId <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AzPrivateDnsZone cmdlet permanently deletes a private Domain Name System (DNS) zone from a specified resource group. All record sets contained in the zone are also deleted. You can pass a PrivateDnsZone object using the PrivateZone parameter or by using the pipeline operator, or alternatively you can specify the Name and ResourceGroupName parameters. You can use the Confirm parameter and $ConfirmPreference Windows PowerShell variable to control whether the cmdlet prompts you for confirmation. When specifying the zone using a PrivateDnsZone object (passed via the pipeline or Zone parameter), the zone is not deleted if it has been changed in Azure DNS since the local PrivateDnsZone object was retrieved (only operations directly on the DNS zone resource count as changes, operations on record sets within the zone do not). This provides protection for concurrent zone changes. This can be suppressed using the Overwrite parameter, which deletes the zone regardless of concurrent changes.

Examples

Example 1: Remove a private zone

Remove-AzPrivateDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup"

This command removes the zone named myzone.com from the resource group named MyResourceGroup.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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 private DNS zone that this cmdlet removes. You must also specify the ResourceGroupName parameter. Alternatively, you can specify the DNS zone using the Zone parameter.

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

-Overwrite

When specifying the zone using a PrivateDnsZone object (passed via the pipeline or Zone parameter), the zone is not deleted if it has been changed in Azure DNS since the local PrivateDnsZone object was retrieved (only operations directly on the DNS zone resource count as changes, operations on record sets within the zone do not). This provides protection for concurrent zone changes. This can be suppressed using the Overwrite parameter, which deletes the zone regardless of concurrent changes.

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

-PassThru

Used for passing the result (boolean) of the operation delete private zone further down the pipeline.

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

-PrivateZone

The private zone object to delete.

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

-ResourceGroupName

Specifies the name of the resource group that contains the zone to remove. You must also specify the ZoneName parameter. Alternatively, you can specify the DNS zone using a PrivateDnsZone object, passed via either the pipeline or the Zone parameter.

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

-ResourceId

Private DNS Zone ResourceID.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PSPrivateDnsZone

String

Outputs

Boolean