az internet-analyzer test

  • Reference

Note

This reference is part of the internet-analyzer extension for the Azure CLI (version 2.0.67 or higher). The extension will automatically install the first time you run an az internet-analyzer test command. Learn more about extensions.

Commands to manage tests.

Commands

Name Description Type Status
az internet-analyzer test create

Create test.

 Extension GA
az internet-analyzer test delete

Delete test.

 Extension GA
az internet-analyzer test list

List tests.

 Extension GA
az internet-analyzer test show

Show test.

 Extension GA
az internet-analyzer test update

Update test.

 Extension GA

az internet-analyzer test create

Create test.

az internet-analyzer test create --name
                                 --profile-name
                                 --resource-group
                                 [--description]
                                 [--enabled-state {Disabled, Enabled}]
                                 [--endpoint-a-endpoint]
                                 [--endpoint-a-name]
                                 [--endpoint-b-endpoint]
                                 [--endpoint-b-name]
                                 [--location]
                                 [--tags]

Examples

Creates a test

az internet-analyzer test create --resource-group "MyResourceGroup" --profile-name \
"MyProfile" --name "MyExperiment" --description "this is my first experiment!" \
--endpoint-a-name "endpoint A" --endpoint-a-endpoint "endpointA.net" --endpoint-b-name \
"endpoint B" --endpoint-b-endpoint "endpointB.net" --enabled-state "Enabled"

Required Parameters

--name

The name of the Internet Analyzer test to be created.

--profile-name

The name of the Internet Analyzer profile under which the new test should be created.

--resource-group -g

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

Optional Parameters

--description

The description of the details or intents of the test.

--enabled-state

The initial of the test.

accepted values: Disabled, Enabled
--endpoint-a-endpoint

The URL of the control endpoint in [/] format (e.g., www.contoso.com or www.contoso.com/some/path/to/trans.gif). Must support HTTPS. If an object path isn't specified explicitly, Internet Analyzer will use "/apc/trans.gif" as the object path by default, which is where the preconfigured endpoints are hosting the one-pixel image.

--endpoint-a-name

The name of the control endpoint.

--endpoint-b-endpoint

The URL of the other endpoint in [/] format (e.g., www.contoso.com or www.contoso.com/some/path/to/trans.gif). Must support HTTPS. If an object path isn't specified explicitly, Internet Analyzer will use "/apc/trans.gif" as the object path by default, which is where the preconfigured endpoints are hosting the one-pixel image.

--endpoint-b-name

The name of the other endpoint.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--tags

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az internet-analyzer test delete

Delete test.

az internet-analyzer test delete --name
                                 --profile-name
                                 --resource-group

Examples

Deletes a test

az internet-analyzer test delete --resource-group "MyResourceGroup" --profile-name \
"MyProfile" --name "MyExperiment"

Required Parameters

--name

The name of the Internet Analyzer test to delete.

--profile-name

The name of the Internet Analyzer profile under which the test exists.

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az internet-analyzer test list

List tests.

az internet-analyzer test list --profile-name
                               --resource-group

Examples

Gets a list of tests

az internet-analyzer test list --resource-group "MyResourceGroup" --profile-name \
"MyProfile"

Required Parameters

--profile-name

The name of the Internet Analyzer profile for which to list tests.

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az internet-analyzer test show

Show test.

az internet-analyzer test show --name
                               --profile-name
                               --resource-group

Examples

Gets a test by name

az internet-analyzer test show --resource-group "MyResourceGroup" --profile-name \
"MyProfile" --name "MyExperiment"

Required Parameters

--name

The name of the Internet Analyzer test to show.

--profile-name

The name of the Internet Analyzer profile under which the test exists.

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az internet-analyzer test update

Update test.

az internet-analyzer test update --name
                                 --profile-name
                                 --resource-group
                                 [--description]
                                 [--enabled-state {Disabled, Enabled}]
                                 [--endpoint-a-endpoint]
                                 [--endpoint-a-name]
                                 [--endpoint-b-endpoint]
                                 [--endpoint-b-name]
                                 [--location]
                                 [--tags]

Examples

Updates a test

az internet-analyzer test update --resource-group "MyResourceGroup" --profile-name \
"MyProfile" --name "MyExperiment" --description "string" --enabled-state "Enabled"

Required Parameters

--name

The name of the Internet Analyzer test to be updated.

--profile-name

The name of the Internet Analyzer profile under which the test exists.

--resource-group -g

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

Optional Parameters

--description

The description of the details or intents of the test.

--enabled-state

The state of the Experiment.

accepted values: Disabled, Enabled
--endpoint-a-endpoint

The URL of the control endpoint in [/] format (e.g., www.contoso.com or www.contoso.com/some/path/to/trans.gif). Must support HTTPS. If an object path isn't specified explicitly, Internet Analyzer will use "/apc/trans.gif" as the object path by default, which is where the preconfigured endpoints are hosting the one-pixel image.

--endpoint-a-name

The name of the control endpoint.

--endpoint-b-endpoint

The URL of the other endpoint in [/] format (e.g., www.contoso.com or www.contoso.com/some/path/to/trans.gif). Must support HTTPS. If an object path isn't specified explicitly, Internet Analyzer will use "/apc/trans.gif" as the object path by default, which is where the preconfigured endpoints are hosting the one-pixel image.

--endpoint-b-name

The name of the other endpoint.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--tags

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.