Iot Connectors - Create Or Update

Crée ou met à jour une ressource IoT Connector avec les paramètres spécifiés.

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

Paramètres URI

Name In Required Type Description
iotConnectorName
path True
  • string

Nom de IoT Connector ressource.

resourceGroupName
path True
  • string

Nom du groupe de ressources qui contient l’instance de service.

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

subscriptionId
path True
  • string

Identificateur de l’abonnement.

workspaceName
path True
  • string

Nom de la ressource d’espace de travail.

api-version
query True
  • string

Version de l’API cliente.

Corps de la demande

Name Type Description
etag
  • string

Un etag associé à la ressource, utilisé pour l’accès concurrentiel optimiste lors de sa modification.

identity

Paramètre indiquant si le service a une identité managée associée.

location
  • string

Emplacement de la ressource.

properties.deviceMapping

Mappages d’appareils.

properties.ingestionEndpointConfiguration

Configuration de la source.

tags
  • object

Balises de ressource.

Réponses

Name Type Description
200 OK

Mise à jour : demande put acceptée et une ressource existante est mise à jour.

201 Created

Créé : demande put acceptée et une ressource existante est créée de manière asynchrone.

202 Accepted

Accepté : demande put acceptée et une ressource existante est mise à jour de façon asynchrone.

Other Status Codes

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

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 emprunter l’identité de votre compte d’utilisateur

Exemples

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

Définitions

createdByType

Type d’identité qui a créé la ressource.

ErrorDetails

Détails de l’erreur.

ErrorDetailsInternal

Détails de l’erreur.

Identity

Paramètre indiquant si le service a une identité managée associée.

IotConnector

IoT Connector définition.

IotEventHubIngestionEndpointConfiguration

Configuration du point de terminaison d’ingestion Event Hub

IotMappingProperties

Contenu de mappage.

provisioningState

État d’approvisionnement.

ServiceManagedIdentityType

Le type d’identité spécifié, actuellement SystemAssigned et None sont autorisés.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

UserAssignedIdentity

Propriétés d’identité attribuées par l’utilisateur

createdByType

Type d’identité qui a créé la ressource.

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

ErrorDetails

Détails de l’erreur.

Name Type Description
error

Détails de l’erreur

ErrorDetailsInternal

Détails de l’erreur.

Name Type Description
code
  • string

Code d'erreur.

message
  • string

Message d’erreur.

target
  • string

Cible de l’erreur particulière.

Identity

Paramètre indiquant si le service a une identité managée associée.

Name Type Description
principalId
  • string

ID du principal de service de l’identité affectée par le système. Cette propriété est fournie uniquement pour une identité affectée par le système.

tenantId
  • string

ID de locataire de l’identité affectée par le système. Cette propriété est fournie uniquement pour une identité affectée par le système.

type

Le type d’identité spécifié, actuellement SystemAssigned et None sont autorisés.

userAssignedIdentities

identités User-Assigned
Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs du dictionnaire peuvent être des objets vides ({}) dans les requêtes.

IotConnector

IoT Connector définition.

Name Type Description
etag
  • string

Un etag associé à la ressource, utilisé pour l’accès concurrentiel optimiste lors de sa modification.

id
  • string

Identificateur de ressource.

identity

Paramètre indiquant si le service a une identité managée associée.

location
  • string

Emplacement de la ressource.

name
  • string

Nom de la ressource.

properties.deviceMapping

Mappages d’appareils.

properties.ingestionEndpointConfiguration

Configuration de la source.

properties.provisioningState

État d’approvisionnement.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

tags
  • object

Balises de ressource.

type
  • string

Type de ressource.

IotEventHubIngestionEndpointConfiguration

Configuration du point de terminaison d’ingestion Event Hub

Name Type Description
consumerGroup
  • string

Groupe de consommateurs du hub d’événements auquel se connecter.

eventHubName
  • string

Nom du hub d’événements auquel se connecter.

fullyQualifiedEventHubNamespace
  • string

Espace de noms complet du hub d’événements auquel se connecter.

IotMappingProperties

Contenu de mappage.

Name Type Description
content
  • object

Mappage.

provisioningState

État d’approvisionnement.

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

Le type d’identité spécifié, actuellement SystemAssigned et None sont autorisés.

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

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Name Type Description
createdAt
  • string

Horodatage de la création de ressources (UTC).

createdBy
  • string

Identité qui a créé la ressource.

createdByType

Type d’identité qui a créé la ressource.

lastModifiedAt
  • string

Horodatage de la dernière modification de la ressource (UTC)

lastModifiedBy
  • string

Identité qui a modifié la ressource pour la dernière fois.

lastModifiedByType

Type d’identité qui a modifié la ressource pour la dernière fois.

UserAssignedIdentity

Propriétés d’identité attribuées par l’utilisateur

Name Type Description
clientId
  • string

ID client de l’identité affectée.

principalId
  • string

ID du principal de l’identité affectée.