iot_connectors

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

Overview

Name	iot_connectors
Type	Resource
Id	azure_extras.health_data_services.iot_connectors

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
deviceMapping	object	Device Mappings.
etag	string	An etag associated with the resource, used for optimistic concurrency when editing it.
identity	object	Setting indicating whether the service has a managed identity associated with it.
ingestionEndpointConfiguration	object	Source configuration.
location	string	The common properties for any location based resource, tracked or proxy.
provisioningState	string	The provisioning state. Known values are: "Deleting", "Succeeded", "Creating", "Accepted", "Verifying", "Updating", "Failed", "Canceled", "Deprovisioned", "Moving", "Suspended", "Warned", and "SystemMaintenance". (Deleting, Succeeded, Creating, Accepted, Verifying, Updating, Failed, Canceled, Deprovisioned, Moving, Suspended, Warned, SystemMaintenance)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	The common properties of tracked resources in the service.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_workspace

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
deviceMapping	object	Device Mappings.
etag	string	An etag associated with the resource, used for optimistic concurrency when editing it.
identity	object	Setting indicating whether the service has a managed identity associated with it.
ingestionEndpointConfiguration	object	Source configuration.
location	string	The common properties for any location based resource, tracked or proxy.
provisioningState	string	The provisioning state. Known values are: "Deleting", "Succeeded", "Creating", "Accepted", "Verifying", "Updating", "Failed", "Canceled", "Deprovisioned", "Moving", "Suspended", "Warned", and "SystemMaintenance". (Deleting, Succeeded, Creating, Accepted, Verifying, Updating, Failed, Canceled, Deprovisioned, Moving, Suspended, Warned, SystemMaintenance)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	The common properties of tracked resources in the service.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, iot_connector_name, subscription_id		Gets the properties of the specified IoT Connector.
list_by_workspace	select	resource_group_name, workspace_name, subscription_id		Lists all IoT Connectors for the given workspace.
create_or_update	insert	resource_group_name, workspace_name, iot_connector_name, subscription_id		Creates or updates an IoT Connector resource with the specified parameters.
update	update	resource_group_name, iot_connector_name, workspace_name, subscription_id		Patch an IoT Connector.
create_or_update	replace	resource_group_name, workspace_name, iot_connector_name, subscription_id		Creates or updates an IoT Connector resource with the specified parameters.
delete	delete	resource_group_name, iot_connector_name, workspace_name, subscription_id		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
iot_connector_name	string	The name of IoT Connector resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_name	string	The name of workspace resource. Required.

SELECT examples

get

Gets the properties of the specified IoT Connector.

SELECT
id,
name,
deviceMapping,
etag,
identity,
ingestionEndpointConfiguration,
location,
provisioningState,
systemData,
tags,
type
FROM azure_extras.health_data_services.iot_connectors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND iot_connector_name = '{{ iot_connector_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_workspace

Lists all IoT Connectors for the given workspace.

SELECT
id,
name,
deviceMapping,
etag,
identity,
ingestionEndpointConfiguration,
location,
provisioningState,
systemData,
tags,
type
FROM azure_extras.health_data_services.iot_connectors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure_extras.health_data_services.iot_connectors (
properties,
tags,
location,
etag,
identity,
resource_group_name,
workspace_name,
iot_connector_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ etag }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ iot_connector_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: iot_connectors
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the iot_connectors resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the iot_connectors resource.
  - name: iot_connector_name
    value: "{{ iot_connector_name }}"
    description: Required parameter for the iot_connectors resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the iot_connectors resource.
  - name: properties
    description: |
      IoT Connector configuration.
    value:
      provisioningState: "{{ provisioningState }}"
      ingestionEndpointConfiguration:
        eventHubName: "{{ eventHubName }}"
        consumerGroup: "{{ consumerGroup }}"
        fullyQualifiedEventHubNamespace: "{{ fullyQualifiedEventHubNamespace }}"
      deviceMapping:
        content: "{{ content }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      The common properties of tracked resources in the service.
  - name: location
    value: "{{ location }}"
    description: |
      The common properties for any location based resource, tracked or proxy.
  - name: etag
    value: "{{ etag }}"
    description: |
      An etag associated with the resource, used for optimistic concurrency when editing it.
  - name: identity
    description: |
      Setting indicating whether the service has a managed identity associated with it.
    value:
      type: "{{ type }}"
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Patch an IoT Connector.

UPDATE azure_extras.health_data_services.iot_connectors
SET 
tags = '{{ tags }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND iot_connector_name = '{{ iot_connector_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

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

REPLACE azure_extras.health_data_services.iot_connectors
SET 
properties = '{{ properties }}',
tags = '{{ tags }}',
location = '{{ location }}',
etag = '{{ etag }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND iot_connector_name = '{{ iot_connector_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes an IoT Connector.

DELETE FROM azure_extras.health_data_services.iot_connectors
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND iot_connector_name = '{{ iot_connector_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;