az network traffic-manager endpoint

Manage Azure Traffic Manager end points.

Commands

az network traffic-manager endpoint create

Create a traffic manager endpoint.

az network traffic-manager endpoint delete

Delete a traffic manager endpoint.

az network traffic-manager endpoint list

List traffic manager endpoints.

az network traffic-manager endpoint show

Get the details of a traffic manager endpoint.

az network traffic-manager endpoint show-geographic-hierarchy

Get the default geographic hierarchy used by the geographic traffic routing method.

az network traffic-manager endpoint update

Update a traffic manager endpoint.

az network traffic-manager endpoint create

Create a traffic manager endpoint.

az network traffic-manager endpoint create --name
                                           --profile-name
                                           --resource-group
                                           --type {azureEndpoints, externalEndpoints, nestedEndpoints}
                                           [--custom-headers]
                                           [--endpoint-location]
                                           [--endpoint-monitor-status]
                                           [--endpoint-status {Disabled, Enabled}]
                                           [--geo-mapping]
                                           [--min-child-endpoints]
                                           [--priority]
                                           [--subnets]
                                           [--subscription]
                                           [--target]
                                           [--target-resource-id]
                                           [--weight]

Examples

Create an endpoint for a performance profile to point to an Azure Web App endpoint.

az network traffic-manager endpoint create -g MyResourceGroup --profile-name MyTmProfile \
    -n MyEndpoint --type azureEndpoints --target-resource-id $MyWebApp1Id --endpoint-status enabled

Required Parameters

--name -n

Endpoint name.

--profile-name

Name of parent profile.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--type -t

Endpoint type.

accepted values: azureEndpoints, externalEndpoints, nestedEndpoints

Optional Parameters

--custom-headers

Space-separated list of custom headers in KEY=VALUE format.

--endpoint-location

Location of the external or nested endpoints when using the 'Performance' routing method.

--endpoint-monitor-status

The monitoring status of the endpoint.

--endpoint-status

The status of the endpoint. If enabled the endpoint is probed for endpoint health and included in the traffic routing method.

accepted values: Disabled, Enabled
--geo-mapping

Space-separated list of country/region codes mapped to this endpoint when using the 'Geographic' routing method.

value from: az network traffic-manager endpoint show-geographic-hierarchy
--min-child-endpoints

The minimum number of endpoints that must be available in the child profile for the parent profile to be considered available. Only applicable to an endpoint of type 'NestedEndpoints'.

--priority

Priority of the endpoint when using the 'Priority' traffic routing method. Values range from 1 to 1000, with lower values representing higher priority.

--subnets

Space-separated list of subnet CIDR prefixes (10.0.0.0/24) or subnet ranges (10.0.0.0-11.0.0.0).

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--target

Fully-qualified DNS name of the endpoint.

--target-resource-id

The Azure Resource URI of the endpoint. Not applicable for endpoints of type 'ExternalEndpoints'.

--weight

Weight of the endpoint when using the 'Weighted' traffic routing method. Values range from 1 to 1000.

az network traffic-manager endpoint delete

Delete a traffic manager endpoint.

az network traffic-manager endpoint delete [--ids]
                                           [--name]
                                           [--profile-name]
                                           [--resource-group]
                                           [--subscription]
                                           [--type {azureEndpoints, externalEndpoints, nestedEndpoints}]

Examples

Delete a traffic manager endpoint.

az network traffic-manager endpoint delete -g MyResourceGroup \ --profile-name MyTmProfile -n MyEndpoint --type azureEndpoints

Delete a traffic manager endpoint. (autogenerated)

az network traffic-manager endpoint delete --name MyEndpoint --profile-name MyTmProfile --resource-group MyResourceGroup --subscription MySubscription --type azureEndpoints

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Endpoint name.

--profile-name

Name of parent profile.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--type -t

Endpoint type.

accepted values: azureEndpoints, externalEndpoints, nestedEndpoints

az network traffic-manager endpoint list

List traffic manager endpoints.

az network traffic-manager endpoint list --profile-name
                                         --resource-group
                                         [--query-examples]
                                         [--subscription]
                                         [--type {azureEndpoints, externalEndpoints, nestedEndpoints}]

Examples

List traffic manager endpoints.

az network traffic-manager endpoint list -g MyResourceGroup --profile-name MyTmProfile

Required Parameters

--profile-name

Name of parent profile.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--type -t

Endpoint type.

accepted values: azureEndpoints, externalEndpoints, nestedEndpoints

az network traffic-manager endpoint show

Get the details of a traffic manager endpoint.

az network traffic-manager endpoint show [--ids]
                                         [--name]
                                         [--profile-name]
                                         [--query-examples]
                                         [--resource-group]
                                         [--subscription]
                                         [--type {azureEndpoints, externalEndpoints, nestedEndpoints}]

Examples

Get the details of a traffic manager endpoint.

az network traffic-manager endpoint show -g MyResourceGroup \
    --profile-name MyTmProfile -n MyEndpoint --type azureEndpoints

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Endpoint name.

--profile-name

Name of parent profile.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--type -t

Endpoint type.

accepted values: azureEndpoints, externalEndpoints, nestedEndpoints

az network traffic-manager endpoint show-geographic-hierarchy

Get the default geographic hierarchy used by the geographic traffic routing method.

az network traffic-manager endpoint show-geographic-hierarchy [--subscription]

Examples

Get the default geographic hierarchy used by the geographic traffic routing method.

az network traffic-manager endpoint show-geographic-hierarchy

Optional Parameters

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az network traffic-manager endpoint update

Update a traffic manager endpoint.

az network traffic-manager endpoint update [--add]
                                           [--custom-headers]
                                           [--endpoint-location]
                                           [--endpoint-monitor-status]
                                           [--endpoint-status {Disabled, Enabled}]
                                           [--force-string]
                                           [--geo-mapping]
                                           [--ids]
                                           [--min-child-endpoints]
                                           [--name]
                                           [--priority]
                                           [--profile-name]
                                           [--remove]
                                           [--resource-group]
                                           [--set]
                                           [--subnets]
                                           [--subscription]
                                           [--target]
                                           [--target-resource-id]
                                           [--type {azureEndpoints, externalEndpoints, nestedEndpoints}]
                                           [--weight]

Examples

Update a traffic manager endpoint to change its weight.

az network traffic-manager endpoint update -g MyResourceGroup --profile-name MyTmProfile \ -n MyEndpoint --weight 20 --type azureEndpoints

Update a traffic manager endpoint. (autogenerated)

az network traffic-manager endpoint update --name MyEndpoint --profile-name MyTmProfile --resource-group MyResourceGroup --target webserver.mysite.com --type azureEndpoints

Update a traffic manager endpoint. (autogenerated)

az network traffic-manager endpoint update --endpoint-status Enabled --name MyEndpoint --profile-name MyTmProfile --resource-group MyResourceGroup --type azureEndpoints

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--custom-headers

Space-separated list of custom headers in KEY=VALUE format.

--endpoint-location

Location of the external or nested endpoints when using the 'Performance' routing method.

--endpoint-monitor-status

The monitoring status of the endpoint.

--endpoint-status

The status of the endpoint. If enabled the endpoint is probed for endpoint health and included in the traffic routing method.

accepted values: Disabled, Enabled
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

--geo-mapping

Space-separated list of country/region codes mapped to this endpoint when using the 'Geographic' routing method.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--min-child-endpoints

The minimum number of endpoints that must be available in the child profile for the parent profile to be considered available. Only applicable to an endpoint of type 'NestedEndpoints'.

--name -n

Endpoint name.

--priority

Priority of the endpoint when using the 'Priority' traffic routing method. Values range from 1 to 1000, with lower values representing higher priority.

--profile-name

Name of parent profile.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--subnets

Space-separated list of subnet CIDR prefixes (10.0.0.0/24) or subnet ranges (10.0.0.0-11.0.0.0).

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--target

Fully-qualified DNS name of the endpoint.

--target-resource-id

The Azure Resource URI of the endpoint. Not applicable for endpoints of type 'ExternalEndpoints'.

--type -t

Endpoint type.

accepted values: azureEndpoints, externalEndpoints, nestedEndpoints
--weight

Weight of the endpoint when using the 'Weighted' traffic routing method. Values range from 1 to 1000.