Compartir a través de

Integration Runtimes - Get

  • Referencia
Servicio:
Synapse
Versión de la API:
2021-06-01

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}?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

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId
 path True

string

Identificador de la suscripción de destino.
workspaceName
 path True

string

Nombre del área de trabajo.
api-version
 query True

string

Versión de la API que se va a usar para esta operación.

Encabezado de la solicitud

Nombre Requerido Tipo Description
If-None-Match

string

ETag de la entidad integration Runtime. Solo se debe especificar para get. Si el ETag coincide con la etiqueta de entidad existente, o si se proporcionó *, no se devolverá ningún contenido.

Respuestas

Nombre Tipo Description
200 OK

IntegrationRuntimeResource

De acuerdo.
Other Status Codes

No modificado.
Other Status Codes

ErrorResponse

Respuesta de error recibida de la operación GET integration Runtime.

Ejemplos

Get integration runtime

Solicitud de ejemplo

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

Respuesta de muestra

status code:
200 
Date: Mon, 22 Apr 2019 18:33:47 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 11997
x-ms-request-id: ad824326-e577-4a47-a092-2e621c4d59d9
x-ms-correlation-request-id: ad824326-e577-4a47-a092-2e621c4d59d9
{
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/integrationruntimes/exampleIntegrationRuntime",
  "name": "exampleIntegrationRuntime",
  "type": "Microsoft.Synapse/workspaces/integrationruntimes",
  "properties": {
    "type": "SelfHosted",
    "description": "A selfhosted integration runtime"
  },
  "etag": "15003c4f-0000-0200-0000-5cbe090b0000"
}
status code:
304
status code:
default 
{
  "error": {
    "code": "Error code",
    "message": "Error message"
  }
}

Definiciones

Nombre Description
DataFlowComputeType

Tipo de proceso del clúster que ejecutará el trabajo de flujo de datos.
EntityReference

Referencia de entidad.
ErrorAdditionalInfo

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

Detalle del error.
ErrorResponse

Respuesta de error
IntegrationRuntimeComputeProperties

Propiedades de recursos de proceso para managed integration Runtime.
IntegrationRuntimeCustomerVirtualNetwork

Definición y propiedades de la red virtual a la que se unirá Azure-SSIS integration Runtime.
IntegrationRuntimeCustomSetupScriptProperties

Propiedades del script de instalación personalizada para un entorno de ejecución de integración dedicado administrado.
IntegrationRuntimeDataFlowProperties

Propiedades de flujo de datos para el entorno de ejecución de integración administrado.
IntegrationRuntimeDataProxyProperties

Propiedades de proxy de datos para un entorno de ejecución de integración dedicado administrado.
IntegrationRuntimeEdition

Edición de SSIS Integration Runtime
IntegrationRuntimeEntityReferenceType

Tipo de esta entidad a la que se hace referencia.
IntegrationRuntimeLicenseType

Tipo de licencia para traer su propio escenario de licencia.
IntegrationRuntimeResource

Tipo de recurso de Integration Runtime.
IntegrationRuntimeSsisCatalogInfo

Información del catálogo para el entorno de ejecución de integración dedicado administrado.
IntegrationRuntimeSsisCatalogPricingTier

Plan de tarifa de la base de datos de catálogo. Los valores válidos se pueden encontrar en https://azure.microsoft.com/en-us/pricing/details/sql-database/
IntegrationRuntimeSsisProperties

Propiedades de SSIS para el entorno de ejecución de integración administrado.
IntegrationRuntimeState

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

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

Propiedades de red virtual para el entorno de ejecución de integración administrado.
LinkedIntegrationRuntimeKeyAuthorization

El tipo de autorización de clave integration Runtime.
LinkedIntegrationRuntimeRbacAuthorization

El tipo de autorización de control de acceso basado en rol (RBAC) integration Runtime.
ManagedIntegrationRuntime

Entorno de ejecución de integración administrado, incluidos los entornos de ejecución de integración dedicados administrados y el elásticos administrados.
SecureString

Definición de cadena segura de Azure Synapse. El valor de cadena se enmascarará con asteriscos '*' durante las llamadas API Get o List.
SelfHostedIntegrationRuntime

Entorno de ejecución de integración autohospedado.

DataFlowComputeType

Tipo de proceso del clúster que ejecutará el trabajo de flujo de datos.

Nombre Tipo Description
ComputeOptimized

string

General

string

MemoryOptimized

string

EntityReference

Referencia de entidad.

Nombre Tipo Description
referenceName

string

Nombre de esta entidad a la que se hace referencia.
type

IntegrationRuntimeEntityReferenceType

Tipo de esta entidad a la que se hace referencia.

ErrorAdditionalInfo

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

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

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

IntegrationRuntimeComputeProperties

Propiedades de recursos de proceso para managed integration Runtime.

Nombre Tipo Description
dataFlowProperties

IntegrationRuntimeDataFlowProperties

Propiedades de flujo de datos para el entorno de ejecución de integración administrado.
location

string

Ubicación del entorno de ejecución de integración administrado. Las regiones admitidas se pueden encontrar en https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities
maxParallelExecutionsPerNode

integer

Número máximo de ejecuciones paralelas por nodo para el entorno de ejecución de integración administrado.
nodeSize

string

Requisito de tamaño de nodo para el entorno de ejecución de integración administrado.
numberOfNodes

integer

El número necesario de nodos para el entorno de ejecución de integración administrado.
vNetProperties

IntegrationRuntimeVNetProperties

Propiedades de red virtual para el entorno de ejecución de integración administrado.

IntegrationRuntimeCustomerVirtualNetwork

Definición y propiedades de la red virtual a la que se unirá Azure-SSIS integration Runtime.

Nombre Tipo Description
subnetId

string

Identificador de la subred a la que se unirá Azure-SSIS integration Runtime.

IntegrationRuntimeCustomSetupScriptProperties

Propiedades del script de instalación personalizada para un entorno de ejecución de integración dedicado administrado.

Nombre Tipo Description
blobContainerUri

string

URI del contenedor de blobs de Azure que contiene el script de instalación personalizado.
sasToken

SecureString

Token de SAS del contenedor de blobs de Azure.

IntegrationRuntimeDataFlowProperties

Propiedades de flujo de datos para el entorno de ejecución de integración administrado.

Nombre Tipo Description
computeType

DataFlowComputeType

Tipo de proceso del clúster que ejecutará el trabajo de flujo de datos.
coreCount

integer

Recuento básico del clúster que ejecutará el trabajo de flujo de datos. Los valores admitidos son: 8, 16, 32, 48, 80, 144 y 272.
timeToLive

integer

Configuración de período de vida (en minutos) del clúster que ejecutará el trabajo de flujo de datos.

IntegrationRuntimeDataProxyProperties

Propiedades de proxy de datos para un entorno de ejecución de integración dedicado administrado.

Nombre Tipo Description
connectVia

EntityReference

Referencia del entorno de ejecución de integración autohospedado.
path

string

Ruta de acceso que contiene los datos almacenados provisionalmente en Blob Storage.
stagingLinkedService

EntityReference

Referencia del servicio vinculado de almacenamiento provisional.

IntegrationRuntimeEdition

Edición de SSIS Integration Runtime

Nombre Tipo Description
Enterprise

string

Standard

string

IntegrationRuntimeEntityReferenceType

Tipo de esta entidad a la que se hace referencia.

Nombre Tipo Description
IntegrationRuntimeReference

string

LinkedServiceReference

string

IntegrationRuntimeLicenseType

Tipo de licencia para traer su propio escenario de licencia.

Nombre Tipo Description
BasePrice

string

LicenseIncluded

string

IntegrationRuntimeResource

Tipo de recurso de Integration Runtime.

Nombre Tipo Description
etag

string

Etag de recursos.
id

string

Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Nombre del recurso
properties IntegrationRuntime:

Propiedades de Integration Runtime.
type

string

Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

IntegrationRuntimeSsisCatalogInfo

Información del catálogo para el entorno de ejecución de integración dedicado administrado.

Nombre Tipo Description
catalogAdminPassword

SecureString

Contraseña de la cuenta de usuario administrador de la base de datos del catálogo.
catalogAdminUserName

string

Nombre de usuario de administrador de la base de datos de catálogo.
catalogPricingTier

IntegrationRuntimeSsisCatalogPricingTier

Plan de tarifa de la base de datos de catálogo. Los valores válidos se pueden encontrar en https://azure.microsoft.com/en-us/pricing/details/sql-database/
catalogServerEndpoint

string

Dirección URL del servidor de base de datos del catálogo.

IntegrationRuntimeSsisCatalogPricingTier

Plan de tarifa de la base de datos de catálogo. Los valores válidos se pueden encontrar en https://azure.microsoft.com/en-us/pricing/details/sql-database/

Nombre Tipo Description
Basic

string

Premium

string

PremiumRS

string

Standard

string

IntegrationRuntimeSsisProperties

Propiedades de SSIS para el entorno de ejecución de integración administrado.

Nombre Tipo Description
catalogInfo

IntegrationRuntimeSsisCatalogInfo

Información del catálogo para el entorno de ejecución de integración dedicado administrado.
customSetupScriptProperties

IntegrationRuntimeCustomSetupScriptProperties

Propiedades del script de instalación personalizada para un entorno de ejecución de integración dedicado administrado.
dataProxyProperties

IntegrationRuntimeDataProxyProperties

Propiedades de proxy de datos para un entorno de ejecución de integración dedicado administrado.
edition

IntegrationRuntimeEdition

Edición de SSIS Integration Runtime
expressCustomSetupProperties

CustomSetupBase[]

Configuración personalizada sin propiedades de script para un entorno de ejecución de integración de SSIS.
licenseType

IntegrationRuntimeLicenseType

Tipo de licencia para traer su propio escenario de licencia.

IntegrationRuntimeState

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

Nombre Tipo Description
AccessDenied

string

Initial

string

Limited

string

NeedRegistration

string

Offline

string

Online

string

Started

string

Starting

string

Stopped

string

Stopping

string

IntegrationRuntimeType

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

Nombre Tipo Description
Managed

string

SelfHosted

string

IntegrationRuntimeVNetProperties

Propiedades de red virtual para el entorno de ejecución de integración administrado.

Nombre Tipo Description
publicIPs

string[]

Identificadores de recursos de las direcciones IP públicas que usará este entorno de ejecución de integración.
subnet

string

Nombre de la subred a la que se unirá este entorno de ejecución de integración.
subnetId

string

El identificador de la subred, al que se unirá este Azure-SSIS integration Runtime.
vNetId

string

Identificador de la red virtual a la que se unirá este entorno de ejecución de integración.

LinkedIntegrationRuntimeKeyAuthorization

El tipo de autorización de clave integration Runtime.

Nombre Tipo Description
authorizationType string:

Key

Tipo de autorización para el uso compartido de Integration Runtime.
key

SecureString

Clave que se usa para la autorización.

LinkedIntegrationRuntimeRbacAuthorization

El tipo de autorización de control de acceso basado en rol (RBAC) integration Runtime.

Nombre Tipo Description
authorizationType string:

RBAC

Tipo de autorización para el uso compartido de Integration Runtime.
resourceId

string

Identificador de recurso del entorno de ejecución de integración que se va a compartir.

ManagedIntegrationRuntime

Entorno de ejecución de integración administrado, incluidos los entornos de ejecución de integración dedicados administrados y el elásticos administrados.

Nombre Tipo Description
description

string

Descripción del entorno de ejecución de integración.
managedVirtualNetwork.id

string

Identificador de la red virtual administrada.
managedVirtualNetwork.referenceName

string

Nombre de referencia de la red virtual administrada
managedVirtualNetwork.type

string

Tipo de la red virtual administrada.
provisioningState

IntegrationRuntimeState

Estado del entorno de ejecución de integración, solo válido para el entorno de ejecución de integración dedicado administrado.
type string:

Managed

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

IntegrationRuntimeComputeProperties

Recurso de proceso para el entorno de ejecución de integración administrado.
typeProperties.customerVirtualNetwork

IntegrationRuntimeCustomerVirtualNetwork

Nombre de la red virtual a la que se unirá Azure-SSIS integration Runtime.
typeProperties.ssisProperties

IntegrationRuntimeSsisProperties

Propiedades de SSIS para el entorno de ejecución de integración administrado.

SecureString

Definición de cadena segura de Azure Synapse. El valor de cadena se enmascarará con asteriscos '*' durante las llamadas API Get o List.

Nombre Tipo Description
type string:

SecureString

Tipo del secreto.
value

string

Valor de cadena segura.

SelfHostedIntegrationRuntime

Entorno de ejecución de integración autohospedado.

Nombre Tipo Description
description

string

Descripción del entorno de ejecución de integración.
type string:

SelfHosted

Tipo de entorno de ejecución de integración.
typeProperties.linkedInfo LinkedIntegrationRuntimeType:

Tipo de entorno de ejecución de integración vinculado de Data Factory