Disable-AzureTrafficManagerProfile
Disables 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
Default (Default)
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-PassThru
Returns $True if the operation succeeded; otherwise, $False. By default, this cmdlet does not generate any output.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | AzureSMProfile |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
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.