az network traffic-manager profile

  • Reference

Manage Azure Traffic Manager profiles.

Commands

az network traffic-manager profile check-dns

Check the availability of a relative DNS name.
az network traffic-manager profile create

Create a traffic manager profile.
az network traffic-manager profile delete

Delete a traffic manager profile.
az network traffic-manager profile list

List traffic manager profiles.
az network traffic-manager profile show

Get the details of a traffic manager profile.
az network traffic-manager profile update

Update a traffic manager profile.

az network traffic-manager profile check-dns

Edit

Check the availability of a relative DNS name.

This checks for the avabilility of dns prefixes for trafficmanager.net.

az network traffic-manager profile check-dns --name
                                             [--subscription]

Examples

Check the availability of 'mywebapp.trafficmanager.net' in Azure.

az network traffic-manager profile check-dns -n mywebapp

Required Parameters

--name -n

DNS prefix to verify availability for.

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

Edit

Create a traffic manager profile.

az network traffic-manager profile create --name
                                          --resource-group
                                          --routing-method {Geographic, Multivalue, Performance, Priority, Subnet, Weighted}
                                          --unique-dns-name
                                          [--custom-headers]
                                          [--interval]
                                          [--max-failures]
                                          [--path]
                                          [--port]
                                          [--protocol {HTTP, HTTPS, TCP}]
                                          [--status {Disabled, Enabled}]
                                          [--status-code-ranges]
                                          [--subscription]
                                          [--tags]
                                          [--timeout]
                                          [--ttl]

Examples

Create a traffic manager profile with performance routing.

az network traffic-manager profile create -g MyResourceGroup -n MyTmProfile --routing-method Performance \
    --unique-dns-name mywebapp --ttl 30 --protocol HTTP --port 80 --path "/"

Required Parameters

--name -n

Traffic manager profile name.

--resource-group -g

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

--routing-method

Routing method.

accepted values: Geographic, Multivalue, Performance, Priority, Subnet, Weighted
--unique-dns-name

Relative DNS name for the traffic manager profile. Resulting FQDN will be <unique-dns-name>.trafficmanager.net and must be globally unique.

Optional Parameters

--custom-headers

Space-separated list of NAME=VALUE pairs.

--interval

The interval in seconds at which health checks are conducted.

--max-failures

The number of consecutive failed health checks tolerated before an endpoint is considered degraded.

--path

Path to monitor. Use ""('""' in PowerShell) for none.

--port

Port to monitor.

default value: 80
--protocol

Monitor protocol.

accepted values: HTTP, HTTPS, TCP
default value: HTTP
--status

Status of the Traffic Manager profile.

accepted values: Disabled, Enabled
default value: Enabled
--status-code-ranges

Space-separated list of status codes in MIN-MAX or VAL format.

--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--timeout

The time in seconds allowed for endpoints to respond to a health check.

--ttl

DNS config time-to-live in seconds.

default value: 30

az network traffic-manager profile delete

Edit

Delete a traffic manager profile.

az network traffic-manager profile delete [--ids]
                                          [--name]
                                          [--resource-group]
                                          [--subscription]

Examples

Delete a traffic manager profile.

az network traffic-manager profile delete -g MyResourceGroup -n MyTmProfile

Delete a traffic manager profile. (autogenerated)

az network traffic-manager profile delete --name MyTmProfile --resource-group MyResourceGroup --subscription MySubscription

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

The name of the Traffic Manager profile to be deleted.

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

az network traffic-manager profile list

Edit

List traffic manager profiles.

az network traffic-manager profile list [--query-examples]
                                        [--resource-group]
                                        [--subscription]

Examples

List traffic manager profiles.

az network traffic-manager profile list -g MyResourceGroup

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.

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

az network traffic-manager profile show

Edit

Get the details of a traffic manager profile.

az network traffic-manager profile show [--ids]
                                        [--name]
                                        [--query-examples]
                                        [--resource-group]
                                        [--subscription]

Examples

Get the details of a traffic manager profile.

az network traffic-manager profile show -g MyResourceGroup -n MyTmProfile

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

The name of the Traffic Manager 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.

az network traffic-manager profile update

Edit

Update a traffic manager profile.

az network traffic-manager profile update [--add]
                                          [--custom-headers]
                                          [--force-string]
                                          [--ids]
                                          [--interval]
                                          [--max-failures]
                                          [--name]
                                          [--path]
                                          [--port]
                                          [--protocol {HTTP, HTTPS, TCP}]
                                          [--remove]
                                          [--resource-group]
                                          [--routing-method {Geographic, Multivalue, Performance, Priority, Subnet, Weighted}]
                                          [--set]
                                          [--status {Disabled, Enabled}]
                                          [--status-code-ranges]
                                          [--subscription]
                                          [--tags]
                                          [--timeout]
                                          [--ttl]

Examples

Update a traffic manager profile to change the TTL to 300.

az network traffic-manager profile update -g MyResourceGroup -n MyTmProfile --ttl 300

Update a traffic manager profile. (autogenerated)

az network traffic-manager profile update --name MyTmProfile --resource-group MyResourceGroup --status Enabled

Update a traffic manager profile. (autogenerated)

az network traffic-manager profile update --name MyTmProfile --path "/" --routing-method Performance

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 NAME=VALUE pairs.

--force-string

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

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

--interval

The interval in seconds at which health checks are conducted.

--max-failures

The number of consecutive failed health checks tolerated before an endpoint is considered degraded.

--name -n

The name of the Traffic Manager profile.

--path

Path to monitor. Use ""('""' in PowerShell) for none.

--port

Port to monitor.

--protocol

Monitor protocol.

accepted values: HTTP, HTTPS, TCP
--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>.

--routing-method

Routing method.

accepted values: Geographic, Multivalue, Performance, Priority, Subnet, Weighted
--set

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

--status

Status of the Traffic Manager profile.

accepted values: Disabled, Enabled
--status-code-ranges

Space-separated list of status codes in MIN-MAX or VAL format.

--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--timeout

The time in seconds allowed for endpoints to respond to a health check.

--ttl

DNS config time-to-live in seconds.