Share via

ImportJob interface

  • Reference
Package:
@azure/arm-storagecache

An import 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

blobsImportedPerSecond

A recent and frequently updated rate of total files, directories, and symlinks imported per second. NOTE: This property will not be serialized. It can only be populated by the server.
blobsWalkedPerSecond

A recent and frequently updated rate of blobs walked per second. NOTE: This property will not be serialized. It can only be populated by the server.
conflictResolutionMode

How the import job will handle conflicts. For example, if the import job is trying to bring in a directory, but a file is at that path, how it handles it. Fail indicates that the import job should stop immediately and not do anything with the conflict. Skip indicates that it should pass over the conflict. OverwriteIfDirty causes the import job to delete and re-import the file or directory if it is a conflicting type, is dirty, or was not previously imported. OverwriteAlways extends OverwriteIfDirty to include releasing files that had been restored but were not dirty. Please reference https://learn.microsoft.com/en-us/azure/azure-managed-lustre/ for a thorough explanation of these resolution modes.
importPrefixes

An array of blob paths/prefixes that get imported into the cluster namespace. It has '/' as the default value.
lastCompletionTime

The time of the last completed archive operation NOTE: This property will not be serialized. It can only be populated by the server.
lastStartedTime

The time the latest archive operation started NOTE: This property will not be serialized. It can only be populated by the server.
maximumErrors

Total non-conflict oriented errors the import job will tolerate before exiting with failure. -1 means infinite. 0 means exit immediately and is the default.
provisioningState

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

The state of the import job. InProgress indicates the import is still running. Canceled indicates it has been canceled by the user. Completed indicates import finished, successfully importing all discovered blobs into the Lustre namespace. CompletedPartial indicates the import finished but some blobs either were found to be conflicting and could not be imported or other errors were encountered. Failed means the import was unable to complete due to a fatal error. NOTE: This property will not be serialized. It can only be populated by the server.
statusMessage

The status message of the import job. NOTE: This property will not be serialized. It can only be populated by the server.
totalBlobsImported

The total blobs that have been imported since import began. NOTE: This property will not be serialized. It can only be populated by the server.
totalBlobsWalked

The total blob objects walked. NOTE: This property will not be serialized. It can only be populated by the server.
totalConflicts

Number of conflicts in the import job. NOTE: This property will not be serialized. It can only be populated by the server.
totalErrors

Number of errors in the import 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

blobsImportedPerSecond

A recent and frequently updated rate of total files, directories, and symlinks imported per second. NOTE: This property will not be serialized. It can only be populated by the server.

blobsImportedPerSecond?: number

Property Value

number

blobsWalkedPerSecond

A recent and frequently updated rate of blobs walked per second. NOTE: This property will not be serialized. It can only be populated by the server.

blobsWalkedPerSecond?: number

Property Value

number

conflictResolutionMode

How the import job will handle conflicts. For example, if the import job is trying to bring in a directory, but a file is at that path, how it handles it. Fail indicates that the import job should stop immediately and not do anything with the conflict. Skip indicates that it should pass over the conflict. OverwriteIfDirty causes the import job to delete and re-import the file or directory if it is a conflicting type, is dirty, or was not previously imported. OverwriteAlways extends OverwriteIfDirty to include releasing files that had been restored but were not dirty. Please reference https://learn.microsoft.com/en-us/azure/azure-managed-lustre/ for a thorough explanation of these resolution modes.

conflictResolutionMode?: string

Property Value

string

importPrefixes

An array of blob paths/prefixes that get imported into the cluster namespace. It has '/' as the default value.

importPrefixes?: string[]

Property Value

string[]

lastCompletionTime

The time of the last completed archive operation NOTE: This property will not be serialized. It can only be populated by the server.

lastCompletionTime?: Date

Property Value

Date

lastStartedTime

The time the latest archive operation started NOTE: This property will not be serialized. It can only be populated by the server.

lastStartedTime?: Date

Property Value

Date

maximumErrors

Total non-conflict oriented errors the import job will tolerate before exiting with failure. -1 means infinite. 0 means exit immediately and is the default.

maximumErrors?: number

Property Value

number

provisioningState

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

provisioningState?: string

Property Value

string

state

The state of the import job. InProgress indicates the import is still running. Canceled indicates it has been canceled by the user. Completed indicates import finished, successfully importing all discovered blobs into the Lustre namespace. CompletedPartial indicates the import finished but some blobs either were found to be conflicting and could not be imported or other errors were encountered. Failed means the import was unable to complete due to a fatal error. NOTE: This property will not be serialized. It can only be populated by the server.

state?: string

Property Value

string

statusMessage

The status message of the import job. NOTE: This property will not be serialized. It can only be populated by the server.

statusMessage?: string

Property Value

string

totalBlobsImported

The total blobs that have been imported since import began. NOTE: This property will not be serialized. It can only be populated by the server.

totalBlobsImported?: number

Property Value

number

totalBlobsWalked

The total blob objects walked. NOTE: This property will not be serialized. It can only be populated by the server.

totalBlobsWalked?: number

Property Value

number

totalConflicts

Number of conflicts in the import job. NOTE: This property will not be serialized. It can only be populated by the server.

totalConflicts?: number

Property Value

number

totalErrors

Number of errors in the import job. NOTE: This property will not be serialized. It can only be populated by the server.

totalErrors?: number

Property Value

number

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