Iot Connectors - Create Or Update

Referenz

Dienst:: Healthcare Apis

API-Version:: 2022-06-01

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 minLength: 3 maxLength: 24	Der Name der IoT Connector-Ressource.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Der Name der Ressourcengruppe, die die Dienstinstanz enthält.
subscriptionId	path	True	string	Der Abonnementbezeichner.
workspaceName	path	True	string minLength: 3 maxLength: 24	Der Name der Arbeitsbereichsressource.
api-version	query	True	string	Client-API-Version.

Anforderungstext

Name	Typ	Beschreibung
etag	string	Ein Etag, das der Ressource zugeordnet ist, wird bei der Bearbeitung für optimistische Parallelität verwendet.
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 – Angenommene Anforderung, und eine vorhandene Ressource wird aktualisiert.
201 Created	IotConnector	Created – Put request accepted and an existing resource is being created asynchron.
202 Accepted	IotConnector	Akzeptiert – Angenommene Anforderung, und eine vorhandene Ressource wird asynchron aktualisiert.
Other Status Codes	ErrorDetails	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.healthcareapis import HealthcareApisManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-healthcareapis
# USAGE
    python iotconnector_create.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = HealthcareApisManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.iot_connectors.begin_create_or_update(
        resource_group_name="testRG",
        workspace_name="workspace1",
        iot_connector_name="blue",
        iot_connector={
            "identity": {"type": "SystemAssigned"},
            "location": "westus",
            "properties": {
                "deviceMapping": {
                    "content": {
                        "template": [
                            {
                                "template": {
                                    "deviceIdExpression": "$.deviceid",
                                    "timestampExpression": "$.measurementdatetime",
                                    "typeMatchExpression": "$..[?(@heartrate)]",
                                    "typeName": "heartrate",
                                    "values": [
                                        {"required": "true", "valueExpression": "$.heartrate", "valueName": "hr"}
                                    ],
                                },
                                "templateType": "JsonPathContent",
                            }
                        ],
                        "templateType": "CollectionContent",
                    }
                },
                "ingestionEndpointConfiguration": {
                    "consumerGroup": "ConsumerGroupA",
                    "eventHubName": "MyEventHubName",
                    "fullyQualifiedEventHubNamespace": "myeventhub.servicesbus.windows.net",
                },
            },
            "tags": {"additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2022-06-01/examples/iotconnectors/iotconnector_Create.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.HealthcareApis;
using Azure.ResourceManager.HealthcareApis.Models;
using Azure.ResourceManager.Models;

// Generated from example definition: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2022-06-01/examples/iotconnectors/iotconnector_Create.json
// this example is just showing the usage of "IotConnectors_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this HealthcareApisWorkspaceResource created on azure
// for more information of creating HealthcareApisWorkspaceResource, please refer to the document of HealthcareApisWorkspaceResource
string subscriptionId = "subid";
string resourceGroupName = "testRG";
string workspaceName = "workspace1";
ResourceIdentifier healthcareApisWorkspaceResourceId = HealthcareApisWorkspaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName);
HealthcareApisWorkspaceResource healthcareApisWorkspace = client.GetHealthcareApisWorkspaceResource(healthcareApisWorkspaceResourceId);

// get the collection of this HealthcareApisIotConnectorResource
HealthcareApisIotConnectorCollection collection = healthcareApisWorkspace.GetHealthcareApisIotConnectors();

// invoke the operation
string iotConnectorName = "blue";
HealthcareApisIotConnectorData data = new HealthcareApisIotConnectorData(new AzureLocation("westus"))
{
    IngestionEndpointConfiguration = new HealthcareApisIotConnectorEventHubIngestionConfiguration()
    {
        EventHubName = "MyEventHubName",
        ConsumerGroup = "ConsumerGroupA",
        FullyQualifiedEventHubNamespace = "myeventhub.servicesbus.windows.net",
    },
    DeviceMappingContent = BinaryData.FromObjectAsJson(new Dictionary<string, object>()
    {
        ["template"] = new object[] { new Dictionary<string, object>()
        {
        ["template"] = new Dictionary<string, object>()
        {
        ["deviceIdExpression"] = "$.deviceid",
        ["timestampExpression"] = "$.measurementdatetime",
        ["typeMatchExpression"] = "$..[?(@heartrate)]",
        ["typeName"] = "heartrate",
        ["values"] = new object[] { new Dictionary<string, object>()
        {
        ["required"] = "true",
        ["valueExpression"] = "$.heartrate",
        ["valueName"] = "hr"} }},
        ["templateType"] = "JsonPathContent"} },
        ["templateType"] = "CollectionContent"
    }),
    Identity = new ManagedServiceIdentity("SystemAssigned"),
    Tags =
    {
    ["additionalProp1"] = "string",
    ["additionalProp2"] = "string",
    ["additionalProp3"] = "string",
    },
};
ArmOperation<HealthcareApisIotConnectorResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, iotConnectorName, data);
HealthcareApisIotConnectorResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
HealthcareApisIotConnectorData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

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

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

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

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 Ereignishub-Endpunkts
IotMappingProperties	Der Zuordnungsinhalt.
provisioningState	Der Bereitstellungsstatus.
ServiceManagedIdentityType	Der Typ der angegebenen Identität, derzeit "SystemAssigned" und "None" sind zulässig.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
UserAssignedIdentity	Benutzer zugewiesene Identitätseigenschaften

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

ErrorDetails

Objekt

Fehlerdetails.

Name	Typ	Beschreibung
error	ErrorDetailsInternal	Fehlerdetails

ErrorDetailsInternal

Objekt

Fehlerdetails.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

Identity

Objekt

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

Name	Typ	Beschreibung
principalId	string (uuid)	Die Dienstprinzipal-ID der vom System zugewiesenen Identität. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt.
tenantId	string (uuid)	Die Mandanten-ID der vom System zugewiesenen Identität. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt.
type	ServiceManagedIdentityType	Der Typ der angegebenen Identität, derzeit "SystemAssigned" und "None" sind zulässig.
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned Identitäten Die Gruppe der benutzerzuweisungen Identitäten, die der Ressource zugeordnet sind. Die Wörterbuchschlüssel "userAssignedIdentities" sind ARM-Ressourcen-IDs im Formular: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Die Wörterbuchwerte können leere Objekte ({}) in Anforderungen sein.

IotConnector

Objekt

IoT Connector-Definition.

Name	Typ	Beschreibung
etag	string	Ein Etag, das der Ressource zugeordnet ist, wird bei der Bearbeitung für optimistische Parallelität verwendet.
id	string	Der Ressourcenbezeichner.
identity	Identity	Einstellung, die angibt, ob dem Dienst eine verwaltete Identität zugeordnet ist.
location	string	Der Ressourcenspeicherort.
name	string pattern: ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$	Der Ressourcenname.
properties.deviceMapping	IotMappingProperties	Gerätezuordnungen.
properties.ingestionEndpointConfiguration	IotEventHubIngestionEndpointConfiguration	Quellkonfiguration.
properties.provisioningState	provisioningState	Der Bereitstellungsstatus.
systemData	systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
tags	object	Ressourcentags.
type	string	Der Ressourcentyp.

IotEventHubIngestionEndpointConfiguration

Objekt

Konfiguration des Ereignishub-Endpunkts

Name	Typ	Beschreibung
consumerGroup	string	Consumergruppe des Ereignishubs, mit dem eine Verbindung hergestellt werden soll.
eventHubName	string	Name des Ereignishubs, mit dem eine Verbindung hergestellt werden soll.
fullyQualifiedEventHubNamespace	string	Vollqualifizierter Namespace des Event Hub, mit dem eine Verbindung hergestellt werden soll.

IotMappingProperties

Objekt

Der Zuordnungsinhalt.

Name	Typ	Beschreibung
content	object	Die Zuordnung.

provisioningState

Enumeration

Der Bereitstellungsstatus.

Wert	Beschreibung
Accepted
Canceled
Creating
Deleting
Deprovisioned
Failed
Moving
Succeeded
Suspended
SystemMaintenance
Updating
Verifying
Warned

ServiceManagedIdentityType

Enumeration

Der Typ der angegebenen Identität, derzeit "SystemAssigned" und "None" sind zulässig.

Wert	Beschreibung
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	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 (date-time)	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

Objekt

Benutzer zugewiesene Identitätseigenschaften

Name	Typ	Beschreibung
clientId	string (uuid)	Die Client-ID der zugewiesenen Identität.
principalId	string (uuid)	Die Prinzipal-ID der zugewiesenen Identität.

Freigeben über

Iot Connectors - Create Or Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Create an IoT Connector

Beispielanforderung

Beispiel für eine Antwort

Definitionen

createdByType

ErrorDetails

ErrorDetailsInternal

Identity

IotConnector

IotEventHubIngestionEndpointConfiguration

IotMappingProperties

provisioningState

ServiceManagedIdentityType

systemData

UserAssignedIdentity