AzureiotcentralClient

Attributes

DynamicValues module-attribute

DynamicValues = List[Dict[str, Any]]

OrganizationStatic module-attribute

OrganizationStatic = str

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'Workflow_CreateTrigger': {'operation_id': 'Workflow_CreateTrigger', 'path': '/{connectionId}/api/preview/_internal/workflow/triggers', 'method': 'post', 'required_parameters': ['application', 'body'], 'callback_payload_type': 'WorkflowTrigger'}}

Classes

DeviceGroupCollection dataclass

DeviceGroupCollection(value: List[DeviceGroup | Mapping[str, Any]], *, next_link: Optional[str] = None)

Response for List device groups

Attributes

value instance-attribute

value: List[DeviceGroup | Mapping[str, Any]]

The collection of device groups.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextLink'})

URL to get the next page of device groups.

DeviceGroup dataclass

DeviceGroup(display_name: str, filter: str, *, id: Optional[str] = None, description: Optional[str] = None, etag: Optional[str] = None, organizations: Optional[List[str]] = None)

Response for Get a device group

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the device group.

display_name class-attribute instance-attribute

display_name: str = dataclass_field(metadata={'wire_name': 'displayName'})

Display name of the device group.

filter instance-attribute

filter: str

Query defining which devices should be in this group.

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

Short summary of device group.

etag class-attribute instance-attribute

etag: Optional[str] = dataclass_field(default=None, kw_only=True)

ETag used to prevent conflict in device group updates.

organizations class-attribute instance-attribute

organizations: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

List of organizations of the device group, only one organization is supported today, multiple organizations will be supported soon.

DeviceGroupDeviceCollection dataclass

DeviceGroupDeviceCollection(value: List[DeviceV1 | Mapping[str, Any]], *, next_link: Optional[str] = None)

Response for Get devices by device group ID

Attributes

value instance-attribute

value: List[DeviceV1 | Mapping[str, Any]]

The collection of devices belonging to the device group.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextLink'})

URL to get the next page of devices in the group.

DeviceCloudProperties dataclass

DeviceCloudProperties(*, additional_properties: Dict[str, Any] = dict())

Response for Get device cloud properties (deprecated)

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DeviceCommand dataclass

DeviceCommand(*, id: Optional[str] = None, request: Optional[Any] = None, response: Optional[Any] = None, connection_timeout: Optional[int] = None, response_timeout: Optional[int] = None, response_code: Optional[int] = None)

Response for Execute a device command (deprecated)

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The request ID of the device command execution.

request class-attribute instance-attribute

request: Optional[Any] = dataclass_field(default=None, kw_only=True)

The payload for the device command.

response class-attribute instance-attribute

response: Optional[Any] = dataclass_field(default=None, kw_only=True)

The payload of the device command response.

connection_timeout class-attribute instance-attribute

connection_timeout: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'connectionTimeout'})

Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds.

response_timeout class-attribute instance-attribute

response_timeout: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'responseTimeout'})

Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds.

response_code class-attribute instance-attribute

response_code: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'responseCode'})

The status code of the device command response.

DeviceRelationshipCollection dataclass

DeviceRelationshipCollection(value: List[DeviceRelationshipStatic | Mapping[str, Any]], *, next_link: Optional[str] = None)

Response for List relationships

Attributes

value instance-attribute

value: List[DeviceRelationshipStatic | Mapping[str, Any]]

The collection of device relationships.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextLink'})

URL to get the next page of device relationships.

DeviceRelationshipStatic dataclass

DeviceRelationshipStatic(*, id: Optional[str] = None, source: Optional[str] = None, target: Optional[str] = None)

Response for Get device relationship

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the device relationship.

source class-attribute instance-attribute

source: Optional[str] = dataclass_field(default=None, kw_only=True)

The device ID of the source (parent) device.

target class-attribute instance-attribute

target: Optional[str] = dataclass_field(default=None, kw_only=True)

The device ID of the source (child) device.

JobCollection dataclass

JobCollection(value: List[JobStatic | Mapping[str, Any]], *, next_link: Optional[str] = None)

Response for List jobs

Attributes

value instance-attribute

value: List[JobStatic | Mapping[str, Any]]

The collection of jobs.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextLink'})

URL to get the next page of jobs.

JobStatic dataclass

JobStatic(display_name: str, group: str, data: List[Dict[str, Any]], *, id: Optional[str] = None, description: Optional[str] = None, batch: Optional[JobBatch | Mapping[str, Any]] = None, cancellation_threshold: Optional[JobCancellationThreshold | Mapping[str, Any]] = None, organizations: Optional[List[str]] = None, scheduled_job_id: Optional[str] = None)

Response for Get a job

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the job.

display_name class-attribute instance-attribute

display_name: str = dataclass_field(metadata={'wire_name': 'displayName'})

Display name of the job.

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

Detailed description of the job.

group instance-attribute

group: str

The ID of the device group on which to execute the job.

batch class-attribute instance-attribute

batch: Optional[JobBatch | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True)

The batching configuration for the job.

cancellation_threshold class-attribute instance-attribute

cancellation_threshold: Optional[JobCancellationThreshold | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'cancellationThreshold'})

The cancellation threshold for the job.

data instance-attribute

data: List[Dict[str, Any]]

Data related to the operation being performed by this job. All entries must be of the same type.

organizations class-attribute instance-attribute

organizations: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon.

scheduled_job_id class-attribute instance-attribute

scheduled_job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'scheduledJobId'})

Id of the scheduled job definition that created this job.

Job dataclass

Job(display_name: str, group: str, *, id: Optional[str] = None, description: Optional[str] = None, batch: Optional[JobBatch | Mapping[str, Any]] = None, cancellation_threshold: Optional[JobCancellationThreshold | Mapping[str, Any]] = None, organizations: Optional[List[str]] = None, scheduled_job_id: Optional[str] = None)

Response for Create a job

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the job.

display_name class-attribute instance-attribute

display_name: str = dataclass_field(metadata={'wire_name': 'displayName'})

Display name of the job.

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

Detailed description of the job.

group instance-attribute

group: str

The ID of the device group on which to execute the job.

batch class-attribute instance-attribute

batch: Optional[JobBatch | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True)

The batching configuration for the job.

cancellation_threshold class-attribute instance-attribute

cancellation_threshold: Optional[JobCancellationThreshold | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'cancellationThreshold'})

The cancellation threshold for the job.

organizations class-attribute instance-attribute

organizations: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon.

scheduled_job_id class-attribute instance-attribute

scheduled_job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'scheduledJobId'})

Id of the scheduled job definition that created this job.

JobDeviceStatusCollection dataclass

JobDeviceStatusCollection(value: List[JobDeviceStatus | Mapping[str, Any]], *, next_link: Optional[str] = None)

Response for Get device statuses

Attributes

value instance-attribute

value: List[JobDeviceStatus | Mapping[str, Any]]

The collection of job device statuses.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextLink'})

URL to get the next page of job device statuses.

OrganizationCollection dataclass

OrganizationCollection(value: List[Organization | Mapping[str, Any]], *, next_link: Optional[str] = None)

Response for List organizations

Attributes

value instance-attribute

value: List[Organization | Mapping[str, Any]]

The collection of organizations.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextLink'})

URL to get the next page of organizations.

Organization dataclass

Organization(*, id: Optional[str] = None, display_name: Optional[str] = None, parent: Optional[str] = None)

Response for Get an organization

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the organization.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

Display name of the organization.

parent class-attribute instance-attribute

parent: Optional[str] = dataclass_field(default=None, kw_only=True)

Display name of the parent organization.

ScheduledJobCollection dataclass

ScheduledJobCollection(value: List[ScheduledJob | Mapping[str, Any]], *, next_link: Optional[str] = None)

Response for List scheduled jobs

Attributes

value instance-attribute

value: List[ScheduledJob | Mapping[str, Any]]

The collection of scheduled jobs.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextLink'})

URL to get the next page of scheduled jobs.

ScheduledJob dataclass

ScheduledJob(display_name: str, group: str, schedule: Dict[str, Any], *, etag: Optional[str] = None, id: Optional[str] = None, description: Optional[str] = None, batch: Optional[JobBatch | Mapping[str, Any]] = None, cancellation_threshold: Optional[JobCancellationThreshold | Mapping[str, Any]] = None, organizations: Optional[List[str]] = None, enabled: Optional[bool] = None, completed: Optional[bool] = None)

Response for Get a scheduled job

Attributes

etag class-attribute instance-attribute

etag: Optional[str] = dataclass_field(default=None, kw_only=True)

ETag used to prevent conflict in scheduled job updates.

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the scheduled job.

display_name class-attribute instance-attribute

display_name: str = dataclass_field(metadata={'wire_name': 'displayName'})

Display name of the scheduled job.

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

Detailed description of the scheduled job.

group instance-attribute

group: str

The ID of the device group on which to execute the job.

batch class-attribute instance-attribute

batch: Optional[JobBatch | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True)

The batching configuration for the scheduled job.

cancellation_threshold class-attribute instance-attribute

cancellation_threshold: Optional[JobCancellationThreshold | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'cancellationThreshold'})

The cancellation threshold for the scheduled job.

organizations class-attribute instance-attribute

organizations: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon.

schedule instance-attribute

schedule: Dict[str, Any]

The schedule at which to execute the job.

enabled class-attribute instance-attribute

enabled: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether the scheduled job is enabled.

completed class-attribute instance-attribute

completed: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether the scheduled job has completed.

ScheduledJobStatic dataclass

ScheduledJobStatic(display_name: str, group: str, data: List[Dict[str, Any]], schedule: Dict[str, Any], *, etag: Optional[str] = None, id: Optional[str] = None, description: Optional[str] = None, batch: Optional[JobBatch | Mapping[str, Any]] = None, cancellation_threshold: Optional[JobCancellationThreshold | Mapping[str, Any]] = None, organizations: Optional[List[str]] = None, enabled: Optional[bool] = None, completed: Optional[bool] = None)

Response for Update a scheduled job

Attributes

etag class-attribute instance-attribute

etag: Optional[str] = dataclass_field(default=None, kw_only=True)

ETag used to prevent conflict in scheduled job updates.

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the scheduled job.

display_name class-attribute instance-attribute

display_name: str = dataclass_field(metadata={'wire_name': 'displayName'})

Display name of the scheduled job.

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

Detailed description of the scheduled job.

group instance-attribute

group: str

The ID of the device group on which to execute the job.

batch class-attribute instance-attribute

batch: Optional[JobBatch | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True)

The batching configuration for the scheduled job.

cancellation_threshold class-attribute instance-attribute

cancellation_threshold: Optional[JobCancellationThreshold | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'cancellationThreshold'})

The cancellation threshold for the scheduled job.

data instance-attribute

data: List[Dict[str, Any]]

Data related to the operation being performed by this job. All entries must be of the same type.

organizations class-attribute instance-attribute

organizations: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon.

schedule instance-attribute

schedule: Dict[str, Any]

The schedule at which to execute the job.

enabled class-attribute instance-attribute

enabled: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether the scheduled job is enabled.

completed class-attribute instance-attribute

completed: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether the scheduled job has completed.

ScheduledJobJobCollection dataclass

ScheduledJobJobCollection(value: List[JobStatic | Mapping[str, Any]], *, next_link: Optional[str] = None)

Response for Get jobs by scheduled job ID

Attributes

value instance-attribute

value: List[JobStatic | Mapping[str, Any]]

The collection of jobs.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextLink'})

URL to get the next page of jobs.

WorkflowTrigger dataclass

WorkflowTrigger(rule: str, url: str, *, id: Optional[str] = None)

Response for When a rule is fired

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the workflow trigger.

rule instance-attribute

rule: str

Unique ID of the rule that is tied to the workflow trigger.

url instance-attribute

url: str

Callback URL of the workflow Trigger.

DeviceV1 dataclass

DeviceV1(*, id: Optional[str] = None, etag: Optional[str] = None, display_name: Optional[str] = None, template: Optional[str] = None, simulated: Optional[bool] = None, enabled: Optional[bool] = None, provisioned: Optional[bool] = None)

Response for Get a device by ID

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the device.

etag class-attribute instance-attribute

etag: Optional[str] = dataclass_field(default=None, kw_only=True)

ETag used to prevent conflict in device updates.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

Display name of the device.

template class-attribute instance-attribute

template: Optional[str] = dataclass_field(default=None, kw_only=True)

The device template definition for the device.

simulated class-attribute instance-attribute

simulated: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether the device is simulated.

enabled class-attribute instance-attribute

enabled: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether the device connection to IoT Central has been enabled.

provisioned class-attribute instance-attribute

provisioned: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether resources have been allocated for the device.

DeviceCommandV1 dataclass

DeviceCommandV1(*, id: Optional[str] = None, request: Optional[Any] = None, response: Optional[Any] = None, connection_timeout: Optional[int] = None, response_timeout: Optional[int] = None, response_code: Optional[int] = None)

Response for Get device command response

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The request ID of the device command execution.

request class-attribute instance-attribute

request: Optional[Any] = dataclass_field(default=None, kw_only=True)

The payload for the device command.

response class-attribute instance-attribute

response: Optional[Any] = dataclass_field(default=None, kw_only=True)

The payload of the device command response.

connection_timeout class-attribute instance-attribute

connection_timeout: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'connectionTimeout'})

Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds.

response_timeout class-attribute instance-attribute

response_timeout: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'responseTimeout'})

Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds.

response_code class-attribute instance-attribute

response_code: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'responseCode'})

The status code of the device command response.

DeviceComponentCommand dataclass

DeviceComponentCommand(*, id: Optional[str] = None, request: Optional[Any] = None, response: Optional[Any] = None, connection_timeout: Optional[int] = None, response_timeout: Optional[int] = None, response_code: Optional[int] = None)

Response for Get component command response

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The request ID of the device command execution.

request class-attribute instance-attribute

request: Optional[Any] = dataclass_field(default=None, kw_only=True)

The payload for the device command.

response class-attribute instance-attribute

response: Optional[Any] = dataclass_field(default=None, kw_only=True)

The payload of the device command response.

connection_timeout class-attribute instance-attribute

connection_timeout: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'connectionTimeout'})

Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds.

response_timeout class-attribute instance-attribute

response_timeout: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'responseTimeout'})

Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds.

response_code class-attribute instance-attribute

response_code: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'responseCode'})

The status code of the device command response.

DeviceComponentTelemetry dataclass

DeviceComponentTelemetry(*, value: Optional[Any] = None, timestamp: Optional[str] = None)

Response for Get component telemetry value

Attributes

value class-attribute instance-attribute

value: Optional[Any] = dataclass_field(default=None, kw_only=True)

The last known value of this device telemetry.

timestamp class-attribute instance-attribute

timestamp: Optional[str] = dataclass_field(default=None, kw_only=True)

String-formatted date representing the time when the telemetry value was sent.

DeviceModuleCommand dataclass

DeviceModuleCommand(*, id: Optional[str] = None, request: Optional[Any] = None, response: Optional[Any] = None, connection_timeout: Optional[int] = None, response_timeout: Optional[int] = None, response_code: Optional[int] = None)

Response for Get module command response

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The request ID of the device command execution.

request class-attribute instance-attribute

request: Optional[Any] = dataclass_field(default=None, kw_only=True)

The payload for the device command.

response class-attribute instance-attribute

response: Optional[Any] = dataclass_field(default=None, kw_only=True)

The payload of the device command response.

connection_timeout class-attribute instance-attribute

connection_timeout: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'connectionTimeout'})

Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds.

response_timeout class-attribute instance-attribute

response_timeout: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'responseTimeout'})

Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds.

response_code class-attribute instance-attribute

response_code: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'responseCode'})

The status code of the device command response.

DeviceModuleComponentCommand dataclass

DeviceModuleComponentCommand(*, id: Optional[str] = None, request: Optional[Any] = None, response: Optional[Any] = None, connection_timeout: Optional[int] = None, response_timeout: Optional[int] = None, response_code: Optional[int] = None)

Response for Get module component command response

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The request ID of the device command execution.

request class-attribute instance-attribute

request: Optional[Any] = dataclass_field(default=None, kw_only=True)

The payload for the device command.

response class-attribute instance-attribute

response: Optional[Any] = dataclass_field(default=None, kw_only=True)

The payload of the device command response.

connection_timeout class-attribute instance-attribute

connection_timeout: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'connectionTimeout'})

Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds.

response_timeout class-attribute instance-attribute

response_timeout: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'responseTimeout'})

Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds.

response_code class-attribute instance-attribute

response_code: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'responseCode'})

The status code of the device command response.

DeviceModuleComponentTelemetry dataclass

DeviceModuleComponentTelemetry(*, value: Optional[Any] = None, timestamp: Optional[str] = None)

Response for Get module component telemetry value

Attributes

value class-attribute instance-attribute

value: Optional[Any] = dataclass_field(default=None, kw_only=True)

The last known value of this device telemetry.

timestamp class-attribute instance-attribute

timestamp: Optional[str] = dataclass_field(default=None, kw_only=True)

String-formatted date representing the time when the telemetry value was sent.

ModuleProperties dataclass

ModuleProperties(*, additional_properties: Dict[str, Any] = dict())

Response for Get module properties

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DeviceModuleTelemetry dataclass

DeviceModuleTelemetry(*, value: Optional[Any] = None, timestamp: Optional[str] = None)

Response for Get module telemetry value

Attributes

value class-attribute instance-attribute

value: Optional[Any] = dataclass_field(default=None, kw_only=True)

The last known value of this device telemetry.

timestamp class-attribute instance-attribute

timestamp: Optional[str] = dataclass_field(default=None, kw_only=True)

String-formatted date representing the time when the telemetry value was sent.

DeviceProperties dataclass

DeviceProperties(*, additional_properties: Dict[str, Any] = dict())

Response for Get device properties

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DeviceTelemetry dataclass

DeviceTelemetry(*, value: Optional[Any] = None, timestamp: Optional[str] = None)

Response for Get device telemetry value

Attributes

value class-attribute instance-attribute

value: Optional[Any] = dataclass_field(default=None, kw_only=True)

The last known value of this device telemetry.

timestamp class-attribute instance-attribute

timestamp: Optional[str] = dataclass_field(default=None, kw_only=True)

String-formatted date representing the time when the telemetry value was sent.

DeviceCollection dataclass

DeviceCollection(value: List[DeviceV1 | Mapping[str, Any]], *, next_link: Optional[str] = None)

Response for List devices

Attributes

value instance-attribute

value: List[DeviceV1 | Mapping[str, Any]]

The collection of devices.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextLink'})

URL to get the next page of devices.

DeviceV2 dataclass

DeviceV2(*, id: Optional[str] = None, etag: Optional[str] = None, display_name: Optional[str] = None, template: Optional[str] = None, simulated: Optional[bool] = None, enabled: Optional[bool] = None, organizations: Optional[List[str]] = None, provisioned: Optional[bool] = None)

Response for Create or update a device

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the device.

etag class-attribute instance-attribute

etag: Optional[str] = dataclass_field(default=None, kw_only=True)

ETag used to prevent conflict in device updates.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

Display name of the device.

template class-attribute instance-attribute

template: Optional[str] = dataclass_field(default=None, kw_only=True)

The device template definition for the device.

simulated class-attribute instance-attribute

simulated: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether the device is simulated.

enabled class-attribute instance-attribute

enabled: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether the device connection to IoT Central has been enabled.

organizations class-attribute instance-attribute

organizations: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

List of organizations of the device, only one organization is supported today, multiple organizations will be supported soon.

provisioned class-attribute instance-attribute

provisioned: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether resources have been allocated for the device.

DeviceTemplateV1 dataclass

DeviceTemplateV1(type_: List[str], *, id: Optional[str] = None, etag: Optional[str] = None, display_name: Optional[str] = None, description: Optional[str] = None, capability_model: Optional[Any] = None)

Response for Get a device template by ID

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@id'})

Unique ID of the device template.

etag class-attribute instance-attribute

etag: Optional[str] = dataclass_field(default=None, kw_only=True)

ETag used to prevent conflict in device template updates.

type_ class-attribute instance-attribute

type_: List[str] = dataclass_field(metadata={'wire_name': '@type'})

The JSON-LD types of this device template.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

Display name of the device template.

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

Detailed description of the device template.

capability_model class-attribute instance-attribute

capability_model: Optional[Any] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'capabilityModel'})

The capability model utilized by this device template.

DeviceTemplateCollectionV1 dataclass

DeviceTemplateCollectionV1(value: List[DeviceTemplateV1 | Mapping[str, Any]], *, next_link: Optional[str] = None)

Response for List device templates

Attributes

value instance-attribute

value: List[DeviceTemplateV1 | Mapping[str, Any]]

The collection of device templates.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextLink'})

URL to get the next page of device templates.

Role dataclass

Role(*, id: Optional[str] = None, display_name: Optional[str] = None)

Response for Get role

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the role.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

Display name of the role.

RoleCollection dataclass

RoleCollection(value: List[Role | Mapping[str, Any]])

Response for List roles

Attributes

value instance-attribute

value: List[Role | Mapping[str, Any]]

The collection of roles.

User dataclass

User(*, additional_properties: Dict[str, Any] = dict())

Response for Create user

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

UserStatic dataclass

UserStatic(roles: List[RoleAssignment | Mapping[str, Any]], *, id: Optional[str] = None, type_: Optional[str] = None)

Response for Get user

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the user.

type_ class-attribute instance-attribute

type_: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'type'})

Type of the user.

roles instance-attribute

roles: List[RoleAssignment | Mapping[str, Any]]

List of role assignments that specify the permissions to access the application.

UserCollection dataclass

UserCollection(value: List[UserStatic | Mapping[str, Any]])

Response for List users

Attributes

value instance-attribute

value: List[UserStatic | Mapping[str, Any]]

The collection of users.

UserPatch dataclass

UserPatch(*, additional_properties: Dict[str, Any] = dict())

Response for Update user

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ApplicationCollection dataclass

ApplicationCollection(value: List[Application | Mapping[str, Any]], *, next_link: Optional[str] = None)

Response for Get the list of applications accessible to the signed-in user

Attributes

value instance-attribute

value: List[Application | Mapping[str, Any]]

The collection of applications.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextLink'})

URL to get the next page of applications.

DeviceTemplateCollection dataclass

DeviceTemplateCollection(value: List[DeviceTemplate | Mapping[str, Any]], *, next_link: Optional[str] = None)

Response for List device templates

Attributes

value instance-attribute

value: List[DeviceTemplate | Mapping[str, Any]]

The collection of device templates.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextLink'})

URL to get the next page of device templates.

SchemaDeviceCloudPropertiesResponse dataclass

SchemaDeviceCloudPropertiesResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Schema_DeviceCloudProperties

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

SchemaDeviceCommandResponse dataclass

SchemaDeviceCommandResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Schema_DeviceCommand

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

SchemaDevicePropertiesResponse dataclass

SchemaDevicePropertiesResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Schema_DeviceProperties

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

SchemaDeviceTelemetryResponse dataclass

SchemaDeviceTelemetryResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Schema_DeviceTelemetry

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

SchemaJobResponse dataclass

SchemaJobResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Schema_Job

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

SchemaScheduledJobResponse dataclass

SchemaScheduledJobResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Schema_ScheduledJob

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

SchemaUserResponse dataclass

SchemaUserResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Schema_User

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

Action dataclass

Action(type_: str, rules: List[str], *, id: Optional[str] = None, display_name: Optional[str] = None)

Definition: Action

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the action.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

Display name of the action.

type_ class-attribute instance-attribute

type_: str = dataclass_field(metadata={'wire_name': 'type'})

Type of the action.

rules instance-attribute

rules: List[str]

Unique IDs of the rules that are tied to the action.

EmailAction dataclass

EmailAction(type_: str, rules: List[str], *, id: Optional[str] = None, display_name: Optional[str] = None)

Definition: EmailAction

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the email action.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

Display name of the email action.

type_ class-attribute instance-attribute

type_: str = dataclass_field(metadata={'wire_name': 'type'})

Type of the email action.

rules instance-attribute

rules: List[str]

Unique IDs of the rules that are tied to the email action.

WebhookAction dataclass

WebhookAction(type_: str, rules: List[str], url: str, *, id: Optional[str] = None, display_name: Optional[str] = None)

Definition: WebhookAction

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the webhook action.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

Display name of the webhook action.

type_ class-attribute instance-attribute

type_: str = dataclass_field(metadata={'wire_name': 'type'})

Type of the webhook action.

rules instance-attribute

rules: List[str]

Unique IDs of the rules that are tied to the webhook action.

url instance-attribute

url: str

Callback URL of the webhook.

PowerAutomateAction dataclass

PowerAutomateAction(type_: str, rules: List[str], *, id: Optional[str] = None, display_name: Optional[str] = None)

Definition: PowerAutomateAction

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the Power Automate action.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

Display name of the Power Automate action.

type_ class-attribute instance-attribute

type_: str = dataclass_field(metadata={'wire_name': 'type'})

Type of the Power Automate action.

rules instance-attribute

rules: List[str]

Unique IDs of the rules that are tied to the Power Automate action.

LogicAppsAction dataclass

LogicAppsAction(type_: str, rules: List[str], *, id: Optional[str] = None, display_name: Optional[str] = None)

Definition: LogicAppsAction

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the Logic Apps action.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

Display name of the Logic Apps action.

type_ class-attribute instance-attribute

type_: str = dataclass_field(metadata={'wire_name': 'type'})

Type of the Logic Apps action.

rules instance-attribute

rules: List[str]

Unique IDs of the rules that are tied to the Logic Apps action.

ActionGroupsAction dataclass

ActionGroupsAction(type_: str, rules: List[str], *, id: Optional[str] = None, display_name: Optional[str] = None)

Definition: ActionGroupsAction

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the Action Groups action.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

Display name of the Action Groups action.

type_ class-attribute instance-attribute

type_: str = dataclass_field(metadata={'wire_name': 'type'})

Type of the Action Groups action.

rules instance-attribute

rules: List[str]

Unique IDs of the rules that are tied to the Action Groups action.

Application dataclass

Application(subdomain: str, host: str, *, id: Optional[str] = None, display_name: Optional[str] = None)

Definition: Application

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the application.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

Display name of the application.

subdomain instance-attribute

subdomain: str

The URL subdomain of the application.

host instance-attribute

host: str

The URL host of the application.

Device dataclass

Device(*, id: Optional[str] = None, etag: Optional[str] = None, display_name: Optional[str] = None, instance_of: Optional[str] = None, simulated: Optional[bool] = None, approved: Optional[bool] = None, provisioned: Optional[bool] = None)

Definition: Device

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the device.

etag class-attribute instance-attribute

etag: Optional[str] = dataclass_field(default=None, kw_only=True)

ETag used to prevent conflict in device updates.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

Display name of the device.

instance_of class-attribute instance-attribute

instance_of: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'instanceOf'})

The device template definition for the device.

simulated class-attribute instance-attribute

simulated: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether the device is simulated.

approved class-attribute instance-attribute

approved: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether the device has been approved to connect to IoT Central.

provisioned class-attribute instance-attribute

provisioned: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether resources have been allocated for the device.

DeviceRelationship dataclass

DeviceRelationship(target: str, *, id: Optional[str] = None)

Definition: DeviceRelationship

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the device relationship.

target instance-attribute

target: str

The device ID of the source (child) device.

DeviceTemplate dataclass

DeviceTemplate(types: List[str], *, id: Optional[str] = None, etag: Optional[str] = None, display_name: Optional[str] = None, description: Optional[str] = None)

Definition: DeviceTemplate

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the device template.

etag class-attribute instance-attribute

etag: Optional[str] = dataclass_field(default=None, kw_only=True)

ETag used to prevent conflict in device template updates.

types instance-attribute

types: List[str]

The types of device to which this template applies.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

Display name of the device template.

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

Detailed description of the device template.

PropertyJobData dataclass

PropertyJobData(data: List[Dict[str, Any]])

Definition: PropertyJobData

Attributes

data instance-attribute

data: List[Dict[str, Any]]

Data related to the operation being performed by this job. All entries must be of the same type.

CommandJobData dataclass

CommandJobData(data: List[Dict[str, Any]])

Definition: CommandJobData

Attributes

data instance-attribute

data: List[Dict[str, Any]]

Data related to the operation being performed by this job. All entries must be of the same type.

CloudPropertyJobData dataclass

CloudPropertyJobData(data: List[Dict[str, Any]])

Definition: CloudPropertyJobData

Attributes

data instance-attribute

data: List[Dict[str, Any]]

The collection of job data.

DeviceTemplateMigrationJobData dataclass

DeviceTemplateMigrationJobData(data: List[Dict[str, Any]])

Definition: DeviceTemplateMigrationJobData

Attributes

data instance-attribute

data: List[Dict[str, Any]]

The collection of job data.

JobDeviceStatus dataclass

JobDeviceStatus(*, id: Optional[str] = None, status: Optional[str] = None)

Definition: JobDeviceStatus

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

ID of the device whose job status is being provided.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True)

Indicates whether the job is starting, running, etc. for the given device.

JobBatch dataclass

JobBatch(type_: str, value: float)

Definition: JobBatch

Attributes

type_ class-attribute instance-attribute

type_: str = dataclass_field(metadata={'wire_name': 'type'})

Whether batching is done on a specified number of devices or a percentage of the total devices.

value instance-attribute

value: float

The number or percentage of devices on which batching is done.

JobCancellationThreshold dataclass

JobCancellationThreshold(type_: str, value: float, *, batch: Optional[bool] = None)

Definition: JobCancellationThreshold

Attributes

type_ class-attribute instance-attribute

type_: str = dataclass_field(metadata={'wire_name': 'type'})

Whether the cancellation threshold is per a specified number of devices or a percentage of the total devices.

value instance-attribute

value: float

The number or percentage of devices on which the cancellation threshold is applied.

batch class-attribute instance-attribute

batch: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether the cancellation threshold applies per-batch or to the overall job.

Rule dataclass

Rule(*, id: Optional[str] = None, display_name: Optional[str] = None)

Definition: Rule

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the rule.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

Display name of the rule.

RuleCollection dataclass

RuleCollection(value: List[Rule | Mapping[str, Any]], *, next_link: Optional[str] = None)

Definition: RuleCollection

Attributes

value instance-attribute

value: List[Rule | Mapping[str, Any]]

The collection of rules.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextLink'})

URL to get the next page of rules.

JobSchedule dataclass

JobSchedule(*, schedule: Optional[Dict[str, Any]] = None)

Definition: JobSchedule

Attributes

schedule class-attribute instance-attribute

schedule: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

The schedule at which to execute the job.

DateJobSchedule dataclass

DateJobSchedule(schedule: Dict[str, Any])

Definition: DateJobSchedule

Attributes

schedule instance-attribute

schedule: Dict[str, Any]

The schedule at which to execute the job.

OccurrencesJobSchedule dataclass

OccurrencesJobSchedule(schedule: Dict[str, Any])

Definition: OccurrencesJobSchedule

Attributes

schedule instance-attribute

schedule: Dict[str, Any]

The schedule at which to execute the job.

JobScheduleEnd dataclass

JobScheduleEnd(*, type_: Optional[str] = None, date: Optional[str] = None, occurrences: Optional[int] = None)

Definition: JobScheduleEnd

Attributes

type_ class-attribute instance-attribute

type_: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'type'})

Type of the job schedule end.

date class-attribute instance-attribute

date: Optional[str] = dataclass_field(default=None, kw_only=True)

The date when to end the scheduled job (YYYY-MM-DDTHH:MM:SSZ).

occurrences class-attribute instance-attribute

occurrences: Optional[int] = dataclass_field(default=None, kw_only=True)

The number of occurrences after which to end the scheduled job.

ScheduledJobPatch dataclass

ScheduledJobPatch(schedule: Dict[str, Any], *, etag: Optional[str] = None, id: Optional[str] = None, enabled: Optional[bool] = None, completed: Optional[bool] = None)

Definition: ScheduledJobPatch

Attributes

etag class-attribute instance-attribute

etag: Optional[str] = dataclass_field(default=None, kw_only=True)

ETag used to prevent conflict in scheduled job updates.

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the scheduled job.

schedule instance-attribute

schedule: Dict[str, Any]

The schedule at which to execute the job.

enabled class-attribute instance-attribute

enabled: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether the scheduled job is enabled.

completed class-attribute instance-attribute

completed: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether the scheduled job has completed.

EmailUser dataclass

EmailUser(type_: str, roles: List[RoleAssignment | Mapping[str, Any]], email: str, *, id: Optional[str] = None)

Definition: EmailUser

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the user.

type_ class-attribute instance-attribute

type_: str = dataclass_field(metadata={'wire_name': 'type'})

Type of the user.

roles instance-attribute

roles: List[RoleAssignment | Mapping[str, Any]]

List of role assignments that specify the permissions to access the application.

email instance-attribute

email: str

Email address of the user.

ServicePrincipalUser dataclass

ServicePrincipalUser(type_: str, roles: List[RoleAssignment | Mapping[str, Any]], tenant_id: str, object_id: str, *, id: Optional[str] = None)

Definition: ServicePrincipalUser

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the user.

type_ class-attribute instance-attribute

type_: str = dataclass_field(metadata={'wire_name': 'type'})

Type of the user.

roles instance-attribute

roles: List[RoleAssignment | Mapping[str, Any]]

List of role assignments that specify the permissions to access the application.

tenant_id class-attribute instance-attribute

tenant_id: str = dataclass_field(metadata={'wire_name': 'tenantId'})

The Microsoft Entra ID tenant ID of the service principal.

object_id class-attribute instance-attribute

object_id: str = dataclass_field(metadata={'wire_name': 'objectId'})

The Microsoft Entra ID object ID of the service principal.

RoleAssignment dataclass

RoleAssignment(role: str)

Definition: RoleAssignment

Attributes

role instance-attribute

role: str

ID of the role for this role assignment.

WebhookActionDevice dataclass

WebhookActionDevice(*, id: Optional[str] = None, etag: Optional[str] = None, display_name: Optional[str] = None, instance_of: Optional[str] = None, simulated: Optional[bool] = None, approved: Optional[bool] = None, provisioned: Optional[bool] = None, cloud_properties: Optional[Dict[str, Any]] = None, properties: Optional[Dict[str, Any]] = None, telemetry: Optional[Dict[str, Any]] = None)

Definition: WebhookActionDevice

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the device.

etag class-attribute instance-attribute

etag: Optional[str] = dataclass_field(default=None, kw_only=True)

ETag used to prevent conflict in device updates.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

Display name of the device.

instance_of class-attribute instance-attribute

instance_of: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'instanceOf'})

The device template definition for the device.

simulated class-attribute instance-attribute

simulated: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether the device is simulated.

approved class-attribute instance-attribute

approved: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether the device has been approved to connect to IoT Central.

provisioned class-attribute instance-attribute

provisioned: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether resources have been allocated for the device.

cloud_properties class-attribute instance-attribute

cloud_properties: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'cloudProperties'})

Cloud properties that triggered the webhook.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

Device properties that triggered the webhook.

telemetry class-attribute instance-attribute

telemetry: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

Device telemetry that triggered the webhook.

WebhookActionBody dataclass

WebhookActionBody(action: Action | Mapping[str, Any], application: Application | Mapping[str, Any], device: WebhookActionDevice | Mapping[str, Any], rule: Rule | Mapping[str, Any], timestamp: str)

Definition: WebhookActionBody

Attributes

action instance-attribute

action: Action | Mapping[str, Any]

Action that triggered the webhook.

application instance-attribute

application: Application | Mapping[str, Any]

Application that triggered the webhook.

device instance-attribute

device: WebhookActionDevice | Mapping[str, Any]

Device that triggered the webhook.

rule instance-attribute

rule: Rule | Mapping[str, Any]

Rule that triggered the webhook.

timestamp instance-attribute

timestamp: str

Timestamp at which the webhook was triggered.

AzureiotcentralClient

AzureiotcentralClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

Bases: ConnectorClientBase

Typed client for azureiotcentral connector.

Initialize a AzureiotcentralClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
credential	AsyncTokenCredential | AzureKeyCredential	Caller-owned Azure Core credential.	required
max_retry_attempts	int	The maximum number of request attempts.	3
timeout	float	The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.	30.0
use_exponential_backoff	bool	Whether retries use exponential backoff.	True
initial_retry_delay_seconds	float	The initial retry delay in seconds.	0.5
maximum_retry_delay_seconds	float	The maximum retry delay in seconds.	120.0
retry_jitter_factor	float	The jitter fraction applied to retry delays.	0.1
retry_unsafe_http_methods	bool	Whether unsafe HTTP methods may be retried.	False
transport	Optional[AsyncHttpTransport]	Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.	None
**kwargs	Any	Optional Azure Core pipeline policy settings.	{}

Methods:

list_device_groups

list_device_groups(application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List device groups

Get the list of device groups in an application.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: DeviceGroups_List.

Parameters:

Name	Type	Description	Default
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

device_groups_get async

device_groups_get(device_group_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get a device group

Get details about an existing device group by ID.

Swagger operation ID: DeviceGroups_Get.

Parameters:

Name	Type	Description	Default
device_group_id	str	Unique ID of the device group.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

device_groups_set async

device_groups_set(input: DeviceGroup | Mapping[str, Any], device_group_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a device group

Create or update a device group.

Swagger operation ID: DeviceGroups_Set.

Parameters:

Name	Type	Description	Default
input	DeviceGroup | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
device_group_id	str	Unique ID of the device group.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

device_groups_remove async

device_groups_remove(device_group_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete device group

Delete an existing device group by ID

Swagger operation ID: DeviceGroups_Remove.

Parameters:

Name	Type	Description	Default
device_group_id	str	Unique ID of the device group.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_device_groups_get_devices

list_device_groups_get_devices(device_group_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get devices by device group ID

Get the list of devices in a device group in an application.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: DeviceGroups_GetDevices.

Parameters:

Name	Type	Description	Default
device_group_id	str	Unique ID of the device group.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

devices_get_cloud_properties async

devices_get_cloud_properties(device_id: str, application: str, *, instance_of: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get device cloud properties (deprecated)

Get all cloud property values of a device by device ID (deprecated).

Swagger operation ID: Devices_GetCloudProperties.

Parameters:

Name	Type	Description	Default
device_id	str	Unique ID of the device.	required
application	str	Unique ID of the application.	required
instance_of	Optional[str]	The device template definition for the device.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

devices_update_cloud_properties async

devices_update_cloud_properties(input: DeviceCloudProperties | Mapping[str, Any], device_id: str, application: str, *, instance_of: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update device cloud properties (deprecated)

Update all cloud property values of a device by device ID (deprecated).

Swagger operation ID: Devices_UpdateCloudProperties.

Parameters:

Name	Type	Description	Default
input	DeviceCloudProperties | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
device_id	str	Unique ID of the device.	required
application	str	Unique ID of the application.	required
instance_of	Optional[str]	The device template definition for the device.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

devices_execute_component_command async

devices_execute_component_command(input: DeviceCommand | Mapping[str, Any], device_id: str, component_name: str, command_name: str, application: str, *, instance_of: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Execute a device command (deprecated)

Execute a command on a device (deprecated).

Swagger operation ID: Devices_ExecuteComponentCommand.

Parameters:

Name	Type	Description	Default
input	DeviceCommand | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
device_id	str	Unique ID of the device.	required
component_name	str	Name of the device component.	required
command_name	str	Name of this device command.	required
application	str	Unique ID of the application.	required
instance_of	Optional[str]	The device template definition for the device.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_device_relationships

list_device_relationships(device_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List relationships

List all relationships based on device ID.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: DeviceRelationships_List.

Parameters:

Name	Type	Description	Default
device_id	str	Unique ID of the device.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

device_relationships_get async

device_relationships_get(device_id: str, relationship_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get device relationship

Get details about an existing device relationship by device ID and by relationship ID.

Swagger operation ID: DeviceRelationships_Get.

Parameters:

Name	Type	Description	Default
device_id	str	Unique ID of the device.	required
relationship_id	str	Unique ID of the device relationship.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

device_relationships_set async

device_relationships_set(input: DeviceRelationship | Mapping[str, Any], relationship_id: str, device_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a device relationship

Create a new device relationship between the given device and a new device given a device ID and a relationship ID.

Swagger operation ID: DeviceRelationships_Set.

Parameters:

Name	Type	Description	Default
input	DeviceRelationship | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
relationship_id	str	Unique ID of the device relationship.	required
device_id	str	Unique ID of the device.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

device_relationships_update async

device_relationships_update(input: DeviceRelationship | Mapping[str, Any], device_id: str, relationship_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update a device relationship

Update an existing device relationship between the given device and a new device given a device ID and a relationship ID.

Swagger operation ID: DeviceRelationships_Update.

Parameters:

Name	Type	Description	Default
input	DeviceRelationship | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
device_id	str	Unique ID of the device.	required
relationship_id	str	Unique ID of the device relationship.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

device_relationships_remove async

device_relationships_remove(device_id: str, relationship_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete a device relationship

Delete an existing device relationship by device ID and relationship ID.

Swagger operation ID: DeviceRelationships_Remove.

Parameters:

Name	Type	Description	Default
device_id	str	Unique ID of the device.	required
relationship_id	str	Unique ID of the device relationship.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_jobs

list_jobs(application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List jobs

Get the list of jobs in an application.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: Jobs_List.

Parameters:

Name	Type	Description	Default
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

jobs_get async

jobs_get(job_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get a job

Get details about an existing job by ID.

Swagger operation ID: Jobs_Get.

Parameters:

Name	Type	Description	Default
job_id	str	Unique ID of the job.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

jobs_set async

jobs_set(input: Job | Mapping[str, Any], job_id: str, application: str, *, job_type: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a job

Create and execute a new job via its job definition.

Swagger operation ID: Jobs_Set.

Parameters:

Name	Type	Description	Default
input	Job | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
job_id	str	Unique ID of the job.	required
application	str	Unique ID of the application.	required
job_type	Optional[str]	Type of the job.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_jobs_get_devices

list_jobs_get_devices(job_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get device statuses

Get the list of individual device statuses by job ID.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: Jobs_GetDevices.

Parameters:

Name	Type	Description	Default
job_id	str	Unique ID of the job.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

jobs_stop async

jobs_stop(job_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Stop a running job

Stop execution of a job that is currently running.

Swagger operation ID: Jobs_Stop.

Parameters:

Name	Type	Description	Default
job_id	str	Unique ID of the job.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

jobs_resume async

jobs_resume(job_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Resume a stopped job

Resume execution of an existing stopped job.

Swagger operation ID: Jobs_Resume.

Parameters:

Name	Type	Description	Default
job_id	str	Unique ID of the job.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

jobs_rerun async

jobs_rerun(job_id: str, rerun_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Resume a job on failed devices

Execute a rerun of an existing job on all failed devices.

Swagger operation ID: Jobs_Rerun.

Parameters:

Name	Type	Description	Default
job_id	str	Unique ID of the job.	required
rerun_id	str	Unique ID of the rerun.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_organizations

list_organizations(application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List organizations

Get the list of organizations in an application.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: Organizations_List.

Parameters:

Name	Type	Description	Default
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

organizations_get async

organizations_get(organization_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get an organization

Get details about an existing organization by ID.

Swagger operation ID: Organizations_Get.

Parameters:

Name	Type	Description	Default
organization_id	str	Unique ID of the organization.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

organizations_set async

organizations_set(input: Organization | Mapping[str, Any], organization_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create an organization

Create a new organization.

Swagger operation ID: Organizations_Set.

Parameters:

Name	Type	Description	Default
input	Organization | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
organization_id	str	Unique ID of the organization.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

organizations_remove async

organizations_remove(organization_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete organization

Delete an existing organization by ID

Swagger operation ID: Organizations_Remove.

Parameters:

Name	Type	Description	Default
organization_id	str	Unique ID of the organization.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_scheduled_jobs

list_scheduled_jobs(application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List scheduled jobs

Get the list of scheduled jobs in an application.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: ScheduledJobs_List.

Parameters:

Name	Type	Description	Default
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

scheduled_jobs_get async

scheduled_jobs_get(scheduled_job_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get a scheduled job

Get details about an existing scheduled job by ID.

Swagger operation ID: ScheduledJobs_Get.

Parameters:

Name	Type	Description	Default
scheduled_job_id	str	Unique ID of the scheduled job.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

scheduled_jobs_set async

scheduled_jobs_set(input: ScheduledJob | Mapping[str, Any], scheduled_job_id: str, application: str, *, job_type: Optional[str] = None, scheduled_job_end_type: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a scheduled job

Create and execute a new scheduled job via its job definition.

Swagger operation ID: ScheduledJobs_Set.

Parameters:

Name	Type	Description	Default
input	ScheduledJob | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
scheduled_job_id	str	Unique ID of the scheduled job.	required
application	str	Unique ID of the application.	required
job_type	Optional[str]	Type of the job.	None
scheduled_job_end_type	Optional[str]	How the scheduled job should end (not applied to device template migrations).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

scheduled_jobs_update async

scheduled_jobs_update(input: ScheduledJobPatch | Mapping[str, Any], scheduled_job_id: str, application: str, *, scheduled_job_end_type: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update a scheduled job

Update an existing scheduled job by ID.

Swagger operation ID: ScheduledJobs_Update.

Parameters:

Name	Type	Description	Default
input	ScheduledJobPatch | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
scheduled_job_id	str	Unique ID of the scheduled job.	required
application	str	Unique ID of the application.	required
scheduled_job_end_type	Optional[str]	How the scheduled job should end (not applied to device template migrations).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

scheduled_jobs_remove async

scheduled_jobs_remove(scheduled_job_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete a scheduled job

Delete an existing scheduled job by ID.

Swagger operation ID: ScheduledJobs_Remove.

Parameters:

Name	Type	Description	Default
scheduled_job_id	str	Unique ID of the scheduled job.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_scheduled_jobs_list_jobs

list_scheduled_jobs_list_jobs(scheduled_job_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get jobs by scheduled job ID

Get the list of jobs for a scheduled job definition.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: ScheduledJobs_ListJobs.

Parameters:

Name	Type	Description	Default
scheduled_job_id	str	Unique ID of the scheduled job.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

devices_get async

devices_get(device_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get a device by ID

Get details about an existing device by device ID.

Swagger operation ID: Devices_Get_V1.

Parameters:

Name	Type	Description	Default
device_id	str	Unique ID of the device.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

devices_get_command_response async

devices_get_command_response(device_id: str, command_name: str, application: str, *, template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get device command response

Get the last response for a device command.

Swagger operation ID: Devices_GetCommandResponse_V1.

Parameters:

Name	Type	Description	Default
device_id	str	Unique ID of the device.	required
command_name	str	Name of this device command.	required
application	str	Unique ID of the application.	required
template	Optional[str]	The device template definition for the device.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

devices_get_component_command_response async

devices_get_component_command_response(device_id: str, component_name: str, command_name: str, application: str, *, template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get component command response

Get the last response for a device component command.

Swagger operation ID: Devices_GetComponentCommandResponse_V1.

Parameters:

Name	Type	Description	Default
device_id	str	Unique ID of the device.	required
component_name	str	Name of the device component.	required
command_name	str	Name of this device command.	required
application	str	Unique ID of the application.	required
template	Optional[str]	The device template definition for the device.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

devices_get_component_telemetry_value async

devices_get_component_telemetry_value(device_id: str, component_name: str, telemetry_name: str, application: str, *, template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get component telemetry value

Get the last telemetry value from a component.

Swagger operation ID: Devices_GetComponentTelemetryValue_V1.

Parameters:

Name	Type	Description	Default
device_id	str	Unique ID of the device.	required
component_name	str	Name of the device component.	required
telemetry_name	str	Name of this device telemetry.	required
application	str	Unique ID of the application.	required
template	Optional[str]	The device template definition for the device.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

devices_get_module_command_response async

devices_get_module_command_response(device_id: str, module: str, command_name: str, application: str, *, template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get module command response

Get the last response for a device module command

Swagger operation ID: Devices_GetModuleCommandResponse_V1.

Parameters:

Name	Type	Description	Default
device_id	str	Unique ID of the device.	required
module	str	Name of the device module.	required
command_name	str	Name of this device command.	required
application	str	Unique ID of the application.	required
template	Optional[str]	The device template definition for the device.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

devices_get_module_component_command_response async

devices_get_module_component_command_response(device_id: str, module: str, component_name: str, command_name: str, application: str, *, template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get module component command response

Get the last response for a module component command.

Swagger operation ID: Devices_GetModuleComponentCommandResponse_V1.

Parameters:

Name	Type	Description	Default
device_id	str	Unique ID of the device.	required
module	str	Name of the device module.	required
component_name	str	Name of the device component.	required
command_name	str	Name of this device command.	required
application	str	Unique ID of the application.	required
template	Optional[str]	The device template definition for the device.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

devices_get_module_component_telemetry_value async

devices_get_module_component_telemetry_value(device_id: str, module: str, component_name: str, telemetry_name: str, application: str, *, template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get module component telemetry value

Get the last telemetry value from a module component.

Swagger operation ID: Devices_GetModuleComponentTelemetryValue_V1.

Parameters:

Name	Type	Description	Default
device_id	str	Unique ID of the device.	required
module	str	Name of the device module.	required
component_name	str	Name of the device component.	required
telemetry_name	str	Name of this device telemetry.	required
application	str	Unique ID of the application.	required
template	Optional[str]	The device template definition for the device.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

devices_get_module_properties async

devices_get_module_properties(device_id: str, module: str, application: str, *, template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get module properties

Get all property values of a module.

Swagger operation ID: Devices_GetModuleProperties_V1.

Parameters:

Name	Type	Description	Default
device_id	str	Unique ID of the device.	required
module	str	Name of the device module.	required
application	str	Unique ID of the application.	required
template	Optional[str]	The device template definition for the device.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

devices_get_module_telemetry_value async

devices_get_module_telemetry_value(device_id: str, module: str, telemetry_name: str, application: str, *, template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get module telemetry value

Get the last telemetry value from a module.

Swagger operation ID: Devices_GetModuleTelemetryValue_V1.

Parameters:

Name	Type	Description	Default
device_id	str	Unique ID of the device.	required
module	str	Name of the device module.	required
telemetry_name	str	Name of this device telemetry.	required
application	str	Unique ID of the application.	required
template	Optional[str]	The device template definition for the device.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

devices_get_properties async

devices_get_properties(device_id: str, application: str, *, template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get device properties

Get all property values of a device by device ID.

Swagger operation ID: Devices_GetProperties_V1.

Parameters:

Name	Type	Description	Default
device_id	str	Unique ID of the device.	required
application	str	Unique ID of the application.	required
template	Optional[str]	The device template definition for the device.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

devices_get_telemetry_value async

devices_get_telemetry_value(device_id: str, telemetry_name: str, application: str, *, template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get device telemetry value

Get the last telemetry value from a device.

Swagger operation ID: Devices_GetTelemetryValue_V1.

Parameters:

Name	Type	Description	Default
device_id	str	Unique ID of the device.	required
telemetry_name	str	Name of this device telemetry.	required
application	str	Unique ID of the application.	required
template	Optional[str]	The device template definition for the device.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_devices

list_devices(application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List devices

Get the list of devices in an application.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: Devices_List_V1.

Parameters:

Name	Type	Description	Default
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

devices_remove async

devices_remove(device_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete a device

Delete an existing device by device ID.

Swagger operation ID: Devices_Remove_V1.

Parameters:

Name	Type	Description	Default
device_id	str	Unique ID of the device.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

devices_run_command async

devices_run_command(input: DeviceCommandV1 | Mapping[str, Any], device_id: str, command_name: str, application: str, *, template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Run a device command

Run a command on a device.

Swagger operation ID: Devices_RunCommand_V1.

Parameters:

Name	Type	Description	Default
input	DeviceCommandV1 | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
device_id	str	Unique ID of the device.	required
command_name	str	Name of this device command.	required
application	str	Unique ID of the application.	required
template	Optional[str]	The device template definition for the device.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

devices_run_component_command async

devices_run_component_command(input: DeviceComponentCommand | Mapping[str, Any], device_id: str, component_name: str, command_name: str, application: str, *, template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Run a component command

Run a command on a component.

Swagger operation ID: Devices_RunComponentCommand_V1.

Parameters:

Name	Type	Description	Default
input	DeviceComponentCommand | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
device_id	str	Unique ID of the device.	required
component_name	str	Name of the device component.	required
command_name	str	Name of this device command.	required
application	str	Unique ID of the application.	required
template	Optional[str]	The device template definition for the device.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

devices_run_module_command async

devices_run_module_command(input: DeviceModuleCommand | Mapping[str, Any], device_id: str, module: str, command_name: str, application: str, *, template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Run a module command

Run a command on a module.

Swagger operation ID: Devices_RunModuleCommand_V1.

Parameters:

Name	Type	Description	Default
input	DeviceModuleCommand | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
device_id	str	Unique ID of the device.	required
module	str	Name of the device module.	required
command_name	str	Name of this device command.	required
application	str	Unique ID of the application.	required
template	Optional[str]	The device template definition for the device.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

devices_run_module_component_command async

devices_run_module_component_command(input: DeviceModuleComponentCommand | Mapping[str, Any], device_id: str, module: str, component_name: str, command_name: str, application: str, *, template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Run a module component command

Run a command on a module component.

Swagger operation ID: Devices_RunModuleComponentCommand_V1.

Parameters:

Name	Type	Description	Default
input	DeviceModuleComponentCommand | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
device_id	str	Unique ID of the device.	required
module	str	Name of the device module.	required
component_name	str	Name of the device component.	required
command_name	str	Name of this device command.	required
application	str	Unique ID of the application.	required
template	Optional[str]	The device template definition for the device.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

devices_set async

devices_set(input: DeviceV2 | Mapping[str, Any], device_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create or update a device

Create a new device or update an existing one by device ID.

Swagger operation ID: Devices_Set_V2.

Parameters:

Name	Type	Description	Default
input	DeviceV2 | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
device_id	str	Unique ID of the device.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

devices_update_module_properties async

devices_update_module_properties(input: ModuleProperties | Mapping[str, Any], device_id: str, module: str, application: str, *, template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update module properties

Update all property values of a module.

Swagger operation ID: Devices_UpdateModuleProperties_V1.

Parameters:

Name	Type	Description	Default
input	ModuleProperties | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
device_id	str	Unique ID of the device.	required
module	str	Name of the device module.	required
application	str	Unique ID of the application.	required
template	Optional[str]	The device template definition for the device.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

devices_update_properties async

devices_update_properties(input: DeviceProperties | Mapping[str, Any], device_id: str, application: str, *, template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update device properties

Update all property values of a device by device ID.

Swagger operation ID: Devices_UpdateProperties_V1.

Parameters:

Name	Type	Description	Default
input	DeviceProperties | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
device_id	str	Unique ID of the device.	required
application	str	Unique ID of the application.	required
template	Optional[str]	The device template definition for the device.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

device_templates_get async

device_templates_get(template_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get a device template by ID

Get details about an existing device template by ID.

Swagger operation ID: DeviceTemplates_Get_V1.

Parameters:

Name	Type	Description	Default
template_id	str	Unique ID of the template.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_device_templates

list_device_templates(application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List device templates

Get the list of device templates in an application.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: DeviceTemplates_List_V1.

Parameters:

Name	Type	Description	Default
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

device_templates_remove async

device_templates_remove(template_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete a device template

Delete an existing device template by ID.

Swagger operation ID: DeviceTemplates_Remove_V1.

Parameters:

Name	Type	Description	Default
template_id	str	Unique ID of the template.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

roles_get async

roles_get(role_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get role

Get a role by ID.

Swagger operation ID: Roles_Get_V1.

Parameters:

Name	Type	Description	Default
role_id	str	Unique ID for the role.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_roles

list_roles(application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List roles

Get the list of roles in an application.

Returns a single-page Azure Core async collection.

Swagger operation ID: Roles_List_V1.

Parameters:

Name	Type	Description	Default
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

users_create async

users_create(input: User | Mapping[str, Any], user_id: str, application: str, *, user_type: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create user

Create a user in the application

Swagger operation ID: Users_Create_V1.

Parameters:

Name	Type	Description	Default
input	User | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
user_id	str	Unique ID of the user.	required
application	str	Unique ID of the application.	required
user_type	Optional[str]	Type of the user.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

users_get async

users_get(user_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get user

Get a user by ID

Swagger operation ID: Users_Get_V1.

Parameters:

Name	Type	Description	Default
user_id	str	Unique ID of the user.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_users

list_users(application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List users

Get the list of users in an application

Returns a single-page Azure Core async collection.

Swagger operation ID: Users_List_V1.

Parameters:

Name	Type	Description	Default
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

users_remove async

users_remove(user_id: str, application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete user

Delete a user

Swagger operation ID: Users_Remove_V1.

Parameters:

Name	Type	Description	Default
user_id	str	Unique ID of the user.	required
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

users_update async

users_update(input: UserPatch | Mapping[str, Any], user_id: str, application: str, *, user_type: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update user

Update a user in the application via patch

Swagger operation ID: Users_Update_V1.

Parameters:

Name	Type	Description	Default
input	UserPatch | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
user_id	str	Unique ID of the user.	required
application	str	Unique ID of the application.	required
user_type	Optional[str]	Type of the user.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_applications

list_applications(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get the list of applications accessible to the signed-in user

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: Applications_List.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_device_templates_2

list_device_templates_2(application: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List device templates

Get the list of device templates in an application.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: DeviceTemplates_List.

Parameters:

Name	Type	Description	Default
application	str	Unique ID of the application.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_workflow_get_components

list_workflow_get_components(application: str, template: str, *, module: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Workflow_GetComponents

Returns a single-page Azure Core async collection.

Swagger operation ID: Workflow_GetComponents.

Parameters:

Name	Type	Description	Default
application	str	Unique ID of the application.	required
template	str	template.	required
module	Optional[str]	module.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_workflow_get_capabilities

list_workflow_get_capabilities(application: str, template: str, *, component: Optional[str] = None, module: Optional[str] = None, type_: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Workflow_GetCapabilities

Returns a single-page Azure Core async collection.

Swagger operation ID: Workflow_GetCapabilities.

Parameters:

Name	Type	Description	Default
application	str	Unique ID of the application.	required
template	str	template.	required
component	Optional[str]	component.	None
module	Optional[str]	module.	None
type_	Optional[str]	type.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_workflow_get_capabilities_v1

list_workflow_get_capabilities_v1(application: str, template: str, *, component: Optional[str] = None, module: Optional[str] = None, type_: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Workflow_GetCapabilities_V1

Returns a single-page Azure Core async collection.

Swagger operation ID: Workflow_GetCapabilities_V1.

Parameters:

Name	Type	Description	Default
application	str	Unique ID of the application.	required
template	str	template.	required
component	Optional[str]	component.	None
module	Optional[str]	module.	None
type_	Optional[str]	type.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_workflow_get_components_v1

list_workflow_get_components_v1(application: str, template: str, *, module: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Workflow_GetComponents_V1

Returns a single-page Azure Core async collection.

Swagger operation ID: Workflow_GetComponents_V1.

Parameters:

Name	Type	Description	Default
application	str	Unique ID of the application.	required
template	str	template.	required
module	Optional[str]	module.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_workflow_get_modules

list_workflow_get_modules(application: str, template: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Workflow_GetModules

Returns a single-page Azure Core async collection.

Swagger operation ID: Workflow_GetModules_V1.

Parameters:

Name	Type	Description	Default
application	str	Unique ID of the application.	required
template	str	template.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

schema_device_cloud_properties async

schema_device_cloud_properties(application: str, *, instance_of: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Schema_DeviceCloudProperties

Swagger operation ID: Schema_DeviceCloudProperties.

Parameters:

Name	Type	Description	Default
application	str	Unique ID of the application.	required
instance_of	Optional[str]	The device template definition for the device.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

schema_device_command async

schema_device_command(application: str, *, instance_of: Optional[str] = None, component: Optional[str] = None, capability: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Schema_DeviceCommand

Swagger operation ID: Schema_DeviceCommand.

Parameters:

Name	Type	Description	Default
application	str	Unique ID of the application.	required
instance_of	Optional[str]	The device template definition for the device.	None
component	Optional[str]	component.	None
capability	Optional[str]	capability.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

schema_device_command_v1 async

schema_device_command_v1(application: str, *, template: Optional[str] = None, module: Optional[str] = None, component: Optional[str] = None, capability: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Schema_DeviceCommand_V1

Swagger operation ID: Schema_DeviceCommand_V1.

Parameters:

Name	Type	Description	Default
application	str	Unique ID of the application.	required
template	Optional[str]	The device template definition for the device.	None
module	Optional[str]	module.	None
component	Optional[str]	component.	None
capability	Optional[str]	capability.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

schema_device_properties async

schema_device_properties(application: str, *, template: Optional[str] = None, module: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Schema_DeviceProperties

Swagger operation ID: Schema_DeviceProperties_V1.

Parameters:

Name	Type	Description	Default
application	str	Unique ID of the application.	required
template	Optional[str]	The device template definition for the device.	None
module	Optional[str]	module.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

schema_device_telemetry async

schema_device_telemetry(application: str, *, template: Optional[str] = None, module: Optional[str] = None, component: Optional[str] = None, capability: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Schema_DeviceTelemetry

Swagger operation ID: Schema_DeviceTelemetry_V1.

Parameters:

Name	Type	Description	Default
application	str	Unique ID of the application.	required
template	Optional[str]	The device template definition for the device.	None
module	Optional[str]	module.	None
component	Optional[str]	component.	None
capability	Optional[str]	capability.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

schema_job async

schema_job(application: str, *, job_type: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Schema_Job

Swagger operation ID: Schema_Job.

Parameters:

Name	Type	Description	Default
application	str	Unique ID of the application.	required
job_type	Optional[str]	job_type.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

schema_scheduled_job async

schema_scheduled_job(application: str, *, scheduled_job_end_type: Optional[str] = None, job_type: Optional[str] = None, patch: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Schema_ScheduledJob

Swagger operation ID: Schema_ScheduledJob.

Parameters:

Name	Type	Description	Default
application	str	Unique ID of the application.	required
scheduled_job_end_type	Optional[str]	scheduled_job_end_type.	None
job_type	Optional[str]	job_type.	None
patch	Optional[bool]	patch.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

schema_user async

schema_user(application: str, *, user_type: Optional[str] = None, patch: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Schema_User

Swagger operation ID: Schema_User_V1.

Parameters:

Name	Type	Description	Default
application	str	Unique ID of the application.	required
user_type	Optional[str]	user_type.	None
patch	Optional[bool]	patch.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

schema_webhook_action_body async

schema_webhook_action_body(application: str, *, rule: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Schema_WebhookActionBody

Swagger operation ID: Schema_WebhookActionBody.

Parameters:

Name	Type	Description	Default
application	str	Unique ID of the application.	required
rule	Optional[str]	rule.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.