--- api_metadata: apiVersion: "storage.k8s.io/v1beta1" import: "k8s.io/api/storage/v1beta1" kind: "VolumeAttributesClass" content_type: "api_reference" description: "VolumeAttributesClass represents a specification of mutable volume attributes defined by the CSI driver." title: "VolumeAttributesClass v1beta1" weight: 12 auto_generated: true --- `apiVersion: storage.k8s.io/v1beta1` `import "k8s.io/api/storage/v1beta1"` ## VolumeAttributesClass {#VolumeAttributesClass} VolumeAttributesClass represents a specification of mutable volume attributes defined by the CSI driver. The class can be specified during dynamic provisioning of PersistentVolumeClaims, and changed in the PersistentVolumeClaim spec after provisioning.
- **apiVersion**: storage.k8s.io/v1beta1 - **kind**: VolumeAttributesClass - **metadata** (}}">ObjectMeta) Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - **driverName** (string), required Name of the CSI driver This field is immutable. - **parameters** (map[string]string) parameters hold volume attributes defined by the CSI driver. These values are opaque to the Kubernetes and are passed directly to the CSI driver. The underlying storage provider supports changing these attributes on an existing volume, however the parameters field itself is immutable. To invoke a volume update, a new VolumeAttributesClass should be created with new parameters, and the PersistentVolumeClaim should be updated to reference the new VolumeAttributesClass. This field is required and must contain at least one key/value pair. The keys cannot be empty, and the maximum number of parameters is 512, with a cumulative max size of 256K. If the CSI driver rejects invalid parameters, the target PersistentVolumeClaim will be set to an "Infeasible" state in the modifyVolumeStatus field. ## VolumeAttributesClassList {#VolumeAttributesClassList} VolumeAttributesClassList is a collection of VolumeAttributesClass objects.
- **apiVersion**: storage.k8s.io/v1beta1 - **kind**: VolumeAttributesClassList - **metadata** (}}">ListMeta) Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - **items** ([]}}">VolumeAttributesClass), required items is the list of VolumeAttributesClass objects. ## Operations {#Operations}
### `get` read the specified VolumeAttributesClass #### HTTP Request GET /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} #### Parameters - **name** (*in path*): string, required name of the VolumeAttributesClass - **pretty** (*in query*): string }}">pretty #### Response 200 (}}">VolumeAttributesClass): OK 401: Unauthorized ### `list` list or watch objects of kind VolumeAttributesClass #### HTTP Request GET /apis/storage.k8s.io/v1beta1/volumeattributesclasses #### Parameters - **allowWatchBookmarks** (*in query*): boolean }}">allowWatchBookmarks - **continue** (*in query*): string }}">continue - **fieldSelector** (*in query*): string }}">fieldSelector - **labelSelector** (*in query*): string }}">labelSelector - **limit** (*in query*): integer }}">limit - **pretty** (*in query*): string }}">pretty - **resourceVersion** (*in query*): string }}">resourceVersion - **resourceVersionMatch** (*in query*): string }}">resourceVersionMatch - **sendInitialEvents** (*in query*): boolean }}">sendInitialEvents - **timeoutSeconds** (*in query*): integer }}">timeoutSeconds - **watch** (*in query*): boolean }}">watch #### Response 200 (}}">VolumeAttributesClassList): OK 401: Unauthorized ### `create` create a VolumeAttributesClass #### HTTP Request POST /apis/storage.k8s.io/v1beta1/volumeattributesclasses #### Parameters - **body**: }}">VolumeAttributesClass, required - **dryRun** (*in query*): string }}">dryRun - **fieldManager** (*in query*): string }}">fieldManager - **fieldValidation** (*in query*): string }}">fieldValidation - **pretty** (*in query*): string }}">pretty #### Response 200 (}}">VolumeAttributesClass): OK 201 (}}">VolumeAttributesClass): Created 202 (}}">VolumeAttributesClass): Accepted 401: Unauthorized ### `update` replace the specified VolumeAttributesClass #### HTTP Request PUT /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} #### Parameters - **name** (*in path*): string, required name of the VolumeAttributesClass - **body**: }}">VolumeAttributesClass, required - **dryRun** (*in query*): string }}">dryRun - **fieldManager** (*in query*): string }}">fieldManager - **fieldValidation** (*in query*): string }}">fieldValidation - **pretty** (*in query*): string }}">pretty #### Response 200 (}}">VolumeAttributesClass): OK 201 (}}">VolumeAttributesClass): Created 401: Unauthorized ### `patch` partially update the specified VolumeAttributesClass #### HTTP Request PATCH /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} #### Parameters - **name** (*in path*): string, required name of the VolumeAttributesClass - **body**: }}">Patch, required - **dryRun** (*in query*): string }}">dryRun - **fieldManager** (*in query*): string }}">fieldManager - **fieldValidation** (*in query*): string }}">fieldValidation - **force** (*in query*): boolean }}">force - **pretty** (*in query*): string }}">pretty #### Response 200 (}}">VolumeAttributesClass): OK 201 (}}">VolumeAttributesClass): Created 401: Unauthorized ### `delete` delete a VolumeAttributesClass #### HTTP Request DELETE /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} #### Parameters - **name** (*in path*): string, required name of the VolumeAttributesClass - **body**: }}">DeleteOptions - **dryRun** (*in query*): string }}">dryRun - **gracePeriodSeconds** (*in query*): integer }}">gracePeriodSeconds - **pretty** (*in query*): string }}">pretty - **propagationPolicy** (*in query*): string }}">propagationPolicy #### Response 200 (}}">VolumeAttributesClass): OK 202 (}}">VolumeAttributesClass): Accepted 401: Unauthorized ### `deletecollection` delete collection of VolumeAttributesClass #### HTTP Request DELETE /apis/storage.k8s.io/v1beta1/volumeattributesclasses #### Parameters - **body**: }}">DeleteOptions - **continue** (*in query*): string }}">continue - **dryRun** (*in query*): string }}">dryRun - **fieldSelector** (*in query*): string }}">fieldSelector - **gracePeriodSeconds** (*in query*): integer }}">gracePeriodSeconds - **labelSelector** (*in query*): string }}">labelSelector - **limit** (*in query*): integer }}">limit - **pretty** (*in query*): string }}">pretty - **propagationPolicy** (*in query*): string }}">propagationPolicy - **resourceVersion** (*in query*): string }}">resourceVersion - **resourceVersionMatch** (*in query*): string }}">resourceVersionMatch - **sendInitialEvents** (*in query*): boolean }}">sendInitialEvents - **timeoutSeconds** (*in query*): integer }}">timeoutSeconds #### Response 200 (}}">Status): OK 401: Unauthorized