CapacityPool interface

Capacity pool resource

Extends

Properties

coolAccess

If enabled (true) the pool can contain cool Access enabled volumes.

encryptionType

Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool.

etag

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

poolId

UUID v4 used to identify the Pool NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState

Azure lifecycle management NOTE: This property will not be serialized. It can only be populated by the server.

qosType

The qos type of the pool

serviceLevel

The service level of the file system

size

Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776).

totalThroughputMibps

Total throughput of pool in MiB/s NOTE: This property will not be serialized. It can only be populated by the server.

utilizedThroughputMibps

Utilized throughput of pool in MiB/s NOTE: This property will not be serialized. It can only be populated by the server.

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

coolAccess

If enabled (true) the pool can contain cool Access enabled volumes.

coolAccess?: boolean

Property Value

boolean

encryptionType

Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool.

encryptionType?: string

Property Value

string

etag

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

poolId

UUID v4 used to identify the Pool NOTE: This property will not be serialized. It can only be populated by the server.

poolId?: string

Property Value

string

provisioningState

Azure lifecycle management NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

qosType

The qos type of the pool

qosType?: string

Property Value

string

serviceLevel

The service level of the file system

serviceLevel: string

Property Value

string

size

Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776).

size: number

Property Value

number

totalThroughputMibps

Total throughput of pool in MiB/s NOTE: This property will not be serialized. It can only be populated by the server.

totalThroughputMibps?: number

Property Value

number

utilizedThroughputMibps

Utilized throughput of pool in MiB/s NOTE: This property will not be serialized. It can only be populated by the server.

utilizedThroughputMibps?: 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

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