Skip to content

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: Optional[List[DeviceGroup]] = None, next_link: Optional[str] = None)

Response for List device groups

Attributes

value class-attribute instance-attribute 
value: Optional[List[DeviceGroup]] = None

The collection of device groups.

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

URL to get the next page of device groups.

DeviceGroup dataclass 

DeviceGroup(id: Optional[str] = None, display_name: Optional[str] = None, filter: 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] = None

Unique ID of the device group.

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display name of the device group.

filter class-attribute instance-attribute 
filter: Optional[str] = None

Query defining which devices should be in this group.

description class-attribute instance-attribute 
description: Optional[str] = None

Short summary of device group.

etag class-attribute instance-attribute 
etag: Optional[str] = None

ETag used to prevent conflict in device group updates.

organizations class-attribute instance-attribute 
organizations: Optional[List[str]] = None

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

DeviceGroupDeviceCollection dataclass 

DeviceGroupDeviceCollection(value: Optional[List[DeviceV1]] = None, next_link: Optional[str] = None)

Response for Get devices by device group ID

Attributes

value class-attribute instance-attribute 
value: Optional[List[DeviceV1]] = None

The collection of devices belonging to the device group.

next_link: Optional[str] = field(default=None, 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] = field(default_factory=dict)

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] = None

The request ID of the device command execution.

request class-attribute instance-attribute 
request: Optional[Any] = None

The payload for the device command.

response class-attribute instance-attribute 
response: Optional[Any] = None

The payload of the device command response.

connection_timeout class-attribute instance-attribute 
connection_timeout: Optional[int] = field(default=None, 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] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'responseCode'})

The status code of the device command response.

DeviceRelationshipCollection dataclass 

DeviceRelationshipCollection(value: Optional[List[DeviceRelationshipStatic]] = None, next_link: Optional[str] = None)

Response for List relationships

Attributes

value class-attribute instance-attribute 
value: Optional[List[DeviceRelationshipStatic]] = None

The collection of device relationships.

next_link: Optional[str] = field(default=None, 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] = None

Unique ID of the device relationship.

source class-attribute instance-attribute 
source: Optional[str] = None

The device ID of the source (parent) device.

target class-attribute instance-attribute 
target: Optional[str] = None

The device ID of the source (child) device.

JobCollection dataclass 

JobCollection(value: Optional[List[JobStatic]] = None, next_link: Optional[str] = None)

Response for List jobs

Attributes

value class-attribute instance-attribute 
value: Optional[List[JobStatic]] = None

The collection of jobs.

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

URL to get the next page of jobs.

JobStatic dataclass 

JobStatic(id: Optional[str] = None, display_name: Optional[str] = None, description: Optional[str] = None, group: Optional[str] = None, batch: Optional[JobBatch] = None, cancellation_threshold: Optional[JobCancellationThreshold] = None, data: Optional[List[Dict[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] = None

Unique ID of the job.

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display name of the job.

description class-attribute instance-attribute 
description: Optional[str] = None

Detailed description of the job.

group class-attribute instance-attribute 
group: Optional[str] = None

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

batch class-attribute instance-attribute 
batch: Optional[JobBatch] = None

The batching configuration for the job.

cancellation_threshold class-attribute instance-attribute 
cancellation_threshold: Optional[JobCancellationThreshold] = field(default=None, metadata={'wire_name': 'cancellationThreshold'})

The cancellation threshold for the job.

data class-attribute instance-attribute 
data: Optional[List[Dict[str, Any]]] = None

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]] = None

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] = field(default=None, metadata={'wire_name': 'scheduledJobId'})

Id of the scheduled job definition that created this job.

Job dataclass 

Job(id: Optional[str] = None, display_name: Optional[str] = None, description: Optional[str] = None, group: Optional[str] = None, batch: Optional[JobBatch] = None, cancellation_threshold: Optional[JobCancellationThreshold] = 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] = None

Unique ID of the job.

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display name of the job.

description class-attribute instance-attribute 
description: Optional[str] = None

Detailed description of the job.

group class-attribute instance-attribute 
group: Optional[str] = None

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

batch class-attribute instance-attribute 
batch: Optional[JobBatch] = None

The batching configuration for the job.

cancellation_threshold class-attribute instance-attribute 
cancellation_threshold: Optional[JobCancellationThreshold] = field(default=None, metadata={'wire_name': 'cancellationThreshold'})

The cancellation threshold for the job.

organizations class-attribute instance-attribute 
organizations: Optional[List[str]] = None

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] = field(default=None, metadata={'wire_name': 'scheduledJobId'})

Id of the scheduled job definition that created this job.

JobDeviceStatusCollection dataclass 

JobDeviceStatusCollection(value: Optional[List[JobDeviceStatus]] = None, next_link: Optional[str] = None)

Response for Get device statuses

Attributes

value class-attribute instance-attribute 
value: Optional[List[JobDeviceStatus]] = None

The collection of job device statuses.

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

URL to get the next page of job device statuses.

OrganizationCollection dataclass 

OrganizationCollection(value: Optional[List[Organization]] = None, next_link: Optional[str] = None)

Response for List organizations

Attributes

value class-attribute instance-attribute 
value: Optional[List[Organization]] = None

The collection of organizations.

next_link: Optional[str] = field(default=None, 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] = None

Unique ID of the organization.

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display name of the organization.

parent class-attribute instance-attribute 
parent: Optional[str] = None

Display name of the parent organization.

ScheduledJobCollection dataclass 

ScheduledJobCollection(value: Optional[List[ScheduledJob]] = None, next_link: Optional[str] = None)

Response for List scheduled jobs

Attributes

value class-attribute instance-attribute 
value: Optional[List[ScheduledJob]] = None

The collection of scheduled jobs.

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

URL to get the next page of scheduled jobs.

ScheduledJob dataclass 

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

Response for Get a scheduled job

Attributes

etag class-attribute instance-attribute 
etag: Optional[str] = None

ETag used to prevent conflict in scheduled job updates.

id class-attribute instance-attribute 
id: Optional[str] = None

Unique ID of the scheduled job.

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display name of the scheduled job.

description class-attribute instance-attribute 
description: Optional[str] = None

Detailed description of the scheduled job.

group class-attribute instance-attribute 
group: Optional[str] = None

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

batch class-attribute instance-attribute 
batch: Optional[JobBatch] = None

The batching configuration for the scheduled job.

cancellation_threshold class-attribute instance-attribute 
cancellation_threshold: Optional[JobCancellationThreshold] = field(default=None, metadata={'wire_name': 'cancellationThreshold'})

The cancellation threshold for the scheduled job.

organizations class-attribute instance-attribute 
organizations: Optional[List[str]] = None

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

schedule class-attribute instance-attribute 
schedule: Optional[Dict[str, Any]] = None

The schedule at which to execute the job.

enabled class-attribute instance-attribute 
enabled: Optional[bool] = None

Whether the scheduled job is enabled.

completed class-attribute instance-attribute 
completed: Optional[bool] = None

Whether the scheduled job has completed.

ScheduledJobStatic dataclass 

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

Response for Update a scheduled job

Attributes

etag class-attribute instance-attribute 
etag: Optional[str] = None

ETag used to prevent conflict in scheduled job updates.

id class-attribute instance-attribute 
id: Optional[str] = None

Unique ID of the scheduled job.

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display name of the scheduled job.

description class-attribute instance-attribute 
description: Optional[str] = None

Detailed description of the scheduled job.

group class-attribute instance-attribute 
group: Optional[str] = None

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

batch class-attribute instance-attribute 
batch: Optional[JobBatch] = None

The batching configuration for the scheduled job.

cancellation_threshold class-attribute instance-attribute 
cancellation_threshold: Optional[JobCancellationThreshold] = field(default=None, metadata={'wire_name': 'cancellationThreshold'})

The cancellation threshold for the scheduled job.

data class-attribute instance-attribute 
data: Optional[List[Dict[str, Any]]] = None

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]] = None

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

schedule class-attribute instance-attribute 
schedule: Optional[Dict[str, Any]] = None

The schedule at which to execute the job.

enabled class-attribute instance-attribute 
enabled: Optional[bool] = None

Whether the scheduled job is enabled.

completed class-attribute instance-attribute 
completed: Optional[bool] = None

Whether the scheduled job has completed.

ScheduledJobJobCollection dataclass 

ScheduledJobJobCollection(value: Optional[List[JobStatic]] = None, next_link: Optional[str] = None)

Response for Get jobs by scheduled job ID

Attributes

value class-attribute instance-attribute 
value: Optional[List[JobStatic]] = None

The collection of jobs.

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

URL to get the next page of jobs.

WorkflowTrigger dataclass 

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

Response for When a rule is fired

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

Unique ID of the workflow trigger.

rule class-attribute instance-attribute 
rule: Optional[str] = None

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

url class-attribute instance-attribute 
url: Optional[str] = None

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] = None

Unique ID of the device.

etag class-attribute instance-attribute 
etag: Optional[str] = None

ETag used to prevent conflict in device updates.

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display name of the device.

template class-attribute instance-attribute 
template: Optional[str] = None

The device template definition for the device.

simulated class-attribute instance-attribute 
simulated: Optional[bool] = None

Whether the device is simulated.

enabled class-attribute instance-attribute 
enabled: Optional[bool] = None

Whether the device connection to IoT Central has been enabled.

provisioned class-attribute instance-attribute 
provisioned: Optional[bool] = None

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] = None

The request ID of the device command execution.

request class-attribute instance-attribute 
request: Optional[Any] = None

The payload for the device command.

response class-attribute instance-attribute 
response: Optional[Any] = None

The payload of the device command response.

connection_timeout class-attribute instance-attribute 
connection_timeout: Optional[int] = field(default=None, 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] = field(default=None, 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] = field(default=None, 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] = None

The request ID of the device command execution.

request class-attribute instance-attribute 
request: Optional[Any] = None

The payload for the device command.

response class-attribute instance-attribute 
response: Optional[Any] = None

The payload of the device command response.

connection_timeout class-attribute instance-attribute 
connection_timeout: Optional[int] = field(default=None, 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] = field(default=None, 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] = field(default=None, 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] = None

The last known value of this device telemetry.

timestamp class-attribute instance-attribute 
timestamp: Optional[str] = None

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] = None

The request ID of the device command execution.

request class-attribute instance-attribute 
request: Optional[Any] = None

The payload for the device command.

response class-attribute instance-attribute 
response: Optional[Any] = None

The payload of the device command response.

connection_timeout class-attribute instance-attribute 
connection_timeout: Optional[int] = field(default=None, 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] = field(default=None, 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] = field(default=None, 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] = None

The request ID of the device command execution.

request class-attribute instance-attribute 
request: Optional[Any] = None

The payload for the device command.

response class-attribute instance-attribute 
response: Optional[Any] = None

The payload of the device command response.

connection_timeout class-attribute instance-attribute 
connection_timeout: Optional[int] = field(default=None, 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] = field(default=None, 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] = field(default=None, 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] = None

The last known value of this device telemetry.

timestamp class-attribute instance-attribute 
timestamp: Optional[str] = None

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] = field(default_factory=dict)

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] = None

The last known value of this device telemetry.

timestamp class-attribute instance-attribute 
timestamp: Optional[str] = None

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] = field(default_factory=dict)

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] = None

The last known value of this device telemetry.

timestamp class-attribute instance-attribute 
timestamp: Optional[str] = None

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

DeviceCollection dataclass 

DeviceCollection(value: Optional[List[DeviceV1]] = None, next_link: Optional[str] = None)

Response for List devices

Attributes

value class-attribute instance-attribute 
value: Optional[List[DeviceV1]] = None

The collection of devices.

next_link: Optional[str] = field(default=None, 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] = None

Unique ID of the device.

etag class-attribute instance-attribute 
etag: Optional[str] = None

ETag used to prevent conflict in device updates.

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display name of the device.

template class-attribute instance-attribute 
template: Optional[str] = None

The device template definition for the device.

simulated class-attribute instance-attribute 
simulated: Optional[bool] = None

Whether the device is simulated.

enabled class-attribute instance-attribute 
enabled: Optional[bool] = None

Whether the device connection to IoT Central has been enabled.

organizations class-attribute instance-attribute 
organizations: Optional[List[str]] = None

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] = None

Whether resources have been allocated for the device.

DeviceTemplateV1 dataclass 

DeviceTemplateV1(id: Optional[str] = None, etag: Optional[str] = None, type_: Optional[List[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] = field(default=None, metadata={'wire_name': '@id'})

Unique ID of the device template.

etag class-attribute instance-attribute 
etag: Optional[str] = None

ETag used to prevent conflict in device template updates.

type_ class-attribute instance-attribute 
type_: Optional[List[str]] = field(default=None, metadata={'wire_name': '@type'})

The JSON-LD types of this device template.

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display name of the device template.

description class-attribute instance-attribute 
description: Optional[str] = None

Detailed description of the device template.

capability_model class-attribute instance-attribute 
capability_model: Optional[Any] = field(default=None, metadata={'wire_name': 'capabilityModel'})

The capability model utilized by this device template.

DeviceTemplateCollectionV1 dataclass 

DeviceTemplateCollectionV1(value: Optional[List[DeviceTemplateV1]] = None, next_link: Optional[str] = None)

Response for List device templates

Attributes

value class-attribute instance-attribute 
value: Optional[List[DeviceTemplateV1]] = None

The collection of device templates.

next_link: Optional[str] = field(default=None, 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] = None

Unique ID of the role.

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display name of the role.

RoleCollection dataclass 

RoleCollection(value: Optional[List[Role]] = None)

Response for List roles

Attributes

value class-attribute instance-attribute 
value: Optional[List[Role]] = None

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] = field(default_factory=dict)

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

UserStatic dataclass 

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

Response for Get user

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

Unique ID of the user.

type_ class-attribute instance-attribute 
type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Type of the user.

roles class-attribute instance-attribute 
roles: Optional[List[RoleAssignment]] = None

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

UserCollection dataclass 

UserCollection(value: Optional[List[UserStatic]] = None)

Response for List users

Attributes

value class-attribute instance-attribute 
value: Optional[List[UserStatic]] = None

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] = field(default_factory=dict)

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

ApplicationCollection dataclass 

ApplicationCollection(value: Optional[List[Application]] = None, next_link: Optional[str] = None)

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

Attributes

value class-attribute instance-attribute 
value: Optional[List[Application]] = None

The collection of applications.

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

URL to get the next page of applications.

DeviceTemplateCollection dataclass 

DeviceTemplateCollection(value: Optional[List[DeviceTemplate]] = None, next_link: Optional[str] = None)

Response for List device templates

Attributes

value class-attribute instance-attribute 
value: Optional[List[DeviceTemplate]] = None

The collection of device templates.

next_link: Optional[str] = field(default=None, 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] = field(default_factory=dict)

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] = field(default_factory=dict)

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] = field(default_factory=dict)

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] = field(default_factory=dict)

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] = field(default_factory=dict)

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] = field(default_factory=dict)

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] = field(default_factory=dict)

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

Action dataclass 

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

Definition: Action

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

Unique ID of the action.

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display name of the action.

type_ class-attribute instance-attribute 
type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Type of the action.

rules class-attribute instance-attribute 
rules: Optional[List[str]] = None

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

EmailAction dataclass 

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

Definition: EmailAction

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

Unique ID of the email action.

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display name of the email action.

type_ class-attribute instance-attribute 
type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Type of the email action.

rules class-attribute instance-attribute 
rules: Optional[List[str]] = None

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

WebhookAction dataclass 

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

Definition: WebhookAction

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

Unique ID of the webhook action.

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display name of the webhook action.

type_ class-attribute instance-attribute 
type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Type of the webhook action.

rules class-attribute instance-attribute 
rules: Optional[List[str]] = None

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

url class-attribute instance-attribute 
url: Optional[str] = None

Callback URL of the webhook.

PowerAutomateAction dataclass 

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

Definition: PowerAutomateAction

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

Unique ID of the Power Automate action.

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display name of the Power Automate action.

type_ class-attribute instance-attribute 
type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Type of the Power Automate action.

rules class-attribute instance-attribute 
rules: Optional[List[str]] = None

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

LogicAppsAction dataclass 

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

Definition: LogicAppsAction

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

Unique ID of the Logic Apps action.

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display name of the Logic Apps action.

type_ class-attribute instance-attribute 
type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Type of the Logic Apps action.

rules class-attribute instance-attribute 
rules: Optional[List[str]] = None

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

ActionGroupsAction dataclass 

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

Definition: ActionGroupsAction

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

Unique ID of the Action Groups action.

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display name of the Action Groups action.

type_ class-attribute instance-attribute 
type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Type of the Action Groups action.

rules class-attribute instance-attribute 
rules: Optional[List[str]] = None

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

Application dataclass 

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

Definition: Application

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

Unique ID of the application.

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display name of the application.

subdomain class-attribute instance-attribute 
subdomain: Optional[str] = None

The URL subdomain of the application.

host class-attribute instance-attribute 
host: Optional[str] = None

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] = None

Unique ID of the device.

etag class-attribute instance-attribute 
etag: Optional[str] = None

ETag used to prevent conflict in device updates.

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display name of the device.

instance_of class-attribute instance-attribute 
instance_of: Optional[str] = field(default=None, metadata={'wire_name': 'instanceOf'})

The device template definition for the device.

simulated class-attribute instance-attribute 
simulated: Optional[bool] = None

Whether the device is simulated.

approved class-attribute instance-attribute 
approved: Optional[bool] = None

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

provisioned class-attribute instance-attribute 
provisioned: Optional[bool] = None

Whether resources have been allocated for the device.

DeviceRelationship dataclass 

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

Definition: DeviceRelationship

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

Unique ID of the device relationship.

target class-attribute instance-attribute 
target: Optional[str] = None

The device ID of the source (child) device.

DeviceTemplate dataclass 

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

Definition: DeviceTemplate

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

Unique ID of the device template.

etag class-attribute instance-attribute 
etag: Optional[str] = None

ETag used to prevent conflict in device template updates.

types class-attribute instance-attribute 
types: Optional[List[str]] = None

The types of device to which this template applies.

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display name of the device template.

description class-attribute instance-attribute 
description: Optional[str] = None

Detailed description of the device template.

PropertyJobData dataclass 

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

Definition: PropertyJobData

Attributes

data class-attribute instance-attribute 
data: Optional[List[Dict[str, Any]]] = None

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

CommandJobData dataclass 

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

Definition: CommandJobData

Attributes

data class-attribute instance-attribute 
data: Optional[List[Dict[str, Any]]] = None

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

CloudPropertyJobData dataclass 

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

Definition: CloudPropertyJobData

Attributes

data class-attribute instance-attribute 
data: Optional[List[Dict[str, Any]]] = None

The collection of job data.

DeviceTemplateMigrationJobData dataclass 

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

Definition: DeviceTemplateMigrationJobData

Attributes

data class-attribute instance-attribute 
data: Optional[List[Dict[str, Any]]] = None

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] = None

ID of the device whose job status is being provided.

status class-attribute instance-attribute 
status: Optional[str] = None

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

JobBatch dataclass 

JobBatch(type_: Optional[str] = None, value: Optional[float] = None)

Definition: JobBatch

Attributes

type_ class-attribute instance-attribute 
type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

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

value class-attribute instance-attribute 
value: Optional[float] = None

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

JobCancellationThreshold dataclass 

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

Definition: JobCancellationThreshold

Attributes

type_ class-attribute instance-attribute 
type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

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

value class-attribute instance-attribute 
value: Optional[float] = None

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

batch class-attribute instance-attribute 
batch: Optional[bool] = None

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] = None

Unique ID of the rule.

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display name of the rule.

RuleCollection dataclass 

RuleCollection(value: Optional[List[Rule]] = None, next_link: Optional[str] = None)

Definition: RuleCollection

Attributes

value class-attribute instance-attribute 
value: Optional[List[Rule]] = None

The collection of rules.

next_link: Optional[str] = field(default=None, 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]] = None

The schedule at which to execute the job.

DateJobSchedule dataclass 

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

Definition: DateJobSchedule

Attributes

schedule class-attribute instance-attribute 
schedule: Optional[Dict[str, Any]] = None

The schedule at which to execute the job.

OccurrencesJobSchedule dataclass 

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

Definition: OccurrencesJobSchedule

Attributes

schedule class-attribute instance-attribute 
schedule: Optional[Dict[str, Any]] = None

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] = field(default=None, metadata={'wire_name': 'type'})

Type of the job schedule end.

date class-attribute instance-attribute 
date: Optional[str] = None

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

occurrences class-attribute instance-attribute 
occurrences: Optional[int] = None

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

ScheduledJobPatch dataclass 

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

Definition: ScheduledJobPatch

Attributes

etag class-attribute instance-attribute 
etag: Optional[str] = None

ETag used to prevent conflict in scheduled job updates.

id class-attribute instance-attribute 
id: Optional[str] = None

Unique ID of the scheduled job.

schedule class-attribute instance-attribute 
schedule: Optional[Dict[str, Any]] = None

The schedule at which to execute the job.

enabled class-attribute instance-attribute 
enabled: Optional[bool] = None

Whether the scheduled job is enabled.

completed class-attribute instance-attribute 
completed: Optional[bool] = None

Whether the scheduled job has completed.

EmailUser dataclass 

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

Definition: EmailUser

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

Unique ID of the user.

type_ class-attribute instance-attribute 
type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Type of the user.

roles class-attribute instance-attribute 
roles: Optional[List[RoleAssignment]] = None

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

email class-attribute instance-attribute 
email: Optional[str] = None

Email address of the user.

ServicePrincipalUser dataclass 

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

Definition: ServicePrincipalUser

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

Unique ID of the user.

type_ class-attribute instance-attribute 
type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Type of the user.

roles class-attribute instance-attribute 
roles: Optional[List[RoleAssignment]] = None

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

tenant_id class-attribute instance-attribute 
tenant_id: Optional[str] = field(default=None, metadata={'wire_name': 'tenantId'})

The Microsoft Entra ID tenant ID of the service principal.

object_id class-attribute instance-attribute 
object_id: Optional[str] = field(default=None, metadata={'wire_name': 'objectId'})

The Microsoft Entra ID object ID of the service principal.

RoleAssignment dataclass 

RoleAssignment(role: Optional[str] = None)

Definition: RoleAssignment

Attributes

role class-attribute instance-attribute 
role: Optional[str] = None

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] = None

Unique ID of the device.

etag class-attribute instance-attribute 
etag: Optional[str] = None

ETag used to prevent conflict in device updates.

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display name of the device.

instance_of class-attribute instance-attribute 
instance_of: Optional[str] = field(default=None, metadata={'wire_name': 'instanceOf'})

The device template definition for the device.

simulated class-attribute instance-attribute 
simulated: Optional[bool] = None

Whether the device is simulated.

approved class-attribute instance-attribute 
approved: Optional[bool] = None

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

provisioned class-attribute instance-attribute 
provisioned: Optional[bool] = None

Whether resources have been allocated for the device.

cloud_properties class-attribute instance-attribute 
cloud_properties: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'cloudProperties'})

Cloud properties that triggered the webhook.

properties class-attribute instance-attribute 
properties: Optional[Dict[str, Any]] = None

Device properties that triggered the webhook.

telemetry class-attribute instance-attribute 
telemetry: Optional[Dict[str, Any]] = None

Device telemetry that triggered the webhook.

WebhookActionBody dataclass 

WebhookActionBody(action: Optional[Action] = None, application: Optional[Application] = None, device: Optional[WebhookActionDevice] = None, rule: Optional[Rule] = None, timestamp: Optional[str] = None)

Definition: WebhookActionBody

Attributes

action class-attribute instance-attribute 
action: Optional[Action] = None

Action that triggered the webhook.

application class-attribute instance-attribute 
application: Optional[Application] = None

Application that triggered the webhook.

device class-attribute instance-attribute 
device: Optional[WebhookActionDevice] = None

Device that triggered the webhook.

rule class-attribute instance-attribute 
rule: Optional[Rule] = None

Rule that triggered the webhook.

timestamp class-attribute instance-attribute 
timestamp: Optional[str] = None

Timestamp at which the webhook was triggered.

AzureiotcentralClient 

AzureiotcentralClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

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
token_provider Optional[TokenProvider]

Optional token provider. Defaults to ManagedIdentityTokenProvider.

 None
options Optional[ConnectorClientOptions]

Optional connector client options.

 None

Methods:

device_groups_list_async async 
device_groups_list_async(application: str) -> dict[str, Any] | None

List device groups

Get the list of device groups in an application.

device_groups_get_async async 
device_groups_get_async(device_group_id: str, application: str) -> dict[str, Any] | None

Get a device group

Get details about an existing device group by ID.

device_groups_set_async async 
device_groups_set_async(input: DeviceGroup, device_group_id: str, application: str) -> dict[str, Any] | None

Create a device group

Create or update a device group.

device_groups_remove_async async 
device_groups_remove_async(device_group_id: str, application: str) -> None

Delete device group

Delete an existing device group by ID

device_groups_get_devices_async async 
device_groups_get_devices_async(device_group_id: str, application: str) -> dict[str, Any] | None

Get devices by device group ID

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

devices_get_cloud_properties_async async 
devices_get_cloud_properties_async(device_id: str, application: str, instance_of: Optional[str] = None) -> dict[str, Any] | None

Get device cloud properties (deprecated)

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

devices_update_cloud_properties_async async 
devices_update_cloud_properties_async(input: DeviceCloudProperties, device_id: str, application: str, instance_of: Optional[str] = None) -> dict[str, Any] | None

Update device cloud properties (deprecated)

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

devices_execute_component_command_async async 
devices_execute_component_command_async(input: DeviceCommand, device_id: str, component_name: str, command_name: str, application: str, instance_of: Optional[str] = None) -> dict[str, Any] | None

Execute a device command (deprecated)

Execute a command on a device (deprecated).

device_relationships_list_async async 
device_relationships_list_async(device_id: str, application: str) -> dict[str, Any] | None

List relationships

List all relationships based on device ID.

device_relationships_get_async async 
device_relationships_get_async(device_id: str, relationship_id: str, application: str) -> dict[str, Any] | None

Get device relationship

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

device_relationships_set_async async 
device_relationships_set_async(input: DeviceRelationship, relationship_id: str, device_id: str, application: str) -> 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.

device_relationships_update_async async 
device_relationships_update_async(input: DeviceRelationship, device_id: str, relationship_id: str, application: str) -> 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.

device_relationships_remove_async async 
device_relationships_remove_async(device_id: str, relationship_id: str, application: str) -> None

Delete a device relationship

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

jobs_list_async async 
jobs_list_async(application: str) -> dict[str, Any] | None

List jobs

Get the list of jobs in an application.

jobs_get_async async 
jobs_get_async(job_id: str, application: str) -> dict[str, Any] | None

Get a job

Get details about an existing job by ID.

jobs_set_async async 
jobs_set_async(input: Job, job_id: str, application: str, job_type: Optional[str] = None) -> dict[str, Any] | None

Create a job

Create and execute a new job via its job definition.

jobs_get_devices_async async 
jobs_get_devices_async(job_id: str, application: str) -> dict[str, Any] | None

Get device statuses

Get the list of individual device statuses by job ID.

jobs_stop_async async 
jobs_stop_async(job_id: str, application: str) -> None

Stop a running job

Stop execution of a job that is currently running.

jobs_resume_async async 
jobs_resume_async(job_id: str, application: str) -> None

Resume a stopped job

Resume execution of an existing stopped job.

jobs_rerun_async async 
jobs_rerun_async(job_id: str, rerun_id: str, application: str) -> dict[str, Any] | None

Resume a job on failed devices

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

organizations_list_async async 
organizations_list_async(application: str) -> dict[str, Any] | None

List organizations

Get the list of organizations in an application.

organizations_get_async async 
organizations_get_async(organization_id: str, application: str) -> dict[str, Any] | None

Get an organization

Get details about an existing organization by ID.

organizations_set_async async 
organizations_set_async(input: Organization, organization_id: str, application: str) -> dict[str, Any] | None

Create an organization

Create a new organization.

organizations_remove_async async 
organizations_remove_async(organization_id: str, application: str) -> None

Delete organization

Delete an existing organization by ID

scheduled_jobs_list_async async 
scheduled_jobs_list_async(application: str) -> dict[str, Any] | None

List scheduled jobs

Get the list of scheduled jobs in an application.

scheduled_jobs_get_async async 
scheduled_jobs_get_async(scheduled_job_id: str, application: str) -> dict[str, Any] | None

Get a scheduled job

Get details about an existing scheduled job by ID.

scheduled_jobs_set_async async 
scheduled_jobs_set_async(input: ScheduledJob, scheduled_job_id: str, application: str, job_type: Optional[str] = None, scheduled_job_end_type: Optional[str] = None) -> dict[str, Any] | None

Create a scheduled job

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

scheduled_jobs_update_async async 
scheduled_jobs_update_async(input: ScheduledJobPatch, scheduled_job_id: str, application: str, scheduled_job_end_type: Optional[str] = None) -> dict[str, Any] | None

Update a scheduled job

Update an existing scheduled job by ID.

scheduled_jobs_remove_async async 
scheduled_jobs_remove_async(scheduled_job_id: str, application: str) -> None

Delete a scheduled job

Delete an existing scheduled job by ID.

scheduled_jobs_list_jobs_async async 
scheduled_jobs_list_jobs_async(scheduled_job_id: str, application: str) -> dict[str, Any] | None

Get jobs by scheduled job ID

Get the list of jobs for a scheduled job definition.

devices_get_async async 
devices_get_async(device_id: str, application: str) -> dict[str, Any] | None

Get a device by ID

Get details about an existing device by device ID.

devices_get_command_response_async async 
devices_get_command_response_async(device_id: str, command_name: str, application: str, template: Optional[str] = None) -> dict[str, Any] | None

Get device command response

Get the last response for a device command.

devices_get_component_command_response_async async 
devices_get_component_command_response_async(device_id: str, component_name: str, command_name: str, application: str, template: Optional[str] = None) -> dict[str, Any] | None

Get component command response

Get the last response for a device component command.

devices_get_component_telemetry_value_async async 
devices_get_component_telemetry_value_async(device_id: str, component_name: str, telemetry_name: str, application: str, template: Optional[str] = None) -> dict[str, Any] | None

Get component telemetry value

Get the last telemetry value from a component.

devices_get_module_command_response_async async 
devices_get_module_command_response_async(device_id: str, module: str, command_name: str, application: str, template: Optional[str] = None) -> dict[str, Any] | None

Get module command response

Get the last response for a device module command

devices_get_module_component_command_response_async async 
devices_get_module_component_command_response_async(device_id: str, module: str, component_name: str, command_name: str, application: str, template: Optional[str] = None) -> dict[str, Any] | None

Get module component command response

Get the last response for a module component command.

devices_get_module_component_telemetry_value_async async 
devices_get_module_component_telemetry_value_async(device_id: str, module: str, component_name: str, telemetry_name: str, application: str, template: Optional[str] = None) -> dict[str, Any] | None

Get module component telemetry value

Get the last telemetry value from a module component.

devices_get_module_properties_async async 
devices_get_module_properties_async(device_id: str, module: str, application: str, template: Optional[str] = None) -> dict[str, Any] | None

Get module properties

Get all property values of a module.

devices_get_module_telemetry_value_async async 
devices_get_module_telemetry_value_async(device_id: str, module: str, telemetry_name: str, application: str, template: Optional[str] = None) -> dict[str, Any] | None

Get module telemetry value

Get the last telemetry value from a module.

devices_get_properties_async async 
devices_get_properties_async(device_id: str, application: str, template: Optional[str] = None) -> dict[str, Any] | None

Get device properties

Get all property values of a device by device ID.

devices_get_telemetry_value_async async 
devices_get_telemetry_value_async(device_id: str, telemetry_name: str, application: str, template: Optional[str] = None) -> dict[str, Any] | None

Get device telemetry value

Get the last telemetry value from a device.

devices_list_async async 
devices_list_async(application: str) -> dict[str, Any] | None

List devices

Get the list of devices in an application.

devices_remove_async async 
devices_remove_async(device_id: str, application: str) -> None

Delete a device

Delete an existing device by device ID.

devices_run_command_async async 
devices_run_command_async(input: DeviceCommandV1, device_id: str, command_name: str, application: str, template: Optional[str] = None) -> dict[str, Any] | None

Run a device command

Run a command on a device.

devices_run_component_command_async async 
devices_run_component_command_async(input: DeviceComponentCommand, device_id: str, component_name: str, command_name: str, application: str, template: Optional[str] = None) -> dict[str, Any] | None

Run a component command

Run a command on a component.

devices_run_module_command_async async 
devices_run_module_command_async(input: DeviceModuleCommand, device_id: str, module: str, command_name: str, application: str, template: Optional[str] = None) -> dict[str, Any] | None

Run a module command

Run a command on a module.

devices_run_module_component_command_async async 
devices_run_module_component_command_async(input: DeviceModuleComponentCommand, device_id: str, module: str, component_name: str, command_name: str, application: str, template: Optional[str] = None) -> dict[str, Any] | None

Run a module component command

Run a command on a module component.

devices_set_async async 
devices_set_async(input: DeviceV2, device_id: str, application: str) -> dict[str, Any] | None

Create or update a device

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

devices_update_module_properties_async async 
devices_update_module_properties_async(input: ModuleProperties, device_id: str, module: str, application: str, template: Optional[str] = None) -> dict[str, Any] | None

Update module properties

Update all property values of a module.

devices_update_properties_async async 
devices_update_properties_async(input: DeviceProperties, device_id: str, application: str, template: Optional[str] = None) -> dict[str, Any] | None

Update device properties

Update all property values of a device by device ID.

device_templates_get_async async 
device_templates_get_async(template_id: str, application: str) -> dict[str, Any] | None

Get a device template by ID

Get details about an existing device template by ID.

device_templates_list_async async 
device_templates_list_async(application: str) -> dict[str, Any] | None

List device templates

Get the list of device templates in an application.

device_templates_remove_async async 
device_templates_remove_async(template_id: str, application: str) -> None

Delete a device template

Delete an existing device template by ID.

roles_get_async async 
roles_get_async(role_id: str, application: str) -> dict[str, Any] | None

Get role

Get a role by ID.

roles_list_async async 
roles_list_async(application: str) -> dict[str, Any] | None

List roles

Get the list of roles in an application.

users_create_async async 
users_create_async(input: User, user_id: str, application: str, user_type: Optional[str] = None) -> dict[str, Any] | None

Create user

Create a user in the application

users_get_async async 
users_get_async(user_id: str, application: str) -> dict[str, Any] | None

Get user

Get a user by ID

users_list_async async 
users_list_async(application: str) -> dict[str, Any] | None

List users

Get the list of users in an application

users_remove_async async 
users_remove_async(user_id: str, application: str) -> None

Delete user

Delete a user

users_update_async async 
users_update_async(input: UserPatch, user_id: str, application: str, user_type: Optional[str] = None) -> dict[str, Any] | None

Update user

Update a user in the application via patch

applications_list_async async 
applications_list_async() -> dict[str, Any] | None

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

device_templates_list_2_async async 
device_templates_list_2_async(application: str) -> dict[str, Any] | None

List device templates

Get the list of device templates in an application.

workflow_get_components_async async 
workflow_get_components_async(application: str, template: str, module: Optional[str] = None) -> dict[str, Any] | None

Workflow_GetComponents

workflow_get_capabilities_async async 
workflow_get_capabilities_async(application: str, template: str, component: Optional[str] = None, module: Optional[str] = None, type_: Optional[str] = None) -> dict[str, Any] | None

Workflow_GetCapabilities

workflow_get_capabilities_v1_async async 
workflow_get_capabilities_v1_async(application: str, template: str, component: Optional[str] = None, module: Optional[str] = None, type_: Optional[str] = None) -> dict[str, Any] | None

Workflow_GetCapabilities_V1

workflow_get_components_v1_async async 
workflow_get_components_v1_async(application: str, template: str, module: Optional[str] = None) -> dict[str, Any] | None

Workflow_GetComponents_V1

workflow_get_modules_async async 
workflow_get_modules_async(application: str, template: str) -> dict[str, Any] | None

Workflow_GetModules

schema_device_cloud_properties_async async 
schema_device_cloud_properties_async(application: str, instance_of: Optional[str] = None) -> dict[str, Any] | None

Schema_DeviceCloudProperties

schema_device_command_async async 
schema_device_command_async(application: str, instance_of: Optional[str] = None, component: Optional[str] = None, capability: Optional[str] = None) -> dict[str, Any] | None

Schema_DeviceCommand

schema_device_command_v1_async async 
schema_device_command_v1_async(application: str, template: Optional[str] = None, module: Optional[str] = None, component: Optional[str] = None, capability: Optional[str] = None) -> dict[str, Any] | None

Schema_DeviceCommand_V1

schema_device_properties_async async 
schema_device_properties_async(application: str, template: Optional[str] = None, module: Optional[str] = None) -> dict[str, Any] | None

Schema_DeviceProperties

schema_device_telemetry_async async 
schema_device_telemetry_async(application: str, template: Optional[str] = None, module: Optional[str] = None, component: Optional[str] = None, capability: Optional[str] = None) -> dict[str, Any] | None

Schema_DeviceTelemetry

schema_job_async async 
schema_job_async(application: str, job_type: Optional[str] = None) -> dict[str, Any] | None

Schema_Job

schema_scheduled_job_async async 
schema_scheduled_job_async(application: str, scheduled_job_end_type: Optional[str] = None, job_type: Optional[str] = None, patch: Optional[bool] = None) -> dict[str, Any] | None

Schema_ScheduledJob

schema_user_async async 
schema_user_async(application: str, user_type: Optional[str] = None, patch: Optional[bool] = None) -> dict[str, Any] | None

Schema_User

schema_webhook_action_body_async async 
schema_webhook_action_body_async(application: str, rule: Optional[str] = None) -> None

Schema_WebhookActionBody