Edit

Share via

Remove-AzureTrafficManagerProfile

  • Reference
Module:
Azure

Removes a Traffic Manager profile.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

Remove-AzureTrafficManagerProfile
      -Name <String>
      [-Force]
      [-PassThru]
      [-Profile <AzureSMProfile>]
      [<CommonParameters>]

Description

The Remove-AzureTrafficManagerProfile cmdlet removes a Microsoft Azure Traffic Manager profile from the current subscription.

Examples

Example 1: Remove a Traffic Manager profile

PS C:\>Remove-AzureTrafficManagerProfile -Name "MyProfile"

This command removes the Traffic Manager profile named MyProfile.

Example 2: Remove a Traffic Manager profile

PS C:\>Remove-AzureTrafficManagerProfile -Name "MyProfile" -Force -PassThru

This command removes the Traffic Manager profile named MyProfile without prompting you for confirmation, and returns the results.

Parameters

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

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

-PassThru

Returns $True if the operation succeeded; otherwise, $False. By default, this cmdlet does not generate any output.

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

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

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

Outputs

Boolean

This cmdlet generates $True or $False. If the operation is successful and if you specify the PassThru parameter, this cmdlet returns a value of $True.