< Back
Add-AzureRmTrafficManagerEndpointConfig
Post
NAME Add-AzureRmTrafficManagerEndpointConfig
SYNOPSIS
Adds an endpoint to a local Traffic Manager profile object.
SYNTAX
Add-AzureRmTrafficManagerEndpointConfig [-DefaultProfile <IAzureContextContainer>] [-EndpointLocation <String>] -EndpointName <String>
-EndpointStatus {Enabled | Disabled} [-GeoMapping <System.Collections.Generic.List`1[System.String]>] [-MinChildEndpoints <UInt32>] [-Priority
<UInt32>] [-Target <String>] [-TargetResourceId <String>] -TrafficManagerProfile <TrafficManagerProfile> -Type {AzureEndpoints | ExternalEndpoints
| NestedEndpoints} [-Weight <UInt32>] [<CommonParameters>]
DESCRIPTION
The Add-AzureRmTrafficManagerEndpointConfig cmdlet adds an endpoint to a local Azure Traffic Manager profile object. You can get a profile by
using the New-AzureRmTrafficManagerProfile or Get-AzureRmTrafficManagerProfile cmdlets.
This cmdlet operates on the local profile object. Commit your changes to the profile for Traffic Manager by using the
Set-AzureRmTrafficManagerProfile cmdlet. To create an endpoint and commit the change in a single operation, use the
New-AzureRmTrafficManagerEndpoint cmdlet.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-EndpointLocation <String>
Specifies the location of the endpoint to use in the Performance traffic-routing method. This parameter is only applicable to endpoints of the
ExternalEndpoints or the NestedEndpoints type. You must specify this parameter when the Performance traffic-routing method is used.
Specify an Azure region name. For a full list of Azure regions, see Azure Regionshttp://azure.microsoft.com/regions/
(http://azure.microsoft.com/regions/).
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-EndpointName <String>
Specifies the name of the Traffic Manager endpoint that this cmdlet adds.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-EndpointStatus <String>
Specifies the status of the endpoint. Valid values are:
- Enabled
- Disabled
If the status is Enabled, the endpoint is probed for endpoint health and is included in the traffic-routing method.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GeoMapping <System.Collections.Generic.List`1[System.String]>
The list of regions mapped to this endpoint when using the 'Geographic' traffic routing method. Please consult Traffic Manager documentation
for a full list of accepted values (https://docs.microsoft.com/en-us/azure/ ... ic-regions).
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MinChildEndpoints <UInt32>
Specify an Azure region name. For a full list of Azure regions, see Azure Regionshttp://azure.microsoft.com/regions/
(http://azure.microsoft.com/regions/).
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Priority <UInt32>
Specifies the priority that Traffic Manager assigns to the endpoint. This parameter is used only if the Traffic Manager profile is configured
with the for Priority traffic-routing method. Valid values are integers from 1 through 1000. Lower values represent higher priority.
If you specify a priority, you must specify priorities on all endpoints in the profile, and no two endpoints can share the same priority
value. If you do not specify priorities, Traffic Manager assigns default priority values to the endpoints, starting with one (1), in the order
the profile lists the endpoints.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Target <String>
Specifies the fully qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses when it directs traffic to this
endpoint. Specify this parameter only for the ExternalEndpoints endpoint type. For other endpoint types, specify the TargetResourceId
parameter instead.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-TargetResourceId <String>
Specifies resource ID of the target. Specify this parameter only for the AzureEndpoints and NestedEndpoints endpoint types. For the
ExternalEndpoints endpoint type, specify the Target parameter instead.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-TrafficManagerProfile <TrafficManagerProfile>
Specifies a local TrafficManagerProfile object. This cmdlet modifies this local object. To obtain a TrafficManagerProfile object, use the
Get-AzureRmTrafficManagerProfile cmdlet.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Type <String>
Specifies the type of endpoint that this cmdlet adds to the Azure Traffic Manager profile. Valid values are:
- AzureEndpoints
- ExternalEndpoints
- NestedEndpoints
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Weight <UInt32>
Specifies the weight that Traffic Manager assigns to the endpoint. Valid values are integers from 1 through 1000. The default value is one
(1). This parameter is used only if the Traffic Manager profile is configured with the Weighted traffic-routing method.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Microsoft.Azure.Commands.Network.TrafficManagerProfile
This cmdlet accepts a TrafficManagerProfile object to this cmdlet.
OUTPUTS
Microsoft.Azure.Commands.Network.TrafficManagerProfile
This cmdlet returns a modified TrafficManagerProfile object.
NOTES
Example 1: Add an endpoint to a profile
PS C:\\>$TrafficManagerProfile = Get-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11"
PS C:\\> Add-AzureRmTrafficManagerEndpointConfig -EndpointName "contoso" -EndpointStatus Enabled -Target "www.contoso.com" -TrafficManagerProfile
$TrafficManagerProfile -Type ExternalEndpoints -EndpointLocation "North Europe" -Priority 1 -Weight 10
PS C:\\> Set-AzureRmTrafficManagerProfile -TrafficManagerProfile $TrafficManagerProfile
The first command gets an Azure Traffic Manager profile by using the Get-AzureRmTrafficManagerProfile cmdlet. The command stores the local profile
in the $TrafficManagerProfile variable.
The second command adds an endpoint named contoso to the profile stored in $TrafficManagerProfile. The command includes configuration data for the
endpoint. This command changes only the local object.
The final command updates the Traffic Manager profile in Azure to match the local value in $TrafficManagerProfile.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ointconfig
Get-AzureRmTrafficManagerProfile
New-AzureRmTrafficManagerEndpoint
Remove-AzureRmTrafficManagerEndpointConfig
Set-AzureRmTrafficManagerProfile
SYNOPSIS
Adds an endpoint to a local Traffic Manager profile object.
SYNTAX
Add-AzureRmTrafficManagerEndpointConfig [-DefaultProfile <IAzureContextContainer>] [-EndpointLocation <String>] -EndpointName <String>
-EndpointStatus {Enabled | Disabled} [-GeoMapping <System.Collections.Generic.List`1[System.String]>] [-MinChildEndpoints <UInt32>] [-Priority
<UInt32>] [-Target <String>] [-TargetResourceId <String>] -TrafficManagerProfile <TrafficManagerProfile> -Type {AzureEndpoints | ExternalEndpoints
| NestedEndpoints} [-Weight <UInt32>] [<CommonParameters>]
DESCRIPTION
The Add-AzureRmTrafficManagerEndpointConfig cmdlet adds an endpoint to a local Azure Traffic Manager profile object. You can get a profile by
using the New-AzureRmTrafficManagerProfile or Get-AzureRmTrafficManagerProfile cmdlets.
This cmdlet operates on the local profile object. Commit your changes to the profile for Traffic Manager by using the
Set-AzureRmTrafficManagerProfile cmdlet. To create an endpoint and commit the change in a single operation, use the
New-AzureRmTrafficManagerEndpoint cmdlet.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-EndpointLocation <String>
Specifies the location of the endpoint to use in the Performance traffic-routing method. This parameter is only applicable to endpoints of the
ExternalEndpoints or the NestedEndpoints type. You must specify this parameter when the Performance traffic-routing method is used.
Specify an Azure region name. For a full list of Azure regions, see Azure Regionshttp://azure.microsoft.com/regions/
(http://azure.microsoft.com/regions/).
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-EndpointName <String>
Specifies the name of the Traffic Manager endpoint that this cmdlet adds.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-EndpointStatus <String>
Specifies the status of the endpoint. Valid values are:
- Enabled
- Disabled
If the status is Enabled, the endpoint is probed for endpoint health and is included in the traffic-routing method.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GeoMapping <System.Collections.Generic.List`1[System.String]>
The list of regions mapped to this endpoint when using the 'Geographic' traffic routing method. Please consult Traffic Manager documentation
for a full list of accepted values (https://docs.microsoft.com/en-us/azure/ ... ic-regions).
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MinChildEndpoints <UInt32>
Specify an Azure region name. For a full list of Azure regions, see Azure Regionshttp://azure.microsoft.com/regions/
(http://azure.microsoft.com/regions/).
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Priority <UInt32>
Specifies the priority that Traffic Manager assigns to the endpoint. This parameter is used only if the Traffic Manager profile is configured
with the for Priority traffic-routing method. Valid values are integers from 1 through 1000. Lower values represent higher priority.
If you specify a priority, you must specify priorities on all endpoints in the profile, and no two endpoints can share the same priority
value. If you do not specify priorities, Traffic Manager assigns default priority values to the endpoints, starting with one (1), in the order
the profile lists the endpoints.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Target <String>
Specifies the fully qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses when it directs traffic to this
endpoint. Specify this parameter only for the ExternalEndpoints endpoint type. For other endpoint types, specify the TargetResourceId
parameter instead.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-TargetResourceId <String>
Specifies resource ID of the target. Specify this parameter only for the AzureEndpoints and NestedEndpoints endpoint types. For the
ExternalEndpoints endpoint type, specify the Target parameter instead.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-TrafficManagerProfile <TrafficManagerProfile>
Specifies a local TrafficManagerProfile object. This cmdlet modifies this local object. To obtain a TrafficManagerProfile object, use the
Get-AzureRmTrafficManagerProfile cmdlet.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Type <String>
Specifies the type of endpoint that this cmdlet adds to the Azure Traffic Manager profile. Valid values are:
- AzureEndpoints
- ExternalEndpoints
- NestedEndpoints
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Weight <UInt32>
Specifies the weight that Traffic Manager assigns to the endpoint. Valid values are integers from 1 through 1000. The default value is one
(1). This parameter is used only if the Traffic Manager profile is configured with the Weighted traffic-routing method.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Microsoft.Azure.Commands.Network.TrafficManagerProfile
This cmdlet accepts a TrafficManagerProfile object to this cmdlet.
OUTPUTS
Microsoft.Azure.Commands.Network.TrafficManagerProfile
This cmdlet returns a modified TrafficManagerProfile object.
NOTES
Example 1: Add an endpoint to a profile
PS C:\\>$TrafficManagerProfile = Get-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11"
PS C:\\> Add-AzureRmTrafficManagerEndpointConfig -EndpointName "contoso" -EndpointStatus Enabled -Target "www.contoso.com" -TrafficManagerProfile
$TrafficManagerProfile -Type ExternalEndpoints -EndpointLocation "North Europe" -Priority 1 -Weight 10
PS C:\\> Set-AzureRmTrafficManagerProfile -TrafficManagerProfile $TrafficManagerProfile
The first command gets an Azure Traffic Manager profile by using the Get-AzureRmTrafficManagerProfile cmdlet. The command stores the local profile
in the $TrafficManagerProfile variable.
The second command adds an endpoint named contoso to the profile stored in $TrafficManagerProfile. The command includes configuration data for the
endpoint. This command changes only the local object.
The final command updates the Traffic Manager profile in Azure to match the local value in $TrafficManagerProfile.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ointconfig
Get-AzureRmTrafficManagerProfile
New-AzureRmTrafficManagerEndpoint
Remove-AzureRmTrafficManagerEndpointConfig
Set-AzureRmTrafficManagerProfile