< Back

Remove-AzureRmDnsZone

Tue Jan 29, 2019 9:46 pm

NAME Remove-AzureRmDnsZone



SYNOPSIS

Removes a DNS zone from a resource group.





SYNTAX

Remove-AzureRmDnsZone [-DefaultProfile <IAzureContextContainer>] [-Force] -Name <String> [-PassThru] -ResourceGroupName <String> [-Confirm]

[-WhatIf] [<CommonParameters>]



Remove-AzureRmDnsZone [-DefaultProfile <IAzureContextContainer>] [-Force] [-Overwrite] [-PassThru] -Zone <DnsZone> [-Confirm] [-WhatIf]

[<CommonParameters>]





DESCRIPTION

The Remove-AzureRmDnsZone cmdlet permanently deletes a Domain Name System (DNS) zone from a specified resource group. All record sets contained in

the zone are also deleted.



You can pass a DnsZone object using the Name parameter or by using the pipeline operator, or alternatively you can specify the ZoneName 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 DnsZone object (passed via the pipeline or Zone parameter), the zone is not deleted if it has been changed in

Azure DNS since the local DnsZone 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.





PARAMETERS

-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Force [<SwitchParameter>]

This parameter is deprecated for this cmdlet. It will be removed in a future release.



To control whether this cmdlet prompts you for confirmation, use the Confirm parameter.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

Specifies the name of the DNS zone that this cmdlet removes. You must also specify the ResourceGroupName parameter.



Alternatively, you can specify the DNS zone using the Zone parameter.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Overwrite [<SwitchParameter>]

When specifying the zone using a DnsZone object (passed via the pipeline or Zone parameter), the zone is not deleted if it has been changed in

Azure DNS since the local DnsZone 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.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

passthru



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-ResourceGroupName <String>

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 DnsZone object, passed via either the pipeline or the Zone parameter.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Zone <DnsZone>

Specifies the DNS zone to delete. The DnsZone object passed can also be passed via the pipeline.



Alternatively, you can specify the DNS zone to delete by using the ZoneName and ResourceGroupName parameters.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

Microsoft.Azure.Commands.Dns.DnsZone

You can pipe a DnsZone object to this cmdlet.





OUTPUTS

None

This cmdlet does not generate any output.





NOTES





Due to the potentially high impact of deleting a DNS zone, by default, this cmdlet prompts for confirmation if the $ConfirmPreference Windows

PowerShell variable has any value other than None.



If you specify Confirm or Confirm:$True , this cmdlet prompts you for confirmation before it runs. If you specify Confirm:$False , the cmdlet

does not prompt you for confirmation.



Example 1: Remove a zone



PS C:\\>Remove-AzureRmDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup"



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







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... ermdnszone

Get-AzureRmDnsZone

New-AzureRmDnsZone

Set-AzureRmDnsZone