Iot Connectors - Create Or Update

Layanan:: Healthcare Apis

Versi API:: 2022-06-01

Membuat atau memperbarui sumber daya Konektor IoT dengan parameter yang ditentukan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
iotConnectorName	path	True	string minLength: 3 maxLength: 24	Nama sumber daya Konektor IoT.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Nama grup sumber daya yang berisi instans layanan.
subscriptionId	path	True	string	Pengidentifikasi langganan.
workspaceName	path	True	string minLength: 3 maxLength: 24	Nama sumber daya ruang kerja.
api-version	query	True	string	Versi Api Klien.

Isi Permintaan

Nama	Jenis	Deskripsi
etag	string	Etag yang terkait dengan sumber daya, digunakan untuk konkurensi optimis saat mengeditnya.
identity	Identity	Pengaturan yang menunjukkan apakah layanan memiliki identitas terkelola yang terkait dengannya.
location	string	Lokasi sumber daya.
properties.deviceMapping	IotMappingProperties	Pemetaan Perangkat.
properties.ingestionEndpointConfiguration	IotEventHubIngestionEndpointConfiguration	Konfigurasi sumber.
tags	object	Tag sumber daya.

Respons

Nama	Jenis	Deskripsi
200 OK	IotConnector	Diperbarui - Masukkan permintaan yang diterima dan sumber daya yang ada diperbarui.
201 Created	IotConnector	Dibuat - Letakkan permintaan diterima dan sumber daya yang ada sedang dibuat secara asinkron.
202 Accepted	IotConnector	Diterima - Permintaan put diterima dan sumber daya yang ada sedang diperbarui secara asinkron.
Other Status Codes	ErrorDetails	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Create an IoT Connector

Permintaan sampel

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

Respon sampel

Kode status:: 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"
  }
}

Kode status:: 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"
  }
}

Kode status:: 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"
  }
}

Definisi

Nama	Deskripsi
createdByType	Jenis identitas yang membuat sumber daya.
ErrorDetails	Detail kesalahan.
ErrorDetailsInternal	Detail kesalahan.
Identity	Pengaturan yang menunjukkan apakah layanan memiliki identitas terkelola yang terkait dengannya.
IotConnector	Definisi Konektor IoT.
IotEventHubIngestionEndpointConfiguration	Konfigurasi titik akhir penyerapan Event Hub
IotMappingProperties	Konten pemetaan.
provisioningState	Status provisi.
ServiceManagedIdentityType	Jenis identitas yang ditentukan, saat ini SystemAssigned dan None diizinkan.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
UserAssignedIdentity	Properti identitas yang ditetapkan pengguna

createdByType

Enumeration

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

ErrorDetails

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
error	ErrorDetailsInternal	Detail kesalahan

ErrorDetailsInternal

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan tertentu.

Identity

Objek

Pengaturan yang menunjukkan apakah layanan memiliki identitas terkelola yang terkait dengannya.

Nama	Jenis	Deskripsi
principalId	string (uuid)	ID perwakilan layanan dari identitas yang ditetapkan sistem. Properti ini hanya akan disediakan untuk identitas yang ditetapkan sistem.
tenantId	string (uuid)	ID penyewa dari identitas yang ditetapkan sistem. Properti ini hanya akan disediakan untuk identitas yang ditetapkan sistem.
type	ServiceManagedIdentityType	Jenis identitas yang ditentukan, saat ini SystemAssigned dan None diizinkan.
userAssignedIdentities	<string, UserAssignedIdentity>	Identitas User-Assigned Kumpulan identitas yang ditetapkan pengguna yang terkait dengan sumber daya. Kunci kamus userAssignedIdentities akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Nilai kamus dapat berupa objek kosong ({}) dalam permintaan.

IotConnector

Objek

Definisi Konektor IoT.

Nama	Jenis	Deskripsi
etag	string	Etag yang terkait dengan sumber daya, digunakan untuk konkurensi optimis saat mengeditnya.
id	string	Pengidentifikasi sumber daya.
identity	Identity	Pengaturan yang menunjukkan apakah layanan memiliki identitas terkelola yang terkait dengannya.
location	string	Lokasi sumber daya.
name	string pattern: ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$	Nama sumber daya.
properties.deviceMapping	IotMappingProperties	Pemetaan Perangkat.
properties.ingestionEndpointConfiguration	IotEventHubIngestionEndpointConfiguration	Konfigurasi sumber.
properties.provisioningState	provisioningState	Status provisi.
systemData	systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya.

IotEventHubIngestionEndpointConfiguration

Objek

Konfigurasi titik akhir penyerapan Event Hub

Nama	Jenis	Deskripsi
consumerGroup	string	Grup konsumen hub peristiwa yang akan disambungkan.
eventHubName	string	Nama Pusat Aktivitas untuk disambungkan.
fullyQualifiedEventHubNamespace	string	Namespace layanan yang sepenuhnya memenuhi syarat dari Pusat Aktivitas untuk disambungkan.

IotMappingProperties

Objek

Konten pemetaan.

Nama	Jenis	Deskripsi
content	object	Pemetaan.

provisioningState

Enumeration

Status provisi.

Nilai	Deskripsi
Deleting
Succeeded
Creating
Accepted
Verifying
Updating
Failed
Canceled
Deprovisioned
Moving
Suspended
Warned
SystemMaintenance

ServiceManagedIdentityType

Enumeration

Jenis identitas yang ditentukan, saat ini SystemAssigned dan None diizinkan.

Nilai	Deskripsi
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.

UserAssignedIdentity

Objek

Properti identitas yang ditetapkan pengguna

Nama	Jenis	Deskripsi
clientId	string (uuid)	ID klien dari identitas yang ditetapkan.
principalId	string (uuid)	ID utama identitas yang ditetapkan.

Bagikan melalui

Iot Connectors - Create Or Update

Parameter URI

Isi Permintaan

Respons

Keamanan

azure_auth

Cakupan

Contoh

Create an IoT Connector

Permintaan sampel

Respon sampel

Definisi

createdByType

ErrorDetails

ErrorDetailsInternal

Identity

IotConnector

IotEventHubIngestionEndpointConfiguration

IotMappingProperties

provisioningState

ServiceManagedIdentityType

systemData

UserAssignedIdentity