Iot Connectors - Create Or Update

Создает или обновляет ресурс IoT Connector с указанными параметрами.

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

Параметры URI

Name In Required Type Description
iotConnectorName
path True
  • string

Имя ресурса IoT Connector.

resourceGroupName
path True
  • string

Имя группы ресурсов, содержащей экземпляр службы.

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True
  • string

Идентификатор подписки.

workspaceName
path True
  • string

Имя ресурса рабочей области.

api-version
query True
  • string

Версия клиентского API.

Текст запроса

Name Type Description
etag
  • string

Тег etag, связанный с ресурсом, используемый для оптимистического параллелизма при редактировании.

identity

Параметр, указывающий, связана ли служба с управляемым удостоверением.

location
  • string

Местоположение ресурса.

properties.deviceMapping

Сопоставления устройств.

properties.ingestionEndpointConfiguration

Конфигурация источника.

tags
  • object

Теги ресурсов.

Ответы

Name Type Description
200 OK

Обновлено. Запрос на размещение принят и обновляется существующий ресурс.

201 Created

Создано. Запрос был принят и существующий ресурс создается асинхронно.

202 Accepted

Принято. Запрос put принят и существующий ресурс обновляется асинхронно.

Other Status Codes

Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Flow OAuth2 Azure Active Directory

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

Scopes

Name Description
user_impersonation олицетворения учетной записи пользователя

Примеры

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

Определения

createdByType

Тип удостоверения, создавшего ресурс.

ErrorDetails

Сведения об ошибке.

ErrorDetailsInternal

Сведения об ошибке.

Identity

Параметр, указывающий, связана ли служба с управляемым удостоверением.

IotConnector

определение IoT Connector.

IotEventHubIngestionEndpointConfiguration

Конфигурация конечной точки приема концентратора событий

IotMappingProperties

Содержимое сопоставления.

provisioningState

Состояние подготовки.

ServiceManagedIdentityType

Тип указанного удостоверения, в настоящее время systemAssigned и None разрешены.

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

UserAssignedIdentity

Свойства назначаемого пользователем удостоверения

createdByType

Тип удостоверения, создавшего ресурс.

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

ErrorDetails

Сведения об ошибке.

Name Type Description
error

Сведения об ошибке

ErrorDetailsInternal

Сведения об ошибке.

Name Type Description
code
  • string

Код ошибки.

message
  • string

Сообщение об ошибке.

target
  • string

Целевой объект конкретной ошибки.

Identity

Параметр, указывающий, связана ли служба с управляемым удостоверением.

Name Type Description
principalId
  • string

Идентификатор субъекта-службы назначенного системой удостоверения. Это свойство будет предоставлено только для назначаемого системой удостоверения.

tenantId
  • string

Идентификатор клиента назначенного системой удостоверения. Это свойство будет предоставлено только для назначаемого системой удостоверения.

type

Тип указанного удостоверения, в настоящее время systemAssigned и None разрешены.

userAssignedIdentities

удостоверения User-Assigned
Набор назначенных пользователем удостоверений, связанных с ресурсом. Ключи словаря userAssignedIdentities будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Значения словаря могут быть пустыми объектами ({}) в запросах.

IotConnector

определение IoT Connector.

Name Type Description
etag
  • string

Тег etag, связанный с ресурсом, используемый для оптимистического параллелизма при редактировании.

id
  • string

Идентификатор ресурса.

identity

Параметр, указывающий, связана ли служба с управляемым удостоверением.

location
  • string

Местоположение ресурса.

name
  • string

Имя ресурса.

properties.deviceMapping

Сопоставления устройств.

properties.ingestionEndpointConfiguration

Конфигурация источника.

properties.provisioningState

Состояние подготовки.

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

tags
  • object

Теги ресурсов.

type
  • string

Тип ресурса.

IotEventHubIngestionEndpointConfiguration

Конфигурация конечной точки приема концентратора событий

Name Type Description
consumerGroup
  • string

Группа потребителей концентратора событий для подключения.

eventHubName
  • string

Имя концентратора событий для подключения.

fullyQualifiedEventHubNamespace
  • string

Полное пространство имен концентратора событий для подключения.

IotMappingProperties

Содержимое сопоставления.

Name Type Description
content
  • object

Сопоставление.

provisioningState

Состояние подготовки.

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

Тип указанного удостоверения, в настоящее время systemAssigned и None разрешены.

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

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Name Type Description
createdAt
  • string

Метка времени создания ресурса (UTC).

createdBy
  • string

Удостоверение, создающее ресурс.

createdByType

Тип удостоверения, создавшего ресурс.

lastModifiedAt
  • string

Метка времени последнего изменения ресурса (UTC)

lastModifiedBy
  • string

Удостоверение, которое в последний раз изменило ресурс.

lastModifiedByType

Тип удостоверения, который последний раз изменил ресурс.

UserAssignedIdentity

Свойства назначаемого пользователем удостоверения

Name Type Description
clientId
  • string

Идентификатор клиента назначенного удостоверения.

principalId
  • string

Идентификатор субъекта назначенного удостоверения.