Freigeben über


Iot Connectors - Create Or Update

Erstellt oder aktualisiert eine IoT Connector-Ressource mit den angegebenen Parametern.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
iotConnectorName
path True

string

Der Name IoT Connector Ressource.

resourceGroupName
path True

string

Der Name der Ressourcengruppe, die den Dienst instance enthält.

RegEx-Muster: ^[-\w\._\(\)]+$

subscriptionId
path True

string

Die Abonnement-ID.

workspaceName
path True

string

Der Name der Arbeitsbereichsressource.

api-version
query True

string

Client-API-Version.

Anforderungstext

Name Typ Beschreibung
etag

string

Ein der Ressource zugeordnetes Etag, das für eine optimistische Parallelität beim Bearbeiten verwendet wird.

identity

Identity

Einstellung, die angibt, ob dem Dienst eine verwaltete Identität zugeordnet ist.

location

string

Der Ressourcenspeicherort.

properties.deviceMapping

IotMappingProperties

Gerätezuordnungen.

properties.ingestionEndpointConfiguration

IotEventHubIngestionEndpointConfiguration

Quellkonfiguration.

tags

object

Ressourcentags.

Antworten

Name Typ Beschreibung
200 OK

IotConnector

Aktualisiert: Put-Anforderung wird akzeptiert, und eine vorhandene Ressource wird aktualisiert.

201 Created

IotConnector

Erstellt: Put-Anforderung wird akzeptiert, und eine vorhandene Ressource wird asynchron erstellt.

202 Accepted

IotConnector

Akzeptiert: Put-Anforderung wird akzeptiert, und eine vorhandene Ressource wird asynchron aktualisiert.

Other Status Codes

ErrorDetails

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

Create an IoT Connector

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
createdByType

Der Identitätstyp, der die Ressource erstellt hat.

ErrorDetails

Fehlerdetails.

ErrorDetailsInternal

Fehlerdetails.

Identity

Einstellung, die angibt, ob dem Dienst eine verwaltete Identität zugeordnet ist.

IotConnector

IoT Connector Definition.

IotEventHubIngestionEndpointConfiguration

Konfiguration des Event Hub-Erfassungsendpunkts

IotMappingProperties

Der Zuordnungsinhalt.

provisioningState

Der Bereitstellungsstatus.

ServiceManagedIdentityType

Der angegebene Identitätstyp ist derzeit "SystemAssigned" und "None" zulässig.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

UserAssignedIdentity

Benutzerseitig zugewiesene Identitätseigenschaften

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name Typ Beschreibung
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorDetails

Fehlerdetails.

Name Typ Beschreibung
error

ErrorDetailsInternal

Fehlerdetails

ErrorDetailsInternal

Fehlerdetails.

Name Typ Beschreibung
code

string

Der Fehlercode.

message

string

Die Fehlermeldung.

target

string

Das Ziel des jeweiligen Fehlers.

Identity

Einstellung, die angibt, ob dem Dienst eine verwaltete Identität zugeordnet ist.

Name Typ Beschreibung
principalId

string

Die Dienstprinzipal-ID der systemseitig zugewiesenen Identität. Diese Eigenschaft wird nur für eine systemseitig zugewiesene Identität bereitgestellt.

tenantId

string

Die Mandanten-ID der systemseitig zugewiesenen Identität. Diese Eigenschaft wird nur für eine systemseitig zugewiesene Identität bereitgestellt.

type

ServiceManagedIdentityType

Der angegebene Identitätstyp ist derzeit "SystemAssigned" und "None" zulässig.

userAssignedIdentities

<string,  UserAssignedIdentity>

User-Assigned Identitäten
Die Gruppe der benutzerseitig zugewiesenen Identitäten, die der Ressource zugeordnet sind. Bei den UserAssignedIdentities-Wörterbuchschlüsseln handelt es sich um ARM-Ressourcen-IDs in der Form : '/subscriptions/{subscriptionId}/resourceGroupGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Die Wörterbuchwerte können leere Objekte ({}) in Anforderungen sein.

IotConnector

IoT Connector Definition.

Name Typ Beschreibung
etag

string

Ein der Ressource zugeordnetes Etag, das für eine optimistische Parallelität beim Bearbeiten verwendet wird.

id

string

Der Ressourcenbezeichner.

identity

Identity

Einstellung, die angibt, ob dem Dienst eine verwaltete Identität zugeordnet ist.

location

string

Der Ressourcenspeicherort.

name

string

Der Name der Ressource.

properties.deviceMapping

IotMappingProperties

Gerätezuordnungen.

properties.ingestionEndpointConfiguration

IotEventHubIngestionEndpointConfiguration

Quellkonfiguration.

properties.provisioningState

provisioningState

Der Bereitstellungsstatus.

systemData

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

tags

object

Ressourcentags.

type

string

Der Ressourcentyp.

IotEventHubIngestionEndpointConfiguration

Konfiguration des Event Hub-Erfassungsendpunkts

Name Typ Beschreibung
consumerGroup

string

Consumergruppe des Event Hubs, mit dem eine Verbindung hergestellt werden soll.

eventHubName

string

Event Hub-Name, mit dem eine Verbindung hergestellt werden soll.

fullyQualifiedEventHubNamespace

string

Vollqualifizierter Namespace des Event Hubs, mit dem eine Verbindung hergestellt werden soll.

IotMappingProperties

Der Zuordnungsinhalt.

Name Typ Beschreibung
content

object

Die Zuordnung.

provisioningState

Der Bereitstellungsstatus.

Name Typ Beschreibung
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

Der angegebene Identitätstyp ist derzeit "SystemAssigned" und "None" zulässig.

Name Typ Beschreibung
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name Typ Beschreibung
createdAt

string

Der Zeitstempel der Ressourcenerstellung (UTC).

createdBy

string

Die Identität, die die Ressource erstellt hat.

createdByType

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

lastModifiedAt

string

Der Zeitstempel der letzten Änderung der Ressource (UTC)

lastModifiedBy

string

Die Identität, die die Ressource zuletzt geändert hat.

lastModifiedByType

createdByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.

UserAssignedIdentity

Benutzerseitig zugewiesene Identitätseigenschaften

Name Typ Beschreibung
clientId

string

Die Client-ID der zugewiesenen Identität.

principalId

string

Die Prinzipal-ID der zugewiesenen Identität.