Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

az stack-hci-vm storagepath

Note

This reference is part of the stack-hci-vm extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az stack-hci-vm storagepath command. Learn more about extensions.

Manage storagepath with stack-hci-vm.

Commands

Name Description Type Status
az stack-hci-vm storagepath create

Create a storage path.

 Extension GA
az stack-hci-vm storagepath delete

Delete a storage path.

 Extension GA
az stack-hci-vm storagepath list

List all the storage paths.

 Extension GA
az stack-hci-vm storagepath show

Get the details of a storage path.

 Extension GA
az stack-hci-vm storagepath update

Update a storage path.

 Extension GA

az stack-hci-vm storagepath create

Create a storage path.

az stack-hci-vm storagepath create --custom-location
 --name
 --path
 --resource-group
 [--acquire-policy-token]
 [--change-reference]
 [--location]
 [--polling-interval]
 [--tags]

Examples

PutStoragePath

az stack-hci-vm storagepath create --resource-group "test-rg" --custom-location "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location" --location "West US2" --path "C:\\path_storage" --name "Default_StoragePath"

Required Parameters

--custom-location

The ID of the custom location.

--name

Name of the storage path.

--path

Path on a disk to create storagepath.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--location -l

If location is not specified, the location of the resource group is used.

--polling-interval

ARM polling interval for long running operations.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az stack-hci-vm storagepath delete

Delete a storage path.

az stack-hci-vm storagepath delete [--acquire-policy-token]
 [--change-reference]
 [--ids]
 [--name]
 [--polling-interval]
 [--resource-group]
 [--subscription]
 [--yes]

Examples

DeleteStoragePath

az stack-hci-vm storagepath delete --resource-group "test-rg" --name "Default_StoragePath"

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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

Name of the storage path.

Property Value
Parameter group: Resource Id Arguments
--polling-interval

ARM polling interval for long running operations.

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

az stack-hci-vm storagepath list

List all the storage paths.

az stack-hci-vm storagepath list [--resource-group]

Examples

ListStoragePathByResourceGroup

az stack-hci-vm storagepath list --resource-group "test-rg"

ListStoragePathByResourceGroup

az stack-hci-vm storagepath list

Optional Parameters

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

--resource-group -g

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

az stack-hci-vm storagepath show

Get the details of a storage path.

az stack-hci-vm storagepath show [--ids]
 [--name]
 [--resource-group]
 [--subscription]

Examples

GetStoragePath

az stack-hci-vm storagepath show --resource-group "test-rg" --name "Default_StoragePath"

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

Name of the storage path.

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

az stack-hci-vm storagepath update

Update a storage path.

az stack-hci-vm storagepath update [--acquire-policy-token]
 [--change-reference]
 [--ids]
 [--name]
 [--resource-group]
 [--subscription]
 [--tags]

Examples

UpdateStoragePath

az stack-hci-vm storagepath update --resource-group "test-rg" --tags additionalProperties="sample" --name "Default_StoragePath"

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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

Name of the storage path.

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

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Feedback

Was this page helpful?