JobsOperations Class
JobsOperations operations.
- Inheritance
-
builtins.objectJobsOperations
Constructor
JobsOperations(client, config, serializer, deserializer)Parameters
| Name | Description |
|---|---|
|
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
| Name | Description |
|---|---|
|
api_version
|
Version of the Api. Constant value: "2021-04-12". |
Methods
cancel_import_export_job
Cancels an import or export job in the IoT Hub.
cancel_import_export_job(id, custom_headers=None, raw=False, **operation_config)Parameters
| Name | Description |
|---|---|
|
id
Required
|
The unique identifier of the job. |
|
custom_headers
|
headers that will be added to the request Default value: None
|
|
raw
|
returns the direct response alongside the deserialized response Default value: False
|
|
operation_config
Required
|
Operation configuration overrides. |
Returns
| Type | Description |
|---|---|
|
<xref:msrest.pipeline.ClientRawResponse>
|
object or ClientRawResponse if raw=true |
Exceptions
| Type | Description |
|---|---|
|
msrest.exceptions.HttpOperationError
|
cancel_scheduled_job
Cancels a scheduled job on the IoT Hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information.
cancel_scheduled_job(id, custom_headers=None, raw=False, **operation_config)Parameters
| Name | Description |
|---|---|
|
id
Required
|
The unique identifier of the job. |
|
custom_headers
|
headers that will be added to the request Default value: None
|
|
raw
|
returns the direct response alongside the deserialized response Default value: False
|
|
operation_config
Required
|
Operation configuration overrides. |
Returns
| Type | Description |
|---|---|
|
<xref:msrest.pipeline.ClientRawResponse>
|
JobResponse or ClientRawResponse if raw=true |
Exceptions
| Type | Description |
|---|---|
|
msrest.exceptions.HttpOperationError
|
create_import_export_job
Creates a new import or export job on the 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
| Name | Description |
|---|---|
|
job_properties
Required
|
The job specifications. |
|
custom_headers
|
headers that will be added to the request Default value: None
|
|
raw
|
returns the direct response alongside the deserialized response Default value: False
|
|
operation_config
Required
|
Operation configuration overrides. |
Returns
| Type | Description |
|---|---|
|
<xref:msrest.pipeline.ClientRawResponse>
|
JobProperties or ClientRawResponse if raw=true |
Exceptions
| Type | Description |
|---|---|
|
msrest.exceptions.HttpOperationError
|
create_scheduled_job
Creates a new job to schedule twin updates or direct methods on the IoT Hub at a scheduled time. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information.
create_scheduled_job(id, job_request, custom_headers=None, raw=False, **operation_config)Parameters
| Name | Description |
|---|---|
|
id
Required
|
The unique identifier of the job. |
|
job_request
Required
|
The job request info. |
|
custom_headers
|
headers that will be added to the request Default value: None
|
|
raw
|
returns the direct response alongside the deserialized response Default value: False
|
|
operation_config
Required
|
Operation configuration overrides. |
Returns
| Type | Description |
|---|---|
|
<xref:msrest.pipeline.ClientRawResponse>
|
JobResponse or ClientRawResponse if raw=true |
Exceptions
| Type | Description |
|---|---|
|
msrest.exceptions.HttpOperationError
|
get_import_export_job
Gets the status of an import or export job in the 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
| Name | Description |
|---|---|
|
id
Required
|
The unique identifier of the job. |
|
custom_headers
|
headers that will be added to the request Default value: None
|
|
raw
|
returns the direct response alongside the deserialized response Default value: False
|
|
operation_config
Required
|
Operation configuration overrides. |
Returns
| Type | Description |
|---|---|
|
<xref:msrest.pipeline.ClientRawResponse>
|
JobProperties or ClientRawResponse if raw=true |
Exceptions
| Type | Description |
|---|---|
|
msrest.exceptions.HttpOperationError
|
get_import_export_jobs
Gets the status of all import and export jobs in the 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
| Name | Description |
|---|---|
|
custom_headers
|
headers that will be added to the request Default value: None
|
|
raw
|
returns the direct response alongside the deserialized response Default value: False
|
|
operation_config
Required
|
Operation configuration overrides. |
Returns
| Type | Description |
|---|---|
|
<xref:msrest.pipeline.ClientRawResponse>
|
list or ClientRawResponse if raw=true |
Exceptions
| Type | Description |
|---|---|
|
msrest.exceptions.HttpOperationError
|
get_scheduled_job
Gets details of a scheduled job from the IoT Hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information.
get_scheduled_job(id, custom_headers=None, raw=False, **operation_config)Parameters
| Name | Description |
|---|---|
|
id
Required
|
The unique identifier of the job. |
|
custom_headers
|
headers that will be added to the request Default value: None
|
|
raw
|
returns the direct response alongside the deserialized response Default value: False
|
|
operation_config
Required
|
Operation configuration overrides. |
Returns
| Type | Description |
|---|---|
|
<xref:msrest.pipeline.ClientRawResponse>
|
JobResponse or ClientRawResponse if raw=true |
Exceptions
| Type | Description |
|---|---|
|
msrest.exceptions.HttpOperationError
|
query_scheduled_jobs
Gets the information about jobs using an IoT Hub query. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information.
query_scheduled_jobs(job_type=None, job_status=None, custom_headers=None, raw=False, **operation_config)Parameters
| Name | Description |
|---|---|
|
job_type
|
The job type. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs#querying-for-progress-on-jobs for a list of possible job types. Default value: None
|
|
job_status
|
The job status. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs#querying-for-progress-on-jobs for a list of possible statuses. Default value: None
|
|
custom_headers
|
headers that will be added to the request Default value: None
|
|
raw
|
returns the direct response alongside the deserialized response Default value: False
|
|
operation_config
Required
|
Operation configuration overrides. |
Returns
| Type | Description |
|---|---|
|
<xref:msrest.pipeline.ClientRawResponse>
|
QueryResult or ClientRawResponse if raw=true |
Exceptions
| Type | Description |
|---|---|
|
msrest.exceptions.HttpOperationError
|
Attributes
models
models = <module 'azure.iot.hub.protocol.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\iot\\hub\\protocol\\models\\__init__.py'>
Azure SDK for Python
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for