Condividi tramite


Integration Runtimes - Get

Ottenere il runtime di integrazione
Ottenere un runtime di integrazione

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
integrationRuntimeName
path True

string

Nome del runtime di integrazione

resourceGroupName
path True

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

subscriptionId
path True

string

ID della sottoscrizione di destinazione.

workspaceName
path True

string

Nome dell'area di lavoro.

api-version
query True

string

Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome Necessario Tipo Descrizione
If-None-Match

string

ETag dell'entità del runtime di integrazione. Deve essere specificato solo per get. Se L'ETag corrisponde al tag di entità esistente o se * è stato specificato, non verrà restituito alcun contenuto.

Risposte

Nome Tipo Descrizione
200 OK

IntegrationRuntimeResource

OK.

Other Status Codes

Non modificato.

Other Status Codes

ErrorResponse

Risposta di errore ricevuta dall'operazione get del runtime di integrazione.

Esempio

Get integration runtime

Esempio di richiesta

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

Risposta di esempio

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"
}
{
  "error": {
    "code": "Error code",
    "message": "Error message"
  }
}

Definizioni

Nome Descrizione
DataFlowComputeType

Tipo di calcolo del cluster che eseguirà il processo del flusso di dati.

EntityReference

Riferimento all'entità.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

ErrorDetail

Dettagli dell'errore.

ErrorResponse

Risposta di errore

IntegrationRuntimeComputeProperties

Proprietà delle risorse di calcolo per il runtime di integrazione gestita.

IntegrationRuntimeCustomerVirtualNetwork

Definizione e proprietà della rete virtuale a cui verrà aggiunto Azure-SSIS runtime di integrazione.

IntegrationRuntimeCustomSetupScriptProperties

Proprietà dello script di installazione personalizzate per un runtime di integrazione dedicato gestito.

IntegrationRuntimeDataFlowProperties

Proprietà del flusso di dati per il runtime di integrazione gestita.

IntegrationRuntimeDataProxyProperties

Proprietà proxy dati per un runtime di integrazione dedicato gestito.

IntegrationRuntimeEdition

Edizione per SSIS Integration Runtime

IntegrationRuntimeEntityReferenceType

Tipo di questa entità a cui si fa riferimento.

IntegrationRuntimeLicenseType

Tipo di licenza per l'uso di uno scenario di licenza personalizzato.

IntegrationRuntimeResource

Tipo di risorsa del runtime di integrazione.

IntegrationRuntimeSsisCatalogInfo

Informazioni sul catalogo per il runtime di integrazione dedicato gestito.

IntegrationRuntimeSsisCatalogPricingTier

Piano tariffario per il database di catalogo. I valori validi sono disponibili in https://azure.microsoft.com/en-us/pricing/details/sql-database/

IntegrationRuntimeSsisProperties

Proprietà SSIS per il runtime di integrazione gestita.

IntegrationRuntimeState

Stato del runtime di integrazione.

IntegrationRuntimeType

Tipo di runtime di integrazione.

IntegrationRuntimeVNetProperties

Proprietà della rete virtuale per il runtime di integrazione gestita.

LinkedIntegrationRuntimeKeyAuthorization

Runtime di integrazione del tipo di autorizzazione della chiave.

LinkedIntegrationRuntimeRbacAuthorization

Runtime di integrazione del tipo di autorizzazione controllo degli accessi in base al ruolo.

ManagedIntegrationRuntime

Runtime di integrazione gestita, inclusi i runtime di integrazione dedicati gestiti e elastici gestiti.

SecureString

Definizione di stringa sicura di Azure Synapse. Il valore stringa verrà mascherato con asterischi '*' durante le chiamate API Get o List.

SelfHostedIntegrationRuntime

Runtime di integrazione self-hosted.

DataFlowComputeType

Tipo di calcolo del cluster che eseguirà il processo del flusso di dati.

Nome Tipo Descrizione
ComputeOptimized

string

General

string

MemoryOptimized

string

EntityReference

Riferimento all'entità.

Nome Tipo Descrizione
referenceName

string

Nome di questa entità a cui si fa riferimento.

type

IntegrationRuntimeEntityReferenceType

Tipo di questa entità a cui si fa riferimento.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.

type

string

Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.

code

string

Codice di errore.

details

ErrorDetail[]

Dettagli dell'errore.

message

string

Messaggio di errore.

target

string

Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.

IntegrationRuntimeComputeProperties

Proprietà delle risorse di calcolo per il runtime di integrazione gestita.

Nome Tipo Descrizione
dataFlowProperties

IntegrationRuntimeDataFlowProperties

Proprietà del flusso di dati per il runtime di integrazione gestita.

location

string

Percorso per il runtime di integrazione gestita. Le aree supportate sono disponibili in https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities

maxParallelExecutionsPerNode

integer

Numero massimo di esecuzioni parallele per nodo per il runtime di integrazione gestita.

nodeSize

string

Requisito delle dimensioni del nodo per il runtime di integrazione gestito.

numberOfNodes

integer

Numero necessario di nodi per il runtime di integrazione gestita.

vNetProperties

IntegrationRuntimeVNetProperties

Proprietà della rete virtuale per il runtime di integrazione gestita.

IntegrationRuntimeCustomerVirtualNetwork

Definizione e proprietà della rete virtuale a cui verrà aggiunto Azure-SSIS runtime di integrazione.

Nome Tipo Descrizione
subnetId

string

ID della subnet a cui verrà aggiunto Azure-SSIS runtime di integrazione.

IntegrationRuntimeCustomSetupScriptProperties

Proprietà dello script di installazione personalizzate per un runtime di integrazione dedicato gestito.

Nome Tipo Descrizione
blobContainerUri

string

URI del contenitore BLOB di Azure che contiene lo script di installazione personalizzato.

sasToken

SecureString

Token di firma di accesso condiviso del contenitore BLOB di Azure.

IntegrationRuntimeDataFlowProperties

Proprietà del flusso di dati per il runtime di integrazione gestita.

Nome Tipo Descrizione
computeType

DataFlowComputeType

Tipo di calcolo del cluster che eseguirà il processo del flusso di dati.

coreCount

integer

Numero di core del cluster che eseguirà il processo del flusso di dati. I valori supportati sono: 8, 16, 32, 48, 80, 144 e 272.

timeToLive

integer

Impostazione durata (in minuti) del cluster che eseguirà il processo del flusso di dati.

IntegrationRuntimeDataProxyProperties

Proprietà proxy dati per un runtime di integrazione dedicato gestito.

Nome Tipo Descrizione
connectVia

EntityReference

Riferimento al runtime di integrazione self-hosted.

path

string

Percorso in cui contenere i dati di gestione temporanea nell'archivio BLOB.

stagingLinkedService

EntityReference

Informazioni di riferimento sul servizio collegato di staging.

IntegrationRuntimeEdition

Edizione per SSIS Integration Runtime

Nome Tipo Descrizione
Enterprise

string

Standard

string

IntegrationRuntimeEntityReferenceType

Tipo di questa entità a cui si fa riferimento.

Nome Tipo Descrizione
IntegrationRuntimeReference

string

LinkedServiceReference

string

IntegrationRuntimeLicenseType

Tipo di licenza per l'uso di uno scenario di licenza personalizzato.

Nome Tipo Descrizione
BasePrice

string

LicenseIncluded

string

IntegrationRuntimeResource

Tipo di risorsa del runtime di integrazione.

Nome Tipo Descrizione
etag

string

Etag risorsa.

id

string

ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Nome della risorsa

properties IntegrationRuntime:

Proprietà del runtime di integrazione.

type

string

Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

IntegrationRuntimeSsisCatalogInfo

Informazioni sul catalogo per il runtime di integrazione dedicato gestito.

Nome Tipo Descrizione
catalogAdminPassword

SecureString

Password dell'account utente amministratore del database del catalogo.

catalogAdminUserName

string

Nome utente amministratore del database di catalogo.

catalogPricingTier

IntegrationRuntimeSsisCatalogPricingTier

Piano tariffario per il database di catalogo. I valori validi sono disponibili in https://azure.microsoft.com/en-us/pricing/details/sql-database/

catalogServerEndpoint

string

URL del server di database del catalogo.

IntegrationRuntimeSsisCatalogPricingTier

Piano tariffario per il database di catalogo. I valori validi sono disponibili in https://azure.microsoft.com/en-us/pricing/details/sql-database/

Nome Tipo Descrizione
Basic

string

Premium

string

PremiumRS

string

Standard

string

IntegrationRuntimeSsisProperties

Proprietà SSIS per il runtime di integrazione gestita.

Nome Tipo Descrizione
catalogInfo

IntegrationRuntimeSsisCatalogInfo

Informazioni sul catalogo per il runtime di integrazione dedicato gestito.

customSetupScriptProperties

IntegrationRuntimeCustomSetupScriptProperties

Proprietà dello script di installazione personalizzate per un runtime di integrazione dedicato gestito.

dataProxyProperties

IntegrationRuntimeDataProxyProperties

Proprietà proxy dati per un runtime di integrazione dedicato gestito.

edition

IntegrationRuntimeEdition

Edizione per SSIS Integration Runtime

expressCustomSetupProperties

CustomSetupBase[]

Installazione personalizzata senza proprietà script per un runtime di integrazione SSIS.

licenseType

IntegrationRuntimeLicenseType

Tipo di licenza per l'uso di uno scenario di licenza personalizzato.

IntegrationRuntimeState

Stato del runtime di integrazione.

Nome Tipo Descrizione
AccessDenied

string

Initial

string

Limited

string

NeedRegistration

string

Offline

string

Online

string

Started

string

Starting

string

Stopped

string

Stopping

string

IntegrationRuntimeType

Tipo di runtime di integrazione.

Nome Tipo Descrizione
Managed

string

SelfHosted

string

IntegrationRuntimeVNetProperties

Proprietà della rete virtuale per il runtime di integrazione gestita.

Nome Tipo Descrizione
publicIPs

string[]

ID risorsa degli indirizzi IP pubblici che verrà usato da questo runtime di integrazione.

subnet

string

Nome della subnet a cui verrà aggiunto questo runtime di integrazione.

subnetId

string

ID della subnet a cui verrà aggiunto questo runtime di integrazione Azure-SSIS.

vNetId

string

ID della rete virtuale a cui verrà aggiunto questo runtime di integrazione.

LinkedIntegrationRuntimeKeyAuthorization

Runtime di integrazione del tipo di autorizzazione della chiave.

Nome Tipo Descrizione
authorizationType string:

Key

Tipo di autorizzazione per la condivisione del runtime di integrazione.

key

SecureString

Chiave utilizzata per l'autorizzazione.

LinkedIntegrationRuntimeRbacAuthorization

Runtime di integrazione del tipo di autorizzazione controllo degli accessi in base al ruolo.

Nome Tipo Descrizione
authorizationType string:

RBAC

Tipo di autorizzazione per la condivisione del runtime di integrazione.

resourceId

string

Identificatore della risorsa del runtime di integrazione da condividere.

ManagedIntegrationRuntime

Runtime di integrazione gestita, inclusi i runtime di integrazione dedicati gestiti e elastici gestiti.

Nome Tipo Descrizione
description

string

Descrizione del runtime di integrazione.

managedVirtualNetwork.id

string

ID della rete virtuale gestita.

managedVirtualNetwork.referenceName

string

Nome di riferimento della rete virtuale gestita

managedVirtualNetwork.type

string

Tipo della rete virtuale gestita.

provisioningState

IntegrationRuntimeState

Stato del runtime di integrazione valido solo per il runtime di integrazione dedicato gestito.

type string:

Managed

Tipo di runtime di integrazione.

typeProperties.computeProperties

IntegrationRuntimeComputeProperties

Risorsa di calcolo per il runtime di integrazione gestita.

typeProperties.customerVirtualNetwork

IntegrationRuntimeCustomerVirtualNetwork

Nome della rete virtuale a cui verrà aggiunto Azure-SSIS runtime di integrazione

typeProperties.ssisProperties

IntegrationRuntimeSsisProperties

Proprietà SSIS per il runtime di integrazione gestita.

SecureString

Definizione di stringa sicura di Azure Synapse. Il valore stringa verrà mascherato con asterischi '*' durante le chiamate API Get o List.

Nome Tipo Descrizione
type string:

SecureString

Tipo del segreto.

value

string

Valore della stringa protetta.

SelfHostedIntegrationRuntime

Runtime di integrazione self-hosted.

Nome Tipo Descrizione
description

string

Descrizione del runtime di integrazione.

type string:

SelfHosted

Tipo di runtime di integrazione.

typeProperties.linkedInfo LinkedIntegrationRuntimeType:

Tipo di runtime di integrazione collegato da Data Factory