Module azure.iotcentral
ballerinax/azure.iotcentral Ballerina library
1.5.1
Overview
This is a generated connector from Azure IoT Central API v1.0 OpenAPI specification.
Azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale.
Prerequisites
- Create an Azure account
- Create an Azure IoT Central application
- Obtain tokens
- Use this guide to obtain the credentials which are needed to create the <ACCESS_TOKEN>
Clients
azure.iotcentral: Client
Isolated
This is a generated connector from Azure IoT Central API v1.0 OpenAPI specification. Azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Create an Azure IoT Central account and obtain OAuth tokens following this guide.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string - URL of the target service
apitokensList
Isolated FunctionRemote Function
function apitokensList(string apiVersion) returns ApiTokenCollection|errorGet the list of API tokens in an application. The token value will never be returned for security reasons.
Parameters
- apiVersion string - The version of the API being called.
Return Type
- ApiTokenCollection|error - Success
apitokensGet
Isolated FunctionRemote Function
Get an API token by ID.
Parameters
- apiVersion string - The version of the API being called.
- tokenId string - Unique ID for the API token.
apitokensCreate
Isolated FunctionRemote Function
function apitokensCreate(string apiVersion, string tokenId, ApiToken payload) returns ApiToken|errorCreate a new API token in the application to use in the IoT Central public API. The token value will be returned in the response, and won't be returned again in subsequent requests.
Parameters
- apiVersion string - The version of the API being called.
- tokenId string - Unique ID for the API token.
- payload ApiToken - API token body.
apitokensRemove
Isolated FunctionRemote Function
Delete an API token.
Parameters
- apiVersion string - The version of the API being called.
- tokenId string - Unique ID for the API token.
devicetemplatesList
Isolated FunctionRemote Function
function devicetemplatesList(string apiVersion) returns DeviceTemplateCollection|errorGet the list of device templates in an application
Parameters
- apiVersion string - The version of the API being called.
Return Type
- DeviceTemplateCollection|error - Success
devicetemplatesGet
Isolated FunctionRemote Function
function devicetemplatesGet(string apiVersion, string deviceTemplateId) returns DeviceTemplate|errorGet a device template by ID
Parameters
- apiVersion string - The version of the API being called.
- deviceTemplateId string - Digital Twin Model Identifier of the device template, More Details
Return Type
- DeviceTemplate|error - Success
devicetemplatesCreate
Isolated FunctionRemote Function
function devicetemplatesCreate(string apiVersion, string deviceTemplateId, DeviceTemplate payload) returns DeviceTemplate|errorPublish a new device template. Default views will be automatically generated for new device templates created this way.
Parameters
- apiVersion string - The version of the API being called.
- deviceTemplateId string - Digital Twin Model Identifier of the device template, More Details
- payload DeviceTemplate - Device template body.
Return Type
- DeviceTemplate|error - Success
devicetemplatesRemove
Isolated FunctionRemote Function
Delete a device template
Parameters
- apiVersion string - The version of the API being called.
- deviceTemplateId string - Digital Twin Model Identifier of the device template, More Details
devicetemplatesUpdate
Isolated FunctionRemote Function
function devicetemplatesUpdate(string apiVersion, string deviceTemplateId, Payload payload) returns DeviceTemplate|errorUpdate the cloud properties and overrides of an existing device template via patch.
Parameters
- apiVersion string - The version of the API being called.
- deviceTemplateId string - Digital Twin Model Identifier of the device template, More Details
- payload Payload - Device template patch body.
Return Type
- DeviceTemplate|error - Success
devicesList
Isolated FunctionRemote Function
function devicesList(string apiVersion) returns DeviceCollection|errorGet the list of devices in an application
Parameters
- apiVersion string - The version of the API being called.
Return Type
- DeviceCollection|error - Success
devicesGet
Isolated FunctionRemote Function
Get a device by ID
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
devicesCreate
Isolated FunctionRemote Function
Create or update a device
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- payload Device - Device body.
devicesRemove
Isolated FunctionRemote Function
Delete a device
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
devicesUpdate
Isolated FunctionRemote Function
Update a device via patch
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- payload Payload - Device patch body.
devicesGetattestation
Isolated FunctionRemote Function
function devicesGetattestation(string apiVersion, string deviceId) returns Attestation|errorGet device attestation
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
Return Type
- Attestation|error - Success
devicesCreateattestation
Isolated FunctionRemote Function
function devicesCreateattestation(string apiVersion, string deviceId, Attestation payload) returns Attestation|errorCreate an individual device attestation
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- payload Attestation - Individual device attestation body.
Return Type
- Attestation|error - Success
devicesRemoveattestation
Isolated FunctionRemote Function
Remove an individual device attestation
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
devicesUpdateattestation
Isolated FunctionRemote Function
function devicesUpdateattestation(string apiVersion, string deviceId, Payload payload) returns Attestation|errorUpdate an individual device attestation via patch
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- payload Payload - Individual device attestation patch body.
Return Type
- Attestation|error - Success
devicesGetcommandhistory
Isolated FunctionRemote Function
function devicesGetcommandhistory(string apiVersion, string deviceId, string commandName) returns DeviceCommandCollection|errorGet device command history
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- commandName string - Name of this device command.
Return Type
- DeviceCommandCollection|error - Success
devicesRuncommand
Isolated FunctionRemote Function
function devicesRuncommand(string apiVersion, string deviceId, string commandName, DeviceCommand payload) returns DeviceCommand|errorRun a device command
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- commandName string - Name of this device command.
- payload DeviceCommand - Device command body.
Return Type
- DeviceCommand|error - Success
devicesListcomponents
Isolated FunctionRemote Function
function devicesListcomponents(string apiVersion, string deviceId) returns Collection|errorList the components present in a device
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
Return Type
- Collection|error - Success
devicesGetcomponentcommandhistory
Isolated FunctionRemote Function
function devicesGetcomponentcommandhistory(string apiVersion, string deviceId, string componentName, string commandName) returns DeviceCommandCollection|errorGet component command history
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- componentName string - Name of the device component.
- commandName string - Name of this device command.
Return Type
- DeviceCommandCollection|error - Success
devicesRuncomponentcommand
Isolated FunctionRemote Function
function devicesRuncomponentcommand(string apiVersion, string deviceId, string componentName, string commandName, DeviceCommand payload) returns DeviceCommand|errorRun a component command
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- componentName string - Name of the device component.
- commandName string - Name of this device command.
- payload DeviceCommand - Device command body.
Return Type
- DeviceCommand|error - Success
devicesGetcomponentproperties
Isolated FunctionRemote Function
function devicesGetcomponentproperties(string apiVersion, string deviceId, string componentName) returns DeviceProperties|errorGet device properties for a specific component
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- componentName string - Name of the device component.
Return Type
- DeviceProperties|error - Success
devicesReplacecomponentproperties
Isolated FunctionRemote Function
function devicesReplacecomponentproperties(string apiVersion, string deviceId, string componentName, DeviceProperties payload) returns DeviceProperties|errorReplace device properties for a specific component
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- componentName string - Name of the device component.
- payload DeviceProperties - Device properties.
Return Type
- DeviceProperties|error - Success
devicesUpdatecomponentproperties
Isolated FunctionRemote Function
function devicesUpdatecomponentproperties(string apiVersion, string deviceId, string componentName, Payload payload) returns DeviceProperties|errorUpdate device properties for a specific component via patch
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- componentName string - Name of the device component.
- payload Payload - Device properties patch.
Return Type
- DeviceProperties|error - Success
devicesGetcomponenttelemetryvalue
Isolated FunctionRemote Function
function devicesGetcomponenttelemetryvalue(string apiVersion, string deviceId, string componentName, string telemetryName) returns DeviceTelemetry|errorGet component telemetry value
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- componentName string - Name of the device component.
- telemetryName string - Name of this device telemetry.
Return Type
- DeviceTelemetry|error - Success
devicesGetcredentials
Isolated FunctionRemote Function
function devicesGetcredentials(string apiVersion, string deviceId) returns DeviceCredentials|errorGet device credentials
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
Return Type
- DeviceCredentials|error - Success
devicesListmodules
Isolated FunctionRemote Function
function devicesListmodules(string apiVersion, string deviceId) returns Collection|errorList the modules present in a device
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
Return Type
- Collection|error - Success
devicesGetmodulecommandhistory
Isolated FunctionRemote Function
function devicesGetmodulecommandhistory(string apiVersion, string deviceId, string moduleName, string commandName) returns DeviceCommandCollection|errorGet module command history
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- moduleName string - Name of the device module.
- commandName string - Name of this device command.
Return Type
- DeviceCommandCollection|error - Success
devicesRunmodulecommand
Isolated FunctionRemote Function
function devicesRunmodulecommand(string apiVersion, string deviceId, string moduleName, string commandName, DeviceCommand payload) returns DeviceCommand|errorRun a module command
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- moduleName string - Name of the device module.
- commandName string - Name of this device command.
- payload DeviceCommand - Device command body.
Return Type
- DeviceCommand|error - Success
devicesListmodulecomponents
Isolated FunctionRemote Function
function devicesListmodulecomponents(string apiVersion, string deviceId, string moduleName) returns Collection|errorList the components present in a module
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- moduleName string - Name of the device module.
Return Type
- Collection|error - Success
devicesGetmodulecomponentcommandhistory
Isolated FunctionRemote Function
function devicesGetmodulecomponentcommandhistory(string apiVersion, string deviceId, string moduleName, string componentName, string commandName) returns DeviceCommandCollection|errorGet module component command history
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- moduleName string - Name of the device module.
- componentName string - Name of the device component.
- commandName string - Name of this device command.
Return Type
- DeviceCommandCollection|error - Success
devicesRunmodulecomponentcommand
Isolated FunctionRemote Function
function devicesRunmodulecomponentcommand(string apiVersion, string deviceId, string moduleName, string componentName, string commandName, DeviceCommand payload) returns DeviceCommand|errorRun a module component command
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- moduleName string - Name of the device module.
- componentName string - Name of the device component.
- commandName string - Name of this device command.
- payload DeviceCommand - Device command body.
Return Type
- DeviceCommand|error - Success
devicesGetmodulecomponentproperties
Isolated FunctionRemote Function
function devicesGetmodulecomponentproperties(string apiVersion, string deviceId, string moduleName, string componentName) returns DeviceProperties|errorGet module properties for a specific component
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- moduleName string - Name of the device module.
- componentName string - Name of the device component.
Return Type
- DeviceProperties|error - Success
devicesReplacemodulecomponentproperties
Isolated FunctionRemote Function
function devicesReplacemodulecomponentproperties(string apiVersion, string deviceId, string moduleName, string componentName, DeviceProperties payload) returns DeviceProperties|errorReplace module properties for a specific component
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- moduleName string - Name of the device module.
- componentName string - Name of the device component.
- payload DeviceProperties - Module properties.
Return Type
- DeviceProperties|error - Success
devicesUpdatemodulecomponentproperties
Isolated FunctionRemote Function
function devicesUpdatemodulecomponentproperties(string apiVersion, string deviceId, string moduleName, string componentName, Payload payload) returns DeviceProperties|errorUpdate module properties for a specific component via patch
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- moduleName string - Name of the device module.
- componentName string - Name of the device component.
- payload Payload - Module properties patch.
Return Type
- DeviceProperties|error - Success
devicesGetmodulecomponenttelemetryvalue
Isolated FunctionRemote Function
function devicesGetmodulecomponenttelemetryvalue(string apiVersion, string deviceId, string moduleName, string componentName, string telemetryName) returns DeviceTelemetry|errorGet module component telemetry value
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- moduleName string - Name of the device module.
- componentName string - Name of the device component.
- telemetryName string - Name of this device telemetry.
Return Type
- DeviceTelemetry|error - Success
devicesGetmoduleproperties
Isolated FunctionRemote Function
function devicesGetmoduleproperties(string apiVersion, string deviceId, string moduleName) returns DeviceProperties|errorGet module properties
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- moduleName string - Name of the device module.
Return Type
- DeviceProperties|error - Success
devicesReplacemoduleproperties
Isolated FunctionRemote Function
function devicesReplacemoduleproperties(string apiVersion, string deviceId, string moduleName, DeviceProperties payload) returns DeviceProperties|errorReplace module properties
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- moduleName string - Name of the device module.
- payload DeviceProperties - Module properties.
Return Type
- DeviceProperties|error - Success
devicesUpdatemoduleproperties
Isolated FunctionRemote Function
function devicesUpdatemoduleproperties(string apiVersion, string deviceId, string moduleName, Payload payload) returns DeviceProperties|errorUpdate module properties via patch
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- moduleName string - Name of the device module.
- payload Payload - Module properties patch.
Return Type
- DeviceProperties|error - Success
devicesGetmoduletelemetryvalue
Isolated FunctionRemote Function
function devicesGetmoduletelemetryvalue(string apiVersion, string deviceId, string moduleName, string telemetryName) returns DeviceTelemetry|errorGet module telemetry value
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- moduleName string - Name of the device module.
- telemetryName string - Name of this device telemetry.
Return Type
- DeviceTelemetry|error - Success
devicesGetproperties
Isolated FunctionRemote Function
function devicesGetproperties(string apiVersion, string deviceId) returns DeviceProperties|errorGet device properties
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
Return Type
- DeviceProperties|error - Success
devicesReplaceproperties
Isolated FunctionRemote Function
function devicesReplaceproperties(string apiVersion, string deviceId, DeviceProperties payload) returns DeviceProperties|errorReplace device properties
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- payload DeviceProperties - Device properties.
Return Type
- DeviceProperties|error - Success
devicesUpdateproperties
Isolated FunctionRemote Function
function devicesUpdateproperties(string apiVersion, string deviceId, Payload payload) returns DeviceProperties|errorUpdate device properties via patch
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- payload Payload - Device properties patch.
Return Type
- DeviceProperties|error - Success
devicesGettelemetryvalue
Isolated FunctionRemote Function
function devicesGettelemetryvalue(string apiVersion, string deviceId, string telemetryName) returns DeviceTelemetry|errorGet device telemetry value
Parameters
- apiVersion string - The version of the API being called.
- deviceId string - Unique ID of the device.
- telemetryName string - Name of this device telemetry.
Return Type
- DeviceTelemetry|error - Success
rolesList
Isolated FunctionRemote Function
function rolesList(string apiVersion) returns RoleCollection|errorGet the list of roles in an application.
Parameters
- apiVersion string - The version of the API being called.
Return Type
- RoleCollection|error - Success
rolesGet
Isolated FunctionRemote Function
Get a role by ID.
Parameters
- apiVersion string - The version of the API being called.
- roleId string - Unique ID for the role.
usersList
Isolated FunctionRemote Function
function usersList(string apiVersion) returns UserCollection|errorGet the list of users in an application
Parameters
- apiVersion string - The version of the API being called.
Return Type
- UserCollection|error - Success
usersGet
Isolated FunctionRemote Function
Get a user by ID
Parameters
- apiVersion string - The version of the API being called.
- userId string - Unique ID of the user.
usersCreate
Isolated FunctionRemote Function
Create a user in the application
Parameters
- apiVersion string - The version of the API being called.
- userId string - Unique ID of the user.
- payload User - User body.
usersRemove
Isolated FunctionRemote Function
Delete a user
Parameters
- apiVersion string - The version of the API being called.
- userId string - Unique ID of the user.
usersUpdate
Isolated FunctionRemote Function
Update a user in the application via patch
Records
azure.iotcentral: ApiTokenCollection
Fields
- value ApiToken[] - The collection of API tokens.
- nextLink string? - URL to get the next page of API tokens.
azure.iotcentral: Attestation
Fields
- 'type string - Type of the attestation.
azure.iotcentral: ClientHttp1Settings
Closed record
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
azure.iotcentral: Collection
Fields
- value record {}[] - The collection of entities.
- nextLink string? - URL to get the next page of entities.
azure.iotcentral: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
azure.iotcentral: Device
Fields
- id string? - Unique ID of the device.
- etag string? - ETag used to prevent conflict in device updates.
- displayName string? - Display name of the device.
- template string? - The device template definition for the device.
- enabled boolean? - Whether the device connection to IoT Central has been enabled.
- provisioned boolean? - Whether resources have been allocated for the device.
- simulated boolean? - Whether the device is simulated.
azure.iotcentral: DeviceCollection
Fields
- value Device[] - The collection of devices.
- nextLink string? - URL to get the next page of devices.
azure.iotcentral: DeviceCommand
Fields
- id string? - The request ID of the device command execution.
- connectionTimeout int? - Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds.
- responseTimeout int? - Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds.
- request record {}? - The payload for the device command.
- response record {}? - The payload of the device command response.
- responseCode int? - The status code of the device command response.
azure.iotcentral: DeviceCommandCollection
Fields
- value DeviceCommand[] - The collection of device command executions.
- nextLink string? - URL to get the next page of device command executions.
azure.iotcentral: DeviceCredentials
Fields
- idScope string - ID scope for connecting to the IoT Central application.
- symmetricKey SymmetricKey? -
- x509 X509? -
- tpm Tpm? -
azure.iotcentral: DeviceProperties
Property values associated with the device.
azure.iotcentral: DeviceTelemetry
Fields
- value record {}? - The last known value of this device telemetry.
- timestamp string? - String-formatted date representing the time when the telemetry value was sent.
azure.iotcentral: DeviceTemplate
Fields
- '\@id string? - Unique ID of the device template.
- '\@type string[] - The JSON-LD types of this device template.
- etag string? - ETag used to prevent conflict in device template updates.
- displayName string? - Display name of the device template.
- description string? - Detailed description of the device template.
- capabilityModel record {} - The capability model utilized by this device template.
azure.iotcentral: DeviceTemplateCollection
Fields
- value DeviceTemplate[] - The collection of device templates.
- nextLink string? - URL to get the next page of device templates.
azure.iotcentral: Payload
azure.iotcentral: Permission
Fields
- roles RoleAssignment[] - List of role assignments that specify the permissions to access the application.
azure.iotcentral: ProxyConfig
Closed record
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
azure.iotcentral: Role
Fields
- id string? - Unique ID of the role.
- displayName string? - Display name of the role.
azure.iotcentral: RoleAssignment
Fields
- role string - ID of the role for this role assignment.
azure.iotcentral: RoleCollection
Fields
- value Role[] - The collection of roles.
- nextLink string? - URL to get the next page of roles.
azure.iotcentral: SymmetricKey
Fields
- primaryKey string - The primary key for this credential.
- secondaryKey string - The secondary key for this credential.
azure.iotcentral: Tpm
Fields
- endorsementKey string - The TPM endorsement key for this credential.
azure.iotcentral: UserCollection
Fields
- value User[] - The collection of users.
- nextLink string? - URL to get the next page of users.
azure.iotcentral: X509
Fields
- clientCertificates X509Certificates? -
azure.iotcentral: X509Certificate
Fields
- certificate string? - The string representation of this certificate.
- info X509CertificateInfo? -
azure.iotcentral: X509CertificateInfo
Fields
- sha1Thumbprint string - The SHA-1 hash value of the certificate.
azure.iotcentral: X509Certificates
Fields
- primary X509Certificate -
- secondary X509Certificate? -