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 enabledRequired Parameters
Endpoint name.
Name of parent profile.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Endpoint type.
Optional Parameters
If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.
Space-separated list of custom headers in KEY=VALUE format.
Location of the external or nested endpoints when using the 'Performance' routing method.
The monitoring status of the endpoint.
The status of the endpoint. If enabled the endpoint is probed for endpoint health and included in the traffic routing method.
Space-separated list of country/region codes mapped to this endpoint when using the 'Geographic' routing method.
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'.
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'.
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 of the endpoint when using the 'Priority' traffic routing method. Values range from 1 to 1000, with lower values representing higher priority.
Space-separated list of subnet CIDR prefixes (10.0.0.0/24) or subnet ranges (10.0.0.0-11.0.0.0).
Fully-qualified DNS name of the endpoint.
The Azure Resource URI of the endpoint. Not applicable for endpoints of type 'ExternalEndpoints'.
Weight of the endpoint when using the 'Weighted' traffic routing method. Values range from 1 to 1000.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
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 azureEndpointsDelete a traffic manager endpoint. (autogenerated)
az network traffic-manager endpoint delete --name MyEndpoint --profile-name MyTmProfile --resource-group MyResourceGroup --subscription MySubscription --type azureEndpointsRequired Parameters
Optional Parameters
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.
Endpoint name.
Name of parent profile.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Endpoint type.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
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 MyTmProfileRequired Parameters
Name of parent profile.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Endpoint type.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
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 azureEndpointsRequired Parameters
Optional Parameters
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.
Endpoint name.
Name of parent profile.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Endpoint type. Allowed values: azureEndpoints, externalEndpoints, nestedEndpoints.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
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-hierarchyExamples
Get the default geographic hierarchy used by the geographic traffic routing method.
az network traffic-manager endpoint show-geographic-hierarchyRequired Parameters
Optional Parameters
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
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 azureEndpointsUpdate a traffic manager endpoint. (autogenerated)
az network traffic-manager endpoint update --name MyEndpoint --profile-name MyTmProfile --resource-group MyResourceGroup --target webserver.mysite.com --type azureEndpointsUpdate a traffic manager endpoint. (autogenerated)
az network traffic-manager endpoint update --endpoint-status Enabled --name MyEndpoint --profile-name MyTmProfile --resource-group MyResourceGroup --type azureEndpointsRequired Parameters
Optional Parameters
If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.
Space-separated list of custom headers in KEY=VALUE format.
Location of the external or nested endpoints when using the 'Performance' routing method.
The monitoring status of the endpoint.
The status of the endpoint. If enabled the endpoint is probed for endpoint health and included in the traffic routing method.
Space-separated list of country/region codes mapped to this endpoint when using the 'Geographic' routing method.
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.
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'.
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'.
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'.
Endpoint name.
Priority of the endpoint when using the 'Priority' traffic routing method. Values range from 1 to 1000, with lower values representing higher priority.
Name of parent profile.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Space-separated list of subnet CIDR prefixes (10.0.0.0/24) or subnet ranges (10.0.0.0-11.0.0.0).
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Fully-qualified DNS name of the endpoint.
The Azure Resource URI of the endpoint. Not applicable for endpoints of type 'ExternalEndpoints'.
Endpoint type.
Weight of the endpoint when using the 'Weighted' traffic routing method. Values range from 1 to 1000.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
