storage_class

Creates, updates, deletes, gets or lists a storage_class resource.

Overview

Name	storage_class
Type	Resource
Id	azure.container_orchestrator_runtime.storage_class

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
accessModes	array	The access mode: [ReadWriteOnce, ReadWriteMany] or [ReadWriteOnce].
allowVolumeExpansion	string	Volume can be expanded or not. Known values are: "Allow" and "Disallow". (Allow, Disallow)
dataResilience	string	Allow single data node failure. Known values are: "NotDataResilient" and "DataResilient". (NotDataResilient, DataResilient)
failoverSpeed	string	Failover speed: NA, Slow, Fast. Known values are: "NotAvailable", "Slow", "Fast", and "Super". (NotAvailable, Slow, Fast, Super)
limitations	array	Limitations of the storage class.
mountOptions	array	Additional mount options.
performance	string	Performance tier. Known values are: "Undefined", "Basic", "Standard", "Premium", and "Ultra". (Undefined, Basic, Standard, Premium, Ultra)
priority	integer	Selection priority when multiple storage classes meet the criteria. 0: Highest, -1: Never use.
provisioner	string	Provisioner name.
provisioningState	string	Resource provision state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
typeProperties	object	Properties of the StorageClass. Required.
volumeBindingMode	string	Binding mode of volumes: Immediate, WaitForFirstConsumer. Known values are: "Immediate" and "WaitForFirstConsumer". (Immediate, WaitForFirstConsumer)

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
accessModes	array	The access mode: [ReadWriteOnce, ReadWriteMany] or [ReadWriteOnce].
allowVolumeExpansion	string	Volume can be expanded or not. Known values are: "Allow" and "Disallow". (Allow, Disallow)
dataResilience	string	Allow single data node failure. Known values are: "NotDataResilient" and "DataResilient". (NotDataResilient, DataResilient)
failoverSpeed	string	Failover speed: NA, Slow, Fast. Known values are: "NotAvailable", "Slow", "Fast", and "Super". (NotAvailable, Slow, Fast, Super)
limitations	array	Limitations of the storage class.
mountOptions	array	Additional mount options.
performance	string	Performance tier. Known values are: "Undefined", "Basic", "Standard", "Premium", and "Ultra". (Undefined, Basic, Standard, Premium, Ultra)
priority	integer	Selection priority when multiple storage classes meet the criteria. 0: Highest, -1: Never use.
provisioner	string	Provisioner name.
provisioningState	string	Resource provision state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
typeProperties	object	Properties of the StorageClass. Required.
volumeBindingMode	string	Binding mode of volumes: Immediate, WaitForFirstConsumer. Known values are: "Immediate" and "WaitForFirstConsumer". (Immediate, WaitForFirstConsumer)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_uri, storage_class_name		Get a StorageClassResource.
list	select	resource_uri		List StorageClassResource resources by parent.
create_or_update	insert	resource_uri, storage_class_name		Create a StorageClassResource.
update	update	resource_uri, storage_class_name		Update a StorageClassResource.
create_or_update	replace	resource_uri, storage_class_name		Create a StorageClassResource.
delete	delete	resource_uri, storage_class_name		Delete a StorageClassResource.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resource_uri	string	The fully qualified Azure Resource manager identifier of the resource. Required.
storage_class_name	string	The name of the the storage class. Required.

SELECT examples

get

Get a StorageClassResource.

SELECT
id,
name,
accessModes,
allowVolumeExpansion,
dataResilience,
failoverSpeed,
limitations,
mountOptions,
performance,
priority,
provisioner,
provisioningState,
systemData,
type,
typeProperties,
volumeBindingMode
FROM azure.container_orchestrator_runtime.storage_class
WHERE resource_uri = '{{ resource_uri }}' -- required
AND storage_class_name = '{{ storage_class_name }}' -- required
;

list

List StorageClassResource resources by parent.

SELECT
id,
name,
accessModes,
allowVolumeExpansion,
dataResilience,
failoverSpeed,
limitations,
mountOptions,
performance,
priority,
provisioner,
provisioningState,
systemData,
type,
typeProperties,
volumeBindingMode
FROM azure.container_orchestrator_runtime.storage_class
WHERE resource_uri = '{{ resource_uri }}' -- required
;

INSERT examples

create_or_update

Create a StorageClassResource.

INSERT INTO azure.container_orchestrator_runtime.storage_class (
properties,
resource_uri,
storage_class_name
)
SELECT 
'{{ properties }}',
'{{ resource_uri }}',
'{{ storage_class_name }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: storage_class
props:
  - name: resource_uri
    value: "{{ resource_uri }}"
    description: Required parameter for the storage_class resource.
  - name: storage_class_name
    value: "{{ storage_class_name }}"
    description: Required parameter for the storage_class resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      allowVolumeExpansion: "{{ allowVolumeExpansion }}"
      mountOptions:
        - "{{ mountOptions }}"
      provisioner: "{{ provisioner }}"
      volumeBindingMode: "{{ volumeBindingMode }}"
      accessModes:
        - "{{ accessModes }}"
      dataResilience: "{{ dataResilience }}"
      failoverSpeed: "{{ failoverSpeed }}"
      limitations:
        - "{{ limitations }}"
      performance: "{{ performance }}"
      priority: {{ priority }}
      typeProperties:
        type: "{{ type }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Update a StorageClassResource.

UPDATE azure.container_orchestrator_runtime.storage_class
SET 
properties = '{{ properties }}'
WHERE 
resource_uri = '{{ resource_uri }}' --required
AND storage_class_name = '{{ storage_class_name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create a StorageClassResource.

REPLACE azure.container_orchestrator_runtime.storage_class
SET 
properties = '{{ properties }}'
WHERE 
resource_uri = '{{ resource_uri }}' --required
AND storage_class_name = '{{ storage_class_name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a StorageClassResource.

DELETE FROM azure.container_orchestrator_runtime.storage_class
WHERE resource_uri = '{{ resource_uri }}' --required
AND storage_class_name = '{{ storage_class_name }}' --required
;