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

Parameter URI

Name In Required Type Description
iotConnectorName
path True
  • string

Nama sumber daya Konektor IoT.

resourceGroupName
path True
  • string

Nama grup sumber daya yang berisi instans layanan.

Regex pattern: ^[-\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

Name Type Description
etag
  • string

Etag yang terkait dengan sumber daya, digunakan untuk konkurensi optimis saat mengeditnya.

identity

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

location
  • string

Lokasi sumber daya.

properties.deviceMapping

Pemetaan Perangkat.

properties.ingestionEndpointConfiguration

Konfigurasi sumber.

tags
  • object

Tag sumber daya.

Respons

Name Type Description
200 OK

Diperbarui - Masukkan permintaan yang diterima dan sumber daya yang ada diperbarui.

201 Created

Dibuat - Letakkan permintaan diterima dan sumber daya yang ada sedang dibuat secara asinkron.

202 Accepted

Diterima - Permintaan put diterima dan sumber daya yang ada sedang diperbarui secara asinkron.

Other Status Codes

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name Description
user_impersonation meniru akun pengguna Anda

Contoh

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

Definisi

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.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorDetails

Detail kesalahan.

Name Type Description
error

Detail kesalahan

ErrorDetailsInternal

Detail kesalahan.

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

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

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

userAssignedIdentities

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.

Name Type Description
etag
  • string

Etag yang terkait dengan sumber daya, digunakan untuk konkurensi optimis saat mengeditnya.

id
  • string

Pengidentifikasi sumber daya.

identity

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

location
  • string

Lokasi sumber daya.

name
  • string

Nama sumber daya.

properties.deviceMapping

Pemetaan Perangkat.

properties.ingestionEndpointConfiguration

Konfigurasi sumber.

properties.provisioningState

Status penyediaan.

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

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

Name Type Description
content
  • object

Pemetaan.

provisioningState

Status penyediaan.

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

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

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned,UserAssigned
  • string
UserAssigned
  • string

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Name Type Description
createdAt
  • string

Tanda waktu pembuatan sumber daya (UTC).

createdBy
  • string

Identitas yang membuat sumber daya.

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

Jenis identitas yang terakhir mengubah sumber daya.

UserAssignedIdentity

Properti identitas yang ditetapkan pengguna

Name Type Description
clientId
  • string

ID klien dari identitas yang ditetapkan.

principalId
  • string

ID utama identitas yang ditetapkan.