Iot Connectors - Create Or Update

Tworzy lub aktualizuje zasób IoT Connector z określonymi parametrami.

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

Parametry identyfikatora URI

Name In Required Type Description
iotConnectorName
path True
  • string

Nazwa zasobu IoT Connector.

resourceGroupName
path True
  • string

Nazwa grupy zasobów, która zawiera wystąpienie usługi.

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

subscriptionId
path True
  • string

Identyfikator subskrypcji.

workspaceName
path True
  • string

Nazwa zasobu obszaru roboczego.

api-version
query True
  • string

Wersja interfejsu API klienta.

Treść żądania

Name Type Description
etag
  • string

Etag skojarzony z zasobem, używany do optymistycznej współbieżności podczas edytowania.

identity

Ustawienie wskazujące, czy usługa ma skojarzona tożsamość zarządzaną.

location
  • string

Lokalizacja zasobu.

properties.deviceMapping

Mapowania urządzeń.

properties.ingestionEndpointConfiguration

Konfiguracja źródła.

tags
  • object

Tagi zasobów.

Odpowiedzi

Name Type Description
200 OK

Zaktualizowano — umieść żądanie zaakceptowane i zaktualizowano istniejący zasób.

201 Created

Utworzone — umieść żądanie zaakceptowane, a istniejący zasób jest tworzony asynchronicznie.

202 Accepted

Zaakceptowano — żądanie zostanie zaakceptowane, a istniejący zasób jest aktualizowany asynchronicznie.

Other Status Codes

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation personifikacja konta użytkownika

Przykłady

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

Definicje

createdByType

Typ tożsamości, która utworzyła zasób.

ErrorDetails

Szczegóły błędu.

ErrorDetailsInternal

Szczegóły błędu.

Identity

Ustawienie wskazujące, czy usługa ma skojarzona tożsamość zarządzaną.

IotConnector

IoT Connector definicja.

IotEventHubIngestionEndpointConfiguration

Konfiguracja punktu końcowego pozyskiwania usługi Event Hub

IotMappingProperties

Zawartość mapowania.

provisioningState

Stan aprowizacji.

ServiceManagedIdentityType

Określony typ tożsamości, obecnie systemAssigned i None są dozwolone.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

UserAssignedIdentity

Właściwości tożsamości przypisanej przez użytkownika

createdByType

Typ tożsamości, która utworzyła zasób.

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

ErrorDetails

Szczegóły błędu.

Name Type Description
error

Szczegóły błędu

ErrorDetailsInternal

Szczegóły błędu.

Name Type Description
code
  • string

Kod błędu.

message
  • string

Komunikat o błędzie.

target
  • string

Element docelowy określonego błędu.

Identity

Ustawienie wskazujące, czy usługa ma skojarzona tożsamość zarządzaną.

Name Type Description
principalId
  • string

Identyfikator jednostki usługi tożsamości przypisanej przez system. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system.

tenantId
  • string

Identyfikator dzierżawy tożsamości przypisanej przez system. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system.

type

Określony typ tożsamości, obecnie systemAssigned i None są dozwolone.

userAssignedIdentities

tożsamości User-Assigned
Zestaw tożsamości przypisanych przez użytkownika skojarzonych z zasobem. Klucze słownika userAssignedIdentities będą identyfikatorami zasobów usługi ARM w postaci: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Wartości słownika mogą być pustymi obiektami ({}) w żądaniach.

IotConnector

IoT Connector definicja.

Name Type Description
etag
  • string

Etag skojarzony z zasobem, używany do optymistycznej współbieżności podczas edytowania.

id
  • string

Identyfikator zasobu.

identity

Ustawienie wskazujące, czy usługa ma skojarzona tożsamość zarządzaną.

location
  • string

Lokalizacja zasobu.

name
  • string

Nazwa zasobu.

properties.deviceMapping

Mapowania urządzeń.

properties.ingestionEndpointConfiguration

Konfiguracja źródła.

properties.provisioningState

Stan aprowizacji.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

tags
  • object

Tagi zasobów.

type
  • string

Typ zasobu.

IotEventHubIngestionEndpointConfiguration

Konfiguracja punktu końcowego pozyskiwania usługi Event Hub

Name Type Description
consumerGroup
  • string

Grupa odbiorców centrum zdarzeń do połączenia.

eventHubName
  • string

Nazwa centrum zdarzeń do nawiązania połączenia.

fullyQualifiedEventHubNamespace
  • string

W pełni kwalifikowana przestrzeń nazw centrum zdarzeń do nawiązania połączenia.

IotMappingProperties

Zawartość mapowania.

Name Type Description
content
  • object

Mapowanie.

provisioningState

Stan aprowizacji.

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

Określony typ tożsamości, obecnie systemAssigned i None są dozwolone.

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

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Name Type Description
createdAt
  • string

Sygnatura czasowa tworzenia zasobu (UTC).

createdBy
  • string

Tożsamość, która utworzyła zasób.

createdByType

Typ tożsamości, która utworzyła zasób.

lastModifiedAt
  • string

Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)

lastModifiedBy
  • string

Tożsamość, która ostatnio zmodyfikowała zasób.

lastModifiedByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.

UserAssignedIdentity

Właściwości tożsamości przypisanej przez użytkownika

Name Type Description
clientId
  • string

Identyfikator klienta przypisanej tożsamości.

principalId
  • string

Identyfikator podmiotu zabezpieczeń przypisanej tożsamości.