Iot Connectors - Create Or Update

Serviço:: Healthcare Apis

Versão da API:: 2022-06-01

Cria ou atualiza um recurso do Conector IoT com os 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 URI

Nome	Em	Obrigatório	Tipo	Description
iotConnectorName	path	True	string minLength: 3 maxLength: 24	O nome do recurso do Conector IoT.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	O nome do grupo de recursos que contém a instância de serviço.
subscriptionId	path	True	string	O identificador da assinatura.
workspaceName	path	True	string minLength: 3 maxLength: 24	O nome do recurso de workspace.
api-version	query	True	string	Versão da API do cliente.

Corpo da solicitação

Nome	Tipo	Description
etag	string	Uma etag associada ao recurso, usada para simultaneidade otimista ao editá-lo.
identity	Identity	Configuração que indica se o serviço tem uma identidade gerenciada associada a ele.
location	string	O local do recurso.
properties.deviceMapping	IotMappingProperties	Mapeamentos de dispositivo.
properties.ingestionEndpointConfiguration	IotEventHubIngestionEndpointConfiguration	Configuração de origem.
tags	object	Marcas de recurso.

Respostas

Nome	Tipo	Description
200 OK	IotConnector	Atualizado – Solicitação de colocação aceita e um recurso existente é atualizado.
201 Created	IotConnector	Criado – Colocar solicitação aceita e um recurso existente está sendo criado de forma assíncrona.
202 Accepted	IotConnector	Aceito – Solicitação de colocação aceita e um recurso existente está sendo atualizado de forma assíncrona.
Other Status Codes	ErrorDetails	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Create an IoT Connector

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
  }
}

Código de status:: 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"
  }
}

Código de status:: 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"
  }
}

Definições

Nome	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorDetails	Detalhes do erro.
ErrorDetailsInternal	Detalhes do erro.
Identity	Configuração que indica se o serviço tem uma identidade gerenciada associada a ele.
IotConnector	Definição do Conector IoT.
IotEventHubIngestionEndpointConfiguration	Configuração do ponto de extremidade de ingestão do Hub de Eventos
IotMappingProperties	O conteúdo do mapeamento.
provisioningState	O estado de provisionamento.
ServiceManagedIdentityType	O tipo de identidade que está sendo especificado, atualmente SystemAssigned e None são permitidos.
systemData	Metadados relativos à criação e última modificação do recurso.
UserAssignedIdentity	Propriedades de identidade atribuídas pelo usuário

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorDetails

Objeto

Detalhes do erro.

Nome	Tipo	Description
error	ErrorDetailsInternal	Detalhes do erro

ErrorDetailsInternal

Objeto

Detalhes do erro.

Nome	Tipo	Description
code	string	O código de erro.
message	string	A mensagem de erro.
target	string	O destino do erro específico.

Identity

Objeto

Configuração que indica se o serviço tem uma identidade gerenciada associada a ele.

Nome	Tipo	Description
principalId	string (uuid)	A ID da entidade de serviço da identidade atribuída pelo sistema. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema.
tenantId	string (uuid)	A ID do locatário da identidade atribuída pelo sistema. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema.
type	ServiceManagedIdentityType	O tipo de identidade que está sendo especificado, atualmente SystemAssigned e None são permitidos.
userAssignedIdentities	<string, UserAssignedIdentity>	Identidades de User-Assigned O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores do dicionário podem ser objetos vazios ({}) em solicitações.

IotConnector

Objeto

Definição do Conector IoT.

Nome	Tipo	Description
etag	string	Uma etag associada ao recurso, usada para simultaneidade otimista ao editá-lo.
id	string	O identificador de recurso.
identity	Identity	Configuração que indica se o serviço tem uma identidade gerenciada associada a ele.
location	string	O local do recurso.
name	string pattern: ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$	O nome do recurso.
properties.deviceMapping	IotMappingProperties	Mapeamentos de dispositivo.
properties.ingestionEndpointConfiguration	IotEventHubIngestionEndpointConfiguration	Configuração de origem.
properties.provisioningState	provisioningState	O estado de provisionamento.
systemData	systemData	Metadados relativos à criação e última modificação do recurso.
tags	object	Marcas de recurso.
type	string	O tipo de recurso.

IotEventHubIngestionEndpointConfiguration

Objeto

Configuração do ponto de extremidade de ingestão do Hub de Eventos

Nome	Tipo	Description
consumerGroup	string	Grupo de consumidores do hub de eventos ao qual se conectar.
eventHubName	string	Nome do Hub de Eventos ao qual se conectar.
fullyQualifiedEventHubNamespace	string	Namespace totalmente qualificado do Hub de Eventos ao qual se conectar.

IotMappingProperties

Objeto

O conteúdo do mapeamento.

Nome	Tipo	Description
content	object	O mapeamento.

provisioningState

Enumeração

O estado de provisionamento.

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

ServiceManagedIdentityType

Enumeração

O tipo de identidade que está sendo especificado, atualmente SystemAssigned e None são permitidos.

Valor	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

UserAssignedIdentity

Objeto

Propriedades de identidade atribuídas pelo usuário

Nome	Tipo	Description
clientId	string (uuid)	A ID do cliente da identidade atribuída.
principalId	string (uuid)	A ID da entidade de segurança da identidade atribuída.

Compartilhar via

Iot Connectors - Create Or Update

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

Create an IoT Connector

Solicitação de exemplo

Resposta de exemplo

Definições

createdByType

ErrorDetails

ErrorDetailsInternal

Identity

IotConnector

IotEventHubIngestionEndpointConfiguration

IotMappingProperties

provisioningState

ServiceManagedIdentityType

systemData

UserAssignedIdentity