Integration Runtimes - Get

Tjänst:: Synapse

API-version:: 2021-06-01

Hämta integrationskörning
Hämta en integrationskörning

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
integrationRuntimeName	path	True	string	Namn på integrationskörning
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string minLength: 1	ID för målprenumerationen.
workspaceName	path	True	string	Namnet på arbetsytan.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatorisk	Typ	Description
If-None-Match		string	ETag för integration runtime-entiteten. Bör endast anges för get. Om ETag matchar den befintliga entitetstaggen, eller om * angavs, returneras inget innehåll.

Svar

Name	Typ	Description
200 OK	IntegrationRuntimeResource	OKEJ.
Other Status Codes		Inte ändrad.
Other Status Codes	ErrorResponse	Ett felsvar som togs emot från GET-integreringskörningsåtgärden.

Exempel

Get integration runtime

Exempelbegäran

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

Exempelsvar

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

Statuskod:: 304

Statuskod:: default

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

Definitioner

Name	Description
DataFlowComputeType	Beräkningstyp för klustret som ska köra dataflödesjobbet.
EntityReference	Entitetsreferensen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
IntegrationRuntimeComputeProperties	Egenskaper för beräkningsresurser för hanterad integrationskörning.
IntegrationRuntimeCustomerVirtualNetwork	Definitionen och egenskaperna för det virtuella nätverk som Azure-SSIS integreringskörningen ska ansluta till.
IntegrationRuntimeCustomSetupScriptProperties	Anpassade konfigurationsskriptegenskaper för en hanterad dedikerad integreringskörning.
IntegrationRuntimeDataFlowProperties	Dataflödesegenskaper för hanterad integrationskörning.
IntegrationRuntimeDataProxyProperties	Dataproxyegenskaper för en hanterad dedikerad integreringskörning.
IntegrationRuntimeEdition	Utgåvan för SSIS Integration Runtime
IntegrationRuntimeEntityReferenceType	Typen av den här refererade entiteten.
IntegrationRuntimeLicenseType	Licenstyp för att ta med ditt eget licensscenario.
IntegrationRuntimeResource	Resurstyp för integrationskörning.
IntegrationRuntimeSsisCatalogInfo	Kataloginformation för hanterad dedikerad integreringskörning.
IntegrationRuntimeSsisCatalogPricingTier	Prisnivån för katalogdatabasen. Det gick att hitta giltiga värden i https://azure.microsoft.com/en-us/pricing/details/sql-database/
IntegrationRuntimeSsisProperties	SSIS-egenskaper för hanterad integrationskörning.
IntegrationRuntimeState	Tillståndet för integrationskörning.
IntegrationRuntimeType	Typ av integrationskörning.
IntegrationRuntimeVNetProperties	VNet-egenskaper för hanterad integrationskörning.
LinkedIntegrationRuntimeKeyAuthorization	Integreringskörning för nyckelauktoriseringstyp.
LinkedIntegrationRuntimeRbacAuthorization	Rollbaserad åtkomstkontroll (RBAC) auktoriseringstyp integrationskörning.
ManagedIntegrationRuntime	Hanterad integrationskörning, inklusive hanterade elastiska och hanterade dedikerade integreringskörningar.
SecureString	Säker strängdefinition för Azure Synapse. Strängvärdet maskeras med asterisker '*' under Get- eller List-API-anrop.
SelfHostedIntegrationRuntime	Lokalt installerad integrationskörning.

DataFlowComputeType

Uppräkning

Beräkningstyp för klustret som ska köra dataflödesjobbet.

Värde	Description
General
MemoryOptimized
ComputeOptimized

EntityReference

Objekt

Entitetsreferensen.

Name	Typ	Description
referenceName	string	Namnet på den refererade entiteten.
type	IntegrationRuntimeEntityReferenceType	Typen av den här refererade entiteten.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

IntegrationRuntimeComputeProperties

Objekt

Egenskaper för beräkningsresurser för hanterad integrationskörning.

Name	Typ	Description
dataFlowProperties	IntegrationRuntimeDataFlowProperties	Dataflödesegenskaper för hanterad integrationskörning.
location	string	Platsen för hanterad integrationskörning. Det gick att hitta de regioner som stöds på https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities
maxParallelExecutionsPerNode	integer (int32) minimum: 1	Maximalt antal parallella körningar per nod för hanterad integrationskörning.
nodeSize	string	Krav på nodstorlek för hanterad integrationskörning.
numberOfNodes	integer (int32) minimum: 1	Det antal noder som krävs för hanterad integrationskörning.
vNetProperties	IntegrationRuntimeVNetProperties	VNet-egenskaper för hanterad integrationskörning.

IntegrationRuntimeCustomerVirtualNetwork

Objekt

Definitionen och egenskaperna för det virtuella nätverk som Azure-SSIS integreringskörningen ska ansluta till.

Name	Typ	Description
subnetId	string	ID:t för det undernät som Azure-SSIS integrationskörning ska anslutas till.

IntegrationRuntimeCustomSetupScriptProperties

Objekt

Anpassade konfigurationsskriptegenskaper för en hanterad dedikerad integreringskörning.

Name	Typ	Description
blobContainerUri	string	URI:n för Azure Blob-containern som innehåller det anpassade installationsskriptet.
sasToken	SecureString	SAS-token för Azure Blob-containern.

IntegrationRuntimeDataFlowProperties

Objekt

Dataflödesegenskaper för hanterad integrationskörning.

Name	Typ	Description
computeType	DataFlowComputeType	Beräkningstyp för klustret som ska köra dataflödesjobbet.
coreCount	integer (int32)	Kärnantal för klustret som ska köra dataflödesjobbet. Värden som stöds är: 8, 16, 32, 48, 80, 144 och 272.
timeToLive	integer (int32) minimum: 0	Inställningen Time to live (i minuter) för klustret som ska köra dataflödesjobbet.

IntegrationRuntimeDataProxyProperties

Objekt

Dataproxyegenskaper för en hanterad dedikerad integreringskörning.

Name	Typ	Description
connectVia	EntityReference	Den lokalt installerade integrationskörningsreferensen.
path	string	Sökvägen som ska innehålla mellanlagrade data i Blob Storage.
stagingLinkedService	EntityReference	Referens för mellanlagring av länkad tjänst.

IntegrationRuntimeEdition

Uppräkning

Utgåvan för SSIS Integration Runtime

Värde	Description
Standard
Enterprise

IntegrationRuntimeEntityReferenceType

Uppräkning

Typen av den här refererade entiteten.

Värde	Description
IntegrationRuntimeReference
LinkedServiceReference

IntegrationRuntimeLicenseType

Uppräkning

Licenstyp för att ta med ditt eget licensscenario.

Värde	Description
BasePrice
LicenseIncluded

IntegrationRuntimeResource

Objekt

Resurstyp för integrationskörning.

Name	Typ	Description
etag	string	Resurs-Etag.
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties	IntegrationRuntime: ManagedIntegrationRuntime SelfHostedIntegrationRuntime	Egenskaper för integrationskörning.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

IntegrationRuntimeSsisCatalogInfo

Objekt

Kataloginformation för hanterad dedikerad integreringskörning.

Name	Typ	Description
catalogAdminPassword	SecureString	Lösenordet för administratörsanvändarkontot för katalogdatabasen.
catalogAdminUserName	string minLength: 1 maxLength: 128	Administratörsanvändarnamnet för katalogdatabasen.
catalogPricingTier	IntegrationRuntimeSsisCatalogPricingTier	Prisnivån för katalogdatabasen. Det gick att hitta giltiga värden i https://azure.microsoft.com/en-us/pricing/details/sql-database/
catalogServerEndpoint	string	Url:en för katalogdatabasservern.

IntegrationRuntimeSsisCatalogPricingTier

Uppräkning

Prisnivån för katalogdatabasen. Det gick att hitta giltiga värden i https://azure.microsoft.com/en-us/pricing/details/sql-database/

Värde	Description
Basic
Standard
Premium
PremiumRS

IntegrationRuntimeSsisProperties

Objekt

SSIS-egenskaper för hanterad integrationskörning.

Name	Typ	Description
catalogInfo	IntegrationRuntimeSsisCatalogInfo	Kataloginformation för hanterad dedikerad integreringskörning.
customSetupScriptProperties	IntegrationRuntimeCustomSetupScriptProperties	Anpassade konfigurationsskriptegenskaper för en hanterad dedikerad integreringskörning.
dataProxyProperties	IntegrationRuntimeDataProxyProperties	Dataproxyegenskaper för en hanterad dedikerad integreringskörning.
edition	IntegrationRuntimeEdition	Utgåvan för SSIS Integration Runtime
expressCustomSetupProperties	CustomSetupBase[]	Anpassad installation utan skriptegenskaper för en SSIS-integreringskörning.
licenseType	IntegrationRuntimeLicenseType	Licenstyp för att ta med ditt eget licensscenario.

IntegrationRuntimeState

Uppräkning

Tillståndet för integrationskörning.

Värde	Description
Initial
Stopped
Started
Starting
Stopping
NeedRegistration
Online
Limited
Offline
AccessDenied

IntegrationRuntimeType

Uppräkning

Typ av integrationskörning.

Värde	Description
Managed
SelfHosted

IntegrationRuntimeVNetProperties

Objekt

VNet-egenskaper för hanterad integrationskörning.

Name	Typ	Description
publicIPs	string[]	Resurs-ID:t för de offentliga IP-adresser som den här integreringskörningen använder.
subnet	string	Namnet på det undernät som integrationskörningen ansluter till.
subnetId	string	ID:t för undernätet som den här Azure-SSIS integrationskörningen ska kopplas till.
vNetId	string	ID:t för det virtuella nätverk som den här integreringskörningen ansluter till.

LinkedIntegrationRuntimeKeyAuthorization

Objekt

Integreringskörning för nyckelauktoriseringstyp.

Name	Typ	Description
authorizationType	string: Key	Auktoriseringstypen för integreringskörningsdelning.
key	SecureString	Nyckeln som används för auktorisering.

LinkedIntegrationRuntimeRbacAuthorization

Objekt

Rollbaserad åtkomstkontroll (RBAC) auktoriseringstyp integrationskörning.

Name	Typ	Description
authorizationType	string: RBAC	Auktoriseringstypen för integreringskörningsdelning.
resourceId	string	Resursidentifieraren för integrationskörningen som ska delas.

ManagedIntegrationRuntime

Objekt

Hanterad integrationskörning, inklusive hanterade elastiska och hanterade dedikerade integreringskörningar.

Name	Typ	Description
description	string	Beskrivning av integrationskörning.
managedVirtualNetwork.id	string	ID för det hanterade virtuella nätverket.
managedVirtualNetwork.referenceName	string	Referensnamnet för det hanterade virtuella nätverket
managedVirtualNetwork.type	string	Typen av det hanterade virtuella nätverket.
provisioningState	IntegrationRuntimeState	Integration Runtime-tillstånd, endast giltigt för hanterad dedikerad integrationskörning.
type	string: Managed	Typ av integrationskörning.
typeProperties.computeProperties	IntegrationRuntimeComputeProperties	Beräkningsresursen för hanterad integrationskörning.
typeProperties.customerVirtualNetwork	IntegrationRuntimeCustomerVirtualNetwork	Namnet på det virtuella nätverk som Azure-SSIS integreringskörning ansluter till
typeProperties.ssisProperties	IntegrationRuntimeSsisProperties	SSIS-egenskaper för hanterad integrationskörning.

SecureString

Objekt

Säker strängdefinition för Azure Synapse. Strängvärdet maskeras med asterisker '*' under Get- eller List-API-anrop.

Name	Typ	Description
type	string: SecureString	Typ av hemlighet.
value	string	Värdet för säker sträng.

SelfHostedIntegrationRuntime

Objekt

Lokalt installerad integrationskörning.

Name	Typ	Description
description	string	Beskrivning av integrationskörning.
type	string: SelfHosted	Typ av integrationskörning.
typeProperties.linkedInfo	LinkedIntegrationRuntimeType: LinkedIntegrationRuntimeKeyAuthorization LinkedIntegrationRuntimeRbacAuthorization	Länkad integrationskörningstyp från datafabriken

Dela via

Integration Runtimes - Get

URI-parametrar

Begärandehuvud

Svar

Exempel

Get integration runtime

Exempelbegäran

Exempelsvar

Definitioner

DataFlowComputeType

EntityReference

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IntegrationRuntimeComputeProperties

IntegrationRuntimeCustomerVirtualNetwork

IntegrationRuntimeCustomSetupScriptProperties

IntegrationRuntimeDataFlowProperties

IntegrationRuntimeDataProxyProperties

IntegrationRuntimeEdition

IntegrationRuntimeEntityReferenceType

IntegrationRuntimeLicenseType

IntegrationRuntimeResource

IntegrationRuntimeSsisCatalogInfo

IntegrationRuntimeSsisCatalogPricingTier

IntegrationRuntimeSsisProperties

IntegrationRuntimeState

IntegrationRuntimeType

IntegrationRuntimeVNetProperties

LinkedIntegrationRuntimeKeyAuthorization

LinkedIntegrationRuntimeRbacAuthorization

ManagedIntegrationRuntime

SecureString

SelfHostedIntegrationRuntime