Iot Connectors - Create Or Update

Crea o actualiza un recurso de IoT Connector con los parámetros especificados.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}?api-version=2021-11-01

Parámetros de identificador URI

Name In Required Type Description
iotConnectorName
path True
  • string

Nombre del recurso de IoT Connector.

resourceGroupName
path True
  • string

Nombre del grupo de recursos que contiene la instancia de servicio.

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True
  • string

Identificador de la suscripción.

workspaceName
path True
  • string

Nombre del recurso del área de trabajo.

api-version
query True
  • string

Versión de api de cliente.

Cuerpo de la solicitud

Name Type Description
etag
  • string

ETag asociado al recurso, que se usa para la simultaneidad optimista al editarlo.

identity

Configuración que indica si el servicio tiene asociada una identidad administrada.

location
  • string

Ubicación del recurso.

properties.deviceMapping

Asignaciones de dispositivos.

properties.ingestionEndpointConfiguration

Configuración de origen.

tags
  • object

Etiquetas del recurso.

Respuestas

Name Type Description
200 OK

Actualizado: se ha aceptado la solicitud put y se actualiza un recurso existente.

201 Created

Creado: se acepta la solicitud Put y se crea un recurso existente de forma asincrónica.

202 Accepted

Aceptado: la solicitud Put aceptada y un recurso existente se actualiza de forma asincrónica.

Other Status Codes

Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Azure Active Directory Flow OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

Create an IoT Connector

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue?api-version=2021-11-01

{
  "location": "westus",
  "tags": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "identity": {
    "type": "SystemAssigned"
  },
  "properties": {
    "ingestionEndpointConfiguration": {
      "eventHubName": "MyEventHubName",
      "consumerGroup": "ConsumerGroupA",
      "fullyQualifiedEventHubNamespace": "myeventhub.servicesbus.windows.net"
    },
    "deviceMapping": {
      "content": {
        "templateType": "CollectionContent",
        "template": [
          {
            "templateType": "JsonPathContent",
            "template": {
              "typeName": "heartrate",
              "typeMatchExpression": "$..[?(@heartrate)]",
              "deviceIdExpression": "$.deviceid",
              "timestampExpression": "$.measurementdatetime",
              "values": [
                {
                  "required": "true",
                  "valueExpression": "$.heartrate",
                  "valueName": "hr"
                }
              ]
            }
          }
        ]
      }
    }
  }
}

Sample Response

{
  "name": "blue",
  "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue",
  "type": "Microsoft.HealthcareApis/workspaces/iotconnectors",
  "location": "westus",
  "etag": "00000000-0000-0000-f5ac-912ca49e01d6",
  "tags": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "identity": {
    "type": "SystemAssigned"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "ingestionEndpointConfiguration": {
      "eventHubName": "MyEventHubName",
      "consumerGroup": "ConsumerGroupA",
      "fullyQualifiedEventHubNamespace": "myeventhub.servicesbus.windows.net"
    },
    "deviceMapping": {
      "content": {
        "templateType": "CollectionContent",
        "template": [
          {
            "templateType": "JsonPathContent",
            "template": {
              "typeName": "heartrate",
              "typeMatchExpression": "$..[?(@heartrate)]",
              "deviceIdExpression": "$.deviceid",
              "timestampExpression": "$.measurementdatetime",
              "values": [
                {
                  "required": "true",
                  "valueExpression": "$.heartrate",
                  "valueName": "hr"
                }
              ]
            }
          }
        ]
      }
    }
  },
  "systemData": {
    "createdBy": "string",
    "createdAt": "2021-01-28T19:26:24.072Z",
    "lastModifiedBy": "string",
    "lastModifiedAt": "2021-01-28T19:26:24.072Z"
  }
}
{
  "name": "blue",
  "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue",
  "type": "Microsoft.HealthcareApis/workspaces/iotconnectors",
  "location": "westus",
  "etag": "00000000-0000-0000-f5ac-912ca49e01d6",
  "tags": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "identity": {
    "type": "SystemAssigned"
  },
  "properties": {
    "provisioningState": "Creating",
    "ingestionEndpointConfiguration": {
      "eventHubName": "MyEventHubName",
      "consumerGroup": "ConsumerGroupA",
      "fullyQualifiedEventHubNamespace": "myeventhub.servicesbus.windows.net"
    },
    "deviceMapping": {
      "content": {
        "templateType": "CollectionContent",
        "template": [
          {
            "templateType": "JsonPathContent",
            "template": {
              "typeName": "heartrate",
              "typeMatchExpression": "$..[?(@heartrate)]",
              "deviceIdExpression": "$.deviceid",
              "timestampExpression": "$.measurementdatetime",
              "values": [
                {
                  "required": "true",
                  "valueExpression": "$.heartrate",
                  "valueName": "hr"
                }
              ]
            }
          }
        ]
      }
    }
  },
  "systemData": {
    "createdBy": "string",
    "createdAt": "2021-01-28T19:26:24.072Z",
    "lastModifiedBy": "string",
    "lastModifiedAt": "2021-01-28T19:26:24.072Z"
  }
}
{
  "name": "blue",
  "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue",
  "type": "Microsoft.HealthcareApis/workspaces/iotconnectors",
  "location": "westus",
  "etag": "00000000-0000-0000-f5ac-912ca49e01d6",
  "tags": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "identity": {
    "type": "SystemAssigned"
  },
  "properties": {
    "provisioningState": "Accepted",
    "ingestionEndpointConfiguration": {
      "eventHubName": "MyEventHubName",
      "consumerGroup": "ConsumerGroupA",
      "fullyQualifiedEventHubNamespace": "myeventhub.servicesbus.windows.net"
    },
    "deviceMapping": {
      "content": {
        "templateType": "CollectionContent",
        "template": [
          {
            "templateType": "JsonPathContent",
            "template": {
              "typeName": "heartrate",
              "typeMatchExpression": "$..[?(@heartrate)]",
              "deviceIdExpression": "$.deviceid",
              "timestampExpression": "$.measurementdatetime",
              "values": [
                {
                  "required": "true",
                  "valueExpression": "$.heartrate",
                  "valueName": "hr"
                }
              ]
            }
          }
        ]
      }
    }
  },
  "systemData": {
    "createdBy": "string",
    "createdAt": "2021-01-28T19:26:24.072Z",
    "lastModifiedBy": "string",
    "lastModifiedAt": "2021-01-28T19:26:24.072Z"
  }
}

Definiciones

createdByType

Tipo de identidad que creó el recurso.

ErrorDetails

Detalles del error.

ErrorDetailsInternal

Detalles del error.

Identity

Configuración que indica si el servicio tiene asociada una identidad administrada.

IotConnector

IoT Connector definición.

IotEventHubIngestionEndpointConfiguration

Configuración del punto de conexión de ingesta del centro de eventos

IotMappingProperties

Contenido de asignación.

provisioningState

Estado de aprovisionamiento.

ServiceManagedIdentityType

Tipo de identidad que se especifica, actualmente Se permiten SystemAssigned y None.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

UserAssignedIdentity

Propiedades de identidad asignadas por el usuario

createdByType

Tipo de identidad que creó el recurso.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorDetails

Detalles del error.

Name Type Description
error

Detalles del error

ErrorDetailsInternal

Detalles del error.

Name Type Description
code
  • string

Código de error.

message
  • string

El mensaje de error.

target
  • string

Destino del error concreto.

Identity

Configuración que indica si el servicio tiene asociada una identidad administrada.

Name Type Description
principalId
  • string

Identificador de la entidad de servicio de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.

tenantId
  • string

Identificador de inquilino de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.

type

Tipo de identidad que se especifica, actualmente Se permiten SystemAssigned y None.

userAssignedIdentities

identidades de User-Assigned
Conjunto de identidades asignadas por el usuario asociadas al recurso. Las claves del diccionario userAssignedIdentities serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Los valores del diccionario pueden ser objetos vacíos ({}) en las solicitudes.

IotConnector

IoT Connector definición.

Name Type Description
etag
  • string

ETag asociado al recurso, que se usa para la simultaneidad optimista al editarlo.

id
  • string

Identificador de recurso.

identity

Configuración que indica si el servicio tiene asociada una identidad administrada.

location
  • string

Ubicación del recurso.

name
  • string

Nombre del recurso.

properties.deviceMapping

Asignaciones de dispositivos.

properties.ingestionEndpointConfiguration

Configuración de origen.

properties.provisioningState

Estado de aprovisionamiento.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

tags
  • object

Etiquetas del recurso.

type
  • string

El tipo de recurso.

IotEventHubIngestionEndpointConfiguration

Configuración del punto de conexión de ingesta del centro de eventos

Name Type Description
consumerGroup
  • string

Grupo de consumidores del centro de eventos al que se va a conectar.

eventHubName
  • string

Nombre del centro de eventos al que conectarse.

fullyQualifiedEventHubNamespace
  • string

Espacio de nombres completo del centro de eventos al que conectarse.

IotMappingProperties

Contenido de asignación.

Name Type Description
content
  • object

Asignación.

provisioningState

Estado de aprovisionamiento.

Name Type Description
Accepted
  • string
Canceled
  • string
Creating
  • string
Deleting
  • string
Deprovisioned
  • string
Failed
  • string
Moving
  • string
Succeeded
  • string
Suspended
  • string
SystemMaintenance
  • string
Updating
  • string
Verifying
  • string
Warned
  • string

ServiceManagedIdentityType

Tipo de identidad que se especifica, actualmente Se permiten SystemAssigned y None.

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned,UserAssigned
  • string
UserAssigned
  • string

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Name Type Description
createdAt
  • string

Marca de tiempo de creación de recursos (UTC).

createdBy
  • string

Identidad que creó el recurso.

createdByType

Tipo de identidad que creó el recurso.

lastModifiedAt
  • string

Marca de tiempo de la última modificación del recurso (UTC)

lastModifiedBy
  • string

Identidad que modificó por última vez el recurso.

lastModifiedByType

Tipo de identidad que modificó por última vez el recurso.

UserAssignedIdentity

Propiedades de identidad asignadas por el usuario

Name Type Description
clientId
  • string

Identificador de cliente de la identidad asignada.

principalId
  • string

Identificador de entidad de seguridad de la identidad asignada.