az vmware workload-network segment

Note

This reference is part of the vmware extension for the Azure CLI (version 2.70.0 or higher). The extension will automatically install the first time you run an az vmware workload-network segment command. Learn more about extensions.

Commands to manage a Segment workload network.

Commands

Name	Description	Type	Status
az vmware workload-network segment create	Create a segment by id in a private cloud workload network.	Extension	GA
az vmware workload-network segment delete	Delete a segment by id in a private cloud workload network.	Extension	GA
az vmware workload-network segment list	List of segments in a private cloud workload network.	Extension	GA
az vmware workload-network segment show	Get a segment by id in a private cloud workload network.	Extension	GA
az vmware workload-network segment update	Update a segment by id in a private cloud workload network.	Extension	GA
az vmware workload-network segment wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az vmware workload-network segment create

Create a segment by id in a private cloud workload network.

az vmware workload-network segment create --name --segment
                                          --private-cloud
                                          --resource-group
                                          [--connected-gateway]
                                          [--dhcp-ranges]
                                          [--display-name]
                                          [--gateway-address]
                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--revision]

Examples

Create a segment by ID in a workload network.

az vmware workload-network segment create --resource-group group1 --private-cloud cloud1 --segment segment1 --display-name segment1 --connected-gateway /infra/tier-1s/gateway --dhcp-ranges "[40.20.0.0-40.20.0.1]" --gateway-address 40.20.20.20/16 --revision 1

Required Parameters

--name --segment -n

NSX Segment identifier. Generally the same as the Segment's display name.

--private-cloud -c

Name of the private cloud.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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.

--connected-gateway

Gateway which to connect segment to.

Property	Value
Parameter group:	Properties Arguments

--dhcp-ranges

DHCP Range assigned for subnet. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Subnet Arguments

--display-name

Display name of the segment.

Property	Value
Parameter group:	Properties Arguments

--gateway-address

Gateway address.

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

--revision

NSX revision number.

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 vmware workload-network segment delete

Delete a segment by id in a private cloud workload network.

az vmware workload-network segment delete [--ids]
                                          [--name --segment]
                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--private-cloud]
                                          [--resource-group]
                                          [--subscription]
                                          [--yes]

Examples

Delete a segment by ID in a workload network.

az vmware workload-network segment delete --resource-group group1 --private-cloud cloud1 --segment segment1

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

--name --segment -n

NSX Segment identifier. Generally the same as the Segment's display 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

--private-cloud -c

Name of the private cloud.

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

--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 vmware workload-network segment list

List of segments in a private cloud workload network.

az vmware workload-network segment list --private-cloud
                                        --resource-group
                                        [--max-items]
                                        [--next-token]

Examples

List of segments in a workload network.

az vmware workload-network segment list --resource-group group1 --private-cloud cloud1

Required Parameters

--private-cloud -c

Name of the private cloud.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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

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 vmware workload-network segment show

Get a segment by id in a private cloud workload network.

az vmware workload-network segment show [--ids]
                                        [--name --segment]
                                        [--private-cloud]
                                        [--resource-group]
                                        [--subscription]

Examples

Get a segment by ID in a workload network.

az vmware workload-network segment show --resource-group group1 --private-cloud cloud1 --segment segment1

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

Property	Value
Parameter group:	Resource Id Arguments

--name --segment -n

NSX Segment identifier. Generally the same as the Segment's display name.

Property	Value
Parameter group:	Resource Id Arguments

--private-cloud -c

Name of the private cloud.

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

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 vmware workload-network segment update

Update a segment by id in a private cloud workload network.

az vmware workload-network segment update [--add]
                                          [--connected-gateway]
                                          [--dhcp-ranges]
                                          [--display-name]
                                          [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--gateway-address]
                                          [--ids]
                                          [--name --segment]
                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--private-cloud]
                                          [--remove]
                                          [--resource-group]
                                          [--revision]
                                          [--set]
                                          [--subscription]

Examples

Update a segment by ID in a workload network.

az vmware workload-network segment update --resource-group group1 --private-cloud cloud1 --segment segment1 --display-name segment1 --connected-gateway /infra/tier-1s/gateway --revision 1 --dhcp-ranges 40.20.0.0 40.20.0.1 --gateway-address 40.20.20.20/16

Optional Parameters

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

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

Property	Value
Parameter group:	Generic Update Arguments

--connected-gateway

Gateway which to connect segment to.

Property	Value
Parameter group:	Properties Arguments

--dhcp-ranges

DHCP Range assigned for subnet. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Subnet Arguments

--display-name

Display name of the segment.

Property	Value
Parameter group:	Properties Arguments

--force-string

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

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--gateway-address

Gateway address.

Property	Value
Parameter group:	Subnet Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name --segment -n

NSX Segment identifier. Generally the same as the Segment's display 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

--private-cloud -c

Name of the private cloud.

Property	Value
Parameter group:	Resource Id Arguments

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update 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

--revision

NSX revision number.

Property	Value
Parameter group:	Properties Arguments

--set

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

Property	Value
Parameter group:	Generic Update 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

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 vmware workload-network segment wait

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

az vmware workload-network segment wait [--created]
                                        [--custom]
                                        [--deleted]
                                        [--exists]
                                        [--ids]
                                        [--interval]
                                        [--name --segment]
                                        [--private-cloud]
                                        [--resource-group]
                                        [--subscription]
                                        [--timeout]
                                        [--updated]

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

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name --segment -n

NSX Segment identifier. Generally the same as the Segment's display name.

Property	Value
Parameter group:	Resource Id Arguments

--private-cloud -c

Name of the private cloud.

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

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

Share via

az vmware workload-network segment

Commands

az vmware workload-network segment create

Examples

Required Parameters

Optional Parameters

az vmware workload-network segment delete

Examples

Optional Parameters

az vmware workload-network segment list

Examples

Required Parameters

Optional Parameters

az vmware workload-network segment show

Examples

Optional Parameters

az vmware workload-network segment update

Examples

Optional Parameters

az vmware workload-network segment wait

Optional Parameters

Feedback