Integration Runtimes - Start

Service:

Synapse

Version d'API:

2021-06-01

Démarrer le runtime d’intégration
Démarrer un runtime d’intégration

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/start?api-version=2021-06-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
integrationRuntimeName	path	True	string	Nom du runtime d’intégration
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string	ID de l’abonnement cible.
workspaceName	path	True	string	Nom de l’espace de travail.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	IntegrationRuntimeStatusResponse	D’ACCORD.
202 Accepted		Accepté.
Other Status Codes	ErrorResponse	Réponse d’erreur reçue du service Azure Synapse.

Exemples

Start integration runtime

Exemple de requête

HTTP

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/integrationRuntimes/exampleManagedIntegrationRuntime/start?api-version=2021-06-01

Exemple de réponse

Code d’état:

200

Date: Wed, 13 Jun 2018 21:33:00 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14912
x-ms-request-id: 2af47f9f-5625-4b01-a3a5-bccb576a4677
x-ms-correlation-request-id: 2af47f9f-5625-4b01-a3a5-bccb576a4677

{
  "name": "exampleManagedIntegrationRuntime",
  "properties": {
    "dataFactoryName": "exampleWorkspaceName",
    "type": "Managed",
    "state": "Started",
    "typeProperties": {
      "nodes": [],
      "otherErrors": [],
      "createTime": "2018-06-13T21:11:01.8695494Z"
    }
  }
}

Code d’état:

202

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
IntegrationRuntimeAutoUpdate	État de la mise à jour automatique du runtime d’intégration.
IntegrationRuntimeInternalChannelEncryptionMode	Il est utilisé pour définir le mode de chiffrement pour le canal de communication nœud-nœud (lorsque plus de 2 nœuds runtime d’intégration auto-hébergés existent).
IntegrationRuntimeState	État du runtime d’intégration.
IntegrationRuntimeStatusResponse	Réponse d’état du runtime d’intégration.
IntegrationRuntimeType	Type de runtime d’intégration.
IntegrationRuntimeUpdateResult	Résultat de la dernière mise à jour du nœud runtime d’intégration.
LinkedIntegrationRuntime	Informations sur le runtime d’intégration lié.
ManagedIntegrationRuntimeError	Définition d’erreur pour le runtime d’intégration managé.
ManagedIntegrationRuntimeNode	Propriétés du nœud runtime d’intégration.
ManagedIntegrationRuntimeNodeStatus	État du nœud runtime d’intégration managée.
ManagedIntegrationRuntimeOperationResult	Propriétés du résultat de l’opération d’exécution d’intégration managée.
ManagedIntegrationRuntimeStatus	État du runtime d’intégration managé.
SelfHostedIntegrationRuntimeNode	Propriétés du nœud runtime d’intégration auto-hébergé.
SelfHostedIntegrationRuntimeNodeStatus	État du nœud runtime d’intégration.
SelfHostedIntegrationRuntimeStatus	État du runtime d’intégration auto-hébergé.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

IntegrationRuntimeAutoUpdate

État de la mise à jour automatique du runtime d’intégration.

Nom	Type	Description
Off	string
On	string

IntegrationRuntimeInternalChannelEncryptionMode

Il est utilisé pour définir le mode de chiffrement pour le canal de communication nœud-nœud (lorsque plus de 2 nœuds runtime d’intégration auto-hébergés existent).

Nom	Type	Description
NotEncrypted	string
NotSet	string
SslEncrypted	string

IntegrationRuntimeState

État du runtime d’intégration.

Nom	Type	Description
AccessDenied	string
Initial	string
Limited	string
NeedRegistration	string
Offline	string
Online	string
Started	string
Starting	string
Stopped	string
Stopping	string

IntegrationRuntimeStatusResponse

Réponse d’état du runtime d’intégration.

Nom	Type	Description
name	string	Nom du runtime d’intégration.
properties	IntegrationRuntimeStatus: ManagedIntegrationRuntimeStatus SelfHostedIntegrationRuntimeStatus	Propriétés du runtime d’intégration.

IntegrationRuntimeType

Type de runtime d’intégration.

Nom	Type	Description
Managed	string
SelfHosted	string

IntegrationRuntimeUpdateResult

Résultat de la dernière mise à jour du nœud runtime d’intégration.

Nom	Type	Description
Fail	string
None	string
Succeed	string

LinkedIntegrationRuntime

Informations sur le runtime d’intégration lié.

Nom	Type	Description
createTime	string	Heure de création du runtime d’intégration lié.
dataFactoryLocation	string	Emplacement de l’espace de travail auquel appartient le runtime d’intégration lié.
dataFactoryName	string	Nom de l’espace de travail auquel appartient le runtime d’intégration lié.
name	string	Nom du runtime d’intégration lié.
subscriptionId	string	ID d’abonnement auquel appartient le runtime d’intégration lié.

ManagedIntegrationRuntimeError

Définition d’erreur pour le runtime d’intégration managé.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Message d'erreur.
parameters	string[]	Paramètres d’erreur du runtime d’intégration managé.
time	string	Heure à laquelle l’erreur s’est produite.

ManagedIntegrationRuntimeNode

Propriétés du nœud runtime d’intégration.

Nom	Type	Description
errors	ManagedIntegrationRuntimeError[]	Erreurs qui se sont produites sur ce nœud runtime d’intégration.
nodeId	string	ID du nœud runtime d’intégration managée.
status	ManagedIntegrationRuntimeNodeStatus	État du nœud runtime d’intégration managée.

ManagedIntegrationRuntimeNodeStatus

État du nœud runtime d’intégration managée.

Nom	Type	Description
Available	string
Recycling	string
Starting	string
Unavailable	string

ManagedIntegrationRuntimeOperationResult

Propriétés du résultat de l’opération d’exécution d’intégration managée.

Nom	Type	Description
activityId	string	ID d’activité de la demande d’opération.
errorCode	string	Code d’erreur.
parameters	string[]	Paramètres d’erreur du runtime d’intégration managé.
result	string	Résultat de l’opération.
startTime	string	Heure de début de l’opération.
type	string	Type d’opération. Peut être démarrer ou arrêter.

ManagedIntegrationRuntimeStatus

État du runtime d’intégration managé.

Nom	Type	Description
dataFactoryName	string	Nom de l’espace de travail auquel appartient le runtime d’intégration.
state	IntegrationRuntimeState	État du runtime d’intégration.
type	string: Managed	Type de runtime d’intégration.
typeProperties.createTime	string	Heure à laquelle le runtime d’intégration a été créé, au format ISO8601.
typeProperties.lastOperation	ManagedIntegrationRuntimeOperationResult	Résultat de la dernière opération qui s’est produite sur ce runtime d’intégration.
typeProperties.nodes	ManagedIntegrationRuntimeNode[]	Liste des nœuds pour le runtime d’intégration managé.
typeProperties.otherErrors	ManagedIntegrationRuntimeError[]	Erreurs qui se sont produites sur ce runtime d’intégration.

SelfHostedIntegrationRuntimeNode

Propriétés du nœud runtime d’intégration auto-hébergé.

Nom	Type	Description
capabilities	object	Dictionnaire des fonctionnalités du runtime d’intégration
concurrentJobsLimit	integer	Nombre maximal de travaux simultanés sur le nœud runtime d’intégration.
expiryTime	string	Heure à laquelle le runtime d’intégration expirera au format ISO8601.
hostServiceUri	string	URI de l’ordinateur hôte du runtime d’intégration.
isActiveDispatcher	boolean	Indique si ce nœud est le répartiteur actif pour les demandes du runtime d’intégration.
lastConnectTime	string	Heure la plus récente à laquelle le runtime d’intégration a été connecté au format ISO8601.
lastEndUpdateTime	string	Dernière fois pour la fin de la mise à jour du nœud runtime d’intégration.
lastStartTime	string	Heure du dernier démarrage du nœud.
lastStartUpdateTime	string	La dernière fois pour le démarrage de la mise à jour du nœud runtime d’intégration.
lastStopTime	string	Heure du dernier arrêt du nœud runtime d’intégration.
lastUpdateResult	IntegrationRuntimeUpdateResult	Résultat de la dernière mise à jour du nœud runtime d’intégration.
machineName	string	Nom de l’ordinateur du nœud runtime d’intégration.
maxConcurrentJobs	integer	Nombre maximal de travaux simultanés dans ce runtime d’intégration.
nodeName	string	Nom du nœud runtime d’intégration.
registerTime	string	Heure à laquelle le nœud runtime d’intégration a été inscrit au format ISO8601.
status	SelfHostedIntegrationRuntimeNodeStatus	État du nœud runtime d’intégration.
version	string	Version du nœud runtime d’intégration.
versionStatus	string	État de la version du nœud runtime d’intégration.

SelfHostedIntegrationRuntimeNodeStatus

État du nœud runtime d’intégration.

Nom	Type	Description
InitializeFailed	string
Initializing	string
Limited	string
NeedRegistration	string
Offline	string
Online	string
Upgrading	string

SelfHostedIntegrationRuntimeStatus

État du runtime d’intégration auto-hébergé.

Nom	Type	Description
dataFactoryName	string	Nom de l’espace de travail auquel appartient le runtime d’intégration.
state	IntegrationRuntimeState	État du runtime d’intégration.
type	string: SelfHosted	Type de runtime d’intégration.
typeProperties.autoUpdate	IntegrationRuntimeAutoUpdate	Indique si la mise à jour automatique du runtime d’intégration auto-hébergée a été activée.
typeProperties.autoUpdateETA	string	Heure estimée à laquelle le runtime d’intégration auto-hébergé sera mis à jour.
typeProperties.capabilities	object	Objet avec des informations supplémentaires sur les fonctionnalités du runtime d’intégration.
typeProperties.createTime	string	Heure à laquelle le runtime d’intégration a été créé, au format ISO8601.
typeProperties.internalChannelEncryption	IntegrationRuntimeInternalChannelEncryptionMode	Il est utilisé pour définir le mode de chiffrement pour le canal de communication nœud-nœud (lorsque plus de 2 nœuds runtime d’intégration auto-hébergés existent).
typeProperties.latestVersion	string	Dernière version du centre de téléchargement.
typeProperties.links	LinkedIntegrationRuntime[]	Liste des runtimes d’intégration liés créés pour partager avec ce runtime d’intégration.
typeProperties.localTimeZoneOffset	string	Décalage de fuseau horaire local en heures.
typeProperties.nodeCommunicationChannelEncryptionMode	string	Mode de chiffrement du canal de communication de nœud
typeProperties.nodes	SelfHostedIntegrationRuntimeNode[]	Liste des nœuds pour ce runtime d’intégration.
typeProperties.pushedVersion	string	Version vers laquelle le runtime d’intégration va être mis à jour.
typeProperties.scheduledUpdateDate	string	Date à laquelle le runtime d’intégration sera planifié pour être mis à jour, au format ISO8601.
typeProperties.serviceUrls	string[]	URL des services utilisés dans le service principal du runtime d’intégration.
typeProperties.taskQueueId	string	ID de file d’attente de tâches du runtime d’intégration.
typeProperties.updateDelayOffset	string	Heure de la date planifiée par service pour mettre à jour le runtime d’intégration, par exemple, PT03H est de 3 heures
typeProperties.version	string	Version du runtime d’intégration.
typeProperties.versionStatus	string	État de la version du runtime d’intégration.