Enable-AzTrafficManagerEndpoint

Enables 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

Enable-AzTrafficManagerEndpoint
      -Name <String>
      -Type <String>
      -ProfileName <String>
      -ResourceGroupName <String>
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]
Enable-AzTrafficManagerEndpoint
      -TrafficManagerEndpoint <TrafficManagerEndpoint>
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]

Description

The Enable-AzTrafficManagerEndpoint cmdlet enables 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 specify a TrafficManagerEndpoint object by 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: Enable an endpoint from a profile

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

This command enables the external endpoint named contoso in the profile named ContosoProfile in resource group ResourceGroup11.

Example 2: Enable an endpoint by using the pipeline

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

This command gets the external endpoint named Contoso from the profile named ContosoProfile in ResourceGroup11. The command then passes that endpoint to the Enable-AzTrafficManagerEndpoint cmdlet by using the pipeline operator. That cmdlet enables that endpoint.

Parameters

-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
-Name

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

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 enables 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 enables 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 enables. 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 disables in 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

Inputs

TrafficManagerEndpoint

Outputs

Boolean