ExpansionJob interface

Package:

@azure/arm-storagecache

An expansion job instance. Follows Azure Resource Manager standards: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md

Extends

TrackedResource

Properties

completionTimeUTC	The time (in UTC) when the expansion job completed. Only populated when job reaches a terminal state. NOTE: This property will not be serialized. It can only be populated by the server.
newStorageCapacityTiB	The new storage capacity in TiB for the AML file system after expansion. This must be a multiple of the Sku step size, and greater than the current storage capacity of the AML file system.
percentComplete	The percentage of expansion job completion. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState	ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property NOTE: This property will not be serialized. It can only be populated by the server.
startTimeUTC	The time (in UTC) the expansion job started. NOTE: This property will not be serialized. It can only be populated by the server.
state	The operational state of the expansion job. InProgress indicates the expansion is still running. Completed indicates expansion finished successfully. Failed means the expansion was unable to complete due to a fatal error. Deleting indicates the expansion is being rolled back. NOTE: This property will not be serialized. It can only be populated by the server.
statusCode	Server-defined status code for expansion job. NOTE: This property will not be serialized. It can only be populated by the server.
statusMessage	Server-defined status message for expansion job. 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. Ex - /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

completionTimeUTC

The time (in UTC) when the expansion job completed. Only populated when job reaches a terminal state. NOTE: This property will not be serialized. It can only be populated by the server.

completionTimeUTC?: Date

Property Value

Date

newStorageCapacityTiB

The new storage capacity in TiB for the AML file system after expansion. This must be a multiple of the Sku step size, and greater than the current storage capacity of the AML file system.

newStorageCapacityTiB?: number

Property Value

number

percentComplete

The percentage of expansion job completion. NOTE: This property will not be serialized. It can only be populated by the server.

percentComplete?: number

Property Value

number

provisioningState

ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

startTimeUTC

The time (in UTC) the expansion job started. NOTE: This property will not be serialized. It can only be populated by the server.

startTimeUTC?: Date

Property Value

Date

state

The operational state of the expansion job. InProgress indicates the expansion is still running. Completed indicates expansion finished successfully. Failed means the expansion was unable to complete due to a fatal error. Deleting indicates the expansion is being rolled back. NOTE: This property will not be serialized. It can only be populated by the server.

state?: string

Property Value

string

statusCode

Server-defined status code for expansion job. NOTE: This property will not be serialized. It can only be populated by the server.

statusCode?: string

Property Value

string

statusMessage

Server-defined status message for expansion job. NOTE: This property will not be serialized. It can only be populated by the server.

statusMessage?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /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