Edit

Disable-AzTrafficManagerEndpoint

  • Reference
Module:
Az.TrafficManager

Disables an endpoint in a Traffic Manager profile.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Disable-AzTrafficManagerEndpoint
       -Name <String>
       -Type <String>
       -ProfileName <String>
       -ResourceGroupName <String>
       [-Force]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
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.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
-Name

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

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-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.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceGroupName

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

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-TrafficManagerEndpoint

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

Type:TrafficManagerEndpoint
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Type

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

  • AzureEndpoints
  • ExternalEndpoints
  • NestedEndpoints
Type:String
Accepted values:AzureEndpoints, ExternalEndpoints, NestedEndpoints
Position:Named
Default value:None
Accept pipeline input:False
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
Accept pipeline input:False
Accept wildcard characters:False

Inputs

TrafficManagerEndpoint

Outputs

Boolean