Iot Connectors - Create Or Update

Başvuru

Service:: Healthcare Apis

API Version:: 2022-06-01

Belirtilen parametrelerle bir IoT Connector kaynağı oluşturur veya güncelleştirir.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
iotConnectorName	path	True	string	IoT Connector kaynağın adı.
resourceGroupName	path	True	string	Hizmet örneğini içeren kaynak grubunun adı. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Abonelik tanımlayıcısı.
workspaceName	path	True	string	Çalışma alanı kaynağının adı.
api-version	query	True	string	İstemci Api Sürümü.

İstek Gövdesi

Name	Tür	Description
etag	string	Kaynakla ilişkilendirilmiş bir etag; düzenleme sırasında iyimser eşzamanlılık için kullanılır.
identity	Identity	Hizmetin kendisiyle ilişkilendirilmiş yönetilen bir kimliğe sahip olup olmadığını gösteren ayar.
location	string	Kaynak konumu.
properties.deviceMapping	IotMappingProperties	Cihaz Eşlemeleri.
properties.ingestionEndpointConfiguration	IotEventHubIngestionEndpointConfiguration	Kaynak yapılandırması.
tags	object	Kaynak etiketleri.

Yanıtlar

Name	Tür	Description
200 OK	IotConnector	Güncelleştirildi - İstek kabul edildi ve mevcut bir kaynak güncelleştirildi.
201 Created	IotConnector	Oluşturuldu - İstek kabul edildi ve mevcut bir kaynak zaman uyumsuz olarak oluşturuluyor.
202 Accepted	IotConnector	Kabul Edildi - İstek kabul edildi ve mevcut bir kaynak zaman uyumsuz olarak güncelleştiriliyor.
Other Status Codes	ErrorDetails	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

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

Tanımlar

Name	Description
createdByType	Kaynağı oluşturan kimliğin türü.
ErrorDetails	Hata ayrıntıları.
ErrorDetailsInternal	Hata ayrıntıları.
Identity	Hizmetin kendisiyle ilişkilendirilmiş yönetilen bir kimliğe sahip olup olmadığını gösteren ayar.
IotConnector	tanımı IoT Connector.
IotEventHubIngestionEndpointConfiguration	Event Hub alım uç noktası yapılandırması
IotMappingProperties	Eşleme içeriği.
provisioningState	Sağlama durumu.
ServiceManagedIdentityType	Belirtilen kimliğin türü, şu anda SystemAssigned ve None değerlerine izin verilir.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
UserAssignedIdentity	Kullanıcı tarafından atanan kimlik özellikleri

createdByType

Kaynağı oluşturan kimliğin türü.

Name	Tür	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorDetails

Hata ayrıntıları.

Name	Tür	Description
error	ErrorDetailsInternal	Hata ayrıntıları

ErrorDetailsInternal

Hata ayrıntıları.

Name	Tür	Description
code	string	Hata kodu.
message	string	Hata iletisi.
target	string	Belirli bir hatanın hedefi.

Identity

Hizmetin kendisiyle ilişkilendirilmiş yönetilen bir kimliğe sahip olup olmadığını gösteren ayar.

Name	Tür	Description
principalId	string	Sistem tarafından atanan kimliğin hizmet sorumlusu kimliği. Bu özellik yalnızca sistem tarafından atanan kimlik için sağlanacaktır.
tenantId	string	Sistem tarafından atanan kimliğin kiracı kimliği. Bu özellik yalnızca sistem tarafından atanan kimlik için sağlanacaktır.
type	ServiceManagedIdentityType	Belirtilen kimliğin türü, şu anda SystemAssigned ve None değerlerine izin verilir.
userAssignedIdentities	<string, UserAssignedIdentity>	kimlikleri User-Assigned Kaynakla ilişkilendirilmiş kullanıcı tarafından atanan kimlik kümesi. userAssignedIdentities sözlük anahtarları şu formda ARM kaynak kimlikleri olacaktır: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Sözlük değerleri, isteklerdeki boş nesneler ({}) olabilir.

IotConnector

tanımı IoT Connector.

Name	Tür	Description
etag	string	Kaynakla ilişkilendirilmiş bir etag; düzenleme sırasında iyimser eşzamanlılık için kullanılır.
id	string	Kaynak tanımlayıcısı.
identity	Identity	Hizmetin kendisiyle ilişkilendirilmiş yönetilen bir kimliğe sahip olup olmadığını gösteren ayar.
location	string	Kaynak konumu.
name	string	Kaynak adı.
properties.deviceMapping	IotMappingProperties	Cihaz Eşlemeleri.
properties.ingestionEndpointConfiguration	IotEventHubIngestionEndpointConfiguration	Kaynak yapılandırması.
properties.provisioningState	provisioningState	Sağlama durumu.
systemData	systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
tags	object	Kaynak etiketleri.
type	string	Kaynak türü.

IotEventHubIngestionEndpointConfiguration

Event Hub alım uç noktası yapılandırması

Name	Tür	Description
consumerGroup	string	Bağlanacak olay hub'ının tüketici grubu.
eventHubName	string	Bağlanacak Olay Hub'ı adı.
fullyQualifiedEventHubNamespace	string	Bağlanacak Olay Hub'ının tam ad alanı.

IotMappingProperties

Eşleme içeriği.

Name	Tür	Description
content	object	Eşleme.

provisioningState

Sağlama durumu.

Name	Tür	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

Belirtilen kimliğin türü, şu anda SystemAssigned ve None değerlerine izin verilir.

Name	Tür	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimliğin türü.

UserAssignedIdentity

Kullanıcı tarafından atanan kimlik özellikleri

Name	Tür	Description
clientId	string	Atanan kimliğin istemci kimliği.
principalId	string	Atanan kimliğin asıl kimliği.