Iot Connectors - Create Or Update

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=2021-11-01

URI Parametreleri

Name In Required Type 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 Type Description
etag
  • string

Kaynakla ilişkilendirilmiş bir etag; düzenleme sırasında iyimser eşzamanlılık için kullanılır.

identity

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

location
  • string

Kaynak konumu.

properties.deviceMapping

Cihaz Eşlemeleri.

properties.ingestionEndpointConfiguration

Kaynak yapılandırması.

tags
  • object

Kaynak etiketleri.

Yanıtlar

Name Type Description
200 OK

Güncelleştirildi - İstek kabul edildi ve mevcut bir kaynak güncelleştirildi.

201 Created

Oluşturuldu - İstek kabul edildi ve mevcut bir kaynak zaman uyumsuz olarak oluşturuluyor.

202 Accepted

Kabul Edildi - İstek kabul edildi ve mevcut bir kaynak zaman uyumsuz olarak güncelleştiriliyor.

Other Status Codes

İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

OAuth2 Flow Azure Active Directory

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=2021-11-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"
                }
              ]
            }
          }
        ]
      }
    }
  }
}

Sample Response

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

Tanımlar

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 Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorDetails

Hata ayrıntıları.

Name Type Description
error

Hata ayrıntıları

ErrorDetailsInternal

Hata ayrıntıları.

Name Type 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 Type 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

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

userAssignedIdentities

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 Type 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

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

Cihaz Eşlemeleri.

properties.ingestionEndpointConfiguration

Kaynak yapılandırması.

properties.provisioningState

Sağlama durumu.

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 Type 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 Type Description
content
  • object

Eşleme.

provisioningState

Sağlama durumu.

Name Type 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 Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned,UserAssigned
  • string
UserAssigned
  • string

systemData

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

Name Type Description
createdAt
  • string

Kaynak oluşturma (UTC) zaman damgası.

createdBy
  • string

Kaynağı oluşturan kimlik.

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

Kaynağı en son değiştiren kimliğin türü.

UserAssignedIdentity

Kullanıcı tarafından atanan kimlik özellikleri

Name Type Description
clientId
  • string

Atanan kimliğin istemci kimliği.

principalId
  • string

Atanan kimliğin asıl kimliği.