az hpc-cache storage-target

  • Reference

Note

This reference is part of the hpc-cache extension for the Azure CLI (version 2.3.0 or higher). The extension will automatically install the first time you run an az hpc-cache storage-target command. Learn more about extensions.

Commands to manage hpc cache storage target.

Commands

Name Description Type Status
az hpc-cache storage-target list

Return a list of Storage Targets for the specified Cache.

 Extension GA
az hpc-cache storage-target remove

Remove a Storage Target from a Cache. This operation is allowed at any time, but if the Cache is down or unhealthy, the actual removal of the Storage Target may be delayed until the Cache is healthy again. Note that if the Cache has data to flush to the Storage Target, the data will be flushed before the Storage Target will be deleted.

 Extension GA
az hpc-cache storage-target show

Return a Storage Target from a Cache.

 Extension GA

az hpc-cache storage-target list

Return a list of Storage Targets for the specified Cache.

az hpc-cache storage-target list --cache-name
                                 --resource-group

Examples

StorageTargets_List

az hpc-cache storage-target list --resource-group "scgroup" --cache-name "sc1"

Required Parameters

--cache-name

Name of Cache.

--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 hpc-cache storage-target remove

Remove a Storage Target from a Cache. This operation is allowed at any time, but if the Cache is down or unhealthy, the actual removal of the Storage Target may be delayed until the Cache is healthy again. Note that if the Cache has data to flush to the Storage Target, the data will be flushed before the Storage Target will be deleted.

az hpc-cache storage-target remove --cache-name
                                   --name
                                   --resource-group

Examples

StorageTargets_Delete

az hpc-cache storage-target remove --resource-group "scgroup" --cache-name "sc1" --name "st1"

Required Parameters

--cache-name

Name of Cache.

--name

Name of the Storage Target.

--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 hpc-cache storage-target show

Return a Storage Target from a Cache.

az hpc-cache storage-target show --cache-name
                                 --name
                                 --resource-group

Examples

StorageTargets_Get

az hpc-cache storage-target show --resource-group "scgroup" --cache-name "sc1" --name "st1"

Required Parameters

--cache-name

Name of Cache.

--name

Name of the Storage Target.

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