Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Disable-AzTrafficManagerEndpoint

Disables an endpoint in a Traffic Manager profile.

Syntax

Fields 

Disable-AzTrafficManagerEndpoint
 -Name <String>
 -Type <String>
 -ProfileName <String>
 -ResourceGroupName <String>
 [-Force]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Object 

Disable-AzTrafficManagerEndpoint
 -TrafficManagerEndpoint <TrafficManagerEndpoint>
 [-Force]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Description

The Disable-AzTrafficManagerEndpoint cmdlet disables an endpoint in an Azure Traffic Manager profile.

You can use the pipeline operator to pass a TrafficManagerEndpoint object to this cmdlet, or you can pass a TrafficManagerEndpoint object using the TrafficManagerEndpoint parameter.

Alternatively, you can specify the endpoint name and type by using the Name and Type parameters, together with the ProfileName and ResourceGroupName parameters.

Examples

Example 1: Disable an endpoint by name

Disable-AzTrafficManagerEndpoint -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName ResourceGroup11 -Type ExternalEndpoints

This command disables the external endpoint named contoso in the profile named ContosoProfile in resource group ResourceGroup11. The command prompts you for confirmation.

Example 2: Disable an endpoint by using the pipeline

Get-AzTrafficManagerEndpoint -Name "contoso" -Type ExternalEndpoints -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" | Disable-AzTrafficManagerEndpoint -Force

This command gets the external endpoint named Contoso from the profile named ContosoProfile in ResourceGroup11. The command then passes that endpoint to the Disable-AzTrafficManagerEndpoint cmdlet by using the pipeline operator. That cmdlet disables that endpoint. The command specifies the Force parameter. Therefore, it does not prompt you for confirmation.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

-DefaultProfile

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

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

-Force

Forces the command to run without asking for user confirmation.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-Name

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-ProfileName

Specifies the name of a Traffic Manager profile in which this cmdlet disables an endpoint. To obtain a profile, use the Get-AzTrafficManagerProfile cmdlet.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-ResourceGroupName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-TrafficManagerEndpoint

Specifies the Traffic Manager endpoint that this cmdlet disables. To obtain a TrafficManagerEndpoint object, use the Get-AzTrafficManagerEndpoint cmdlet.

Parameter properties

Type:TrafficManagerEndpoint
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-Type

Specifies the type of endpoint that this cmdlet adds to the Traffic Manager profile. Valid values are:

  • AzureEndpoints
  • ExternalEndpoints
  • NestedEndpoints

Parameter properties

Type:String
Default value:None
Accepted values:AzureEndpoints, ExternalEndpoints, NestedEndpoints
Supports wildcards:False
DontShow:False

Parameter sets

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

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.

Inputs

TrafficManagerEndpoint

Outputs

Boolean

Related Links

Feedback

Was this page helpful?