JobProperties Class

Definition

Contains properties of a Job. See online documentation for more infomration.

public class JobProperties
type JobProperties = class
Public Class JobProperties
Inheritance
JobProperties

Constructors

JobProperties()

Default constructor that creates an empty JobProperties object.

Properties

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.

Identity

The managed identity used to access the storage account for import and export jobs.

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.

JobId

System generated. Ignored at creation.

OutputBlobContainerUri

URI to a blob container. This is used to output the status of the job and the results. Including a SAS token is dependent on the StorageAuthenticationType property.

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.

StartTimeUtc

System generated. Ignored at creation.

Status

System generated. Ignored at creation.

StorageAuthenticationType

Specifies authentication type being used for connecting to storage account.

Type

Required. 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 Import job

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

Creates an instance of JobProperties with parameters ready to start an Import job

Applies to