Iot Connectors - Create Or Update

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

Name In Required Type Description
iotConnectorName
path True
  • string

O nome do recurso IoT Connector.

resourceGroupName
path True
  • string

O nome do grupo de recursos que contém a instância de serviço.

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

subscriptionId
path True
  • string

O identificador de assinatura.

workspaceName
path True
  • string

O nome do recurso espaço de trabalho.

api-version
query True
  • string

Versão Api do cliente.

Corpo do Pedido

Name Type Description
etag
  • string

Um etag associado ao recurso, usado para a concordância otimista ao editá-lo.

identity

Definição indicando se o serviço tem uma identidade gerida associada a ele.

location
  • string

A localização do recurso.

properties.deviceMapping

Mapeamentos de dispositivos.

properties.ingestionEndpointConfiguration

Configuração de origem.

tags
  • object

Etiquetas de recursos.

Respostas

Name Type Description
200 OK

Atualizado - Coloque o pedido aceite e um recurso existente é atualizado.

201 Created

Criado - Coloque o pedido aceite e um recurso existente está sendo criado assíncroneamente.

202 Accepted

Aceite - Aceite - Aceite pedido e um recurso existente está a ser atualizado assíncroticamente.

Other Status Codes

Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Flow de Azure Ative Directory OAuth2

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

Scopes

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

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

Definições

createdByType

O tipo de identidade que criou o recurso.

ErrorDetails

Detalhes de erro.

ErrorDetailsInternal

Detalhes de erro.

Identity

Definição indicando se o serviço tem uma identidade gerida associada a ele.

IotConnector

IoT Connector definição.

IotEventHubIngestionEndpointConfiguration

Configuração do ponto final do Centro de Ingestão de Eventos

IotMappingProperties

O conteúdo do mapeamento.

provisioningState

O estado de provisionamento.

ServiceManagedIdentityType

Tipo de identidade sendo especificado, atualmente SystemAssigned e Nenhum é permitido.

systemData

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

UserAssignedIdentity

Propriedades de identidade atribuídas pelo utilizador

createdByType

O tipo de identidade que criou o recurso.

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

ErrorDetails

Detalhes de erro.

Name Type Description
error

Detalhes do erro

ErrorDetailsInternal

Detalhes de erro.

Name Type Description
code
  • string

O código de erro.

message
  • string

A mensagem de erro.

target
  • string

O alvo do erro particular.

Identity

Definição indicando se o serviço tem uma identidade gerida associada a ele.

Name Type Description
principalId
  • string

A identificação principal do sistema atribuiu identidade. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.

tenantId
  • string

A identidade do inquilino do sistema atribuiu identidade. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.

type

Tipo de identidade sendo especificado, atualmente SystemAssigned e Nenhum é permitido.

userAssignedIdentities

Identidades User-Assigned
O conjunto de identidades atribuídas pelo utilizador associado ao recurso. As teclas do dicionário de nomeações do utilizador serão ids de recursos ARM no formulário: '/subscrições/{subscriçãoId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores do dicionário podem ser objetos vazios ({}) em pedidos.

IotConnector

IoT Connector definição.

Name Type Description
etag
  • string

Um etag associado ao recurso, usado para a concordância otimista ao editá-lo.

id
  • string

O identificador de recursos.

identity

Definição indicando se o serviço tem uma identidade gerida associada a ele.

location
  • string

A localização do recurso.

name
  • string

O nome do recurso.

properties.deviceMapping

Mapeamentos de dispositivos.

properties.ingestionEndpointConfiguration

Configuração de origem.

properties.provisioningState

O estado de provisionamento.

systemData

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

tags
  • object

Etiquetas de recursos.

type
  • string

O tipo de recurso.

IotEventHubIngestionEndpointConfiguration

Configuração do ponto final do Centro de Ingestão de Eventos

Name Type Description
consumerGroup
  • string

Grupo de consumidores do centro de eventos ligado.

eventHubName
  • string

Nome do Centro de Eventos para ligar.

fullyQualifiedEventHubNamespace
  • string

Espaço de nome totalmente qualificado do Centro de Eventos para se conectar.

IotMappingProperties

O conteúdo do mapeamento.

Name Type Description
content
  • object

O mapeamento.

provisioningState

O estado de provisionamento.

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 identidade sendo especificado, atualmente SystemAssigned e Nenhum é permitido.

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

systemData

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

Name Type Description
createdAt
  • string

O calendário da criação de recursos (UTC).

createdBy
  • string

A identidade que criou o recurso.

createdByType

O tipo de identidade que criou o recurso.

lastModifiedAt
  • string

O tempotampesso da última modificação de recursos (UTC)

lastModifiedBy
  • string

A identidade que modificou o recurso pela última vez.

lastModifiedByType

O tipo de identidade que modificou o recurso pela última vez.

UserAssignedIdentity

Propriedades de identidade atribuídas pelo utilizador

Name Type Description
clientId
  • string

A identificação do cliente da identidade atribuída.

principalId
  • string

A identificação principal da identidade atribuída.