Iot Connectors - Create Or Update

Servicio:: Healthcare Apis

Versión de la API:: 2022-06-01

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

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
iotConnectorName	path	True	string minLength: 3 maxLength: 24	Nombre del recurso del conector de IoT.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Nombre del grupo de recursos que contiene la instancia de servicio.
subscriptionId	path	True	string	Identificador de la suscripción.
workspaceName	path	True	string minLength: 3 maxLength: 24	Nombre del recurso del área de trabajo.
api-version	query	True	string	Versión de api de cliente.

Cuerpo de la solicitud

Nombre	Tipo	Description
etag	string	ETAG asociado al recurso, que se usa para la simultaneidad optimista al editarlo.
identity	Identity	Configuración que indica si el servicio tiene una identidad administrada asociada.
location	string	Ubicación del recurso.
properties.deviceMapping	IotMappingProperties	Asignaciones de dispositivos.
properties.ingestionEndpointConfiguration	IotEventHubIngestionEndpointConfiguration	Configuración de origen.
tags	object	Etiquetas de recursos.

Respuestas

Nombre	Tipo	Description
200 OK	IotConnector	Actualizado: se ha aceptado la solicitud put y se actualiza un recurso existente.
201 Created	IotConnector	Creado: se acepta la solicitud put y se crea un recurso existente de forma asincrónica.
202 Accepted	IotConnector	Aceptado: la solicitud put aceptada y un recurso existente se actualiza de forma asincrónica.
Other Status Codes	ErrorDetails	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Create an IoT Connector

Solicitud de ejemplo

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue?api-version=2022-06-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"
                }
              ]
            }
          }
        ]
      }
    }
  }
}

Respuesta de muestra

status code:: 200

{
  "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"
  }
}

status code:: 201

{
  "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"
  }
}

status code:: 202

{
  "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

Nombre	Description
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 una identidad administrada asociada.
IotConnector	Definición del conector de IoT.
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 relativos a la creación y última modificación del recurso.
UserAssignedIdentity	Propiedades de identidad asignadas por el usuario

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorDetails

Object

Detalles del error.

Nombre	Tipo	Description
error	ErrorDetailsInternal	Detalles del error

ErrorDetailsInternal

Object

Detalles del error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error.
target	string	Destino del error concreto.

Identity

Object

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

Nombre	Tipo	Description
principalId	string (uuid)	Identificador de entidad de servicio de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
tenantId	string (uuid)	Identificador de inquilino de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
type	ServiceManagedIdentityType	Tipo de identidad que se especifica, actualmente Se permiten SystemAssigned y None.
userAssignedIdentities	<string, UserAssignedIdentity>	identidades de User-Assigned Conjunto de identidades asignadas por el usuario asociadas al recurso. Las claves de 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

Object

Definición del conector de IoT.

Nombre	Tipo	Description
etag	string	ETAG asociado al recurso, que se usa para la simultaneidad optimista al editarlo.
id	string	Identificador de recurso.
identity	Identity	Configuración que indica si el servicio tiene una identidad administrada asociada.
location	string	Ubicación del recurso.
name	string pattern: ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$	Nombre del recurso.
properties.deviceMapping	IotMappingProperties	Asignaciones de dispositivos.
properties.ingestionEndpointConfiguration	IotEventHubIngestionEndpointConfiguration	Configuración de origen.
properties.provisioningState	provisioningState	Estado de aprovisionamiento.
systemData	systemData	Metadatos relativos a la creación y última modificación del recurso.
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso.

IotEventHubIngestionEndpointConfiguration

Object

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

Nombre	Tipo	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

Object

Contenido de asignación.

Nombre	Tipo	Description
content	object	Asignación.

provisioningState

Enumeración

Estado de aprovisionamiento.

Valor	Description
Deleting
Succeeded
Creating
Accepted
Verifying
Updating
Failed
Canceled
Deprovisioned
Moving
Suspended
Warned
SystemMaintenance

ServiceManagedIdentityType

Enumeración

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

Valor	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

UserAssignedIdentity

Object

Propiedades de identidad asignadas por el usuario

Nombre	Tipo	Description
clientId	string (uuid)	Identificador de cliente de la identidad asignada.
principalId	string (uuid)	Identificador de entidad de seguridad de la identidad asignada.

Compartir a través de

Iot Connectors - Create Or Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Create an IoT Connector

Solicitud de ejemplo

Respuesta de muestra

Definiciones

createdByType

ErrorDetails

ErrorDetailsInternal

Identity

IotConnector

IotEventHubIngestionEndpointConfiguration

IotMappingProperties

provisioningState

ServiceManagedIdentityType

systemData

UserAssignedIdentity