az hpc-cache

Commands to manage hpc cache.

Commands

az hpc-cache blob-storage-target

Commands to create hpc cache blob storage target.

az hpc-cache blob-storage-target add

Create or update a blob Storage Target. This operation is allowed at any time, but if the Cache is down or unhealthy, the actual creation/modification of the Storage Target may be delayed until the Cache is healthy again.

az hpc-cache blob-storage-target update

Create or update a blob Storage Target. This operation is allowed at any time, but if the Cache is down or unhealthy, the actual creation/modification of the Storage Target may be delayed until the Cache is healthy again.

az hpc-cache create

Create or update a Cache.

az hpc-cache delete

Schedules a Cache for deletion.

az hpc-cache flush

Tells a Cache to write all dirty data to the Storage Target(s). During the flush, clients will see errors returned until the flush is complete.

az hpc-cache list

Returns all Caches the user has access to under a resource group.

az hpc-cache nfs-storage-target

Commands to create hpc cache nfs storage target.

az hpc-cache nfs-storage-target add

Create or update a nfs Storage Target. This operation is allowed at any time, but if the Cache is down or unhealthy, the actual creation/modification of the Storage Target may be delayed until the Cache is healthy again.

az hpc-cache nfs-storage-target update

Create or update a nfs Storage Target. This operation is allowed at any time, but if the Cache is down or unhealthy, the actual creation/modification of the Storage Target may be delayed until the Cache is healthy again.

az hpc-cache show

Returns a Cache.

az hpc-cache skus

Commands to manage hpc cache skus.

az hpc-cache skus list

Get the list of StorageCache.Cache SKUs available to this subscription.

az hpc-cache start

Tells a Stopped state Cache to transition to Active state.

az hpc-cache stop

Tells an Active Cache to transition to Stopped state.

az hpc-cache storage-target

Commands to manage hpc cache storage target.

az hpc-cache storage-target list

Returns a list of Storage Targets for the specified Cache.

az hpc-cache storage-target remove

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

Returns a Storage Target from a Cache.

az hpc-cache update

Create or update a Cache.

az hpc-cache upgrade-firmware

Upgrade a Cache's firmware if a new version is available. Otherwise, this operation has no effect.

az hpc-cache usage-model

Commands to manage hpc cache usage model.

az hpc-cache usage-model list

Get the list of Cache Usage Models available to this subscription.

az hpc-cache wait

Waits a hpc Cache to specified state.

az hpc-cache create

Create or update a Cache.

az hpc-cache create --cache-size-gb
                    --location
                    --name
                    --resource-group
                    --sku-name
                    --subnet
                    [--no-wait]
                    [--tags]

Examples

Caches_CreateOrUpdate

az hpc-cache create --resource-group "scgroup" --name "sc1" --location "eastus" \
--cache-size-gb "3072" --subnet "/subscriptions/{{ subscription_id }}/resourceGroups/{{ re
source_group }}/providers/Microsoft.Network/virtualNetworks/{{ virtual_network_name }}/sub
nets/{{ subnet_name }}" --sku-name "Standard_2G"

Required Parameters

--cache-size-gb

The size of this Cache, in GB.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--name

Name of Cache.

--resource-group -g

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

--sku-name

SKU name for this Cache.

--subnet

Subnet used for the Cache.

Optional Parameters

--no-wait

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

--tags

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

az hpc-cache delete

Schedules a Cache for deletion.

az hpc-cache delete --name
                    --resource-group
                    [--no-wait]

Examples

Caches_Delete

az hpc-cache delete --resource-group "scgroup" --name "sc"

Required Parameters

--name

Name of Cache.

--resource-group -g

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

Optional Parameters

--no-wait

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

az hpc-cache flush

Tells a Cache to write all dirty data to the Storage Target(s). During the flush, clients will see errors returned until the flush is complete.

az hpc-cache flush --name
                   --resource-group

Examples

Caches_Flush

az hpc-cache flush --resource-group "scgroup" --name "sc"

Required Parameters

--name

Name of Cache.

--resource-group -g

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

az hpc-cache list

Returns all Caches the user has access to under a resource group.

az hpc-cache list [--resource-group]

Examples

Caches_List

az hpc-cache list

Caches_ListByResourceGroup

az hpc-cache list --resource-group "scgroup"

Optional Parameters

--resource-group -g

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

az hpc-cache show

Returns a Cache.

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

Examples

Caches_Get

az hpc-cache show --resource-group "scgroup" --name "sc1"

Required Parameters

--name

Name of Cache.

--resource-group -g

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

az hpc-cache start

Tells a Stopped state Cache to transition to Active state.

az hpc-cache start --name
                   --resource-group
                   [--no-wait]

Examples

Caches_Start

az hpc-cache start --resource-group "scgroup" --name "sc"

Required Parameters

--name

Name of Cache.

--resource-group -g

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

Optional Parameters

--no-wait

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

az hpc-cache stop

Tells an Active Cache to transition to Stopped state.

az hpc-cache stop --name
                  --resource-group
                  [--no-wait]

Examples

Caches_Stop

az hpc-cache stop --resource-group "scgroup" --name "sc"

Required Parameters

--name

Name of Cache.

--resource-group -g

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

Optional Parameters

--no-wait

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

az hpc-cache update

Create or update a Cache.

az hpc-cache update --name
                    --resource-group
                    [--cache-size-gb]
                    [--location]
                    [--sku-name]
                    [--subnet]
                    [--tags]

Examples

Caches_Update

az hpc-cache update --resource-group "scgroup" --name "sc1" --location "eastus" \
--cache-size-gb "3072" --subnet "/subscriptions/{{ subscription_id }}/resourceGroups/{{ re
source_group }}/providers/Microsoft.Network/virtualNetworks/{{ virtual_network_name }}/sub
nets/{{ subnet_name }}" --sku-name "Standard_2G"

Required Parameters

--name

Name of Cache.

--resource-group -g

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

Optional Parameters

--cache-size-gb

The size of this Cache, in GB.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--sku-name

SKU name for this Cache.

--subnet

Subnet used for the Cache.

--tags

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

az hpc-cache upgrade-firmware

Upgrade a Cache's firmware if a new version is available. Otherwise, this operation has no effect.

az hpc-cache upgrade-firmware --name
                              --resource-group

Examples

Caches_UpgradeFirmware

az hpc-cache upgrade-firmware --resource-group "scgroup" --name "sc"

Required Parameters

--name

Name of Cache.

--resource-group -g

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

az hpc-cache wait

Waits a hpc Cache to specified state.

az hpc-cache wait --name
                  --resource-group
                  [--created]
                  [--custom]
                  [--deleted]
                  [--exists]
                  [--interval]
                  [--timeout]
                  [--updated]

Examples

Caches_Wait

az hpc-cache wait --resource-group "scgroup" --name "sc" --created

Required Parameters

--name

Name of Cache.

--resource-group -g

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

Optional Parameters

--created

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

--custom

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

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--interval

Polling interval in seconds.

default value: 30
--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.