Iot Connectors - Create Or Update

Tjänst:: Healthcare Apis

API-version:: 2022-06-01

Skapar eller uppdaterar en IoT Connector-resurs med de angivna parametrarna.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
iotConnectorName	path	True	string minLength: 3 maxLength: 24	Namnet på IoT Connector-resursen.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Namnet på resursgruppen som innehåller tjänstinstansen.
subscriptionId	path	True	string	Prenumerationsidentifieraren.
workspaceName	path	True	string minLength: 3 maxLength: 24	Namnet på arbetsytans resurs.
api-version	query	True	string	Klient-API-version.

Begärandetext

Name	Typ	Description
etag	string	En etag som är associerad med resursen och som används för optimistisk samtidighet när den redigeras.
identity	Identity	Inställning som anger om tjänsten har en hanterad identitet som är associerad med den.
location	string	Resursplatsen.
properties.deviceMapping	IotMappingProperties	Enhetsmappningar.
properties.ingestionEndpointConfiguration	IotEventHubIngestionEndpointConfiguration	Källkonfiguration.
tags	object	Resurstaggar.

Svar

Name	Typ	Description
200 OK	IotConnector	Uppdaterad – Godkänn begäran och en befintlig resurs uppdateras.
201 Created	IotConnector	Skapad – Skicka begäran accepterad och en befintlig resurs skapas asynkront.
202 Accepted	IotConnector	Accepterad – Godkänn begäran och en befintlig resurs uppdateras asynkront.
Other Status Codes	ErrorDetails	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Create an IoT Connector

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 200

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

Statuskod:: 201

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

Statuskod:: 202

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

Definitioner

Name	Description
createdByType	Den typ av identitet som skapade resursen.
ErrorDetails	Felinformation.
ErrorDetailsInternal	Felinformation.
Identity	Inställning som anger om tjänsten har en hanterad identitet som är associerad med den.
IotConnector	IoT Connector-definition.
IotEventHubIngestionEndpointConfiguration	Konfiguration av slutpunktskonfiguration för händelsehubbinmatning
IotMappingProperties	Mappningsinnehållet.
provisioningState	Etableringstillståndet.
ServiceManagedIdentityType	Typ av identitet som anges, för närvarande SystemAssigned och None tillåts.
systemData	Metadata som rör skapande och senaste ändring av resursen.
UserAssignedIdentity	Användartilldelade identitetsegenskaper

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

ErrorDetails

Objekt

Felinformation.

Name	Typ	Description
error	ErrorDetailsInternal	Felinformation

ErrorDetailsInternal

Objekt

Felinformation.

Name	Typ	Description
code	string	Felkoden.
message	string	Felmeddelandet.
target	string	Målet för det specifika felet.

Identity

Objekt

Inställning som anger om tjänsten har en hanterad identitet som är associerad med den.

Name	Typ	Description
principalId	string (uuid)	Tjänstens huvudnamns-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
tenantId	string (uuid)	Klientorganisations-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
type	ServiceManagedIdentityType	Typ av identitet som anges, för närvarande SystemAssigned och None tillåts.
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned identiteter Uppsättningen användartilldelade identiteter som är associerade med resursen. Ordlistenycklarna userAssignedIdentities är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Ordlistevärdena kan vara tomma objekt ({}) i begäranden.

IotConnector

Objekt

IoT Connector-definition.

Name	Typ	Description
etag	string	En etag som är associerad med resursen och som används för optimistisk samtidighet när den redigeras.
id	string	Resursidentifieraren.
identity	Identity	Inställning som anger om tjänsten har en hanterad identitet som är associerad med den.
location	string	Resursplatsen.
name	string pattern: ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$	Resursnamnet.
properties.deviceMapping	IotMappingProperties	Enhetsmappningar.
properties.ingestionEndpointConfiguration	IotEventHubIngestionEndpointConfiguration	Källkonfiguration.
properties.provisioningState	provisioningState	Etableringstillståndet.
systemData	systemData	Metadata som rör skapande och senaste ändring av resursen.
tags	object	Resurstaggar.
type	string	Resurstypen.

IotEventHubIngestionEndpointConfiguration

Objekt

Konfiguration av slutpunktskonfiguration för händelsehubbinmatning

Name	Typ	Description
consumerGroup	string	Konsumentgrupp för händelsehubben som ska anslutas till.
eventHubName	string	Event Hub-namn att ansluta till.
fullyQualifiedEventHubNamespace	string	Fullständigt kvalificerat namnområde för den händelsehubb som ska anslutas till.

IotMappingProperties

Objekt

Mappningsinnehållet.

Name	Typ	Description
content	object	Mappningen.

provisioningState

Uppräkning

Etableringstillståndet.

Värde	Description
Deleting
Succeeded
Creating
Accepted
Verifying
Updating
Failed
Canceled
Deprovisioned
Moving
Suspended
Warned
SystemMaintenance

ServiceManagedIdentityType

Uppräkning

Typ av identitet som anges, för närvarande SystemAssigned och None tillåts.

Värde	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

UserAssignedIdentity

Objekt

Användartilldelade identitetsegenskaper

Name	Typ	Description
clientId	string (uuid)	Klient-ID för den tilldelade identiteten.
principalId	string (uuid)	Huvud-ID för den tilldelade identiteten.

Dela via

Iot Connectors - Create Or Update

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

Create an IoT Connector

Exempelbegäran

Exempelsvar

Definitioner

createdByType

ErrorDetails

ErrorDetailsInternal

Identity

IotConnector

IotEventHubIngestionEndpointConfiguration

IotMappingProperties

provisioningState

ServiceManagedIdentityType

systemData

UserAssignedIdentity