az network traffic-manager endpoint

Manage traffic manager end points.

Commands

az network traffic-manager endpoint create Create an endpoint.
az network traffic-manager endpoint delete Delete an endpoint.
az network traffic-manager endpoint list List endpoints.
az network traffic-manager endpoint show Get the details for an endpoint.
az network traffic-manager endpoint show-geographic-hierarchy Gets the default Geographic Hierarchy used by the Geographic traffic routing method.
az network traffic-manager endpoint update Update an endpoint.

az network traffic-manager endpoint create

Create an endpoint.

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

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

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

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

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

az network traffic-manager endpoint list

List endpoints.

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

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

az network traffic-manager endpoint show

Get the details for an endpoint.

az network traffic-manager endpoint show --name
--profile-name
--resource-group
--type {azureEndpoints, externalEndpoints, nestedEndpoints}

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

az network traffic-manager endpoint show-geographic-hierarchy

Gets the default Geographic Hierarchy used by the Geographic traffic routing method.

az network traffic-manager endpoint show-geographic-hierarchy

az network traffic-manager endpoint update

Update an endpoint.

az network traffic-manager endpoint update --name
--profile-name
--resource-group
[--add]
[--endpoint-location]
[--endpoint-monitor-status]
[--endpoint-status]
[--geo-mapping]
[--min-child-endpoints]
[--priority]
[--remove]
[--set]
[--target]
[--target-resource-id]
[--type {azureEndpoints, externalEndpoints, nestedEndpoints}]
[--weight]

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

Optional Parameters

--add
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .
--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.
--geo-mapping
--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.
--remove
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
--set
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
--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.