Volume interface
Volume represents storage made available for use by resources running on the cluster.
- Extends
Properties
| allocated |
The allocated size of the volume in Mebibytes. |
| assigned |
The assigned resource ID of the storage appliance that hosts the volume. |
| attached |
The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters. |
| detailed |
The more detailed status of the volume. |
| detailed |
The descriptive message about the current detailed status. |
| etag | "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") |
| extended |
The extended location of the resource. This property is required when creating the resource. |
| provisioning |
The provisioning state of the volume. |
| serial |
The unique identifier of the volume. |
| size |
The requested storage allocation for the volume in Mebibytes. |
| storage |
The resource ID of the storage appliance that hosts the volume. |
Inherited Properties
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| location | The geo-location where the resource lives |
| name | The name of the resource |
| system |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
| tags | Resource tags. |
| type | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
Property Details
allocatedSizeMiB
The allocated size of the volume in Mebibytes.
allocatedSizeMiB?: numberProperty Value
number
assignedStorageApplianceId
The assigned resource ID of the storage appliance that hosts the volume.
assignedStorageApplianceId?: stringProperty Value
string
attachedTo
The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters.
attachedTo?: string[]Property Value
string[]
detailedStatus
The more detailed status of the volume.
detailedStatus?: stringProperty Value
string
detailedStatusMessage
The descriptive message about the current detailed status.
detailedStatusMessage?: stringProperty Value
string
etag
"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")
etag?: stringProperty Value
string
extendedLocation
The extended location of the resource. This property is required when creating the resource.
extendedLocation: ExtendedLocationProperty Value
provisioningState
The provisioning state of the volume.
provisioningState?: stringProperty Value
string
serialNumber
The unique identifier of the volume.
serialNumber?: stringProperty Value
string
sizeMiB
The requested storage allocation for the volume in Mebibytes.
sizeMiB: numberProperty Value
number
storageApplianceId
The resource ID of the storage appliance that hosts the volume.
storageApplianceId?: stringProperty Value
string
Inherited Property Details
id
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
id?: stringProperty Value
string
Inherited From TrackedResource.id
location
The geo-location where the resource lives
location: stringProperty Value
string
Inherited From TrackedResource.location
name
systemData
Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemData?: SystemDataProperty Value
Inherited From TrackedResource.systemData
tags
Resource tags.
tags?: Record<string, string>Property Value
Record<string, string>
Inherited From TrackedResource.tags
type
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
type?: stringProperty Value
string
Inherited From TrackedResource.type
