Get-AzureRmTrafficManagerEndpoint

Reference

Module:: AzureRM.TrafficManager

Gets an endpoint for a Traffic Manager profile.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

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

Get-AzureRmTrafficManagerEndpoint
   -TrafficManagerEndpoint <TrafficManagerEndpoint>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzureRmTrafficManagerEndpoint 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-AzureRmTrafficManagerEndpoint 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

PS C:\>$TrafficManagerEndpoint = Get-AzureRmTrafficManagerEndpoint -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:	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

Parameter 'TrafficManagerEndpoint' accepts value of type 'TrafficManagerEndpoint' from the pipeline

Outputs