< Back

Disable-AzureRmTrafficManagerProfile

Tue Jan 29, 2019 10:11 pm

NAME Disable-AzureRmTrafficManagerProfile



SYNOPSIS

Disables a Traffic Manager profile.





SYNTAX

Disable-AzureRmTrafficManagerProfile [-DefaultProfile <IAzureContextContainer>] [-Force] -Name <String> -ResourceGroupName <String> [-Confirm]

[-WhatIf] [<CommonParameters>]



Disable-AzureRmTrafficManagerProfile [-DefaultProfile <IAzureContextContainer>] [-Force] -TrafficManagerProfile <TrafficManagerProfile> [-Confirm]

[-WhatIf] [<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.





PARAMETERS

-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Force [<SwitchParameter>]

Forces the command to run without asking for user confirmation.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

Specifies the name of the Traffic Manager profile that this cmdlet disables.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ResourceGroupName <String>

Specifies the name of a resource group. This cmdlet disables a Traffic Manager profile in the group that this parameter specifies.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-TrafficManagerProfile <TrafficManagerProfile>

Specifies a TrafficManagerProfile object to disable. To obtain a TrafficManagerProfile object, use the Get-AzureRmTrafficManagerProfile cmdlet.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

Microsoft.Azure.Commands.Network.TrafficManagerProfile

This cmdlet accepts a TrafficManagerProfile object.





OUTPUTS

System.Boolean







NOTES









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.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... gerprofile

Enable-AzureRmTrafficManagerProfile

Get-AzureRmTrafficManagerProfile

New-AzureRmTrafficManagerProfile

Remove-AzureRmTrafficManagerProfile

Set-AzureRmTrafficManagerProfile