Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The workspaces/iotconnectors resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.HealthcareApis/workspaces/iotconnectors resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.HealthcareApis/workspaces/iotconnectors@2024-03-31' = {
parent: resourceSymbolicName
etag: 'string'
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
deviceMapping: {
content: any(...)
}
ingestionEndpointConfiguration: {
consumerGroup: 'string'
eventHubName: 'string'
fullyQualifiedEventHubNamespace: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.HealthcareApis/workspaces/iotconnectors
| Name | Description | Value |
|---|---|---|
| etag | An etag associated with the resource, used for optimistic concurrency when editing it. | string |
| identity | Setting indicating whether the service has a managed identity associated with it. | ServiceManagedIdentityIdentity |
| location | The resource location. | string |
| name | The resource name | string Constraints: Min length = 3 Max length = 24 (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: workspaces |
| properties | IoT Connector configuration. | IotConnectorProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
IotConnectorProperties
| Name | Description | Value |
|---|---|---|
| deviceMapping | Device Mappings. | IotMappingProperties |
| ingestionEndpointConfiguration | Source configuration. | IotEventHubIngestionEndpointConfiguration |
IotEventHubIngestionEndpointConfiguration
| Name | Description | Value |
|---|---|---|
| consumerGroup | Consumer group of the event hub to connected to. | string |
| eventHubName | Event Hub name to connect to. | string |
| fullyQualifiedEventHubNamespace | Fully qualified namespace of the Event Hub to connect to. | string |
IotMappingProperties
| Name | Description | Value |
|---|---|---|
| content | The mapping. | any |
ResourceTags
| Name | Description | Value |
|---|
ServiceManagedIdentityIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of identity being specified, currently SystemAssigned and None are allowed. | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
Usage Examples
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
| Bicep File | Description |
|---|---|
| Deploy the MedTech service | The MedTech service is one of the Azure Health Data Services designed to ingest device data from multiple devices, transform the device data into FHIR Observations, which are then persisted in the Azure Health Data Services FHIR service. |
| Deploy the MedTech service including an Azure IoT Hub | The MedTech service is one of the Azure Health Data Services designed to ingest device data from multiple devices, transform the device data into FHIR Observations, which are then persisted in the Azure Health Data Services FHIR service. |
ARM template resource definition
The workspaces/iotconnectors resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.HealthcareApis/workspaces/iotconnectors resource, add the following JSON to your template.
{
"type": "Microsoft.HealthcareApis/workspaces/iotconnectors",
"apiVersion": "2024-03-31",
"name": "string",
"etag": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"deviceMapping": {
"content": {}
},
"ingestionEndpointConfiguration": {
"consumerGroup": "string",
"eventHubName": "string",
"fullyQualifiedEventHubNamespace": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.HealthcareApis/workspaces/iotconnectors
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-03-31' |
| etag | An etag associated with the resource, used for optimistic concurrency when editing it. | string |
| identity | Setting indicating whether the service has a managed identity associated with it. | ServiceManagedIdentityIdentity |
| location | The resource location. | string |
| name | The resource name | string Constraints: Min length = 3 Max length = 24 (required) |
| properties | IoT Connector configuration. | IotConnectorProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.HealthcareApis/workspaces/iotconnectors' |
IotConnectorProperties
| Name | Description | Value |
|---|---|---|
| deviceMapping | Device Mappings. | IotMappingProperties |
| ingestionEndpointConfiguration | Source configuration. | IotEventHubIngestionEndpointConfiguration |
IotEventHubIngestionEndpointConfiguration
| Name | Description | Value |
|---|---|---|
| consumerGroup | Consumer group of the event hub to connected to. | string |
| eventHubName | Event Hub name to connect to. | string |
| fullyQualifiedEventHubNamespace | Fully qualified namespace of the Event Hub to connect to. | string |
IotMappingProperties
| Name | Description | Value |
|---|---|---|
| content | The mapping. | any |
ResourceTags
| Name | Description | Value |
|---|
ServiceManagedIdentityIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of identity being specified, currently SystemAssigned and None are allowed. | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Deploy the MedTech service |
The MedTech service is one of the Azure Health Data Services designed to ingest device data from multiple devices, transform the device data into FHIR Observations, which are then persisted in the Azure Health Data Services FHIR service. |
| Deploy the MedTech service including an Azure IoT Hub |
The MedTech service is one of the Azure Health Data Services designed to ingest device data from multiple devices, transform the device data into FHIR Observations, which are then persisted in the Azure Health Data Services FHIR service. |
Terraform (AzAPI provider) resource definition
The workspaces/iotconnectors resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.HealthcareApis/workspaces/iotconnectors resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.HealthcareApis/workspaces/iotconnectors@2024-03-31"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
etag = "string"
properties = {
deviceMapping = {
content = ?
}
ingestionEndpointConfiguration = {
consumerGroup = "string"
eventHubName = "string"
fullyQualifiedEventHubNamespace = "string"
}
}
}
}
Property Values
Microsoft.HealthcareApis/workspaces/iotconnectors
| Name | Description | Value |
|---|---|---|
| etag | An etag associated with the resource, used for optimistic concurrency when editing it. | string |
| identity | Setting indicating whether the service has a managed identity associated with it. | ServiceManagedIdentityIdentity |
| location | The resource location. | string |
| name | The resource name | string Constraints: Min length = 3 Max length = 24 (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: workspaces |
| properties | IoT Connector configuration. | IotConnectorProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.HealthcareApis/workspaces/iotconnectors@2024-03-31" |
IotConnectorProperties
| Name | Description | Value |
|---|---|---|
| deviceMapping | Device Mappings. | IotMappingProperties |
| ingestionEndpointConfiguration | Source configuration. | IotEventHubIngestionEndpointConfiguration |
IotEventHubIngestionEndpointConfiguration
| Name | Description | Value |
|---|---|---|
| consumerGroup | Consumer group of the event hub to connected to. | string |
| eventHubName | Event Hub name to connect to. | string |
| fullyQualifiedEventHubNamespace | Fully qualified namespace of the Event Hub to connect to. | string |
IotMappingProperties
| Name | Description | Value |
|---|---|---|
| content | The mapping. | any |
ResourceTags
| Name | Description | Value |
|---|
ServiceManagedIdentityIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of identity being specified, currently SystemAssigned and None are allowed. | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|