Bagikan melalui


Iot Connectors - Create Or Update

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

Nama sumber daya Konektor IoT.

resourceGroupName
path True

string

Nama grup sumber daya yang berisi instans layanan.

Pola regex: ^[-\w\._\(\)]+$

subscriptionId
path True

string

Pengidentifikasi langganan.

workspaceName
path True

string

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

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

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

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 Pusat Aktivitas

IotMappingProperties

Konten pemetaan.

provisioningState

Status penyediaan.

ServiceManagedIdentityType

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

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

UserAssignedIdentity

Properti identitas yang ditetapkan pengguna

createdByType

Jenis identitas yang membuat sumber daya.

Nama Jenis Deskripsi
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorDetails

Detail kesalahan.

Nama Jenis Deskripsi
error

ErrorDetailsInternal

Detail kesalahan

ErrorDetailsInternal

Detail kesalahan.

Nama Jenis Deskripsi
code

string

Kode kesalahan.

message

string

Pesan kesalahan.

target

string

Target kesalahan tertentu.

Identity

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

Nama Jenis Deskripsi
principalId

string

ID perwakilan layanan dari identitas yang ditetapkan sistem. Properti ini hanya akan disediakan untuk identitas yang ditetapkan sistem.

tenantId

string

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 diperbolehkan.

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

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

Nama sumber daya.

properties.deviceMapping

IotMappingProperties

Pemetaan Perangkat.

properties.ingestionEndpointConfiguration

IotEventHubIngestionEndpointConfiguration

Konfigurasi sumber.

properties.provisioningState

provisioningState

Status penyediaan.

systemData

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

tags

object

Tag sumber daya.

type

string

Jenis sumber daya.

IotEventHubIngestionEndpointConfiguration

Konfigurasi titik akhir penyerapan Pusat Aktivitas

Nama Jenis Deskripsi
consumerGroup

string

Grup konsumen hub peristiwa yang akan disambungkan.

eventHubName

string

Nama Pusat Aktivitas untuk disambungkan.

fullyQualifiedEventHubNamespace

string

Namespace layanan pusat aktivitas yang sepenuhnya memenuhi syarat untuk disambungkan.

IotMappingProperties

Konten pemetaan.

Nama Jenis Deskripsi
content

object

Pemetaan.

provisioningState

Status penyediaan.

Nama Jenis Deskripsi
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

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

Nama Jenis Deskripsi
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama Jenis Deskripsi
createdAt

string

Tanda waktu pembuatan sumber daya (UTC).

createdBy

string

Identitas yang membuat sumber daya.

createdByType

createdByType

Jenis identitas yang membuat sumber daya.

lastModifiedAt

string

Tanda waktu modifikasi terakhir sumber daya (UTC)

lastModifiedBy

string

Identitas yang terakhir mengubah sumber daya.

lastModifiedByType

createdByType

Jenis identitas yang terakhir mengubah sumber daya.

UserAssignedIdentity

Properti identitas yang ditetapkan pengguna

Nama Jenis Deskripsi
clientId

string

ID klien dari identitas yang ditetapkan.

principalId

string

ID utama identitas yang ditetapkan.