Edit

Share via

Get-AzTrafficManagerEndpoint

Module:
Az.TrafficManager Module

Gets an endpoint for a Traffic Manager profile.

Syntax

Fields 

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

Object 

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.

Parameter properties

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

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

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

Parameter properties

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

Parameter sets

Fields
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProfileName

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

Parameter properties

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

Parameter sets

Fields
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

Specifies the name of a resource group. This cmdlet gets 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

Fields
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TrafficManagerEndpoint

Specifies the Traffic Manager endpoint that this cmdlet gets.

Parameter properties

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

Parameter sets

Object
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-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

Fields
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

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

TrafficManagerEndpoint