Integration Runtimes - Get

Dienst:: Synapse

API-Version:: 2021-06-01

Integrationslaufzeit abrufen
Abrufen einer Integrationslaufzeit

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
integrationRuntimeName	path	True	string	Name der Integrationslaufzeit
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
workspaceName	path	True	string	Der Name des Arbeitsbereichs.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
If-None-Match		string	ETag der Integrationslaufzeitentität. Sollte nur für get angegeben werden. Wenn das ETag mit dem vorhandenen Entitätstag übereinstimmt oder wenn * angegeben wurde, werden keine Inhalte zurückgegeben.

Antworten

Name	Typ	Beschreibung
200 OK	IntegrationRuntimeResource	OKAY.
Other Status Codes		Nicht geändert.
Other Status Codes	ErrorResponse	Eine Fehlerantwort, die vom GET-Integrations-Laufzeitvorgang empfangen wurde.

Beispiele

Get integration runtime

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

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

Statuscode:: 304

Statuscode:: default

{
  "error": {
    "code": "Error code",
    "message": "Error message"
  }
}

Definitionen

Name	Beschreibung
DataFlowComputeType	Computetyp des Clusters, der den Datenflussauftrag ausführt.
EntityReference	Der Entitätsverweis.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
IntegrationRuntimeComputeProperties	Die Computeressourceneigenschaften für die Laufzeit der verwalteten Integration.
IntegrationRuntimeCustomerVirtualNetwork	Definition und Eigenschaften des virtuellen Netzwerks, dem Azure-SSIS Integrationslaufzeit beitreten.
IntegrationRuntimeCustomSetupScriptProperties	Benutzerdefinierte Setupskripteigenschaften für eine verwaltete dedizierte Integrationslaufzeit.
IntegrationRuntimeDataFlowProperties	Datenflusseigenschaften für verwaltete Integrationslaufzeit.
IntegrationRuntimeDataProxyProperties	Datenproxyeigenschaften für eine verwaltete dedizierte Integrationslaufzeit.
IntegrationRuntimeEdition	Die Edition für die SSIS-Integrationslaufzeit
IntegrationRuntimeEntityReferenceType	Der Typ dieser Entität, auf die verwiesen wird.
IntegrationRuntimeLicenseType	Lizenztyp für die Bereitstellung Ihres eigenen Lizenzszenarios.
IntegrationRuntimeResource	Ressourcentyp der Integrationslaufzeit.
IntegrationRuntimeSsisCatalogInfo	Kataloginformationen für die verwaltete dedizierte Integrationslaufzeit.
IntegrationRuntimeSsisCatalogPricingTier	Die Preisstufe für die Katalogdatenbank. Die gültigen Werte wurden in https://azure.microsoft.com/en-us/pricing/details/sql-database/
IntegrationRuntimeSsisProperties	SSIS-Eigenschaften für die Laufzeit der verwalteten Integration.
IntegrationRuntimeState	Der Status der Integrationslaufzeit.
IntegrationRuntimeType	Der Typ der Integrationslaufzeit.
IntegrationRuntimeVNetProperties	VNet-Eigenschaften für verwaltete Integrationslaufzeit.
LinkedIntegrationRuntimeKeyAuthorization	Die Hauptintegrationslaufzeit des Autorisierungstyps.
LinkedIntegrationRuntimeRbacAuthorization	Die Integrationslaufzeit für die rollenbasierte Zugriffssteuerung (RBAC).
ManagedIntegrationRuntime	Verwaltete Integrationslaufzeit, einschließlich verwalteter elastischer und verwalteter dedizierter Integrationslaufzeiten.
SecureString	Definition der sicheren Azure Synapse-Zeichenfolge. Der Zeichenfolgenwert wird bei Get- oder List-API-Aufrufen mit Sternchen '*' maskiert.
SelfHostedIntegrationRuntime	Selbst gehostete Integrationslaufzeit.

DataFlowComputeType

Enumeration

Computetyp des Clusters, der den Datenflussauftrag ausführt.

Wert	Beschreibung
General
MemoryOptimized
ComputeOptimized

EntityReference

Objekt

Der Entitätsverweis.

Name	Typ	Beschreibung
referenceName	string	Der Name dieser Referenzentität.
type	IntegrationRuntimeEntityReferenceType	Der Typ dieser Entität, auf die verwiesen wird.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

IntegrationRuntimeComputeProperties

Objekt

Die Computeressourceneigenschaften für die Laufzeit der verwalteten Integration.

Name	Typ	Beschreibung
dataFlowProperties	IntegrationRuntimeDataFlowProperties	Datenflusseigenschaften für verwaltete Integrationslaufzeit.
location	string	Der Speicherort für die Laufzeit der verwalteten Integration. Die unterstützten Regionen finden Sie unter https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities
maxParallelExecutionsPerNode	integer (int32) minimum: 1	Maximale Anzahl paralleler Ausführungen pro Knoten für die Laufzeit der verwalteten Integration.
nodeSize	string	Die Knotengrößenanforderung für die verwaltete Integrationslaufzeit.
numberOfNodes	integer (int32) minimum: 1	Die erforderliche Anzahl von Knoten für die Laufzeit der verwalteten Integration.
vNetProperties	IntegrationRuntimeVNetProperties	VNet-Eigenschaften für verwaltete Integrationslaufzeit.

IntegrationRuntimeCustomerVirtualNetwork

Objekt

Definition und Eigenschaften des virtuellen Netzwerks, dem Azure-SSIS Integrationslaufzeit beitreten.

Name	Typ	Beschreibung
subnetId	string	Die ID des Subnetzes, zu dem Azure-SSIS Integrationslaufzeit beitreten wird.

IntegrationRuntimeCustomSetupScriptProperties

Objekt

Benutzerdefinierte Setupskripteigenschaften für eine verwaltete dedizierte Integrationslaufzeit.

Name	Typ	Beschreibung
blobContainerUri	string	Der URI des Azure-Blobcontainers, der das benutzerdefinierte Setupskript enthält.
sasToken	SecureString	Das SAS-Token des Azure-Blobcontainers.

IntegrationRuntimeDataFlowProperties

Objekt

Datenflusseigenschaften für verwaltete Integrationslaufzeit.

Name	Typ	Beschreibung
computeType	DataFlowComputeType	Computetyp des Clusters, der den Datenflussauftrag ausführt.
coreCount	integer (int32)	Die Kernanzahl des Clusters, der den Datenflussauftrag ausführt. Unterstützte Werte sind: 8, 16, 32, 48, 80, 144 und 272.
timeToLive	integer (int32) minimum: 0	Zeit für live (in Minuten) des Clusters, der den Datenflussauftrag ausführt.

IntegrationRuntimeDataProxyProperties

Objekt

Datenproxyeigenschaften für eine verwaltete dedizierte Integrationslaufzeit.

Name	Typ	Beschreibung
connectVia	EntityReference	Die selbst gehostete Integrationslaufzeitreferenz.
path	string	Der Pfad, der die mehrstufigen Daten im Blob-Speicher enthalten soll.
stagingLinkedService	EntityReference	Der Verweis auf den stagingverknüpften Dienst.

IntegrationRuntimeEdition

Enumeration

Die Edition für die SSIS-Integrationslaufzeit

Wert	Beschreibung
Standard
Enterprise

IntegrationRuntimeEntityReferenceType

Enumeration

Der Typ dieser Entität, auf die verwiesen wird.

Wert	Beschreibung
IntegrationRuntimeReference
LinkedServiceReference

IntegrationRuntimeLicenseType

Enumeration

Lizenztyp für die Bereitstellung Ihres eigenen Lizenzszenarios.

Wert	Beschreibung
BasePrice
LicenseIncluded

IntegrationRuntimeResource

Objekt

Ressourcentyp der Integrationslaufzeit.

Name	Typ	Beschreibung
etag	string	Ressourcen-Etag.
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties	IntegrationRuntime: ManagedIntegrationRuntime SelfHostedIntegrationRuntime	Integrationslaufzeiteigenschaften.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

IntegrationRuntimeSsisCatalogInfo

Objekt

Kataloginformationen für die verwaltete dedizierte Integrationslaufzeit.

Name	Typ	Beschreibung
catalogAdminPassword	SecureString	Das Kennwort des Administratorbenutzerkontos der Katalogdatenbank.
catalogAdminUserName	string minLength: 1 maxLength: 128	Der Administratorbenutzername der Katalogdatenbank.
catalogPricingTier	IntegrationRuntimeSsisCatalogPricingTier	Die Preisstufe für die Katalogdatenbank. Die gültigen Werte wurden in https://azure.microsoft.com/en-us/pricing/details/sql-database/
catalogServerEndpoint	string	Die Url des Katalogdatenbankservers.

IntegrationRuntimeSsisCatalogPricingTier

Enumeration

Die Preisstufe für die Katalogdatenbank. Die gültigen Werte wurden in https://azure.microsoft.com/en-us/pricing/details/sql-database/

Wert	Beschreibung
Basic
Standard
Premium
PremiumRS

IntegrationRuntimeSsisProperties

Objekt

SSIS-Eigenschaften für die Laufzeit der verwalteten Integration.

Name	Typ	Beschreibung
catalogInfo	IntegrationRuntimeSsisCatalogInfo	Kataloginformationen für die verwaltete dedizierte Integrationslaufzeit.
customSetupScriptProperties	IntegrationRuntimeCustomSetupScriptProperties	Benutzerdefinierte Setupskripteigenschaften für eine verwaltete dedizierte Integrationslaufzeit.
dataProxyProperties	IntegrationRuntimeDataProxyProperties	Datenproxyeigenschaften für eine verwaltete dedizierte Integrationslaufzeit.
edition	IntegrationRuntimeEdition	Die Edition für die SSIS-Integrationslaufzeit
expressCustomSetupProperties	CustomSetupBase[]	Benutzerdefiniertes Setup ohne Skripteigenschaften für eine SSIS-Integrationslaufzeit.
licenseType	IntegrationRuntimeLicenseType	Lizenztyp für die Bereitstellung Ihres eigenen Lizenzszenarios.

IntegrationRuntimeState

Enumeration

Der Status der Integrationslaufzeit.

Wert	Beschreibung
Initial
Stopped
Started
Starting
Stopping
NeedRegistration
Online
Limited
Offline
AccessDenied

IntegrationRuntimeType

Enumeration

Der Typ der Integrationslaufzeit.

Wert	Beschreibung
Managed
SelfHosted

IntegrationRuntimeVNetProperties

Objekt

VNet-Eigenschaften für verwaltete Integrationslaufzeit.

Name	Typ	Beschreibung
publicIPs	string[]	Ressourcen-IDs der öffentlichen IP-Adressen, die von dieser Integrationslaufzeit verwendet werden.
subnet	string	Der Name des Subnetzes, dem diese Integrationslaufzeit beitritt.
subnetId	string	Die ID des Subnetzes, mit dem diese Azure-SSIS Integrationslaufzeit verbunden wird.
vNetId	string	Die ID des VNet, dem diese Integrationslaufzeit beitritt.

LinkedIntegrationRuntimeKeyAuthorization

Objekt

Die Hauptintegrationslaufzeit des Autorisierungstyps.

Name	Typ	Beschreibung
authorizationType	string: Key	Der Autorisierungstyp für die Integrationslaufzeitfreigabe.
key	SecureString	Der für die Autorisierung verwendete Schlüssel.

LinkedIntegrationRuntimeRbacAuthorization

Objekt

Die Integrationslaufzeit für die rollenbasierte Zugriffssteuerung (RBAC).

Name	Typ	Beschreibung
authorizationType	string: RBAC	Der Autorisierungstyp für die Integrationslaufzeitfreigabe.
resourceId	string	Der Ressourcenbezeichner der integrationslaufzeit, die freigegeben werden soll.

ManagedIntegrationRuntime

Objekt

Verwaltete Integrationslaufzeit, einschließlich verwalteter elastischer und verwalteter dedizierter Integrationslaufzeiten.

Name	Typ	Beschreibung
description	string	Beschreibung der Integrationslaufzeit.
managedVirtualNetwork.id	string	Die ID des verwalteten virtuellen Netzwerks.
managedVirtualNetwork.referenceName	string	Der Verweisname des verwalteten virtuellen Netzwerks
managedVirtualNetwork.type	string	Der Typ des verwalteten virtuellen Netzwerks.
provisioningState	IntegrationRuntimeState	Integrationslaufzeitstatus, nur gültig für verwaltete dedizierte Integrationslaufzeit.
type	string: Managed	Typ der Integrationslaufzeit.
typeProperties.computeProperties	IntegrationRuntimeComputeProperties	Die Computeressource für die Laufzeit der verwalteten Integration.
typeProperties.customerVirtualNetwork	IntegrationRuntimeCustomerVirtualNetwork	Der Name des virtuellen Netzwerks, dem Azure-SSIS Integrationslaufzeit beitreten wird
typeProperties.ssisProperties	IntegrationRuntimeSsisProperties	SSIS-Eigenschaften für die Laufzeit der verwalteten Integration.

SecureString

Objekt

Definition der sicheren Azure Synapse-Zeichenfolge. Der Zeichenfolgenwert wird bei Get- oder List-API-Aufrufen mit Sternchen '*' maskiert.

Name	Typ	Beschreibung
type	string: SecureString	Typ des geheimen Schlüssels.
value	string	Wert der sicheren Zeichenfolge.

SelfHostedIntegrationRuntime

Objekt

Selbst gehostete Integrationslaufzeit.

Name	Typ	Beschreibung
description	string	Beschreibung der Integrationslaufzeit.
type	string: SelfHosted	Typ der Integrationslaufzeit.
typeProperties.linkedInfo	LinkedIntegrationRuntimeType: LinkedIntegrationRuntimeKeyAuthorization LinkedIntegrationRuntimeRbacAuthorization	Verknüpfter Integrations-Laufzeittyp aus Data Factory