Skip to content

Latest commit

 

History

History
221 lines (165 loc) · 6.14 KB

Add-AzureTrafficManagerEndpoint.md

File metadata and controls

221 lines (165 loc) · 6.14 KB
Raw
external help file ms.assetid online version schema
Microsoft.WindowsAzure.Commands.TrafficManager.dll-Help.xml
CF1FC482-812D-4BAD-BA3A-D88E614A5165
2.0.0

Add-AzureTrafficManagerEndpoint

SYNOPSIS

Adds an endpoint to a Traffic Manager profile.

[!INCLUDE rdfe-banner]

SYNTAX

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

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.

EXAMPLES

Example 1: Add an endpoint to a profile

PS C:\>$TrafficManagerProfile = Get-AzureTrafficManagerProfile -Name "ContosoProfile"
PS C:\> Add-AzureTrafficManagerEndpoint -TrafficManagerProfile $TrafficManagerProfile -DomainName "Contoso02App.cloudapp.net" -Status "Enabled" -Type "CloudService" | 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 adds an endpoint to Traffic Manager profile that is stored in $TrafficManagerProfile. The endpoint has the domain name Contoso02App.couldapp.net. The command also specifies whether it is enabled and its type. The command passes the profile object to the Set-AzureTrafficManagerProfile cmdlet to connect to Azure to save your changes.

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

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

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.

PARAMETERS

-DomainName

Specifies the domain name of the endpoint to add.

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-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 https://azure.microsoft.com/regions/.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
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
Parameter Sets: (All)
Aliases: 

Required: False
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
Parameter Sets: (All)
Aliases: 

Required: False
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
Parameter Sets: (All)
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TrafficManagerProfile

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

Type: IProfileWithDefinition
Parameter Sets: (All)
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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
Parameter Sets: (All)
Aliases: 

Required: True
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
Parameter Sets: (All)
Aliases: 

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

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

This cmdlet generates a Traffic Manager profile object, which contains information about the updated profile.

NOTES

RELATED LINKS

Remove-AzureTrafficManagerEndpoint

Set-AzureTrafficManagerEndpoint

Get-AzureTrafficManagerProfile

Set-AzureTrafficManagerProfile