Share via

az networkcloud storageappliance

  • Preview
  • Reference

Note

This reference is part of the networkcloud extension for the Azure CLI (version 2.61.0 or higher). The extension will automatically install the first time you run an az networkcloud storageappliance 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 storage appliance.

Commands

Name Description Type Status
az networkcloud storageappliance disable-remote-vendor-management

Disable remote vendor management of the provided storage appliance.

 Extension Preview
az networkcloud storageappliance enable-remote-vendor-management

Enable remote vendor management of the provided storage appliance.

 Extension Preview
az networkcloud storageappliance list

List storage appliances in the provided resource group or subscription.

 Extension Preview
az networkcloud storageappliance show

Get properties of the provided storage appliance.

 Extension Preview
az networkcloud storageappliance update

Update properties of the provided storage appliance, or update tags associated with the storage appliance Properties and tag updates can be done independently.

 Extension Preview
az networkcloud storageappliance wait

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

 Extension Preview

az networkcloud storageappliance disable-remote-vendor-management

Preview

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

Disable remote vendor management of the provided storage appliance.

az networkcloud storageappliance disable-remote-vendor-management [--ids]
                                                                  [--name]
                                                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                                  [--resource-group]
                                                                  [--subscription]

Examples

Turn off remote vendor management for storage appliance

az networkcloud storageappliance disable-remote-vendor-management --resource-group "resourceGroupName" --storage-appliance-name "storageApplianceName"

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 --storage-appliance-name -n

The name of the storage appliance.

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

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 storageappliance enable-remote-vendor-management

Preview

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

Enable remote vendor management of the provided storage appliance.

az networkcloud storageappliance enable-remote-vendor-management [--ids]
                                                                 [--name]
                                                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                                 [--resource-group]
                                                                 [--subscription]

Examples

Turn on remote vendor management for storage appliance

az networkcloud storageappliance enable-remote-vendor-management --resource-group "resourceGroupName" --storage-appliance-name "storageApplianceName"

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 --storage-appliance-name -n

The name of the storage appliance.

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

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 storageappliance list

Preview

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

List storage appliances in the provided resource group or subscription.

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

Examples

List storage appliances for subscription

az networkcloud storageappliance list

List storage appliances for resource group

az networkcloud storageappliance 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 storageappliance 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 storage appliance.

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

Examples

Get storage appliance

az networkcloud storageappliance show --resource-group "resourceGroupName" --storage-appliance-name "storageApplianceName"

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 --storage-appliance-name -n

The name of the storage appliance.

--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 storageappliance update

Preview

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

Update properties of the provided storage appliance, or update tags associated with the storage appliance Properties and tag updates can be done independently.

az networkcloud storageappliance update [--ids]
                                        [--name]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--resource-group]
                                        [--serial-number]
                                        [--subscription]
                                        [--tags]

Examples

Patch storage appliance

az networkcloud storageappliance update --resource-group "resourceGroupName" --storage-appliance-name "storageApplianceName" --serial-number "BM1219XXX" --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 --storage-appliance-name -n

The name of the storage appliance.

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

--serial-number

The serial number for the storage appliance.

--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 storageappliance 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 storageappliance 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 --storage-appliance-name -n

The name of the storage appliance.

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