az network traffic-manager profile

Manage Azure Traffic Manager profiles.

Commands

Name	Description	Type	Status
az network traffic-manager profile check-dns	Check the availability of a relative DNS name.	Core	GA
az network traffic-manager profile create	Create a traffic manager profile.	Core	GA
az network traffic-manager profile delete	Delete a Traffic Manager profile.	Core	GA
az network traffic-manager profile list	List all Traffic Manager profiles within a resource group.	Core	GA
az network traffic-manager profile show	Get a Traffic Manager profile.	Core	GA
az network traffic-manager profile update	Update a traffic manager profile.	Core	GA

az network traffic-manager profile check-dns

Check the availability of a relative DNS name.

az network traffic-manager profile check-dns [--acquire-policy-token]
                                             [--change-reference]
                                             [--name]
                                             [--type]

Examples

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

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

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--name -n

DNS prefix to verify availability for.

Property	Value
Parameter group:	Parameters Arguments

--type

The type of the resource.

Property	Value
Parameter group:	Parameters Arguments
Default value:	Microsoft.Network/trafficManagerProfiles

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

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
                                          [--acquire-policy-token]
                                          [--change-reference]
                                          [--custom-headers]
                                          [--interval]
                                          [--max-failures]
                                          [--max-return]
                                          [--path]
                                          [--port]
                                          [--protocol {HTTP, HTTPS, TCP}]
                                          [--record-type {A, AAAA, CNAME}]
                                          [--status {Disabled, Enabled}]
                                          [--status-code-ranges]
                                          [--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.

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

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--custom-headers

Space-separated list of NAME=VALUE pairs.

Property	Value
Parameter group:	Monitor Configuration Arguments

--interval

The interval in seconds at which health checks are conducted.

Property	Value
Parameter group:	Monitor Configuration Arguments

--max-failures

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

Property	Value
Parameter group:	Monitor Configuration Arguments

--max-return

Maximum number of endpoints to be returned for MultiValue routing type.

--path

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

Property	Value
Parameter group:	Monitor Configuration Arguments

--port

Port to monitor.

Property	Value
Parameter group:	Monitor Configuration Arguments
Default value:	80

--protocol

Monitor protocol.

Property	Value
Parameter group:	Monitor Configuration Arguments
Default value:	HTTP
Accepted values:	HTTP, HTTPS, TCP

--record-type

When record type is set, a traffic manager profile will allow only endpoints that match this type. If it is not set, traffic manager profile will allow adding all types of endpoints. It is returned as null when this is not set.

Property	Value
Accepted values:	A, AAAA, CNAME

--status

Status of the Traffic Manager profile.

Property	Value
Default value:	Enabled
Accepted values:	Disabled, Enabled

--status-code-ranges

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

Property	Value
Parameter group:	Monitor Configuration Arguments

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

Property	Value
Parameter group:	Monitor Configuration Arguments

--ttl

DNS config time-to-live in seconds.

Property	Value
Default value:	30

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

Delete a Traffic Manager profile.

az network traffic-manager profile delete [--acquire-policy-token]
                                          [--change-reference]
                                          [--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

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

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

The name of the Traffic Manager profile to be deleted.

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

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

List all Traffic Manager profiles within a resource group.

az network traffic-manager profile list [--resource-group]

Examples

List traffic manager profiles.

az network traffic-manager profile list -g MyResourceGroup

Optional Parameters

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

--resource-group -g

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

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

Get a Traffic Manager profile.

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

Examples

Get the details of a traffic manager profile.

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

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 --profile-name -n

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

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

Update a traffic manager profile.

az network traffic-manager profile update [--acquire-policy-token]
                                          [--change-reference]
                                          [--custom-headers]
                                          [--ids]
                                          [--interval]
                                          [--max-failures]
                                          [--max-return]
                                          [--name]
                                          [--path]
                                          [--port]
                                          [--protocol {HTTP, HTTPS, TCP}]
                                          [--record-type {A, AAAA, CNAME}]
                                          [--resource-group]
                                          [--routing-method {Geographic, Multivalue, Performance, Priority, Subnet, Weighted}]
                                          [--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

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--custom-headers

Space-separated list of NAME=VALUE pairs.

Property	Value
Parameter group:	Monitor Configuration Arguments

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

--interval

The interval in seconds at which health checks are conducted.

Property	Value
Parameter group:	Monitor Configuration Arguments

--max-failures

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

Property	Value
Parameter group:	Monitor Configuration Arguments

--max-return

Maximum number of endpoints to be returned for MultiValue routing type.

--name -n

Traffic manager profile name.

Property	Value
Parameter group:	Resource Id Arguments

--path

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

Property	Value
Parameter group:	Monitor Configuration Arguments

--port

Port to monitor.

Property	Value
Parameter group:	Monitor Configuration Arguments

--protocol

Monitor protocol.

Property	Value
Parameter group:	Monitor Configuration Arguments
Accepted values:	HTTP, HTTPS, TCP

--record-type

When record type is set, a traffic manager profile will allow only endpoints that match this type. If it is not set, traffic manager profile will allow adding all types of endpoints. It is returned as null when this is not set.

Property	Value
Accepted values:	A, AAAA, CNAME

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

--routing-method

Routing method.

Property	Value
Accepted values:	Geographic, Multivalue, Performance, Priority, Subnet, Weighted

--status

Status of the Traffic Manager profile.

Property	Value
Accepted values:	Disabled, Enabled

--status-code-ranges

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

Property	Value
Parameter group:	Monitor Configuration 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

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

Property	Value
Parameter group:	Monitor Configuration Arguments

--ttl

DNS config time-to-live in seconds.

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