Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Add-AzureTrafficManagerEndpoint

Add-AzureTrafficManagerEndpoint

microsoft.windowsazure.commands.trafficmanager.dll

Synopsis

Adds an endpoint to a Traffic Manager profile.

Syntax

Add-AzureTrafficManagerEndpoint [-DomainName] [-Location] [-Type] [-Status] [-Weight] [-MinChildEndpoints] [-TrafficManagerProfile] [<CommonParameters>]

Detailed Description

The Add-AzureTrafficManagerEndpoint cmdlet adds an endpoint to a Microsoft Azure Traffic Manager profile. After you add an endpoint, pass the result to the Set-AzureTrafficManagerProfile cmdlet by using the pipeline operator. That cmdlet connects to Azure to save your changes.

Parameters

-DomainName <String>

Specifies the domain name of the endpoint to add.

Aliases

None

Required?

true

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-Location <String>

Specifies the location of the endpoint the cmdlet adds. This must be an Azure location.This parameter must contain a value for endpoints of the type "Any" in a profile that has the load balancing method set to "Performance". You can find a list of possible values for this parameter under Name by calling List Locations. For more information, see List Locations at http://msdn.microsoft.com/en-us/library/gg441293.aspx.

Aliases

None

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-Type <String>

Specifies the type of endpoint. Valid values are: -- CloudService -- AzureWebsite -- Any -- TrafficManager If there is more than one AzureWebsite endpoint, the endpoints must be in different datacenters.

Aliases

None

Required?

true

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-Status <String>

Specifies the status of the monitoring endpoint. Valid values are: -- Enabled -- Disabled If you specify a value of Enabled, Traffic Manager monitors the endpoint and the load-balancing method considers it when managing traffic.

Aliases

None

Required?

true

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-Weight <Nullable`1[Int32]>

Specifies the weight of the endpoint the cmdlet adds. The valid value range for this parameter is [1,1000].This parameter is only used for RoundRobin load balancing policies.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-MinChildEndpoints <Nullable`1[Int32]>

Specifies the minimum amount of endpoints the nested profile has to have online for this endpoint to be considered online. The valid value for this parameter should be bigger than 0.This parameter is only used for TrafficManager endpoint types.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-TrafficManagerProfile <IProfileWithDefinition>

Specifies the Traffic Manager profile object to which to add the endpoint.

Aliases

None

Required?

true

Position

0

Default value

none

Accept pipeline input?

true (ByValue, ByPropertyName)

Accept wildcard characters?

false

Input Type


Return Type

Microsoft.WindowsAzure.Commands.Utilities.TrafficManager.Models.IProfileWithDefinition

Notes

Examples

-------------------------- Example 1: Add an endpoint to a profile --------------------------

The first command uses the Get-AzureTrafficManagerProfile cmdlet to get the profile named ContosoProfile, and then stores it in the $TrafficManagerProfile variable.

PS C:\>$TrafficManagerProfile = Get-AzureTrafficManagerProfile -Name "ContosoProfile"
PS C:\> Add-AzureTrafficManagerEndpoint -TrafficManagerProfile $TrafficManagerProfile -DomainName "Contoso02App.cloudapp.net" -Status "Enabled" -Type "CloudService" | Set-AzureTrafficManagerProfile

-------------------------- Example 2: Add an endpoint that has a specified location and weight --------------------------

This command adds an endpoint to a Traffic Manager profile. The endpoint has the domain name Contoso02App.couldapp.net. The command also specifies whether it is enabled and its type. The command also specifies the weight and location for the endpoint. The command passes the profile object to Set-AzureTrafficManagerProfile to connect to Azure to save your changes.

PS C:\>Add-AzureTrafficManagerEndpoint -TrafficManagerProfile ContosoTrafficManagerProfile -DomainName " Contoso02App.cloudapp.net" -Status Enabled -Type CloudService -Weight 2 -Location myLocation | Set-AzureTrafficManagerProfile

Online Version
Remove-AzureTrafficManagerEndpoint
Set-AzureTrafficManagerEndpoint
Get-AzureTrafficManagerProfile
Set-AzureTrafficManagerProfile