Skip to content

Latest commit

 

History

History
216 lines (167 loc) · 6.12 KB

Remove-AzPrivateDnsZone.md

File metadata and controls

216 lines (167 loc) · 6.12 KB
external help file Module Name online version schema
Microsoft.Azure.PowerShell.Cmdlets.PrivateDns.dll-Help.xml
Az.PrivateDns
2.0.0

Remove-AzPrivateDnsZone

SYNOPSIS

Removes a private DNS zone from a resource group.

SYNTAX

Fields (Default)

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

Object

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

ResourceId

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

-DefaultProfile

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

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
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: System.String
Parameter Sets: Fields
Aliases:

Required: True
Position: Named
Default value: None
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: System.Management.Automation.SwitchParameter
Parameter Sets: Object
Aliases:

Required: False
Position: Named
Default value: None
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: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

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

-PrivateZone

The private zone object to delete.

Type: Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsZone
Parameter Sets: Object
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
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: System.String
Parameter Sets: Fields
Aliases:

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

-ResourceId

Private DNS Zone ResourceID.

Type: System.String
Parameter Sets: ResourceId
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

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

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsZone

System.String

OUTPUTS

System.Boolean

NOTES

RELATED LINKS

Get-AzPrivateDnsZone

New-AzPrivateDnsZone

Set-AzPrivateDnsZone