Share via

Volume interface

  • Reference
Package:
@azure/arm-networkcloud

Volume represents storage made available for use by resources running on the cluster.

Extends
TrackedResource

Properties

attachedTo

The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters. NOTE: This property will not be serialized. It can only be populated by the server.
detailedStatus

The more detailed status of the volume. NOTE: This property will not be serialized. It can only be populated by the server.
detailedStatusMessage

The descriptive message about the current detailed status. NOTE: This property will not be serialized. It can only be populated by the server.
extendedLocation

The extended location of the cluster associated with the resource.
provisioningState

The provisioning state of the volume. NOTE: This property will not be serialized. It can only be populated by the server.
serialNumber

The unique identifier of the volume. NOTE: This property will not be serialized. It can only be populated by the server.
sizeMiB

The size of the allocation for this volume in Mebibytes.

Inherited Properties

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
location

The geo-location where the resource lives
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

attachedTo

The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters. NOTE: This property will not be serialized. It can only be populated by the server.

attachedTo?: string[]

Property Value

string[]

detailedStatus

The more detailed status of the volume. NOTE: This property will not be serialized. It can only be populated by the server.

detailedStatus?: string

Property Value

string

detailedStatusMessage

The descriptive message about the current detailed status. NOTE: This property will not be serialized. It can only be populated by the server.

detailedStatusMessage?: string

Property Value

string

extendedLocation

The extended location of the cluster associated with the resource.

extendedLocation: ExtendedLocation

Property Value

ExtendedLocation

provisioningState

The provisioning state of the volume. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

serialNumber

The unique identifier of the volume. NOTE: This property will not be serialized. It can only be populated by the server.

serialNumber?: string

Property Value

string

sizeMiB

The size of the allocation for this volume in Mebibytes.

sizeMiB: number

Property Value

number

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type