az network traffic-manager profile
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
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
DNS prefix to verify availability for.
Optional Parameters
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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.
Increase logging verbosity. Use --debug for full debug logs.
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
[--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
Traffic manager profile name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Routing method.
Relative DNS name for the traffic manager profile. Resulting FQDN will be <unique-dns-name>.trafficmanager.net
and must be globally unique.
Optional Parameters
Space-separated list of NAME=VALUE pairs.
The interval in seconds at which health checks are conducted.
The number of consecutive failed health checks tolerated before an endpoint is considered degraded.
Path to monitor. Use ""('""' in PowerShell) for none.
Port to monitor.
Monitor protocol.
Status of the Traffic Manager profile.
Space-separated list of status codes in MIN-MAX or VAL format.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
The time in seconds allowed for endpoints to respond to a health check.
DNS config time-to-live in seconds.
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.
Increase logging verbosity. Use --debug for full debug logs.
az network traffic-manager profile delete
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
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 name of the Traffic Manager profile to be deleted.
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
.
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.
Increase logging verbosity. Use --debug for full debug logs.
az network traffic-manager profile list
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
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.
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
.
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.
Increase logging verbosity. Use --debug for full debug logs.
az network traffic-manager profile show
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
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 name of the Traffic Manager profile.
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.
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
.
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.
Increase logging verbosity. Use --debug for full debug logs.
az network traffic-manager profile update
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 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>.
Space-separated list of NAME=VALUE pairs.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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 interval in seconds at which health checks are conducted.
The number of consecutive failed health checks tolerated before an endpoint is considered degraded.
The name of the Traffic Manager profile.
Path to monitor. Use ""('""' in PowerShell) for none.
Port to monitor.
Monitor protocol.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Routing method.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Status of the Traffic Manager profile.
Space-separated list of status codes in MIN-MAX or VAL format.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
The time in seconds allowed for endpoints to respond to a health check.
DNS config time-to-live in seconds.
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.
Increase logging verbosity. Use --debug for full debug logs.