Integration Runtimes - Start

Servicio:: Synapse

Versión de la API:: 2021-06-01

Inicio del entorno de ejecución de integración
Inicio de un entorno de ejecución de integración

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
integrationRuntimeName	path	True	string	Nombre del entorno de ejecución de integración
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
workspaceName	path	True	string	Nombre del área de trabajo.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	IntegrationRuntimeStatusResponse	De acuerdo.
202 Accepted		Aceptado.
Other Status Codes	ErrorResponse	Respuesta de error recibida del servicio Azure Synapse.

Ejemplos

Start integration runtime

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
    }
  }
}

status code:: 202

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
IntegrationRuntimeAutoUpdate	Estado de la actualización automática del entorno de ejecución de integración.
IntegrationRuntimeInternalChannelEncryptionMode	Se usa para establecer el modo de cifrado para el canal de comunicación de nodo-nodo (cuando existen más de 2 nodos del entorno de ejecución de integración autohospedado).
IntegrationRuntimeState	Estado del entorno de ejecución de integración.
IntegrationRuntimeStatusResponse	Respuesta de estado del entorno de ejecución de integración.
IntegrationRuntimeType	Tipo de entorno de ejecución de integración.
IntegrationRuntimeUpdateResult	Resultado de la última actualización del nodo de Integration Runtime.
LinkedIntegrationRuntime	Información del entorno de ejecución de integración vinculado.
ManagedIntegrationRuntimeError	Definición de error para el entorno de ejecución de integración administrado.
ManagedIntegrationRuntimeNode	Propiedades del nodo integration Runtime.
ManagedIntegrationRuntimeNodeStatus	Estado del nodo del entorno de ejecución de integración administrado.
ManagedIntegrationRuntimeOperationResult	Propiedades del resultado de la operación del entorno de ejecución de integración administrado.
ManagedIntegrationRuntimeStatus	Estado del entorno de ejecución de integración administrado.
SelfHostedIntegrationRuntimeNode	Propiedades del nodo del entorno de ejecución de integración autohospedado.
SelfHostedIntegrationRuntimeNodeStatus	Estado del nodo de Integration Runtime.
SelfHostedIntegrationRuntimeStatus	Estado del entorno de ejecución de integración autohospedado.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

IntegrationRuntimeAutoUpdate

Enumeración

Estado de la actualización automática del entorno de ejecución de integración.

Valor	Description
On
Off

IntegrationRuntimeInternalChannelEncryptionMode

Enumeración

Se usa para establecer el modo de cifrado para el canal de comunicación de nodo-nodo (cuando existen más de 2 nodos del entorno de ejecución de integración autohospedado).

Valor	Description
NotSet
SslEncrypted
NotEncrypted

IntegrationRuntimeState

Enumeración

Estado del entorno de ejecución de integración.

Valor	Description
Initial
Stopped
Started
Starting
Stopping
NeedRegistration
Online
Limited
Offline
AccessDenied

IntegrationRuntimeStatusResponse

Object

Respuesta de estado del entorno de ejecución de integración.

Nombre	Tipo	Description
name	string	Nombre del entorno de ejecución de integración.
properties	IntegrationRuntimeStatus: ManagedIntegrationRuntimeStatus SelfHostedIntegrationRuntimeStatus	Propiedades de Integration Runtime.

IntegrationRuntimeType

Enumeración

Tipo de entorno de ejecución de integración.

Valor	Description
Managed
SelfHosted

IntegrationRuntimeUpdateResult

Enumeración

Resultado de la última actualización del nodo de Integration Runtime.

Valor	Description
None
Succeed
Fail

LinkedIntegrationRuntime

Object

Información del entorno de ejecución de integración vinculado.

Nombre	Tipo	Description
createTime	string (date-time)	Tiempo de creación del entorno de ejecución de integración vinculado.
dataFactoryLocation	string	Ubicación del área de trabajo a la que pertenece el entorno de ejecución de integración vinculado.
dataFactoryName	string	Nombre del área de trabajo a la que pertenece el entorno de ejecución de integración vinculado.
name	string	Nombre del entorno de ejecución de integración vinculado.
subscriptionId	string	Identificador de suscripción al que pertenece el entorno de ejecución de integración vinculado.

ManagedIntegrationRuntimeError

Object

Definición de error para el entorno de ejecución de integración administrado.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error.
parameters	string[]	Parámetros de error de Integration Runtime administrados.
time	string (date-time)	Hora en que se produjo el error.

ManagedIntegrationRuntimeNode

Object

Propiedades del nodo integration Runtime.

Nombre	Tipo	Description
errors	ManagedIntegrationRuntimeError[]	Errores que se produjeron en este nodo de Integration Runtime.
nodeId	string	Identificador del nodo del entorno de ejecución de integración administrado.
status	ManagedIntegrationRuntimeNodeStatus	Estado del nodo del entorno de ejecución de integración administrado.

ManagedIntegrationRuntimeNodeStatus

Enumeración

Estado del nodo del entorno de ejecución de integración administrado.

Valor	Description
Starting
Available
Recycling
Unavailable

ManagedIntegrationRuntimeOperationResult

Object

Propiedades del resultado de la operación del entorno de ejecución de integración administrado.

Nombre	Tipo	Description
activityId	string	Identificador de actividad de la solicitud de operación.
errorCode	string	Código de error.
parameters	string[]	Parámetros de error de Integration Runtime administrados.
result	string	Resultado de la operación.
startTime	string (date-time)	Hora de inicio de la operación.
type	string	Tipo de operación. Podría iniciarse o detenerse.

ManagedIntegrationRuntimeStatus

Object

Estado del entorno de ejecución de integración administrado.

Nombre	Tipo	Description
dataFactoryName	string	Nombre del área de trabajo a la que pertenece el entorno de ejecución de integración.
state	IntegrationRuntimeState	Estado del entorno de ejecución de integración.
type	string: Managed	Tipo de entorno de ejecución de integración.
typeProperties.createTime	string (date-time)	Hora en la que se creó el entorno de ejecución de integración, en ISO8601 formato.
typeProperties.lastOperation	ManagedIntegrationRuntimeOperationResult	El último resultado de la operación que se produjo en este entorno de ejecución de integración.
typeProperties.nodes	ManagedIntegrationRuntimeNode[]	La lista de nodos para el entorno de ejecución de integración administrado.
typeProperties.otherErrors	ManagedIntegrationRuntimeError[]	Errores que se produjeron en este entorno de ejecución de integración.

SelfHostedIntegrationRuntimeNode

Object

Propiedades del nodo del entorno de ejecución de integración autohospedado.

Nombre	Tipo	Description
capabilities	object	Diccionario de funcionalidades del entorno de ejecución de integración
concurrentJobsLimit	integer (int32)	Número máximo de trabajos simultáneos en el nodo de Integration Runtime.
expiryTime	string (date-time)	Hora en la que el entorno de ejecución de integración expirará en ISO8601 formato.
hostServiceUri	string	URI para la máquina host del entorno de ejecución de integración.
isActiveDispatcher	boolean	Indica si este nodo es el distribuidor activo para las solicitudes de Integration Runtime.
lastConnectTime	string (date-time)	La hora más reciente en la que se conectó el entorno de ejecución de integración en ISO8601 formato.
lastEndUpdateTime	string (date-time)	La última vez que finalice la actualización del nodo de Integration Runtime.
lastStartTime	string (date-time)	Hora en que se inició el nodo por última vez.
lastStartUpdateTime	string (date-time)	La última vez que se inicie la actualización del nodo de Integration Runtime.
lastStopTime	string (date-time)	Hora de última detención del nodo del entorno de ejecución de integración.
lastUpdateResult	IntegrationRuntimeUpdateResult	Resultado de la última actualización del nodo de Integration Runtime.
machineName	string	Nombre del equipo del nodo de Integration Runtime.
maxConcurrentJobs	integer (int32)	Los trabajos simultáneos máximos en este entorno de ejecución de integración.
nodeName	string	Nombre del nodo de Integration Runtime.
registerTime	string (date-time)	Hora en la que se registró el nodo de Integration Runtime en ISO8601 formato.
status	SelfHostedIntegrationRuntimeNodeStatus	Estado del nodo de Integration Runtime.
version	string	Versión del nodo de Integration Runtime.
versionStatus	string	Estado de la versión del nodo de Integration Runtime.

SelfHostedIntegrationRuntimeNodeStatus

Enumeración

Estado del nodo de Integration Runtime.

Valor	Description
NeedRegistration
Online
Limited
Offline
Upgrading
Initializing
InitializeFailed

SelfHostedIntegrationRuntimeStatus

Object

Estado del entorno de ejecución de integración autohospedado.

Nombre	Tipo	Description
dataFactoryName	string	Nombre del área de trabajo a la que pertenece el entorno de ejecución de integración.
state	IntegrationRuntimeState	Estado del entorno de ejecución de integración.
type	string: SelfHosted	Tipo de entorno de ejecución de integración.
typeProperties.autoUpdate	IntegrationRuntimeAutoUpdate	Indica si se ha activado la actualización automática del entorno de ejecución de integración autohospedado.
typeProperties.autoUpdateETA	string (date-time)	Tiempo estimado en el que se actualizará el entorno de ejecución de integración autohospedado.
typeProperties.capabilities	object	Objeto con información adicional sobre las funcionalidades del entorno de ejecución de integración.
typeProperties.createTime	string (date-time)	Hora en la que se creó el entorno de ejecución de integración, en ISO8601 formato.
typeProperties.internalChannelEncryption	IntegrationRuntimeInternalChannelEncryptionMode	Se usa para establecer el modo de cifrado para el canal de comunicación de nodo-nodo (cuando existen más de 2 nodos del entorno de ejecución de integración autohospedado).
typeProperties.latestVersion	string	La versión más reciente en el centro de descarga.
typeProperties.links	LinkedIntegrationRuntime[]	Lista de entornos de ejecución de integración vinculados que se crean para compartir con este entorno de ejecución de integración.
typeProperties.localTimeZoneOffset	string	Desplazamiento de zona horaria local en horas.
typeProperties.nodeCommunicationChannelEncryptionMode	string	Modo de cifrado de canal de comunicación de nodo
typeProperties.nodes	SelfHostedIntegrationRuntimeNode[]	Lista de nodos para este entorno de ejecución de integración.
typeProperties.pushedVersion	string	Versión a la que se va a actualizar el entorno de ejecución de integración.
typeProperties.scheduledUpdateDate	string (date-time)	Fecha en la que se programará la actualización del entorno de ejecución de integración, en ISO8601 formato.
typeProperties.serviceUrls	string[]	Las direcciones URL de los servicios usados en el servicio back-end de Integration Runtime.
typeProperties.taskQueueId	string	Identificador de cola de tareas del entorno de ejecución de integración.
typeProperties.updateDelayOffset	string	La hora en la fecha programada por el servicio para actualizar el entorno de ejecución de integración, por ejemplo, PT03H es de 3 horas.
typeProperties.version	string	Versión del entorno de ejecución de integración.
typeProperties.versionStatus	string	Estado de la versión de Integration Runtime.