az networkcloud trunkednetwork

  • Preview
  • Reference

Note

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

Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage trunked network.

Commands

Name Description Type Status
az networkcloud trunkednetwork create

Create a new trunked network or update the properties of the existing trunked network.

 Extension Preview
az networkcloud trunkednetwork delete

Delete the provided trunked network.

 Extension Preview
az networkcloud trunkednetwork list

List trunked networks in the provided resource group or subscription.

 Extension Preview
az networkcloud trunkednetwork show

Get properties of the provided trunked network.

 Extension Preview
az networkcloud trunkednetwork update

Update tags associated with the provided trunked network.

 Extension Preview
az networkcloud trunkednetwork wait

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

 Extension Preview

az networkcloud trunkednetwork create

Preview

Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a new trunked network or update the properties of the existing trunked network.

az networkcloud trunkednetwork create --extended-location
                                      --isolation-domain-ids
                                      --name
                                      --resource-group
                                      --vlans
                                      [--interface-name]
                                      [--location]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--tags]

Examples

Create or update trunked network

az networkcloud trunkednetwork create --resource-group "resourceGroupName" --name "trunkedNetworkName" --extended-location name="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" type="CustomLocation" --location "location" --interface-name "eth0" --isolation-domain-ids "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName" "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" --vlans 12 14 --tags key1="myvalue1" key2="myvalue2"

Required Parameters

--extended-location

The extended location of the cluster associated with the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--isolation-domain-ids

The list of resource IDs representing the Network Fabric isolation domains. It can be any combination of l2IsolationDomain and l3IsolationDomain resources. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--name --trunked-network-name -n

The name of the trunked network.

--resource-group -g

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

--vlans

The list of vlans that are selected from the isolation domains for trunking. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Optional Parameters

--interface-name

The default interface name for this trunked network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine.

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 networkcloud trunkednetwork delete

Preview

Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete the provided trunked network.

az networkcloud trunkednetwork delete [--ids]
                                      [--name]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--resource-group]
                                      [--subscription]
                                      [--yes]

Examples

Delete trunked network

az networkcloud trunkednetwork delete --resource-group "resourceGroupName" --name "trunkedNetworkName"

Optional Parameters

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

--name --trunked-network-name -n

The name of the trunked network.

--no-wait

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

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

--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 networkcloud trunkednetwork list

Preview

Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List trunked networks in the provided resource group or subscription.

az networkcloud trunkednetwork list [--max-items]
                                    [--next-token]
                                    [--resource-group]

Examples

List trunked networks for subscription

az networkcloud trunkednetwork list

List trunked networks for resource group

az networkcloud trunkednetwork list --resource-group "resourceGroupName"

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.

--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 networkcloud trunkednetwork show

Preview

Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get properties of the provided trunked network.

az networkcloud trunkednetwork show [--ids]
                                    [--name]
                                    [--resource-group]
                                    [--subscription]

Examples

Get trunked network

az networkcloud trunkednetwork show --resource-group "resourceGroupName" --name "trunkedNetworkName"

Optional Parameters

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

--name --trunked-network-name -n

The name of the trunked network.

--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 networkcloud trunkednetwork update

Preview

Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update tags associated with the provided trunked network.

az networkcloud trunkednetwork update [--ids]
                                      [--name]
                                      [--resource-group]
                                      [--subscription]
                                      [--tags]

Examples

Update tags for trunked network

az networkcloud trunkednetwork update --resource-group "resourceGroupName" --name "trunkedNetworkName" --tags key1="myvalue1" key2="myvalue2"

Optional Parameters

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

--name --trunked-network-name -n

The name of the trunked network.

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

--tags

The Azure resource tags that will replace the existing ones. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 networkcloud trunkednetwork wait

Preview

Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

az networkcloud trunkednetwork wait [--created]
                                    [--custom]
                                    [--deleted]
                                    [--exists]
                                    [--ids]
                                    [--interval]
                                    [--name]
                                    [--resource-group]
                                    [--subscription]
                                    [--timeout]
                                    [--updated]

Optional Parameters

--created

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

default value: False
--custom

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

--deleted

Wait until deleted.

default value: False
--exists

Wait until the resource exists.

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.

--interval

Polling interval in seconds.

default value: 30
--name --trunked-network-name -n

The name of the trunked network.

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

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

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.