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

Set-AzureTrafficManagerProfile

microsoft.windowsazure.commands.trafficmanager.dll, microsoft.azure.commands.trafficmanager.dll

Synopsis

Updates the properties of a Traffic Manager profile.

Syntax

Set-AzureTrafficManagerProfile [-Name] [-LoadBalancingMethod] [-MonitorPort] [-MonitorProtocol] [-MonitorRelativePath] [-Ttl] [-TrafficManagerProfile] [<CommonParameters>]

Detailed Description

The Set-AzureTrafficManagerProfile cmdlet updates the properties of a Microsoft Azure Traffic Manager profile.For profiles for which you have set the LoadBalancingMethod value to "Failover", you can determine the failover order of the endpoints you have added to your profile with the Add-AzureTrafficManagerEndpoint cmdlet. For more information, see Example 3 below.

Parameters

-Name <String>

Specifies the name of the Traffic Manager profile to update.

Aliases

None

Required?

false

Position

named

Default value

none

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-LoadBalancingMethod <String>

Specifies the load balancing method to use to distribute the connection. Valid values are: -- Performance -- Failover -- RoundRobin

Aliases

None

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-MonitorPort <Nullable`1[Int32]>

Specifies the port used to monitor endpoint health. Valid values are integer values greater than 0 and less than or equal to 65,535.

Aliases

None

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-MonitorProtocol <String>

Specifies the protocol to use to monitor endpoint health. Valid values are: -- Http -- Https

Aliases

None

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-MonitorRelativePath <String>

Specifies the path relative to the endpoint domain name to probe for health state. The path must meet the following restrictions: -- The path must be from 1 through 1000 characters. -- It must start with a forward slash, /. -- It must contain no XML elements, <>. -- It must contain no double slashes, //. -- It must contain no invalid HTML escape characters. For example, %XY.

Aliases

None

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-Ttl <Nullable`1[Int32]>

Specifies the DNS Time-to-Live (TTL) that informs the Local DNS resolvers how long to cache DNS entries. Valid values are an integer from 30 through 999,999.

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 you use to set the profile.

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: Set the TTL for a Traffic Manager profile --------------------------

This command sets the TTL to 60 seconds for the Traffic Manager profile object MyTrafficManagerProfile.

PS C:\>Set-AzureTrafficManagerProfile -TrafficManagerProfile $MyTrafficManagerProfile -Ttl 60

-------------------------- Example 2: Set several values for a profile --------------------------

This command gets a Traffic Manager profile named MyProfile by using the Get-AzureTrafficManagerProfile cmdlet. The profile uses the RoundRobin load balancing method, a TTL of 30 seconds, the monitor protocol HTTP, the monitor port, and the relative path for a Traffic Manager profile.

PS C:\>Get-AzureTrafficManagerProfile -Name "MyProfile" | Set-AzureTrafficManagerProfile -LoadBalancingMethod "RoundRobin" -Ttl 30 -MonitorProtocol "Http" -MonitorPort 80 -MonitorRelativePath "/"

-------------------------- Example 3: Reorder endpoints to desired failover order --------------------------

This example reorders the endpoints added to MyProfile to the desired failover order.

PS C:\>$Profile = Get-AzureTrafficManagerProfile -Name "MyProfile"
PS C:\> $Profile.Endpoints[0],$Profile.Endpoints[1] = $Profile.Endpoints[1],$Profile.Endpoints[0]
PS C:\> $Profile = Set-AzureTrafficManagerProfile

Online Version
Disable-AzureTrafficManagerProfile
Enable-AzureTrafficManagerProfile
Get-AzureTrafficManagerProfile
New-AzureTrafficManagerProfile
Remove-AzureTrafficManagerProfile