az k8s-runtime storage-class
Note
This reference is part of the k8s-runtime extension for the Azure CLI (version 2.57.0 or higher). The extension will automatically install the first time you run an az k8s-runtime storage-class command. Learn more about extensions.
This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Manage storage classes of Arc Kubernetes clusters.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az k8s-runtime storage-class create |
Create a StorageClass. |
Extension | Preview |
| az k8s-runtime storage-class delete |
Delete a StorageClass. |
Extension | Preview |
| az k8s-runtime storage-class disable |
Disable storage class service in a connected cluster. |
Extension | Preview |
| az k8s-runtime storage-class enable |
Enable storage class service in a connected cluster. |
Extension | Preview |
| az k8s-runtime storage-class list |
List StorageClass resources by parent. |
Extension | Preview |
| az k8s-runtime storage-class show |
Get a StorageClass. |
Extension | Preview |
| az k8s-runtime storage-class update |
Update a StorageClass. |
Extension | Preview |
| az k8s-runtime storage-class wait |
Place the CLI in a waiting state until a condition is met. |
Extension | Preview |
az k8s-runtime storage-class create
Command group 'k8s-runtime storage-class' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Create a StorageClass.
az k8s-runtime storage-class create --resource-uri
--storage-class-name
[--access-modes]
[--allow-volume-expansion {Allow, Disallow}]
[--data-resilience {DataResilient, NotDataResilient}]
[--failover-speed {Fast, NotAvailable, Slow, Super}]
[--limitations]
[--mount-options]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--performance {Basic, Premium, Standard, Ultra, Undefined}]
[--priority]
[--provisioner]
[--type-properties]
[--volume-binding-mode {Immediate, WaitForFirstConsumer}]Examples
Create an RWX storage class on top of managed-csi storage class
az k8s-runtime storage-class create --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1 --storage-class-name rwxsc --type-properties rwx.backing-storage-class-name=managed-csiCreate a Blob storage class
az k8s-runtime storage-class create --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1 --storage-class-name blobsc --type-properties blob.azure-storage-account-key=accountkey blob.azure-storage-account-name=accountnameRequired Parameters
The fully qualified Azure Resource manager identifier of the resource.
The name of the the storage class.
Optional Parameters
The access mode: [ReadWriteOnce, ReadWriteMany] or [ReadWriteOnce] Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Volume can be expanded or not.
Allow single data node failure.
Failover speed: NA, Slow, Fast.
Limitations of the storage class Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Additional mount options Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Do not wait for the long-running operation to finish.
Performance tier.
Selection priority when multiple storage classes meet the criteria. 0: Highest, -1: Never use.
Provisioner name.
Properties of the StorageClass Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Binding mode of volumes: Immediate, WaitForFirstConsumer.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az k8s-runtime storage-class delete
Command group 'k8s-runtime storage-class' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Delete a StorageClass.
az k8s-runtime storage-class delete --resource-uri
--storage-class-name
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--yes]Examples
Delete a storage class
az k8s-runtime storage-class delete --storage-class-name sc1 --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1Required Parameters
The fully qualified Azure Resource manager identifier of the resource.
The name of the the storage class.
Optional Parameters
Do not wait for the long-running operation to finish.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az k8s-runtime storage-class disable
Command group 'k8s-runtime storage-class' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Disable storage class service in a connected cluster.
az k8s-runtime storage-class disable --resource-uriRequired Parameters
The resource uri of the connected cluster.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az k8s-runtime storage-class enable
Command group 'k8s-runtime storage-class' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Enable storage class service in a connected cluster.
az k8s-runtime storage-class enable --resource-uriRequired Parameters
The resource uri of the connected cluster.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az k8s-runtime storage-class list
Command group 'k8s-runtime storage-class' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
List StorageClass resources by parent.
az k8s-runtime storage-class list --resource-uri
[--max-items]
[--next-token]Examples
List all storage classes in a cluster
az k8s-runtime storage-class list --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1Required Parameters
The fully qualified Azure Resource manager identifier of the resource.
Optional Parameters
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az k8s-runtime storage-class show
Command group 'k8s-runtime storage-class' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get a StorageClass.
az k8s-runtime storage-class show --resource-uri
--storage-class-nameExamples
Show a storage class
az k8s-runtime storage-class show --storage-class-name sc1 --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1Required Parameters
The fully qualified Azure Resource manager identifier of the resource.
The name of the the storage class.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az k8s-runtime storage-class update
Command group 'k8s-runtime storage-class' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Update a StorageClass.
az k8s-runtime storage-class update --resource-uri
--storage-class-name
[--access-modes]
[--allow-volume-expansion {Allow, Disallow}]
[--data-resilience {DataResilient, NotDataResilient}]
[--failover-speed {Fast, NotAvailable, Slow, Super}]
[--limitations]
[--mount-options]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--performance {Basic, Premium, Standard, Ultra, Undefined}]
[--priority]
[--type-properties]Examples
Update the properties of a Blob storage class
az k8s-runtime storage-class update --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1 --storage-class-name blobsc --type-properties azure-storage-account-key=accountkey azure-storage-account-name=accountnameRequired Parameters
The fully qualified Azure Resource manager identifier of the resource.
The name of the the storage class.
Optional Parameters
The access mode: [ReadWriteOnce, ReadWriteMany] or [ReadWriteOnce] Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Volume can be expanded or not.
Allow single data node failure.
Failover speed: NA, Slow, Fast.
Limitations of the storage class Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Additional mount options Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Do not wait for the long-running operation to finish.
Performance tier.
Selection priority when multiple storage classes meet the criteria. 0: Highest, -1: Never use.
New storage class type of storageClass Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az k8s-runtime storage-class wait
Command group 'k8s-runtime storage-class' 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 k8s-runtime storage-class wait --resource-uri
--storage-class-name
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]Required Parameters
The fully qualified Azure Resource manager identifier of the resource.
The name of the the storage class.
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
Polling interval in seconds.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for