Feedback Edit

JobProperties Class

  • Reference

JobProperties.

Inheritance
Model
JobProperties

Constructor

JobProperties(*, job_id: Optional[str] = None, start_time_utc=None, end_time_utc=None, type=None, status=None, progress: Optional[int] = None, input_blob_container_uri: Optional[str] = None, input_blob_name: Optional[str] = None, output_blob_container_uri: Optional[str] = None, output_blob_name: Optional[str] = None, exclude_keys_in_export: Optional[bool] = None, storage_authentication_type=None, identity=None, failure_reason: Optional[str] = None, include_configurations: Optional[bool] = None, configurations_blob_name: Optional[str] = None, **kwargs)

Parameters

job_id
str
Required

The unique identifier of the job.

start_time_utc
datetime
Required

System generated. Ignored at creation. The start date and time of the job in UTC.

end_time_utc
datetime
Required

System generated. Ignored at creation. The end date and time of the job in UTC.

type
str or <xref:protocol.models.enum>
Required

The job type. Possible values include: 'unknown', 'export', 'import', 'backup', 'readDeviceProperties', 'writeDeviceProperties', 'updateDeviceConfiguration', 'rebootDevice', 'factoryResetDevice', 'firmwareUpdate', 'scheduleDeviceMethod', 'scheduleUpdateTwin', 'restoreFromBackup', 'failoverDataCopy'

status
str or <xref:protocol.models.enum>
Required

System generated. Ignored at creation. The status of the job. Possible values include: 'unknown', 'enqueued', 'running', 'completed', 'failed', 'cancelled', 'scheduled', 'queued'

progress
int
Required

System generated. Ignored at creation. The percentage of job completion.

input_blob_container_uri
str
Required

The URI containing SAS token to a blob container that contains registry data to sync.

input_blob_name
str
Required

The blob name to use when importing from the input blob container.

output_blob_container_uri
str
Required

The SAS token to access the blob container. This is used to output the status and results of the job.

output_blob_name
str
Required

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

exclude_keys_in_export
bool
Required

Optional for export jobs; ignored for other jobs. If not specified, the service defaults to false. If false, authorization keys are included in export output. Keys are exported as null otherwise.

storage_authentication_type
str or <xref:protocol.models.enum>
Required

The authentication type used for connecting to the storage account. Possible values include: 'keyBased', 'identityBased'

identity
ManagedIdentity
Required
failure_reason
str
Required

System genereated. Ignored at creation. The reason for failure, if a failure occurred.

include_configurations
bool
Required

Defaults to false. If true, then configurations are included in the data export/import.

configurations_blob_name
str
Required

Defaults to configurations.txt. Specifies the name of the blob to use when exporting/importing configurations.