Iot Connectors - Create Or Update

Vytvoří nebo aktualizuje prostředek IoT Connector zadanými parametry.

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

Parametry identifikátoru URI

Name In Required Type Description
iotConnectorName
path True
  • string

Název prostředku IoT Connector.

resourceGroupName
path True
  • string

Název skupiny prostředků, která obsahuje instanci služby.

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

subscriptionId
path True
  • string

Identifikátor předplatného.

workspaceName
path True
  • string

Název prostředku pracovního prostoru.

api-version
query True
  • string

Verze rozhraní API klienta.

Text požadavku

Name Type Description
etag
  • string

Značka přidružená k prostředku, která se používá k optimistické souběžnosti při úpravách.

identity

Nastavení určující, jestli má služba přidruženou spravovanou identitu.

location
  • string

Umístění prostředku.

properties.deviceMapping

Mapování zařízení

properties.ingestionEndpointConfiguration

Konfigurace zdroje

tags
  • object

Značky prostředků

Odpovědi

Name Type Description
200 OK

Aktualizováno – Žádost byla přijata a existující prostředek se aktualizuje.

201 Created

Vytvořeno – Žádost byla přijata a existující prostředek se vytváří asynchronně.

202 Accepted

Přijato – žádost byla přijata a existující prostředek se aktualizuje asynchronně.

Other Status Codes

Odpověď na chybu popisující, proč operace selhala.

Zabezpečení

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 zosobnění uživatelského účtu

Příklady

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

Definice

createdByType

Typ identity, která prostředek vytvořila.

ErrorDetails

Podrobnosti o chybě.

ErrorDetailsInternal

Podrobnosti o chybě.

Identity

Nastavení určující, jestli má služba přidruženou spravovanou identitu.

IotConnector

IoT Connector definici.

IotEventHubIngestionEndpointConfiguration

Konfigurace koncového bodu příjmu dat centra událostí

IotMappingProperties

Obsah mapování

provisioningState

Stav zřizování

ServiceManagedIdentityType

Typ zadané identity, aktuálně SystemAssigned a None jsou povoleny.

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

UserAssignedIdentity

Vlastnosti identity přiřazené uživatelem

createdByType

Typ identity, která prostředek vytvořila.

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

ErrorDetails

Podrobnosti o chybě.

Name Type Description
error

Podrobnosti o chybě

ErrorDetailsInternal

Podrobnosti o chybě.

Name Type Description
code
  • string

Kód chyby

message
  • string

Chybová zpráva

target
  • string

Cíl konkrétní chyby.

Identity

Nastavení určující, jestli má služba přidruženou spravovanou identitu.

Name Type Description
principalId
  • string

ID instančního objektu identity přiřazené systémem. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem.

tenantId
  • string

ID tenanta identity přiřazené systémem. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem.

type

Typ zadané identity, aktuálně SystemAssigned a None jsou povoleny.

userAssignedIdentities

identity User-Assigned
Sada identit přiřazených uživatelem přidružených k prostředku. Klíče slovníku userAssignedIdentities budou ID prostředků ARM ve formuláři: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Hodnoty slovníku můžou být prázdné objekty ({}) v požadavcích.

IotConnector

IoT Connector definici.

Name Type Description
etag
  • string

Značka přidružená k prostředku, která se používá k optimistické souběžnosti při úpravách.

id
  • string

Identifikátor prostředku.

identity

Nastavení určující, jestli má služba přidruženou spravovanou identitu.

location
  • string

Umístění prostředku.

name
  • string

Název prostředku.

properties.deviceMapping

Mapování zařízení

properties.ingestionEndpointConfiguration

Konfigurace zdroje

properties.provisioningState

Stav zřizování

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

tags
  • object

Značky prostředků

type
  • string

Typ prostředku.

IotEventHubIngestionEndpointConfiguration

Konfigurace koncového bodu příjmu dat centra událostí

Name Type Description
consumerGroup
  • string

Skupina příjemců centra událostí, ke které se má připojit.

eventHubName
  • string

Název centra událostí, ke kterému se chcete připojit.

fullyQualifiedEventHubNamespace
  • string

Plně kvalifikovaný obor názvů centra událostí pro připojení.

IotMappingProperties

Obsah mapování

Name Type Description
content
  • object

Mapování.

provisioningState

Stav zřizování

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

Typ zadané identity, aktuálně SystemAssigned a None jsou povoleny.

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

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name Type Description
createdAt
  • string

Časové razítko vytvoření prostředku (UTC).

createdBy
  • string

Identita, která prostředek vytvořila.

createdByType

Typ identity, která prostředek vytvořila.

lastModifiedAt
  • string

Časové razítko poslední změny zdroje (UTC)

lastModifiedBy
  • string

Identita, která prostředek naposledy upravila.

lastModifiedByType

Typ identity, která naposledy upravila prostředek.

UserAssignedIdentity

Vlastnosti identity přiřazené uživatelem

Name Type Description
clientId
  • string

ID klienta přiřazené identity.

principalId
  • string

ID objektu zabezpečení přiřazené identity.