Iot Connectors - Create Or Update

Crea o aggiorna una risorsa IoT Connector con i parametri specificati.

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

Parametri dell'URI

Name In Required Type Description
iotConnectorName
path True
  • string

Nome della risorsa IoT Connector.

resourceGroupName
path True
  • string

Nome del gruppo di risorse che contiene l'istanza del servizio.

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

subscriptionId
path True
  • string

L'identificatore della sottoscrizione.

workspaceName
path True
  • string

Nome della risorsa dell'area di lavoro.

api-version
query True
  • string

Versione api client.

Corpo della richiesta

Name Type Description
etag
  • string

Un etag associato alla risorsa, usato per la concorrenza ottimistica durante la modifica.

identity

Impostazione che indica se al servizio è associata un'identità gestita.

location
  • string

Percorso della risorsa.

properties.deviceMapping

Mapping dei dispositivi.

properties.ingestionEndpointConfiguration

Configurazione di origine.

tags
  • object

Tag delle risorse.

Risposte

Name Type Description
200 OK

Aggiornato: richiesta put accettata e una risorsa esistente viene aggiornata.

201 Created

Creato: la richiesta Put accettata e viene creata una risorsa esistente in modo asincrono.

202 Accepted

Accettato: la richiesta Put accettata e una risorsa esistente viene aggiornata in modo asincrono.

Other Status Codes

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

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 rappresentare l'account utente

Esempio

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

Definizioni

createdByType

Tipo di identità che ha creato la risorsa.

ErrorDetails

Dettagli errore.

ErrorDetailsInternal

Dettagli errore.

Identity

Impostazione che indica se al servizio è associata un'identità gestita.

IotConnector

IoT Connector definizione.

IotEventHubIngestionEndpointConfiguration

Configurazione dell'endpoint di inserimento dell'hub eventi

IotMappingProperties

Contenuto di mapping.

provisioningState

Stato del provisioning.

ServiceManagedIdentityType

Tipo di identità specificato, attualmente SystemAssigned e None sono consentiti.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

UserAssignedIdentity

Proprietà di identità assegnate dall'utente

createdByType

Tipo di identità che ha creato la risorsa.

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

ErrorDetails

Dettagli errore.

Name Type Description
error

Dettagli errore

ErrorDetailsInternal

Dettagli errore.

Name Type Description
code
  • string

Codice di errore.

message
  • string

Messaggio di errore.

target
  • string

Destinazione dell'errore specifico.

Identity

Impostazione che indica se al servizio è associata un'identità gestita.

Name Type Description
principalId
  • string

ID dell'entità servizio dell'identità assegnata dal sistema. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema.

tenantId
  • string

ID tenant dell'identità assegnata dal sistema. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema.

type

Tipo di identità specificato, attualmente SystemAssigned e None sono consentiti.

userAssignedIdentities

identità User-Assigned
Set di identità assegnate dall'utente associate alla risorsa. Le chiavi del dizionario userAssignedIdentities saranno ID risorsa ARM nel formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. I valori del dizionario possono essere oggetti vuoti ({}) nelle richieste.

IotConnector

IoT Connector definizione.

Name Type Description
etag
  • string

Un etag associato alla risorsa, usato per la concorrenza ottimistica durante la modifica.

id
  • string

Identificatore della risorsa.

identity

Impostazione che indica se al servizio è associata un'identità gestita.

location
  • string

Percorso della risorsa.

name
  • string

Nome della risorsa.

properties.deviceMapping

Mapping dei dispositivi.

properties.ingestionEndpointConfiguration

Configurazione di origine.

properties.provisioningState

Stato del provisioning.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

tags
  • object

Tag delle risorse.

type
  • string

Tipo di risorsa.

IotEventHubIngestionEndpointConfiguration

Configurazione dell'endpoint di inserimento dell'hub eventi

Name Type Description
consumerGroup
  • string

Gruppo di consumer dell'hub eventi a cui connettersi.

eventHubName
  • string

Nome dell'hub eventi a cui connettersi.

fullyQualifiedEventHubNamespace
  • string

Spazio dei nomi completo dell'hub eventi a cui connettersi.

IotMappingProperties

Contenuto di mapping.

Name Type Description
content
  • object

Mapping.

provisioningState

Stato del provisioning.

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 di identità specificato, attualmente SystemAssigned e None sono consentiti.

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

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Name Type Description
createdAt
  • string

Timestamp della creazione di risorse (UTC).

createdBy
  • string

Identità che ha creato la risorsa.

createdByType

Tipo di identità che ha creato la risorsa.

lastModifiedAt
  • string

Timestamp dell'ultima modifica della risorsa (UTC)

lastModifiedBy
  • string

Identità che ha modificato l'ultima volta la risorsa.

lastModifiedByType

Tipo di identità che ha modificato l'ultima volta la risorsa.

UserAssignedIdentity

Proprietà di identità assegnate dall'utente

Name Type Description
clientId
  • string

ID client dell'identità assegnata.

principalId
  • string

ID principale dell'identità assegnata.