az network traffic-manager endpoint

Manage Azure Traffic Manager end points.

Commands

Name	Description	Type	Status
az network traffic-manager endpoint create	Create a traffic manager endpoint.	Core	GA
az network traffic-manager endpoint delete	Delete a traffic manager endpoint.	Core	GA
az network traffic-manager endpoint list	List traffic manager endpoints.	Core	GA
az network traffic-manager endpoint show	Get the details of a traffic manager endpoint.	Core	GA
az network traffic-manager endpoint show-geographic-hierarchy	Get the default geographic hierarchy used by the geographic traffic routing method.	Core	GA
az network traffic-manager endpoint update	Update a traffic manager endpoint.	Core	GA

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}
                                           [--always-serve {Disabled, Enabled}]
                                           [--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.

Property	Value
Accepted values:	azureEndpoints, externalEndpoints, nestedEndpoints

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--always-serve

If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.

Property	Value
Accepted values:	Disabled, Enabled

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

Property	Value
Accepted values:	Disabled, Enabled

--geo-mapping

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

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

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

Endpoint name.

Property	Value
Parameter group:	Resource Id Arguments

--profile-name

Name of parent profile.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--type -t

Endpoint type.

Property	Value
Parameter group:	Resource Id Arguments
Accepted values:	AzureEndpoints, ExternalEndpoints, NestedEndpoints

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az network traffic-manager endpoint list

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--type -t

Endpoint type.

Property	Value
Accepted values:	azureEndpoints, externalEndpoints, nestedEndpoints

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az network traffic-manager endpoint show

Get the details of a traffic manager endpoint.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

Endpoint name.

Property	Value
Parameter group:	Resource Id Arguments

--profile-name

Name of parent profile.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--type -t

Endpoint type. Allowed values: azureEndpoints, externalEndpoints, nestedEndpoints.

Property	Value
Parameter group:	Resource Id Arguments
Accepted values:	AzureEndpoints, ExternalEndpoints, NestedEndpoints

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

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

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.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az network traffic-manager endpoint update

Update a traffic manager endpoint.

az network traffic-manager endpoint update [--always-serve {Disabled, Enabled}]
                                           [--custom-headers]
                                           [--endpoint-location]
                                           [--endpoint-monitor-status]
                                           [--endpoint-status {Disabled, Enabled}]
                                           [--geo-mapping]
                                           [--ids]
                                           [--min-child-endpoints]
                                           [--min-child-ipv4]
                                           [--min-child-ipv6]
                                           [--name]
                                           [--priority]
                                           [--profile-name]
                                           [--resource-group]
                                           [--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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--always-serve

If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.

Property	Value
Accepted values:	Disabled, Enabled

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

Property	Value
Accepted values:	Disabled, Enabled

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

Property	Value
Parameter group:	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'.

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

--name -n

Endpoint name.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments
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.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False