Share via

AutoExportJob interface

Package:
@azure/arm-storagecache

An auto export 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 export job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will disable the current active auto export job. By default it is set to 'Enable'.
autoExportPrefixes

An array of blob paths/prefixes that get auto exported to the cluster namespace. It has '/' as the default value. Number of maximum allowed paths for now is 1.
currentIterationFilesDiscovered

Files discovered for export in current iteration. It may increase while more export items are found. NOTE: This property will not be serialized. It can only be populated by the server.
currentIterationFilesExported

Files that have been exported in current iteration. NOTE: This property will not be serialized. It can only be populated by the server.
currentIterationFilesFailed

Files failed to export in current iteration. NOTE: This property will not be serialized. It can only be populated by the server.
currentIterationMiBDiscovered

Data (in MiB) discovered for export in current iteration. It may increase while more export items are found. NOTE: This property will not be serialized. It can only be populated by the server.
currentIterationMiBExported

Data (in MiB) that have been exported in current iteration. NOTE: This property will not be serialized. It can only be populated by the server.
exportIterationCount

Number of iterations completed since the start of the export. 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 export job. NOTE: This property will not be serialized. It can only be populated by the server.
lastStartedTimeUTC

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

Time (in UTC) of the last successfully completed export iteration. Look at logging container for details. 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.
state

The operational state of auto export. InProgress indicates the export is running. Disabling indicates the user has requested to disable the export but the disabling is still in progress. Disabled indicates auto export has been disabled. DisableFailed indicates the disabling has failed. Failed means the export was unable to continue, due to a fatal error.
statusCode

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

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

Total files exported since the start of the export. This is accumulative, some files may be counted repeatedly. NOTE: This property will not be serialized. It can only be populated by the server.
totalFilesFailed

Total files failed to be export since the last successfully completed iteration. This is accumulative, some files may be counted repeatedly. NOTE: This property will not be serialized. It can only be populated by the server.
totalMiBExported

Total data (in MiB) exported since the start of the export. This is accumulative, some files may be counted repeatedly. 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 export job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will disable the current active auto export job. By default it is set to 'Enable'.

adminStatus?: string

Property Value

string

autoExportPrefixes

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

autoExportPrefixes?: string[]

Property Value

string[]

currentIterationFilesDiscovered

Files discovered for export in current iteration. It may increase while more export items are found. NOTE: This property will not be serialized. It can only be populated by the server.

currentIterationFilesDiscovered?: number

Property Value

number

currentIterationFilesExported

Files that have been exported in current iteration. NOTE: This property will not be serialized. It can only be populated by the server.

currentIterationFilesExported?: number

Property Value

number

currentIterationFilesFailed

Files failed to export in current iteration. NOTE: This property will not be serialized. It can only be populated by the server.

currentIterationFilesFailed?: number

Property Value

number

currentIterationMiBDiscovered

Data (in MiB) discovered for export in current iteration. It may increase while more export items are found. NOTE: This property will not be serialized. It can only be populated by the server.

currentIterationMiBDiscovered?: number

Property Value

number

currentIterationMiBExported

Data (in MiB) that have been exported in current iteration. NOTE: This property will not be serialized. It can only be populated by the server.

currentIterationMiBExported?: number

Property Value

number

exportIterationCount

Number of iterations completed since the start of the export. NOTE: This property will not be serialized. It can only be populated by the server.

exportIterationCount?: number

Property Value

number

lastCompletionTimeUTC

The time (in UTC) of the last completed auto export 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 export job started. NOTE: This property will not be serialized. It can only be populated by the server.

lastStartedTimeUTC?: Date

Property Value

Date

lastSuccessfulIterationCompletionTimeUTC

Time (in UTC) of the last successfully completed export iteration. Look at logging container for details. NOTE: This property will not be serialized. It can only be populated by the server.

lastSuccessfulIterationCompletionTimeUTC?: Date

Property Value

Date

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 operational state of auto export. InProgress indicates the export is running. Disabling indicates the user has requested to disable the export but the disabling is still in progress. Disabled indicates auto export has been disabled. DisableFailed indicates the disabling has failed. Failed means the export was unable to continue, due to a fatal error.

state?: string

Property Value

string

statusCode

Server-defined status code for auto export 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 export job. NOTE: This property will not be serialized. It can only be populated by the server.

statusMessage?: string

Property Value

string

totalFilesExported

Total files exported since the start of the export. This is accumulative, some files may be counted repeatedly. NOTE: This property will not be serialized. It can only be populated by the server.

totalFilesExported?: number

Property Value

number

totalFilesFailed

Total files failed to be export since the last successfully completed iteration. This is accumulative, some files may be counted repeatedly. NOTE: This property will not be serialized. It can only be populated by the server.

totalFilesFailed?: number

Property Value

number

totalMiBExported

Total data (in MiB) exported since the start of the export. This is accumulative, some files may be counted repeatedly. NOTE: This property will not be serialized. It can only be populated by the server.

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