Share via

az network manager verifier-workspace reachability-analysis-run

Note

This reference is part of the virtual-network-manager extension for the Azure CLI (version 2.61.0 or higher). The extension will automatically install the first time you run an az network manager verifier-workspace reachability-analysis-run command. Learn more about extensions.

Manage reachability analysis run with network.

Commands

Name Description Type Status
az network manager verifier-workspace reachability-analysis-run create

Create Reachability Analysis Runs.

 Extension GA
az network manager verifier-workspace reachability-analysis-run delete

Delete Reachability Analysis Run.

 Extension GA
az network manager verifier-workspace reachability-analysis-run list

List list of Reachability Analysis Runs.

 Extension GA
az network manager verifier-workspace reachability-analysis-run show

Get Reachability Analysis Run.

 Extension GA
az network manager verifier-workspace reachability-analysis-run wait

Place the CLI in a waiting state until a condition is met.

 Extension GA

az network manager verifier-workspace reachability-analysis-run create

Create Reachability Analysis Runs.

az network manager verifier-workspace reachability-analysis-run create --intent-id
                                                                       --manager-name --network-manager-name
                                                                       --name --reachability-analysis-run-name
                                                                       --resource-group
                                                                       --workspace-name
                                                                       [--description]

Examples

ReachabilityAnalysisRunCreate

az network manager verifier-workspace reachability-analysis-run create --name "myAnalysisRun" --workspace-name "myVerifierWorkspace" --network-manager-name "myAVNM" --resource-group "myAVNMResourceGroup" --subscription "00000000-0000-0000-0000-000000000000" --description “hello world analysis run” --intent-id “/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ myAVNMResourceGroup /providers/Microsoft.Network/networkManagers/myAVNM/verifierWorkspaces/myVerifierWorkspace /reachabilityAnalysisIntents/myAnalysisIntent”

Required Parameters

--intent-id

Id of the intent resource to run analysis on.

Property Value
Parameter group: Properties Arguments
--manager-name --network-manager-name

The name of the network manager.

--name --reachability-analysis-run-name -n

Reachability Analysis Run name.

--resource-group -g

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

--workspace-name

Workspace name.

Optional Parameters

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

--description

Description of the resource.

Property Value
Parameter group: Properties 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.

--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 manager verifier-workspace reachability-analysis-run delete

Delete Reachability Analysis Run.

az network manager verifier-workspace reachability-analysis-run delete [--ids]
                                                                       [--manager-name --network-manager-name]
                                                                       [--name --reachability-analysis-run-name]
                                                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                                       [--resource-group]
                                                                       [--subscription]
                                                                       [--workspace-name]
                                                                       [--yes]

Examples

ReachabilityAnalysisRunDelete

az network manager verifier-workspace reachability-analysis-run delete --workspace-name "myVerifierWorkspace" --network-manager-name "myAVNM" --resource-group "myAVNMResourceGroup" --name “myAnalysisRun” --subscription "00000000-0000-0000-0000-000000000000"

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
--manager-name --network-manager-name

The name of the network manager.

Property Value
Parameter group: Resource Id Arguments
--name --reachability-analysis-run-name -n

Reachability Analysis Run name.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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
--workspace-name

Workspace name.

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
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 manager verifier-workspace reachability-analysis-run list

List list of Reachability Analysis Runs.

az network manager verifier-workspace reachability-analysis-run list --manager-name --network-manager-name
                                                                     --resource-group
                                                                     --workspace-name
                                                                     [--max-items]
                                                                     [--next-token]
                                                                     [--skip]
                                                                     [--skip-token]
                                                                     [--sort-key]
                                                                     [--sort-value]
                                                                     [--top]

Examples

ReachabilityAnalysisRunList

az network manager verifier-workspace reachability-analysis-run list --workspace-name "myVerifierWorkspace" --network-manager-name "myAVNM" --resource-group "myAVNMResourceGroup" --subscription "00000000-0000-0000-0000-000000000000"

Required Parameters

--manager-name --network-manager-name

The name of the network manager.

--resource-group -g

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

--workspace-name

Workspace name.

Optional Parameters

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

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination Arguments
--skip

Optional num entries to skip.

Property Value
Default value: 0
--skip-token

Optional skip token.

--sort-key

Optional key by which to sort.

--sort-value

Optional sort value for pagination.

--top

Optional num entries to show.

Property Value
Default value: 50
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 manager verifier-workspace reachability-analysis-run show

Get Reachability Analysis Run.

az network manager verifier-workspace reachability-analysis-run show [--ids]
                                                                     [--manager-name --network-manager-name]
                                                                     [--name --reachability-analysis-run-name]
                                                                     [--resource-group]
                                                                     [--subscription]
                                                                     [--workspace-name]

Examples

ReachabilityAnalysisRunGet

az network manager verifier-workspace reachability-analysis-run show --name "myAnalysisRun" --workspace-name "myVerifierWorkspace" --network-manager-name "myAVNM" --resource-group "myAVNMResourceGroup" --subscription "00000000-0000-0000-0000-000000000000"

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
--manager-name --network-manager-name

The name of the network manager.

Property Value
Parameter group: Resource Id Arguments
--name --reachability-analysis-run-name -n

Reachability Analysis Run name.

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

Workspace name.

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 manager verifier-workspace reachability-analysis-run wait

Place the CLI in a waiting state until a condition is met.

az network manager verifier-workspace reachability-analysis-run wait [--created]
                                                                     [--custom]
                                                                     [--deleted]
                                                                     [--exists]
                                                                     [--ids]
                                                                     [--interval]
                                                                     [--manager-name --network-manager-name]
                                                                     [--name --reachability-analysis-run-name]
                                                                     [--resource-group]
                                                                     [--subscription]
                                                                     [--timeout]
                                                                     [--updated]
                                                                     [--workspace-name]

Optional Parameters

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

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--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

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--manager-name --network-manager-name

The name of the network manager.

Property Value
Parameter group: Resource Id Arguments
--name --reachability-analysis-run-name -n

Reachability Analysis Run name.

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

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--workspace-name

Workspace name.

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