Set-​Azure​Traffic​Manager​Endpoint

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

Syntax

Set-AzureTrafficManagerEndpoint
   -DomainName <String>
   [-Location <String>]
   [-MinChildEndpoints <Int32>]
   [-Profile <AzureSMProfile>]
   [-Status <String>]
   -TrafficManagerProfile <IProfileWithDefinition>
   [-Type <String>]
   [-Weight <Int32>]
   [<CommonParameters>]

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.

Examples

Example 1: Update an endpoint for a profile

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

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

The second command updates the endpoint in the Traffic Manager profile that is stored in $TrafficManagerProfile. The endpoint has the domain name ContosoApp02.cloudapp.net. The command also specifies the status, type, weight, and location of the endpoint. The command passes the modified profile to the Set-AzureTrafficManagerProfile cmdlet to connect to Azure to save your changes.

Required Parameters

-DomainName

Specifies the domain name of the endpoint to modify.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-TrafficManagerProfile

Specifies the Traffic Manager profile object for which to modify the endpoint.

Type:IProfileWithDefinition
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False

Optional Parameters

-Location

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" or of type "TrafficManager" in a profile that has the load balancing method set to "Performance". The possible values are the Azure region names, as listed at http://azure.microsoft.com/regions/http://azure.microsoft.com/regions/.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-MinChildEndpoints

Specifies the minimum number of endpoints the nested profile must have online for this endpoint to be considered online.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Type:AzureSMProfile
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Status

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.
Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Type

Specifies the type of endpoint. Valid values are: - CloudService

  • AzureWebsite
  • TrafficManager

    - Any

    If there is more than one AzureWebsite endpoint, the endpoints must be in different datacenters.
Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Weight

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.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Outputs

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