Partager via


Integration Runtimes - Update

Mises à jour un runtime d’intégration.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}?api-version=2018-06-01

Paramètres URI

Nom Dans Obligatoire Type Description
factoryName
path True

string

Nom de la fabrique.

Modèle d’expression régulière: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

integrationRuntimeName
path True

string

Nom du runtime d’intégration.

Modèle d’expression régulière: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

resourceGroupName
path True

string

Nom du groupe de ressources.

Modèle d’expression régulière: ^[-\w\._\(\)]+$

subscriptionId
path True

string

Identificateur de l’abonnement.

api-version
query True

string

Version de l'API.

Corps de la demande

Nom Type Description
autoUpdate

IntegrationRuntimeAutoUpdate

Active ou désactive la fonctionnalité de mise à jour automatique du runtime d’intégration auto-hébergé. Consultez https://go.microsoft.com/fwlink/?linkid=854189.

updateDelayOffset

string

Le décalage horaire (en heures) dans la journée, par exemple, PT03H est de 3 heures. La mise à jour automatique du runtime d’intégration se produit à cette heure.

Réponses

Nom Type Description
200 OK

IntegrationRuntimeResource

OK.

Other Status Codes

CloudError

Réponse d’erreur reçue du service Azure Data Factory.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

IntegrationRuntimes_Update

Exemple de requête

PATCH https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationRuntimes/exampleIntegrationRuntime?api-version=2018-06-01

{
  "autoUpdate": "Off",
  "updateDelayOffset": "\"PT3H\""
}

Exemple de réponse

Date: Wed, 13 Jun 2018 21:33:04 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1192
x-ms-request-id: eb1c35f8-4b37-4d08-b5dd-d6a0ad8b182d
x-ms-correlation-request-id: eb1c35f8-4b37-4d08-b5dd-d6a0ad8b182d
{
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationruntimes/exampleIntegrationRuntime",
  "name": "exampleIntegrationRuntime",
  "type": "Microsoft.DataFactory/factories/integrationruntimes",
  "properties": {
    "type": "SelfHosted",
    "description": "A selfhosted integration runtime"
  },
  "etag": "0400f1a1-0000-0000-0000-5b2188640000"
}

Définitions

Nom Description
CloudError

Objet qui définit la structure d’une réponse d’erreur Azure Data Factory.

CopyComputeScaleProperties

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

CredentialReference

Type de référence d’informations d’identification.

CredentialReferenceType

Type de référence d’informations d’identification.

CustomProperties

Les propriétés personnalisées sont utilisées pour optimiser les performances d’exécution du flux de données.

DataFlowComputeType

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

EntityReference

Référence d’entité.

IntegrationRuntimeAutoUpdate

État de la mise à jour automatique du runtime d’intégration.

IntegrationRuntimeComputeProperties

Propriétés de ressource de calcul pour le runtime d’intégration managée.

IntegrationRuntimeCustomerVirtualNetwork

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

IntegrationRuntimeCustomSetupScriptProperties

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

IntegrationRuntimeDataFlowProperties

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

IntegrationRuntimeDataProxyProperties

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

IntegrationRuntimeEdition

Édition de la Integration Runtime 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 de catalogue. Les valeurs valides se trouvent dans https://azure.microsoft.com/en-us/pricing/details/sql-database/

IntegrationRuntimeSsisProperties

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

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ée.

LinkedIntegrationRuntimeKeyAuthorization

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

LinkedIntegrationRuntimeRbacAuthorization

Runtime d’intégration du type d’autorisation de contrôle d’accès en fonction du rôle (RBAC).

ManagedIntegrationRuntime

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

ManagedVirtualNetworkReference

Type de référence Réseau virtuel managé.

ManagedVirtualNetworkReferenceType

Type de référence Réseau virtuel managé.

PackageStore

Magasin de packages pour le runtime d’intégration SSIS.

PipelineExternalComputeScaleProperties

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

SecureString

Azure Data Factory définition de chaîne sécurisée. 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é.

UpdateIntegrationRuntimeRequest

Mettre à jour la demande du runtime d’intégration.

CloudError

Objet qui définit la structure d’une réponse d’erreur Azure Data Factory.

Nom Type Description
error.code

string

Code d’erreur.

error.details

CloudError[]

Tableau avec des détails d’erreur supplémentaires.

error.message

string

Message d’erreur.

error.target

string

Nom/chemin de propriété dans la demande associée à l’erreur.

CopyComputeScaleProperties

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

Nom Type Description
dataIntegrationUnit

integer

Paramètre de numéro DIU réservé à l’exécution de l’activité de copie. Les valeurs prises en charge sont des multiples de 4 dans la plage 4-256.

timeToLive

integer

Paramètre de durée de vie (en minutes) du runtime d’intégration qui exécute l’activité de copie.

CredentialReference

Type de référence d’informations d’identification.

Nom Type Description
referenceName

string

Nom des informations d’identification de référence.

type

CredentialReferenceType

Type de référence d’informations d’identification.

CredentialReferenceType

Type de référence d’informations d’identification.

Nom Type Description
CredentialReference

string

CustomProperties

Les propriétés personnalisées sont utilisées pour optimiser les performances d’exécution du flux de données.

Nom Type Description
name

string

Nom de la propriété personnalisée.

value

string

Valeur de la propriété personnalisée.

DataFlowComputeType

Type de calcul du cluster qui exécutera 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.

IntegrationRuntimeAutoUpdate

État de la mise à jour automatique du runtime d’intégration.

Nom Type Description
Off

string

On

string

IntegrationRuntimeComputeProperties

Propriétés de ressource de calcul pour le runtime d’intégration managée.

Nom Type Description
copyComputeScaleProperties

CopyComputeScaleProperties

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

dataFlowProperties

IntegrationRuntimeDataFlowProperties

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

location

string

Emplacement du runtime d’intégration managée. 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ée.

nodeSize

string

La taille de nœud requise pour le runtime d’intégration managée.

numberOfNodes

integer

Nombre de nœuds requis pour le runtime d’intégration managée.

pipelineExternalComputeScaleProperties

PipelineExternalComputeScaleProperties

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

vNetProperties

IntegrationRuntimeVNetProperties

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

IntegrationRuntimeCustomerVirtualNetwork

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

Nom Type Description
subnetId

string

ID du sous-réseau auquel le runtime d’intégration Azure-SSIS sera 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 SAS du conteneur d’objets blob Azure.

IntegrationRuntimeDataFlowProperties

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

Nom Type Description
cleanup

boolean

Le cluster ne sera pas recyclé et il sera utilisé lors de la prochaine exécution de l’activité de flux de données jusqu’à ce que la durée de vie (durée de vie) soit atteinte si cette valeur est définie sur false. La valeur par défaut est true.

computeType

DataFlowComputeType

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

coreCount

integer

Nombre de cœurs du cluster qui exécutera le travail de flux de données. Les valeurs prises en charge sont : 8, 16, 32, 48, 80, 144 et 272.

customProperties

CustomProperties[]

Les propriétés personnalisées sont utilisées pour optimiser les performances d’exécution du flux de données.

timeToLive

integer

Paramètre de durée de vie (en minutes) du cluster qui exécutera 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

Référence du runtime d’intégration auto-hébergé.

path

string

Chemin d’accès à contenir les données intermédiaires dans le stockage Blob.

stagingLinkedService

EntityReference

Référence du service lié intermédiaire.

IntegrationRuntimeEdition

Édition de la Integration Runtime 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 identifie les modifications apportées à la ressource.

id

string

Identificateur de ressource.

name

string

Nom de la ressource.

properties IntegrationRuntime:

Propriétés du runtime d’intégration.

type

string

Type de ressource.

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 de 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 de catalogue. Les valeurs valides se trouvent dans https://azure.microsoft.com/en-us/pricing/details/sql-database/

catalogServerEndpoint

string

URL du serveur de base de données de catalogue.

dualStandbyPairName

string

Nom de la paire de secours double des runtimes d’intégration Azure-SSIS pour prendre en charge le basculement SSISDB.

IntegrationRuntimeSsisCatalogPricingTier

Niveau tarifaire de la base de données de catalogue. Les valeurs valides se trouvent 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ée.

Nom Type Description
catalogInfo

IntegrationRuntimeSsisCatalogInfo

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

credential

CredentialReference

Référence des informations d’identification contenant des informations d’authentification.

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 de la Integration Runtime 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.

packageStores

PackageStore[]

Magasins de packages pour le Integration Runtime SSIS.

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ée.

Nom Type Description
publicIPs

string[]

ID de ressource des adresses IP publiques que ce runtime d’intégration utilisera.

subnet

string

Nom du sous-réseau que ce runtime d’intégration doit joindre.

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 sera joint.

LinkedIntegrationRuntimeKeyAuthorization

Runtime d’intégration du 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 de contrôle d’accès en fonction du rôle (RBAC).

Nom Type Description
authorizationType string:

RBAC

Type d’autorisation pour le partage du runtime d’intégration.

credential

CredentialReference

Référence des informations d’identification contenant des informations d’authentification.

resourceId

string

Identificateur de ressource du runtime d’intégration à partager.

ManagedIntegrationRuntime

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

Nom Type Description
description

string

Description du runtime d’intégration.

managedVirtualNetwork

ManagedVirtualNetworkReference

Informations de référence sur les Réseau virtuel managés.

state

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ée.

typeProperties.customerVirtualNetwork

IntegrationRuntimeCustomerVirtualNetwork

Nom du réseau virtuel auquel le runtime d’intégration Azure-SSIS sera joint

typeProperties.ssisProperties

IntegrationRuntimeSsisProperties

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

ManagedVirtualNetworkReference

Type de référence Réseau virtuel managé.

Nom Type Description
referenceName

string

Référencer le nom ManagedVirtualNetwork.

type

ManagedVirtualNetworkReferenceType

Type de référence Réseau virtuel managé.

ManagedVirtualNetworkReferenceType

Type de référence Réseau virtuel managé.

Nom Type Description
ManagedVirtualNetworkReference

string

PackageStore

Magasin de packages pour le runtime d’intégration SSIS.

Nom Type Description
name

string

Nom du magasin de packages

packageStoreLinkedService

EntityReference

Référence du service lié au magasin de packages.

PipelineExternalComputeScaleProperties

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

Nom Type Description
numberOfExternalNodes

integer

Nombre des nœuds externes, qui doit être supérieur à 0 et inférieur à 11.

numberOfPipelineNodes

integer

Nombre de nœuds de pipeline, qui doit être supérieur à 0 et inférieur à 11.

timeToLive

integer

Paramètre de durée de vie (en minutes) du runtime d’intégration qui exécute le pipeline et l’activité externe.

SecureString

Azure Data Factory définition de chaîne sécurisée. 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 la 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:

Définition de base d’un runtime d’intégration lié.

typeProperties.selfContainedInteractiveAuthoringEnabled

boolean

Une autre option pour garantir la fonction de création interactive lorsque votre runtime d’intégration auto-hébergé n’est pas en mesure d’établir une connexion avec Azure Relay.

UpdateIntegrationRuntimeRequest

Mettre à jour la demande du runtime d’intégration.

Nom Type Description
autoUpdate

IntegrationRuntimeAutoUpdate

Active ou désactive la fonctionnalité de mise à jour automatique du runtime d’intégration auto-hébergé. Consultez https://go.microsoft.com/fwlink/?linkid=854189.

updateDelayOffset

string

Le décalage horaire (en heures) dans la journée, par exemple, PT03H est de 3 heures. La mise à jour automatique du runtime d’intégration se produit à cette heure.