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
 

Set-AzureTrafficManagerEndpoint

Set-AzureTrafficManagerEndpoint

microsoft.windowsazure.commands.trafficmanager.dll

Synopsis

Updates the properties of an endpoint in a Traffic Manager profile.

Syntax

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

Detailed Description

The Set-AzureTrafficManagerEndpoint cmdlet updates the properties of an endpoint in a Microsoft Azure Traffic Manager profile. If the endpoint does not exist in the current profile, this cmdlet creates it. 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 modify.

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?

false

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?

false

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

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 for which to modify 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: Update an endpoint for 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:\> Set-AzureTrafficManagerEndpoint -TrafficManagerProfile $TrafficManagerProfile -DomainName "ContosoApp02.cloudapp.net" -Status "Enabled" -Type "CloudService" -Weight 2 -Location myLocation | Set-AzureTrafficManagerProfile

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