Disable-AzureTrafficManagerProfile.md

external help file	ms.assetid	online version	schema
Microsoft.WindowsAzure.Commands.TrafficManager.dll-Help.xml	ECE9C2A6-7DA2-4477-B877-9970FBE26D7C		2.0.0

Disable-AzureTrafficManagerProfile

SYNOPSIS

Disables a Traffic Manager profile.

[!INCLUDE rdfe-banner]

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.

PARAMETERS

-Name

Specifies the name of the Traffic Manager profile to disable.

Type: String
Parameter Sets: (All)
Aliases: 

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

-PassThru

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
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
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
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 (https://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

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.

NOTES

RELATED LINKS

Enable-AzureTrafficManagerProfile

Get-AzureTrafficManagerProfile

New-AzureTrafficManagerProfile

Remove-AzureTrafficManagerProfile

Set-AzureTrafficManagerProfile