< Back
New-AzureRmTrafficManagerEndpoint
Post
NAME New-AzureRmTrafficManagerEndpoint
SYNOPSIS
Creates an endpoint in a Traffic Manager profile.
SYNTAX
New-AzureRmTrafficManagerEndpoint [-DefaultProfile <IAzureContextContainer>] [-EndpointLocation <String>] -EndpointStatus {Enabled | Disabled}
[-GeoMapping <System.Collections.Generic.List`1[System.String]>] [-MinChildEndpoints <UInt32>] -Name <String> [-Priority <UInt32>] -ProfileName
<String> -ResourceGroupName <String> [-Target <String>] [-TargetResourceId <String>] -Type {AzureEndpoints | ExternalEndpoints | NestedEndpoints}
[-Weight <UInt32>] [<CommonParameters>]
DESCRIPTION
The New-AzureRmTrafficManagerEndpoint cmdlet creates an endpoint in an Azure Traffic Manager profile.
This cmdlet commits each new endpoint to the Traffic Manager service. To add multiple endpoints to a local Traffic Manager profile object and
commit changes in a single operation, use the Add-AzureRmTrafficManagerEndpointConfig 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 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
-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.
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
-Name <String>
Specifies the name of the Traffic Manager endpoint that this cmdlet creates.
Required? true
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
-ProfileName <String>
Specifies the name of a Traffic Manager profile to which this cmdlet adds an endpoint. To obtain a profile, use the
New-AzureRmTrafficManagerProfile or Get-AzureRmTrafficManagerProfile cmdlets.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of a resource group. This cmdlet creates a Traffic Manager endpoint in the group that this parameter specifies.
Required? true
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
-Type <String>
Specifies the type of endpoint that this cmdlet adds to the 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
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint
NOTES
Example 1: Create an external endpoint for a profile
PS C:\\>New-AzureRmTrafficManagerEndpoint -EndpointStatus Enabled -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName
"ResourceGroup11" -Type ExternalEndpoints -EndpointLocation "North Europe" -Priority 1 -Target "www.contoso.com" -Weight 10
This command creates an external endpoint named contoso in the profile named ContosoProfile in the resource group named ResourceGroup11.
Example 2: Create an Azure endpoint for a profile
PS C:\\>New-AzureRmTrafficManagerEndpoint -EndpointStatus Enabled -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName
"ResourceGroup11" -Type AzureEndpoints -Priority 1 -TargetResourceId
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-CentralUS/providers/Microsoft.Web/sites/contoso-web-app" -Weight 10
This command creates an Azure endpoint named contoso in the profile named ContosoProfile in resource group ResouceGroup11. The Azure endpoint
points to the Azure Web App whose Azure Resource Manager ID is given by the URI path in TargetResourceId . The command does not specify the
EndpointLocation parameter because the Web App resource supplies the location.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... erendpoint
Disable-AzureRmTrafficManagerEndpoint
Enable-AzureRmTrafficManagerEndpoint
Get-AzureRmTrafficManagerEndpoint
Get-AzureRmTrafficManagerProfile
New-AzureRmTrafficManagerProfile
Remove-AzureRmTrafficManagerEndpointConfig
Set-AzureRmTrafficManagerProfile
SYNOPSIS
Creates an endpoint in a Traffic Manager profile.
SYNTAX
New-AzureRmTrafficManagerEndpoint [-DefaultProfile <IAzureContextContainer>] [-EndpointLocation <String>] -EndpointStatus {Enabled | Disabled}
[-GeoMapping <System.Collections.Generic.List`1[System.String]>] [-MinChildEndpoints <UInt32>] -Name <String> [-Priority <UInt32>] -ProfileName
<String> -ResourceGroupName <String> [-Target <String>] [-TargetResourceId <String>] -Type {AzureEndpoints | ExternalEndpoints | NestedEndpoints}
[-Weight <UInt32>] [<CommonParameters>]
DESCRIPTION
The New-AzureRmTrafficManagerEndpoint cmdlet creates an endpoint in an Azure Traffic Manager profile.
This cmdlet commits each new endpoint to the Traffic Manager service. To add multiple endpoints to a local Traffic Manager profile object and
commit changes in a single operation, use the Add-AzureRmTrafficManagerEndpointConfig 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 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
-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.
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
-Name <String>
Specifies the name of the Traffic Manager endpoint that this cmdlet creates.
Required? true
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
-ProfileName <String>
Specifies the name of a Traffic Manager profile to which this cmdlet adds an endpoint. To obtain a profile, use the
New-AzureRmTrafficManagerProfile or Get-AzureRmTrafficManagerProfile cmdlets.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of a resource group. This cmdlet creates a Traffic Manager endpoint in the group that this parameter specifies.
Required? true
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
-Type <String>
Specifies the type of endpoint that this cmdlet adds to the 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
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint
NOTES
Example 1: Create an external endpoint for a profile
PS C:\\>New-AzureRmTrafficManagerEndpoint -EndpointStatus Enabled -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName
"ResourceGroup11" -Type ExternalEndpoints -EndpointLocation "North Europe" -Priority 1 -Target "www.contoso.com" -Weight 10
This command creates an external endpoint named contoso in the profile named ContosoProfile in the resource group named ResourceGroup11.
Example 2: Create an Azure endpoint for a profile
PS C:\\>New-AzureRmTrafficManagerEndpoint -EndpointStatus Enabled -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName
"ResourceGroup11" -Type AzureEndpoints -Priority 1 -TargetResourceId
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-CentralUS/providers/Microsoft.Web/sites/contoso-web-app" -Weight 10
This command creates an Azure endpoint named contoso in the profile named ContosoProfile in resource group ResouceGroup11. The Azure endpoint
points to the Azure Web App whose Azure Resource Manager ID is given by the URI path in TargetResourceId . The command does not specify the
EndpointLocation parameter because the Web App resource supplies the location.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... erendpoint
Disable-AzureRmTrafficManagerEndpoint
Enable-AzureRmTrafficManagerEndpoint
Get-AzureRmTrafficManagerEndpoint
Get-AzureRmTrafficManagerProfile
New-AzureRmTrafficManagerProfile
Remove-AzureRmTrafficManagerEndpointConfig
Set-AzureRmTrafficManagerProfile