Iot Connectors - Create Or Update

Odwołanie

Service:: Healthcare Apis

API Version:: 2022-06-01

Tworzy lub aktualizuje zasób IoT Connector przy użyciu określonych parametrów.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
iotConnectorName	path	True	string	Nazwa zasobu IoT Connector.
resourceGroupName	path	True	string	Nazwa grupy zasobów zawierającej wystąpienie usługi. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Identyfikator subskrypcji.
workspaceName	path	True	string	Nazwa zasobu obszaru roboczego.
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Typ	Opis
etag	string	Element etag skojarzony z zasobem, używany do optymistycznej współbieżności podczas jej edytowania.
identity	Identity	Ustawienie wskazujące, czy usługa ma skojarzona tożsamość zarządzaną.
location	string	Lokalizacja zasobu.
properties.deviceMapping	IotMappingProperties	Mapowania urządzeń.
properties.ingestionEndpointConfiguration	IotEventHubIngestionEndpointConfiguration	Konfiguracja źródła.
tags	object	Tagi zasobów.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	IotConnector	Zaktualizowano — umieść żądanie zaakceptowane i zaktualizowano istniejący zasób.
201 Created	IotConnector	Utworzone — umieść żądanie zaakceptowane i istniejący zasób jest tworzony asynchronicznie.
202 Accepted	IotConnector	Zaakceptowane — zaakceptuj żądanie, a istniejący zasób jest aktualizowany asynchronicznie.
Other Status Codes	ErrorDetails	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Create an IoT Connector

Sample Request

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

Sample Response

Status code:: 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"
  }
}

Status code:: 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"
  }
}

Status code:: 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"
  }
}

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorDetails	Szczegóły błędu.
ErrorDetailsInternal	Szczegóły błędu.
Identity	Ustawienie wskazujące, czy usługa ma skojarzona tożsamość zarządzaną.
IotConnector	definicja IoT Connector.
IotEventHubIngestionEndpointConfiguration	Konfiguracja punktu końcowego pozyskiwania centrum zdarzeń
IotMappingProperties	Zawartość mapowania.
provisioningState	Stan aprowizacji.
ServiceManagedIdentityType	Typ określonej tożsamości, obecnie SystemAssigned i None są dozwolone.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
UserAssignedIdentity	Właściwości tożsamości przypisanej przez użytkownika

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorDetails

Szczegóły błędu.

Nazwa	Typ	Opis
error	ErrorDetailsInternal	Szczegóły błędu

ErrorDetailsInternal

Szczegóły błędu.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy określonego błędu.

Identity

Ustawienie wskazujące, czy usługa ma skojarzona tożsamość zarządzaną.

Nazwa	Typ	Opis
principalId	string	Identyfikator jednostki usługi tożsamości przypisanej przez system. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system.
tenantId	string	Identyfikator dzierżawy tożsamości przypisanej przez system. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system.
type	ServiceManagedIdentityType	Typ określonej tożsamości, obecnie SystemAssigned i None są dozwolone.
userAssignedIdentities	<string, UserAssignedIdentity>	tożsamości User-Assigned Zestaw tożsamości przypisanych przez użytkownika skojarzonych z zasobem. Klucze słownika userAssignedIdentities będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Wartości słownika mogą być pustymi obiektami ({}) w żądaniach.

IotConnector

definicja IoT Connector.

Nazwa	Typ	Opis
etag	string	Element etag skojarzony z zasobem, używany do optymistycznej współbieżności podczas jej edytowania.
id	string	Identyfikator zasobu.
identity	Identity	Ustawienie wskazujące, czy usługa ma skojarzona tożsamość zarządzaną.
location	string	Lokalizacja zasobu.
name	string	Nazwa zasobu.
properties.deviceMapping	IotMappingProperties	Mapowania urządzeń.
properties.ingestionEndpointConfiguration	IotEventHubIngestionEndpointConfiguration	Konfiguracja źródła.
properties.provisioningState	provisioningState	Stan aprowizacji.
systemData	systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
tags	object	Tagi zasobów.
type	string	Typ zasobu.

IotEventHubIngestionEndpointConfiguration

Konfiguracja punktu końcowego pozyskiwania centrum zdarzeń

Nazwa	Typ	Opis
consumerGroup	string	Grupa odbiorców centrum zdarzeń do połączenia.
eventHubName	string	Nazwa centrum zdarzeń do nawiązania połączenia.
fullyQualifiedEventHubNamespace	string	W pełni kwalifikowana przestrzeń nazw centrum zdarzeń do nawiązania połączenia.

IotMappingProperties

Zawartość mapowania.

Nazwa	Typ	Opis
content	object	Mapowanie.

provisioningState

Stan aprowizacji.

Nazwa	Typ	Opis
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

Typ określonej tożsamości, obecnie SystemAssigned i None są dozwolone.

Nazwa	Typ	Opis
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobów (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

UserAssignedIdentity

Właściwości tożsamości przypisanej przez użytkownika

Nazwa	Typ	Opis
clientId	string	Identyfikator klienta przypisanej tożsamości.
principalId	string	Identyfikator podmiotu zabezpieczeń przypisanej tożsamości.