Dela via


JobProperties Class

Definition

Contains the properties available for import/export job.

public class JobProperties
public abstract class JobProperties : Microsoft.Azure.Devices.IotHubJobResponse
type JobProperties = class
type JobProperties = class
    inherit IotHubJobResponse
Public Class JobProperties
Public MustInherit Class JobProperties
Inherits IotHubJobResponse
Inheritance
JobProperties
Inheritance
JobProperties
Derived

Constructors

JobProperties()

Creates an instance of this class. Provided for unit testing purposes only.

Properties

ConfigurationsBlobName

Specifies the name of the blob to use when using configurations.

EndedOnUtc

When the job finished.

(Inherited from IotHubJobResponse)
EndTimeUtc

System generated. Ignored at creation. Represents the time the job stopped processing.

ExcludeKeysInExport

Optional for export jobs; ignored for other jobs. Default: false. If false, authorization keys are included in export output. Keys are exported as null otherwise.

FailureReason

System genereated. Ignored at creation. If status == failure, this represents a string containing the reason.

FailureReason

If status == failure, this represents a string containing the reason.

(Inherited from IotHubJobResponse)
Identity

The managed identity used to access the storage account for the job.

IncludeConfigurations

Whether or not to include configurations in the job.

InputBlobContainerUri

URI to a blob container that contains registry data to sync. Including a SAS token is dependent on the StorageAuthenticationType property.

InputBlobName

The blob name to be used when importing from the provided input blob container.

IsFinished

Convenience property to determine if the job is in a terminal state, based on Status.

(Inherited from IotHubJobResponse)
JobId

System generated. Ignored at creation.

JobId

The unique Id of the job.

(Inherited from IotHubJobResponse)
JobType

The type of job to execute.

OutputBlobContainerUri

URI to a blob container, used to output the status of the job and the results.

OutputBlobName

The name of the blob that will be created in the provided output blob container. This blob will contain the exported device registry information for the IoT hub.

Progress

System generated. Ignored at creation. Represents the percentage of completion.

StartedOnUtc

When the job started running.

(Inherited from IotHubJobResponse)
StartTimeUtc

System generated. Ignored at creation.

Status

System generated. Ignored at creation.

Status

The status of the job.

(Inherited from IotHubJobResponse)
StorageAuthenticationType

Specifies authentication type being used for connecting to storage account.

Type

The type of job to execute.

Methods

CreateForExportJob(String, Boolean, String, Nullable<StorageAuthenticationType>, ManagedIdentity)

Creates an instance of JobProperties with parameters ready to start an export job.

CreateForImportJob(String, String, String, Nullable<StorageAuthenticationType>, ManagedIdentity)

Creates an instance of JobProperties with parameters ready to start an import job.

Applies to