az network traffic-manager endpoint

Reference

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

Edit

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]
                                           [--min-child-ipv4]
                                           [--min-child-ipv6]
                                           [--priority]
                                           [--subnets]
                                           [--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'.

--min-child-ipv4

The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'.

--min-child-ipv6

The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to 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).

--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.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network traffic-manager endpoint delete

Edit

Delete a traffic manager endpoint.

az network traffic-manager endpoint delete [--ids]
                                           [--name]
                                           [--profile-name]
                                           [--resource-group]
                                           [--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>.

--type -t

Endpoint type.

accepted values: azureEndpoints, externalEndpoints, nestedEndpoints

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network traffic-manager endpoint list

Edit

List traffic manager endpoints.

az network traffic-manager endpoint list --profile-name
                                         --resource-group
                                         [--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

--type -t

Endpoint type.

accepted values: azureEndpoints, externalEndpoints, nestedEndpoints

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network traffic-manager endpoint show

Edit

Get the details of a traffic manager endpoint.

az network traffic-manager endpoint show [--ids]
                                         [--name]
                                         [--profile-name]
                                         [--resource-group]
                                         [--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

--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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network traffic-manager endpoint show-geographic-hierarchy

Edit

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

az network traffic-manager endpoint show-geographic-hierarchy

Examples

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

az network traffic-manager endpoint show-geographic-hierarchy

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network traffic-manager endpoint update

Edit

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]
                                           [--min-child-ipv4]
                                           [--min-child-ipv6]
                                           [--name]
                                           [--priority]
                                           [--profile-name]
                                           [--remove]
                                           [--resource-group]
                                           [--set]
                                           [--subnets]
                                           [--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

--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'.

--min-child-ipv4

--min-child-ipv6

--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).

--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.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network traffic-manager endpoint

Commands

az network traffic-manager endpoint create

Examples

Required Parameters

Optional Parameters

az network traffic-manager endpoint delete

Examples

Optional Parameters

az network traffic-manager endpoint list

Examples

Required Parameters

Optional Parameters

az network traffic-manager endpoint show

Examples

Optional Parameters

az network traffic-manager endpoint show-geographic-hierarchy

Examples

az network traffic-manager endpoint update

Examples

Optional Parameters

Feedback