Disable-AzureRmTrafficManagerProfile
Disables a Traffic Manager profile.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Disable-AzureRmTrafficManagerProfile
-Name <String>
-ResourceGroupName <String>
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Disable-AzureRmTrafficManagerProfile
-TrafficManagerProfile <TrafficManagerProfile>
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Disable-AzureRmTrafficManagerProfile cmdlet disables an Azure Traffic Manager profile. You can specify the profile object by using the pipeline or as a parameter value. Alternatively, you can specify the profile by using the Name and ResourceGroupName parameters.
Examples
Example 1: Disable a profile specified by name
PS C:\>Disable-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11"
This command disables the profile named ContosoProfile in ResourceGroup11. The command prompts you for confirmation.
Example 2: Disable a profile by using the pipeline
PS C:\>Get-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" | Disable-AzureRmTrafficManagerProfile -Force
This command gets the profile named ContosoProfile in ResourceGroup11. The command then passes that profile to the Disable-AzureRmTrafficManagerProfile cmdlet by using the pipeline operator. That cmdlet disables 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: | 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 disables.
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 disables 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 disable. To obtain a TrafficManagerProfile object, use the Get-AzureRmTrafficManagerProfile 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 |
Inputs
Microsoft.Azure.Commands.Network.TrafficManagerProfile
This cmdlet accepts a TrafficManagerProfile object.