Disable-​Azure​Traffic​Manager​Profile

Disables a Traffic Manager profile.

Syntax

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

Description

The Disable-AzureTrafficManagerProfile cmdlet disables a Microsoft Azure Traffic Manager profile. You can use the PassThru parameter to display whether the operation succeeds.

Examples

Example 1: Disable a Traffic Manager profile and display the results

PS C:\>Disable-AzureTrafficManagerProfile -Name "MyProfile" -PassThru
True

This command disables the Traffic Manager profile named MyProfile. The command specifies the PassThru parameter to display whether the command succeeded.

Example 2: Disable a Traffic Manager profile and display no results

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

This command disables the Traffic Manager profile named MyProfile but does not display whether the command succeeded.

Required Parameters

-Name

Specifies the name of the Traffic Manager profile to disable.

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

Optional Parameters

-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
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
Accept pipeline input:False
Accept wildcard characters:False

Outputs

System.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.