Iot Connectors - Create Or Update

Hizmet:: Healthcare Apis

API Sürümü:: 2022-06-01

IoT Bağlayıcısı kaynağını belirtilen parametrelerle 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 minLength: 3 maxLength: 24	IoT Bağlayıcısı kaynağının adı.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Hizmet örneğini içeren kaynak grubunun adı.
subscriptionId	path	True	string	Abonelik tanımlayıcısı.
workspaceName	path	True	string minLength: 3 maxLength: 24	Ç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şkili 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 Akışı

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

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

Örnekler

Create an IoT Connector

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:: 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"
  }
}

Durum kodu:: 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"
  }
}

Durum kodu:: 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	IoT Bağlayıcısı tanımı.
IotEventHubIngestionEndpointConfiguration	Olay Hub'ı alma uç noktası yapılandırması
IotMappingProperties	Eşleme içeriği.
provisioningState	Sağlama durumu.
ServiceManagedIdentityType	Belirtilen kimlik 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

Listeleme

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

Değer	Description
User
Application
ManagedIdentity
Key

ErrorDetails

Object

Hata ayrıntıları.

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

ErrorDetailsInternal

Object

Hata ayrıntıları.

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

Identity

Object

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

Name	Tür	Description
principalId	string (uuid)	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 (uuid)	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 kimlik türü, şu anda SystemAssigned ve None değerlerine izin verilir.
userAssignedIdentities	<string, UserAssignedIdentity>	kimlikleri User-Assigned Kaynakla ilişkili 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

Object

IoT Bağlayıcısı tanımı.

Name	Tür	Description
etag	string	Kaynakla ilişkili 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 pattern: ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$	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

Object

Olay Hub'ı alma 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

Object

Eşleme içeriği.

Name	Tür	Description
content	object	Eşleme.

provisioningState

Listeleme

Sağlama durumu.

Değer	Description
Deleting
Succeeded
Creating
Accepted
Verifying
Updating
Failed
Canceled
Deprovisioned
Moving
Suspended
Warned
SystemMaintenance

ServiceManagedIdentityType

Listeleme

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

Değer	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

systemData

Object

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

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

UserAssignedIdentity

Object

Kullanıcı tarafından atanan kimlik özellikleri

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

Aracılığıyla paylaş

Iot Connectors - Create Or Update

URI Parametreleri

İstek Gövdesi

Yanıtlar

Güvenlik

azure_auth

Kapsamlar

Örnekler

Create an IoT Connector

Örnek isteği

Örnek yanıt

Tanımlar

createdByType

ErrorDetails

ErrorDetailsInternal

Identity

IotConnector

IotEventHubIngestionEndpointConfiguration

IotMappingProperties

provisioningState

ServiceManagedIdentityType

systemData

UserAssignedIdentity