Edit

Get-AzTrafficManagerEndpoint

  • Reference
Module:
Az.TrafficManager

Gets an endpoint for a Traffic Manager profile.

Syntax

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

Description

The Get-AzTrafficManagerEndpoint cmdlet gets an endpoint for an Azure Traffic Manager profile.

You can modify this object locally, and then apply changes to the profile by using the Set-AzTrafficManagerEndpoint cmdlet. Specify the endpoint by using the Name and Type parameters. You can specify the Traffic Manager profile either by using the ProfileName and ResourceGroupName parameter, or by specifying a TrafficManagerProfile object. Alternatively, you can pass that value by using the pipeline.

Examples

Example 1: Get an endpoint

$TrafficManagerEndpoint = Get-AzTrafficManagerEndpoint -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" -Type AzureEndpoints

This command gets the Azure endpoint named contoso from the profile named ContosoProfile in the resource group named ResourceGroup11, and then stores that object in the $TrafficManagerEndpoint variable.

Parameters

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

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

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ProfileName

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

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 gets a Traffic Manager endpoint in the group that this parameter specifies.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-TrafficManagerEndpoint

Specifies the Traffic Manager endpoint that this cmdlet gets.

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

Inputs

TrafficManagerEndpoint

Outputs

TrafficManagerEndpoint