AutoImportJob interface

Package:

@azure/arm-storagecache

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

adminStatus	The administrative status of the auto import job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will disable the current active auto import job. By default it is set to 'Enable'.
autoImportPrefixes	An array of blob paths/prefixes that get auto imported to the cluster namespace. It has '/' as the default value. Number of maximum allowed paths is 100.
blobSyncEvents	The storage account blob change feed status of the auto import job. NOTE: This property will not be serialized. It can only be populated by the server.
conflictResolutionMode	How the auto import job will handle conflicts. For example, if the auto import job is trying to bring in a directory, but a file is at that path, how it handles it. Fail indicates that the auto import job should stop immediately and not do anything with the conflict. Skip indicates that it should pass over the conflict. OverwriteIfDirty causes the auto import job to delete and re-import the file or directory if it is a conflicting type, is dirty, or is currently released. 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/blob-integration#conflict-resolution-mode for a thorough explanation of these resolution modes.
enableDeletions	Whether or not to enable deletions during auto import. This only affects overwrite-dirty.
importedDirectories	Number of directories imported during full scan. NOTE: This property will not be serialized. It can only be populated by the server.
importedFiles	Number of files imported during full scan. NOTE: This property will not be serialized. It can only be populated by the server.
importedSymlinks	Number of symlinks imported during full scan. NOTE: This property will not be serialized. It can only be populated by the server.
lastCompletionTimeUTC	The time (in UTC) of the last completed auto import job. NOTE: This property will not be serialized. It can only be populated by the server.
lastStartedTimeUTC	The time (in UTC) the latest auto import job started. NOTE: This property will not be serialized. It can only be populated by the server.
maximumErrors	Total non-conflict-oriented errors (e.g., OS errors) Import will tolerate before exiting with failure. -1 means infinite. 0 means exit immediately on any error.
preexistingDirectories	Number of preexisting directories during full scan. NOTE: This property will not be serialized. It can only be populated by the server.
preexistingFiles	Number of preexisting files during full scan. NOTE: This property will not be serialized. It can only be populated by the server.
preexistingSymlinks	Number of preexisting symlinks during full scan. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState	ARM provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.
rateOfBlobImport	Rate of blob import during full scan. NOTE: This property will not be serialized. It can only be populated by the server.
rateOfBlobWalk	Rate of blobs walked during full scan. NOTE: This property will not be serialized. It can only be populated by the server.
scanEndTime	Date and time of when the full scan ended. NOTE: This property will not be serialized. It can only be populated by the server.
scanStartTime	Date and time of when the currently running full scan began. NOTE: This property will not be serialized. It can only be populated by the server.
state	The state of the auto import operation. NOTE: This property will not be serialized. It can only be populated by the server.
statusCode	Server-defined status code for auto import job. NOTE: This property will not be serialized. It can only be populated by the server.
statusMessage	Server-defined status message for auto import job. NOTE: This property will not be serialized. It can only be populated by the server.
totalBlobsImported	Total number of blobs imported during full scan. NOTE: This property will not be serialized. It can only be populated by the server.
totalBlobsWalked	Total number of blobs walked during full scan. NOTE: This property will not be serialized. It can only be populated by the server.
totalConflicts	Total conflicts encountered during full scan. NOTE: This property will not be serialized. It can only be populated by the server.
totalErrors	Total errors encountered during full scan. 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

adminStatus

The administrative status of the auto import job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will disable the current active auto import job. By default it is set to 'Enable'.

adminStatus?: string

Property Value

string

autoImportPrefixes

An array of blob paths/prefixes that get auto imported to the cluster namespace. It has '/' as the default value. Number of maximum allowed paths is 100.

autoImportPrefixes?: string[]

Property Value

string[]

blobSyncEvents

The storage account blob change feed status of the auto import job. NOTE: This property will not be serialized. It can only be populated by the server.

blobSyncEvents?: AutoImportJobPropertiesStatusBlobSyncEvents

Property Value

AutoImportJobPropertiesStatusBlobSyncEvents

conflictResolutionMode

How the auto import job will handle conflicts. For example, if the auto import job is trying to bring in a directory, but a file is at that path, how it handles it. Fail indicates that the auto import job should stop immediately and not do anything with the conflict. Skip indicates that it should pass over the conflict. OverwriteIfDirty causes the auto import job to delete and re-import the file or directory if it is a conflicting type, is dirty, or is currently released. 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/blob-integration#conflict-resolution-mode for a thorough explanation of these resolution modes.

conflictResolutionMode?: string

Property Value

string

enableDeletions

Whether or not to enable deletions during auto import. This only affects overwrite-dirty.

enableDeletions?: boolean

Property Value

boolean

importedDirectories

Number of directories imported during full scan. NOTE: This property will not be serialized. It can only be populated by the server.

importedDirectories?: number

Property Value

number

importedFiles

Number of files imported during full scan. NOTE: This property will not be serialized. It can only be populated by the server.

importedFiles?: number

Property Value

number

importedSymlinks

Number of symlinks imported during full scan. NOTE: This property will not be serialized. It can only be populated by the server.

importedSymlinks?: number

Property Value

number

lastCompletionTimeUTC

The time (in UTC) of the last completed auto import job. NOTE: This property will not be serialized. It can only be populated by the server.

lastCompletionTimeUTC?: Date

Property Value

Date

lastStartedTimeUTC

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

lastStartedTimeUTC?: Date

Property Value

Date

maximumErrors

Total non-conflict-oriented errors (e.g., OS errors) Import will tolerate before exiting with failure. -1 means infinite. 0 means exit immediately on any error.

maximumErrors?: number

Property Value

number

preexistingDirectories

Number of preexisting directories during full scan. NOTE: This property will not be serialized. It can only be populated by the server.

preexistingDirectories?: number

Property Value

number

preexistingFiles

Number of preexisting files during full scan. NOTE: This property will not be serialized. It can only be populated by the server.

preexistingFiles?: number

Property Value

number

preexistingSymlinks

Number of preexisting symlinks during full scan. NOTE: This property will not be serialized. It can only be populated by the server.

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

rateOfBlobImport

Rate of blob import during full scan. NOTE: This property will not be serialized. It can only be populated by the server.

rateOfBlobImport?: number

Property Value

number

rateOfBlobWalk

Rate of blobs walked during full scan. NOTE: This property will not be serialized. It can only be populated by the server.

rateOfBlobWalk?: number

Property Value

number

scanEndTime

Date and time of when the full scan ended. NOTE: This property will not be serialized. It can only be populated by the server.

scanEndTime?: Date

Property Value

Date

scanStartTime

Date and time of when the currently running full scan began. NOTE: This property will not be serialized. It can only be populated by the server.

scanStartTime?: Date

Property Value

Date

state

The state of the auto import operation. 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 auto import 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 auto import job. NOTE: This property will not be serialized. It can only be populated by the server.

statusMessage?: string

Property Value

string

totalBlobsImported

Total number of blobs imported during full scan. NOTE: This property will not be serialized. It can only be populated by the server.

totalBlobsImported?: number

Property Value

number

totalBlobsWalked

Total number of blobs walked during full scan. NOTE: This property will not be serialized. It can only be populated by the server.

totalBlobsWalked?: number

Property Value

number

totalConflicts

Total conflicts encountered during full scan. NOTE: This property will not be serialized. It can only be populated by the server.

totalConflicts?: number

Property Value

number

totalErrors

Total errors encountered during full scan. 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