Integration Runtimes - Get

Référence

Service:: Synapse

Version d'API:: 2021-06-01

Obtenir le runtime d’intégration
Obtenir un runtime d’intégration

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
integrationRuntimeName	path	True	string	Nom du runtime d’intégration
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string	ID de l’abonnement cible.
workspaceName	path	True	string	Nom de l’espace de travail.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

En-tête de la demande

Nom	Obligatoire	Type	Description
If-None-Match		string	ETag de l’entité runtime d’intégration. Doit être spécifié uniquement pour obtenir. Si l’ETag correspond à la balise d’entité existante ou si * a été fourni, aucun contenu n’est retourné.

Réponses

Nom	Type	Description
200 OK	IntegrationRuntimeResource	D’ACCORD.
Other Status Codes		Non modifié.
Other Status Codes	ErrorResponse	Réponse d’erreur reçue de l’opération d’exécution d’intégration GET.

Exemples

Get integration runtime

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
}

Code d’état:: 304

Code d’état:: default

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

Définitions

Nom	Description
DataFlowComputeType	Type de calcul du cluster qui exécute le travail de flux de données.
EntityReference	Référence d’entité.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
IntegrationRuntimeComputeProperties	Propriétés des ressources de calcul pour le runtime d’intégration managé.
IntegrationRuntimeCustomerVirtualNetwork	Définition et propriétés du réseau virtuel auquel Azure-SSIS runtime d’intégration se joint.
IntegrationRuntimeCustomSetupScriptProperties	Propriétés de script d’installation personnalisées pour un runtime d’intégration dédié managé.
IntegrationRuntimeDataFlowProperties	Propriétés du flux de données pour le runtime d’intégration managé.
IntegrationRuntimeDataProxyProperties	Propriétés du proxy de données pour un runtime d’intégration dédié managé.
IntegrationRuntimeEdition	Édition du runtime d’intégration SSIS
IntegrationRuntimeEntityReferenceType	Type de cette entité référencée.
IntegrationRuntimeLicenseType	Type de licence pour apporter votre propre scénario de licence.
IntegrationRuntimeResource	Type de ressource runtime d’intégration.
IntegrationRuntimeSsisCatalogInfo	Informations de catalogue pour le runtime d’intégration dédié managé.
IntegrationRuntimeSsisCatalogPricingTier	Niveau tarifaire de la base de données du catalogue. Les valeurs valides sont disponibles dans https://azure.microsoft.com/en-us/pricing/details/sql-database/
IntegrationRuntimeSsisProperties	Propriétés SSIS pour le runtime d’intégration managé.
IntegrationRuntimeState	État du runtime d’intégration.
IntegrationRuntimeType	Type de runtime d’intégration.
IntegrationRuntimeVNetProperties	Propriétés de réseau virtuel pour le runtime d’intégration managé.
LinkedIntegrationRuntimeKeyAuthorization	Runtime d’intégration de type d’autorisation de clé.
LinkedIntegrationRuntimeRbacAuthorization	Runtime d’intégration du type d’autorisation en fonction du rôle (RBAC).
ManagedIntegrationRuntime	Runtime d’intégration managé, y compris les runtimes d’intégration managés élastiques et managés dédiés.
SecureString	Définition de chaîne sécurisée Azure Synapse. La valeur de chaîne est masquée avec des astérisques '*' pendant les appels d’API Get ou List.
SelfHostedIntegrationRuntime	Runtime d’intégration auto-hébergé.

DataFlowComputeType

Type de calcul du cluster qui exécute le travail de flux de données.

Nom	Type	Description
ComputeOptimized	string
General	string
MemoryOptimized	string

EntityReference

Référence d’entité.

Nom	Type	Description
referenceName	string	Nom de cette entité référencée.
type	IntegrationRuntimeEntityReferenceType	Type de cette entité référencée.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

IntegrationRuntimeComputeProperties

Propriétés des ressources de calcul pour le runtime d’intégration managé.

Nom	Type	Description
dataFlowProperties	IntegrationRuntimeDataFlowProperties	Propriétés du flux de données pour le runtime d’intégration managé.
location	string	Emplacement du runtime d’intégration managé. Les régions prises en charge se trouvent sur https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities
maxParallelExecutionsPerNode	integer	Nombre maximal d’exécutions parallèles par nœud pour le runtime d’intégration managé.
nodeSize	string	Exigence de taille de nœud pour le runtime d’intégration managé.
numberOfNodes	integer	Nombre requis de nœuds pour le runtime d’intégration managé.
vNetProperties	IntegrationRuntimeVNetProperties	Propriétés de réseau virtuel pour le runtime d’intégration managé.

IntegrationRuntimeCustomerVirtualNetwork

Définition et propriétés du réseau virtuel auquel Azure-SSIS runtime d’intégration se joint.

Nom	Type	Description
subnetId	string	ID du sous-réseau auquel Azure-SSIS runtime d’intégration se joint.

IntegrationRuntimeCustomSetupScriptProperties

Propriétés de script d’installation personnalisées pour un runtime d’intégration dédié managé.

Nom	Type	Description
blobContainerUri	string	URI du conteneur d’objets blob Azure qui contient le script d’installation personnalisé.
sasToken	SecureString	Jeton SAP du conteneur d’objets blob Azure.

IntegrationRuntimeDataFlowProperties

Propriétés du flux de données pour le runtime d’intégration managé.

Nom	Type	Description
computeType	DataFlowComputeType	Type de calcul du cluster qui exécute le travail de flux de données.
coreCount	integer	Nombre principal du cluster qui exécute le travail de flux de données. Les valeurs prises en charge sont les suivantes : 8, 16, 32, 48, 80, 144 et 272.
timeToLive	integer	Paramètre de temps de vie (en minutes) du cluster qui exécute le travail de flux de données.

IntegrationRuntimeDataProxyProperties

Propriétés du proxy de données pour un runtime d’intégration dédié managé.

Nom	Type	Description
connectVia	EntityReference	Informations de référence sur le runtime d’intégration auto-hébergé.
path	string	Chemin d’accès pour contenir les données intermédiaires dans le stockage Blob.
stagingLinkedService	EntityReference	Informations de référence sur le service lié intermédiaire.

IntegrationRuntimeEdition

Édition du runtime d’intégration SSIS

Nom	Type	Description
Enterprise	string
Standard	string

IntegrationRuntimeEntityReferenceType

Type de cette entité référencée.

Nom	Type	Description
IntegrationRuntimeReference	string
LinkedServiceReference	string

IntegrationRuntimeLicenseType

Type de licence pour apporter votre propre scénario de licence.

Nom	Type	Description
BasePrice	string
LicenseIncluded	string

IntegrationRuntimeResource

Type de ressource runtime d’intégration.

Nom	Type	Description
etag	string	Etag de ressource.
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nom de la ressource
properties	IntegrationRuntime: ManagedIntegrationRuntime SelfHostedIntegrationRuntime	Propriétés du runtime d’intégration.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

IntegrationRuntimeSsisCatalogInfo

Informations de catalogue pour le runtime d’intégration dédié managé.

Nom	Type	Description
catalogAdminPassword	SecureString	Mot de passe du compte d’utilisateur administrateur de la base de données du catalogue.
catalogAdminUserName	string	Nom d’utilisateur administrateur de la base de données de catalogue.
catalogPricingTier	IntegrationRuntimeSsisCatalogPricingTier	Niveau tarifaire de la base de données du catalogue. Les valeurs valides sont disponibles dans https://azure.microsoft.com/en-us/pricing/details/sql-database/
catalogServerEndpoint	string	URL du serveur de base de données du catalogue.

IntegrationRuntimeSsisCatalogPricingTier

Niveau tarifaire de la base de données du catalogue. Les valeurs valides sont disponibles dans https://azure.microsoft.com/en-us/pricing/details/sql-database/

Nom	Type	Description
Basic	string
Premium	string
PremiumRS	string
Standard	string

IntegrationRuntimeSsisProperties

Propriétés SSIS pour le runtime d’intégration managé.

Nom	Type	Description
catalogInfo	IntegrationRuntimeSsisCatalogInfo	Informations de catalogue pour le runtime d’intégration dédié managé.
customSetupScriptProperties	IntegrationRuntimeCustomSetupScriptProperties	Propriétés de script d’installation personnalisées pour un runtime d’intégration dédié managé.
dataProxyProperties	IntegrationRuntimeDataProxyProperties	Propriétés du proxy de données pour un runtime d’intégration dédié managé.
edition	IntegrationRuntimeEdition	Édition du runtime d’intégration SSIS
expressCustomSetupProperties	CustomSetupBase[]	Configuration personnalisée sans propriétés de script pour un runtime d’intégration SSIS.
licenseType	IntegrationRuntimeLicenseType	Type de licence pour apporter votre propre scénario de licence.

IntegrationRuntimeState

État du runtime d’intégration.

Nom	Type	Description
AccessDenied	string
Initial	string
Limited	string
NeedRegistration	string
Offline	string
Online	string
Started	string
Starting	string
Stopped	string
Stopping	string

IntegrationRuntimeType

Type de runtime d’intégration.

Nom	Type	Description
Managed	string
SelfHosted	string

IntegrationRuntimeVNetProperties

Propriétés de réseau virtuel pour le runtime d’intégration managé.

Nom	Type	Description
publicIPs	string[]	ID de ressource des adresses IP publiques utilisées par ce runtime d’intégration.
subnet	string	Nom du sous-réseau auquel ce runtime d’intégration se joint.
subnetId	string	ID du sous-réseau auquel ce runtime d’intégration Azure-SSIS sera joint.
vNetId	string	ID du réseau virtuel auquel ce runtime d’intégration se joint.

LinkedIntegrationRuntimeKeyAuthorization

Runtime d’intégration de type d’autorisation de clé.

Nom	Type	Description
authorizationType	string: Key	Type d’autorisation pour le partage du runtime d’intégration.
key	SecureString	Clé utilisée pour l’autorisation.

LinkedIntegrationRuntimeRbacAuthorization

Runtime d’intégration du type d’autorisation en fonction du rôle (RBAC).

Nom	Type	Description
authorizationType	string: RBAC	Type d’autorisation pour le partage du runtime d’intégration.
resourceId	string	Identificateur de ressource du runtime d’intégration à partager.

ManagedIntegrationRuntime

Runtime d’intégration managé, y compris les runtimes d’intégration managés élastiques et managés dédiés.

Nom	Type	Description
description	string	Description du runtime d’intégration.
managedVirtualNetwork.id	string	ID du réseau virtuel managé.
managedVirtualNetwork.referenceName	string	Nom de référence du réseau virtuel managé
managedVirtualNetwork.type	string	Type du réseau virtuel managé.
provisioningState	IntegrationRuntimeState	État du runtime d’intégration, valide uniquement pour le runtime d’intégration dédié managé.
type	string: Managed	Type de runtime d’intégration.
typeProperties.computeProperties	IntegrationRuntimeComputeProperties	Ressource de calcul pour le runtime d’intégration managé.
typeProperties.customerVirtualNetwork	IntegrationRuntimeCustomerVirtualNetwork	Nom du réseau virtuel auquel Azure-SSIS runtime d’intégration rejoint
typeProperties.ssisProperties	IntegrationRuntimeSsisProperties	Propriétés SSIS pour le runtime d’intégration managé.

SecureString

Définition de chaîne sécurisée Azure Synapse. La valeur de chaîne est masquée avec des astérisques '*' pendant les appels d’API Get ou List.

Nom	Type	Description
type	string: SecureString	Type du secret.
value	string	Valeur de chaîne sécurisée.

SelfHostedIntegrationRuntime

Runtime d’intégration auto-hébergé.

Nom	Type	Description
description	string	Description du runtime d’intégration.
type	string: SelfHosted	Type de runtime d’intégration.
typeProperties.linkedInfo	LinkedIntegrationRuntimeType: LinkedIntegrationRuntimeKeyAuthorization LinkedIntegrationRuntimeRbacAuthorization	Type de runtime d’intégration lié à partir de la fabrique de données

Partager via