iot_connectors

Creates, updates, deletes, gets or lists an iot_connectors resource.

Overview

Name	iot_connectors
Type	Resource
Id	azure_extras.healthcare.iot_connectors

Fields

The following fields are returned by SELECT queries:

get

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
identity	object	Setting indicating whether the service has a managed identity associated with it.
properties	object	IoT Connector configuration.
systemData	object	Metadata pertaining to creation and last modification of the resource.

list_by_workspace

List of IoT Connectors.

Name	Datatype	Description
identity	object	Setting indicating whether the service has a managed identity associated with it.
properties	object	IoT Connector configuration.
systemData	object	Metadata pertaining to creation and last modification of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, subscriptionId, workspaceName, iotConnectorName		Gets the properties of the specified IoT Connector.
list_by_workspace	select	resourceGroupName, subscriptionId, workspaceName		Lists all IoT Connectors for the given workspace
create_or_update	insert	resourceGroupName, subscriptionId, workspaceName, iotConnectorName		Creates or updates an IoT Connector resource with the specified parameters.
update	update	resourceGroupName, subscriptionId, iotConnectorName, workspaceName		Patch an IoT Connector.
delete	delete	subscriptionId, resourceGroupName, iotConnectorName, workspaceName		Deletes an IoT Connector.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
iotConnectorName	string	The name of IoT Connector resource.
resourceGroupName	string	The name of the resource group that contains the service instance.
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of workspace resource.

SELECT examples

get

Gets the properties of the specified IoT Connector.

SELECT
identity,
properties,
systemData
FROM azure_extras.healthcare.iot_connectors
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND iotConnectorName = '{{ iotConnectorName }}' -- required
;

list_by_workspace

Lists all IoT Connectors for the given workspace

SELECT
identity,
properties,
systemData
FROM azure_extras.healthcare.iot_connectors
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
;

INSERT examples

create_or_update

Creates or updates an IoT Connector resource with the specified parameters.

INSERT INTO azure_extras.healthcare.iot_connectors (
data__identity,
data__properties,
resourceGroupName,
subscriptionId,
workspaceName,
iotConnectorName
)
SELECT 
'{{ identity }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ iotConnectorName }}'
RETURNING
identity,
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: iot_connectors
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the iot_connectors resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the iot_connectors resource.
    - name: workspaceName
      value: string
      description: Required parameter for the iot_connectors resource.
    - name: iotConnectorName
      value: string
      description: Required parameter for the iot_connectors resource.
    - name: identity
      value: object
      description: |
        Setting indicating whether the service has a managed identity associated with it.
    - name: properties
      value: object
      description: |
        IoT Connector configuration.

UPDATE examples

update

Patch an IoT Connector.

UPDATE azure_extras.healthcare.iot_connectors
SET 
data__tags = '{{ tags }}',
data__identity = '{{ identity }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND iotConnectorName = '{{ iotConnectorName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
RETURNING
identity,
properties,
systemData;

DELETE examples

delete

Deletes an IoT Connector.

DELETE FROM azure_extras.healthcare.iot_connectors
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND iotConnectorName = '{{ iotConnectorName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
;