JobClientOperations Class

JobClientOperations operations.

Inheritance
builtins.object
JobClientOperations

Constructor

JobClientOperations(client, config, serializer, deserializer)

Parameters

client
Required

Client for service requests.

config
Required

Configuration of service client.

serializer
Required

An object model serializer.

deserializer
Required

An object model deserializer.

Variables

api_version

The API version to use for the request. Constant value: "2020-05-31-preview".

Methods

cancel_import_export_job

Cancels an import or export job in an IoT hub.

Cancels an import or export job in an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information.

cancel_job

Cancels a scheduled job on an IoT hub.

Cancels a scheduled job on an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information.

create_import_export_job

Create a new import/export job on an IoT hub.

Create a new import/export job on an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information.

create_job

Creates a new job to schedule update twins or device direct methods on an IoT hub at a scheduled time.

Creates a new job to schedule update twins or device direct methods on an IoT hub at a scheduled time. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information.

get_import_export_job

Gets the status of an import or export job in an iot hub.

Gets the status of an import or export job in an iot hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information.

get_import_export_jobs

Gets the status of all import/export jobs in an iot hub.

Gets the status of all import/export jobs in an iot hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information.

get_job

Retrieves details of a scheduled job from an IoT hub.

Retrieves details of a scheduled job from an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information.

query_jobs

Query an IoT hub to retrieve information regarding jobs using the IoT Hub query language.

Query an IoT hub to retrieve information regarding jobs using the IoT Hub query language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. Pagination of results is supported. This returns information about jobs only.

cancel_import_export_job

Cancels an import or export job in an IoT hub.

Cancels an import or export job in an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information.

cancel_import_export_job(id, custom_headers=None, raw=False, **operation_config)

Parameters

id
str
Required

Job ID.

custom_headers
dict
default value: None

headers that will be added to the request

raw
bool
default value: False

returns the direct response alongside the deserialized response

operation_config
Required

Operation configuration overrides.

Returns

object or ClientRawResponse if raw=true

Return type

Exceptions

cancel_job

Cancels a scheduled job on an IoT hub.

Cancels a scheduled job on an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information.

cancel_job(id, custom_headers=None, raw=False, **operation_config)

Parameters

id
str
Required

Job ID.

custom_headers
dict
default value: None

headers that will be added to the request

raw
bool
default value: False

returns the direct response alongside the deserialized response

operation_config
Required

Operation configuration overrides.

Returns

JobResponse or ClientRawResponse if raw=true

Return type

<xref:protocol.models.JobResponse>,

Exceptions

create_import_export_job

Create a new import/export job on an IoT hub.

Create a new import/export job on an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information.

create_import_export_job(job_properties, custom_headers=None, raw=False, **operation_config)

Parameters

job_properties
<xref:protocol.models.JobProperties>
Required

Specifies the job specification.

custom_headers
dict
default value: None

headers that will be added to the request

raw
bool
default value: False

returns the direct response alongside the deserialized response

operation_config
Required

Operation configuration overrides.

Returns

JobProperties or ClientRawResponse if raw=true

Return type

<xref:protocol.models.JobProperties>,

Exceptions

create_job

Creates a new job to schedule update twins or device direct methods on an IoT hub at a scheduled time.

Creates a new job to schedule update twins or device direct methods on an IoT hub at a scheduled time. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information.

create_job(id, job_request, custom_headers=None, raw=False, **operation_config)

Parameters

id
str
Required

Job ID.

job_request
<xref:protocol.models.JobRequest>
Required
custom_headers
dict
default value: None

headers that will be added to the request

raw
bool
default value: False

returns the direct response alongside the deserialized response

operation_config
Required

Operation configuration overrides.

Returns

JobResponse or ClientRawResponse if raw=true

Return type

<xref:protocol.models.JobResponse>,

Exceptions

get_import_export_job

Gets the status of an import or export job in an iot hub.

Gets the status of an import or export job in an iot hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information.

get_import_export_job(id, custom_headers=None, raw=False, **operation_config)

Parameters

id
str
Required

Job ID.

custom_headers
dict
default value: None

headers that will be added to the request

raw
bool
default value: False

returns the direct response alongside the deserialized response

operation_config
Required

Operation configuration overrides.

Returns

JobProperties or ClientRawResponse if raw=true

Return type

<xref:protocol.models.JobProperties>,

Exceptions

get_import_export_jobs

Gets the status of all import/export jobs in an iot hub.

Gets the status of all import/export jobs in an iot hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information.

get_import_export_jobs(custom_headers=None, raw=False, **operation_config)

Parameters

custom_headers
dict
default value: None

headers that will be added to the request

raw
bool
default value: False

returns the direct response alongside the deserialized response

operation_config
Required

Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[<xref:protocol.models.JobProperties>],

Exceptions

get_job

Retrieves details of a scheduled job from an IoT hub.

Retrieves details of a scheduled job from an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information.

get_job(id, custom_headers=None, raw=False, **operation_config)

Parameters

id
str
Required

Job ID.

custom_headers
dict
default value: None

headers that will be added to the request

raw
bool
default value: False

returns the direct response alongside the deserialized response

operation_config
Required

Operation configuration overrides.

Returns

JobResponse or ClientRawResponse if raw=true

Return type

<xref:protocol.models.JobResponse>,

Exceptions

query_jobs

Query an IoT hub to retrieve information regarding jobs using the IoT Hub query language.

Query an IoT hub to retrieve information regarding jobs using the IoT Hub query language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. Pagination of results is supported. This returns information about jobs only.

query_jobs(job_type=None, job_status=None, custom_headers=None, raw=False, **operation_config)

Parameters

job_type
str
default value: None

Job Type.

job_status
str
default value: None

Job Status.

custom_headers
dict
default value: None

headers that will be added to the request

raw
bool
default value: False

returns the direct response alongside the deserialized response

operation_config
Required

Operation configuration overrides.

Returns

QueryResult or ClientRawResponse if raw=true

Return type

<xref:protocol.models.QueryResult>,

Exceptions

Attributes

models

models = <module 'azure.iot.hub.protocol.models' from 'c:\\hostedtoolcache\\windows\\python\\3.6.8\\x64\\lib\\site-packages\\azure\\iot\\hub\\protocol\\models\\__init__.py'>