Remove-AzTrafficManagerProfile
Deletes a Traffic Manager profile.
Syntax
Remove-AzTrafficManagerProfile
-Name <String>
-ResourceGroupName <String>
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-AzTrafficManagerProfile
-TrafficManagerProfile <TrafficManagerProfile>
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Remove-AzTrafficManagerProfile cmdlet deletes an Azure Traffic Manager profile. Specify the profile to delete by using the Name and ResourceGroupName parameters. Alternatively, you can specify a TrafficManagerProfile object using the TrafficManagerProfile parameter, or you can use the pipeline.
Examples
Example 1: Delete a profile specified by name
Remove-AzTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11"
This command deletes the profile named ContosoProfile in ResourceGroup11. The command prompts you for confirmation.
Example 2: Delete a profile by using the pipeline
Get-AzTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" | Remove-AzTrafficManagerProfile -Force
This command gets the profile named ContosoProfile in ResourceGroup11. The command then passes that profile to the Remove-AzTrafficManagerProfile cmdlet by using the pipeline operator. That cmdlet deletes that profile. The command specifies the Force parameter. Therefore, it does not prompt you for confirmation.
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 |
-Force
Forces the command to run without asking for user confirmation.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Specifies the name of the Traffic Manager profile that this cmdlet deletes.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
Specifies the name of a resource group. This cmdlet deletes a Traffic Manager profile in the group that this parameter specifies.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TrafficManagerProfile
Specifies a TrafficManagerProfile object to delete. To obtain a TrafficManagerProfile object, use the Get-AzTrafficManagerProfile cmdlet.
Type: | TrafficManagerProfile |
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 |