az network manager scope-connection

  • Reference

Note

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

Manage scope connection with network.

Commands

Name Description Type Status
az network manager scope-connection create

Create scope connection from Network Manager.

 Extension GA
az network manager scope-connection delete

Delete the pending scope connection created by this network manager.

 Extension GA
az network manager scope-connection list

List all scope connections created by this network manager.

 Extension GA
az network manager scope-connection show

Get specified scope connection created by this Network Manager.

 Extension GA
az network manager scope-connection update

Update scope connection from Network Manager.

 Extension GA

az network manager scope-connection create

Create scope connection from Network Manager.

az network manager scope-connection create --connection-name
                                           --network-manager
                                           --resource-group
                                           --resource-id
                                           --tenant-id
                                           [--description]

Examples

Create network manager scope-connection

az network manager scope-connection create --name "TestScopeConnect" --network-manager-name "testNetworkManager" --resource-group "rg1" --description "A sample policy" --tenant-id 00000000-0000-0000-0000-000000000000 --resource-id /subscriptions/00000000-0000-0000-0000-000000000000

Required Parameters

--connection-name --name --scope-connection-name -n

Name for the cross-tenant connection.

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

--resource-id

Resource ID.

--tenant-id

Tenant ID.

Optional Parameters

--description

A description of the scope connection.

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 network manager scope-connection delete

Delete the pending scope connection created by this network manager.

az network manager scope-connection delete [--connection-name]
                                           [--ids]
                                           [--network-manager]
                                           [--resource-group]
                                           [--subscription]
                                           [--yes]

Examples

Delete network manager scope connection

az network manager scope-connection delete --name "TestScopeConnect" --network-manager-name "testNetworkManager" --resource-group "rg1"

Optional Parameters

--connection-name --name --scope-connection-name -n

Name for the cross-tenant connection.

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

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

--subscription

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

--yes -y

Do not prompt for confirmation.

default value: False
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 network manager scope-connection list

List all scope connections created by this network manager.

az network manager scope-connection list --network-manager
                                         --resource-group
                                         [--max-items]
                                         [--next-token]
                                         [--skip-token]
                                         [--top]

Examples

List scope connections in a network manager

az network manager scope-connection list --network-manager-name "testNetworkManager" --resource-group "rg1"

Required Parameters

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

Optional Parameters

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

--next-token

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

--skip-token

SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.

--top

An optional query parameter which specifies the maximum number of records to be returned by the server.

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 network manager scope-connection show

Get specified scope connection created by this Network Manager.

az network manager scope-connection show [--connection-name]
                                         [--ids]
                                         [--network-manager]
                                         [--resource-group]
                                         [--subscription]

Examples

Get network manager scope-connection

az network manager scope-connection show --name "TestScopeConnect" --network-manager-name "testNetworkManager" --resource-group "rg1"

Optional Parameters

--connection-name --name --scope-connection-name -n

Name for the cross-tenant connection.

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

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

--subscription

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

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 network manager scope-connection update

Update scope connection from Network Manager.

az network manager scope-connection update [--add]
                                           [--connection-name]
                                           [--description]
                                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--ids]
                                           [--network-manager]
                                           [--remove]
                                           [--resource-group]
                                           [--set]
                                           [--subscription]

Examples

Update network manager scope-connection

az network manager scope-connection update --name "TestScopeConnect" --network-manager-name "testNetworkManager" --resource-group "rg1" --description "A sample policy"

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

--connection-name --name --scope-connection-name -n

Name for the cross-tenant connection.

--description

A description of the scope connection.

--force-string

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

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

The name of the network manager.

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

--set

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

--subscription

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

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.