Microsoft. Workspace Synapse/Runtime di integrazione

Definizione della risorsa Bicep

Il tipo di risorsa workspaces/integrationRuntimes può essere distribuito con operazioni destinate a:

  • Resource groups - Vedi resource group

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Esempi di utilizzo

Campioni di Bicep

Un esempio base di utilizzo di Synapse Azure Integration Runtime.

param resourceName string = 'acctest0001'
param location string = 'westeurope'
@description('The SQL administrator login for the Synapse workspace')
param sqlAdministratorLogin string
@secure()
@description('The SQL administrator login password for the Synapse workspace')
param sqlAdministratorLoginPassword string

resource blobService 'Microsoft.Storage/storageAccounts/blobServices@2022-09-01' existing = {
  name: 'default'
  parent: storageAccount
}

resource storageAccount 'Microsoft.Storage/storageAccounts@2021-09-01' = {
  name: resourceName
  location: location
  sku: {
    name: 'Standard_LRS'
  }
  kind: 'StorageV2'
  properties: {}
}

resource workspace 'Microsoft.Synapse/workspaces@2021-06-01' = {
  name: resourceName
  location: location
  properties: {
    defaultDataLakeStorage: {
      accountUrl: storageAccount.properties.primaryEndpoints.dfs
      filesystem: container.name
    }
    managedVirtualNetwork: 'default'
    publicNetworkAccess: 'Enabled'
    sqlAdministratorLogin: sqlAdministratorLogin
    sqlAdministratorLoginPassword: sqlAdministratorLoginPassword
  }
}

resource integrationRuntime 'Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01-preview' = {
  name: resourceName
  parent: workspace
  properties: {
    description: 'test'
    type: 'SelfHosted'
  }
}

resource container 'Microsoft.Storage/storageAccounts/blobServices/containers@2022-09-01' = {
  name: resourceName
  parent: blobService
  properties: {
    metadata: {
      key: 'value'
    }
  }
}

Formato risorsa

Per creare un Microsoft. Risorsa Synapse/workspaces/integrationRuntimes, aggiungi il seguente Bicep al tuo template.

resource symbolicname 'Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    description: 'string'
    type: 'string'
    // For remaining properties, see IntegrationRuntime objects
  }
}

Oggetti LinkedIntegrationRuntimeType

Impostare la proprietà authorizationType per specificare il tipo di oggetto.

Per la chiave, utilizzare:

{
  authorizationType: 'Key'
  key: {
    type: 'string'
    value: 'string'
  }
}

Per RBAC, utilizzare:

{
  authorizationType: 'RBAC'
  resourceId: 'string'
}

Oggetti CustomSetupBase

Impostare la proprietà tipo di per specificare il tipo di oggetto.

Per CmdkeySetup, usare:

{
  type: 'CmdkeySetup'
  typeProperties: {
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    targetName: any(...)
    userName: any(...)
  }
}

Per ComponentSetup, utilizzare:

{
  type: 'ComponentSetup'
  typeProperties: {
    componentName: 'string'
    licenseKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
  }
}

Per EnvironmentVariableSetup, usare:

{
  type: 'EnvironmentVariableSetup'
  typeProperties: {
    variableName: 'string'
    variableValue: 'string'
  }
}

Oggetti IntegrationRuntime

Impostare la proprietà tipo di per specificare il tipo di oggetto.

Per Managed, utilizzare:

{
  managedVirtualNetwork: {
    id: 'string'
    referenceName: 'string'
    type: 'string'
  }
  type: 'Managed'
  typeProperties: {
    computeProperties: {
      dataFlowProperties: {
        computeType: 'string'
        coreCount: int
        timeToLive: int
      }
      location: 'string'
      maxParallelExecutionsPerNode: int
      nodeSize: 'string'
      numberOfNodes: int
      vNetProperties: {
        publicIPs: [
          'string'
        ]
        subnet: 'string'
        subnetId: 'string'
        vNetId: 'string'
      }
    }
    customerVirtualNetwork: {
      subnetId: 'string'
    }
    ssisProperties: {
      catalogInfo: {
        catalogAdminPassword: {
          type: 'string'
          value: 'string'
        }
        catalogAdminUserName: 'string'
        catalogPricingTier: 'string'
        catalogServerEndpoint: 'string'
      }
      customSetupScriptProperties: {
        blobContainerUri: 'string'
        sasToken: {
          type: 'string'
          value: 'string'
        }
      }
      dataProxyProperties: {
        connectVia: {
          referenceName: 'string'
          type: 'string'
        }
        path: 'string'
        stagingLinkedService: {
          referenceName: 'string'
          type: 'string'
        }
      }
      edition: 'string'
      expressCustomSetupProperties: [
        {
          type: 'string'
          // For remaining properties, see CustomSetupBase objects
        }
      ]
      licenseType: 'string'
    }
  }
}

Per SelfHosted, utilizzare:

{
  type: 'SelfHosted'
  typeProperties: {
    linkedInfo: {
      authorizationType: 'string'
      // For remaining properties, see LinkedIntegrationRuntimeType objects
    }
  }
}

Oggetti SecretBase

Impostare la proprietà tipo di per specificare il tipo di oggetto.

Per SecureString, utilizzare:

{
  type: 'SecureString'
  value: 'string'
}

Valori delle proprietà

Microsoft. Synapse/workspaces/integrazioneRuntime.

Name Description Value
name Nome della risorsa stringa (obbligatorio)
parent In Bicep, puoi specificare la risorsa genitore per una risorsa figlia. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per ulteriori informazioni, vedi Risorsa figlio esterna risorsa genitore.		 Nome simbolico per la risorsa di tipo: workspaces
properties Integration runtime proprietà. IntegrationRuntime (obbligatorio)

CmdkeySetup

Name Description Value
type Tipo di installazione personalizzata. 'CmdkeySetup' (obbligatorio)
typeProperties Comando cmdkey proprietà del tipo di installazione personalizzato. CmdkeySetupTypeProperties (obbligatorio)

CmdkeySetupTypeProperties

Name Description Value
password La password dell'access alla fonte dati. SecretBase (obbligatorio)
targetName Il nome del server per l'access alla sorgente dati. qualsiasi (obbligatorio)
userName Il nome utente dell'accesso alla fonte dati. qualsiasi (obbligatorio)

ComponentSetup

Name Description Value
type Tipo di installazione personalizzata. 'ComponentSetup' (obbligatorio)
typeProperties Installare le proprietà del tipo di componente di terze parti. LicensedComponentSetupTypeProperties (obbligatorio)

CustomSetupBase

Name Description Value
type Impostare su 'CmdkeySetup' per il tipo CmdkeySetup. Impostare su 'ComponentSetup' per il tipo ComponentSetup. Impostare su 'EnvironmentVariableSetup' per il tipo EnvironmentVariableSetup. 'CmdkeySetup'
'ComponentSetup'
'EnvironmentVariableSetup' (obbligatorio)

EntityReference

Name Description Value
referenceName Nome di questa entità a cui si fa riferimento. string
type Tipo di questa entità a cui si fa riferimento. 'IntegrationRuntimeReference'
'LinkedServiceReference'

EnvironmentVariableSetup

Name Description Value
type Tipo di installazione personalizzata. 'EnvironmentVariableSetup' (obbligatorio)
typeProperties Aggiungere proprietà del tipo di variabile di ambiente. EnvironmentVariableSetupTypeProperties (obbligatorio)

EnvironmentVariableSetupTypeProperties

Name Description Value
variableName Nome della variabile di ambiente. stringa (obbligatorio)
variableValue Valore della variabile di ambiente. stringa (obbligatorio)

IntegrationRuntime

Name Description Value
description Integration runtime descrizione. string
type Impostare su "Managed" per il tipo ManagedIntegrationRuntime. Impostare su 'SelfHosted' per il tipo SelfHostedIntegrationRuntime. 'Managed'
'SelfHosted' (obbligatorio)

IntegrationRuntimeComputeProperties

Name Description Value
dataFlowProperties Data flow proprietà per managed integration runtime. IntegrationRuntimeDataFlowProperties
location La posizione per il managed integration runtime. Le regioni supportate si trovano su /azure/data-factory/data-factory-data-movement-activities string
maxParallelExecutionsPerNode Le esecuzioni parallele massime contano per nodo per il runtime di integration runtime gestita. int

Constraints:
Valore minimo = 1
nodeSize Il requisito di dimensione del nodo per gestire il tempo di integration runtime. string
numberOfNodes Il numero richiesto di nodi per l'integration runtime gestita. int

Constraints:
Valore minimo = 1
vNetProperties Proprietà VNet per l'integration runtime gestita. IntegrationRuntimeVNetProperties

IntegrationRuntimeCustomerVirtualNetwork

Name Description Value
subnetId L'ID della subnet a cui il runtime di integrazione Azure-SSIS si unirà. string

IntegrationRuntimeCustomSetupScriptProperties

Name Description Value
blobContainerUri L'URI del contenitore di blob Azure che contiene lo script di setup personalizzato. string
sasToken Il token SAS del contenitore blob Azure. SecureString

IntegrationRuntimeDataFlowProperties

Name Description Value
computeType Tipo di calcolo del cluster che eseguirà il data flow job. 'ComputeOptimized'
'General'
'MemoryOptimized'
coreCount Conteggio dei core del cluster che eseguirà il data flow job. I valori supportati sono: 8, 16, 32, 48, 80, 144 e 272. int
timeToLive Impostazione time to live (in minuti) del cluster che eseguirà il data flow job. int

Constraints:
Valore minimo = 0

IntegrationRuntimeDataProxyProperties

Name Description Value
connectVia Il riferimento di integration runtime self-ospitato. Riferimento entità
path Il percorso per contenere i dati a stadi nel Blob storage. string
stagingLinkedService Informazioni di riferimento sul servizio collegato di staging. Riferimento entità

IntegrationRuntimeSsisCatalogInfo

Name Description Value
catalogAdminPassword Password dell'account utente amministratore del database del catalogo. SecureString
catalogAdminUserName Nome utente amministratore del database di catalogo. string

Constraints:
Lunghezza minima = 1
Lunghezza massima = 128
catalogPricingTier Piano tariffario per il database di catalogo. I valori validi si potevano trovare in https://azure.microsoft.com/pricing/details/sql-database/ 'Basic'
'Premium'
'PremiumRS'
'Standard'
catalogServerEndpoint URL del server di database del catalogo. string

IntegrationRuntimeSsisProperties

Name Description Value
catalogInfo Informazioni di catalogo per il tempo di integration runtime dedicato gestito. IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties Proprietà personalizzate dello script di setup per un runtime di integration runtime dedicato gestito. IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties Proprietà proxy dati per un runtime di integration runtime dedicato gestito. IntegrationRuntimeDataProxyProperties
edition L'edizione per l'SSIS Integration Runtime 'Enterprise'
'Standard'
expressCustomSetupProperties Configurazione personalizzata senza proprietà di script per un runtime di integrazione runtime SSIS. CustomSetupBase[]
licenseType Tipo di licenza per l'uso di uno scenario di licenza personalizzato. 'BasePrice'
'LicenseIncluded'

IntegrationRuntimeVNetProperties

Name Description Value
publicIPs ID delle risorse degli indirizzi IP pubblici che questa integration runtime utilizzerà. string[]
subnet Il nome della subnet a cui questa integration runtime si unirà. string
subnetId L'ID della subnet a cui verrà collegato il runtime di integrazione di Azure-SSIS. string
vNetId L'ID del VNet a cui questa integration runtime si unirà. string

LicensedComponentSetupTypeProperties

Name Description Value
componentName Nome del componente di terze parti. stringa (obbligatorio)
licenseKey Chiave di licenza per attivare il componente. SecretBase

LinkedIntegrationRuntimeKeyAuthorization

Name Description Value
authorizationType Il tipo di autorizzazione per la condivisione a integration runtime. 'Chiave' (obbligatorio)
key Chiave utilizzata per l'autorizzazione. SecureString (obbligatorio)

LinkedIntegrationRuntimeRbacAuthorization

Name Description Value
authorizationType Il tipo di autorizzazione per la condivisione a integration runtime. 'RBAC' (obbligatorio)
resourceId L'identificatore della risorsa del runtime di integration runtime da condividere. stringa (obbligatorio)

LinkedIntegrationRuntimeType

Name Description Value
authorizationType Impostare su 'Key' per il tipo LinkedIntegrationRuntimeKeyAuthorization. Impostare su "RBAC" per il tipo LinkedIntegrationRuntimeRbacAuthorization. 'Key'
'RBAC' (obbligatorio)

ManagedIntegrationRuntime

Name Description Value
managedVirtualNetwork Integrazione gestita, runtime, rete virtuale gestita. ManagedIntegrationRuntimeManagedVirtualNetworkReference
type Tipo di integration runtime. 'Gestito' (obbligatorio)
typeProperties Proprietà di integration runtime gestite. ManagedIntegrationRuntimeTypeProperties (obbligatorio)

ManagedIntegrationRuntimeManagedVirtualNetworkReference

Name Description Value
id L'id della managed virtual network. string
referenceName Il nome di riferimento della managed virtual network string
type Il tipo di managed virtual network. string

ManagedIntegrationRuntimeTypeProperties

Name Description Value
computeProperties La risorsa di calcolo per il managed integration runtime. IntegrationRuntimeComputeProperties
customerVirtualNetwork Il nome della rete virtuale a cui si unirà il runtime di integrazione Azure-SSIS IntegrationRuntimeCustomerVirtualNetwork
ssisProperties Proprietà SSIS per il runtime di integration gestita. IntegrationRuntimeSsisProperties

SecretBase

Name Description Value
type Impostare su 'SecureString' per il tipo SecureString. 'SecureString' (obbligatorio)

SecureString

Name Description Value
type Tipo del segreto. stringa (obbligatorio)
value Valore della stringa protetta. stringa (obbligatorio)

SecureString

Name Description Value
type Tipo del segreto. 'SecureString' (obbligatorio)
value Valore della stringa protetta. stringa (obbligatorio)

SelfHostedIntegrationRuntime

Name Description Value
type Tipo di integration runtime. 'SelfHosted' (obbligatorio)
typeProperties Quando questa proprietà non è nulla, significa che si tratta di un tempo di integrazione collegata. La proprietà viene utilizzata per access all'integration runtime originale. SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

Name Description Value
linkedInfo Tipo di integration runtime collegato dalla data factory LinkedIntegrationRuntimeType

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa workspaces/integrationRuntimes può essere distribuito con operazioni destinate a:

Esempi di utilizzo

Formato risorsa

Per creare un Microsoft. Risorsa Synapse/workspaces/integrationRuntimes, aggiungi il seguente JSON al tuo template.

{
  "type": "Microsoft.Synapse/workspaces/integrationRuntimes",
  "apiVersion": "2021-06-01",
  "name": "string",
  "properties": {
    "description": "string",
    "type": "string"
    // For remaining properties, see IntegrationRuntime objects
  }
}

Oggetti LinkedIntegrationRuntimeType

Impostare la proprietà authorizationType per specificare il tipo di oggetto.

Per la chiave, utilizzare:

{
  "authorizationType": "Key",
  "key": {
    "type": "string",
    "value": "string"
  }
}

Per RBAC, utilizzare:

{
  "authorizationType": "RBAC",
  "resourceId": "string"
}

Oggetti CustomSetupBase

Impostare la proprietà tipo di per specificare il tipo di oggetto.

Per CmdkeySetup, usare:

{
  "type": "CmdkeySetup",
  "typeProperties": {
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "targetName": {},
    "userName": {}
  }
}

Per ComponentSetup, utilizzare:

{
  "type": "ComponentSetup",
  "typeProperties": {
    "componentName": "string",
    "licenseKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    }
  }
}

Per EnvironmentVariableSetup, usare:

{
  "type": "EnvironmentVariableSetup",
  "typeProperties": {
    "variableName": "string",
    "variableValue": "string"
  }
}

Oggetti IntegrationRuntime

Impostare la proprietà tipo di per specificare il tipo di oggetto.

Per Managed, utilizzare:

{
  "managedVirtualNetwork": {
    "id": "string",
    "referenceName": "string",
    "type": "string"
  },
  "type": "Managed",
  "typeProperties": {
    "computeProperties": {
      "dataFlowProperties": {
        "computeType": "string",
        "coreCount": "int",
        "timeToLive": "int"
      },
      "location": "string",
      "maxParallelExecutionsPerNode": "int",
      "nodeSize": "string",
      "numberOfNodes": "int",
      "vNetProperties": {
        "publicIPs": [ "string" ],
        "subnet": "string",
        "subnetId": "string",
        "vNetId": "string"
      }
    },
    "customerVirtualNetwork": {
      "subnetId": "string"
    },
    "ssisProperties": {
      "catalogInfo": {
        "catalogAdminPassword": {
          "type": "string",
          "value": "string"
        },
        "catalogAdminUserName": "string",
        "catalogPricingTier": "string",
        "catalogServerEndpoint": "string"
      },
      "customSetupScriptProperties": {
        "blobContainerUri": "string",
        "sasToken": {
          "type": "string",
          "value": "string"
        }
      },
      "dataProxyProperties": {
        "connectVia": {
          "referenceName": "string",
          "type": "string"
        },
        "path": "string",
        "stagingLinkedService": {
          "referenceName": "string",
          "type": "string"
        }
      },
      "edition": "string",
      "expressCustomSetupProperties": [ {
        "type": "string"
        // For remaining properties, see CustomSetupBase objects
      } ],
      "licenseType": "string"
    }
  }
}

Per SelfHosted, utilizzare:

{
  "type": "SelfHosted",
  "typeProperties": {
    "linkedInfo": {
      "authorizationType": "string"
      // For remaining properties, see LinkedIntegrationRuntimeType objects
    }
  }
}

Oggetti SecretBase

Impostare la proprietà tipo di per specificare il tipo di oggetto.

Per SecureString, utilizzare:

{
  "type": "SecureString",
  "value": "string"
}

Valori delle proprietà

Microsoft. Synapse/workspaces/integrazioneRuntime.

Name Description Value
apiVersion Versione dell'API '2021-06-01'
name Nome della risorsa stringa (obbligatorio)
properties Integration runtime proprietà. IntegrationRuntime (obbligatorio)
type Tipo di risorsa 'Microsoft. Synapse/workspaces/integrationRuntimes'

CmdkeySetup

Name Description Value
type Tipo di installazione personalizzata. 'CmdkeySetup' (obbligatorio)
typeProperties Comando cmdkey proprietà del tipo di installazione personalizzato. CmdkeySetupTypeProperties (obbligatorio)

CmdkeySetupTypeProperties

Name Description Value
password La password dell'access alla fonte dati. SecretBase (obbligatorio)
targetName Il nome del server per l'access alla sorgente dati. qualsiasi (obbligatorio)
userName Il nome utente dell'accesso alla fonte dati. qualsiasi (obbligatorio)

ComponentSetup

Name Description Value
type Tipo di installazione personalizzata. 'ComponentSetup' (obbligatorio)
typeProperties Installare le proprietà del tipo di componente di terze parti. LicensedComponentSetupTypeProperties (obbligatorio)

CustomSetupBase

Name Description Value
type Impostare su 'CmdkeySetup' per il tipo CmdkeySetup. Impostare su 'ComponentSetup' per il tipo ComponentSetup. Impostare su 'EnvironmentVariableSetup' per il tipo EnvironmentVariableSetup. 'CmdkeySetup'
'ComponentSetup'
'EnvironmentVariableSetup' (obbligatorio)

EntityReference

Name Description Value
referenceName Nome di questa entità a cui si fa riferimento. string
type Tipo di questa entità a cui si fa riferimento. 'IntegrationRuntimeReference'
'LinkedServiceReference'

EnvironmentVariableSetup

Name Description Value
type Tipo di installazione personalizzata. 'EnvironmentVariableSetup' (obbligatorio)
typeProperties Aggiungere proprietà del tipo di variabile di ambiente. EnvironmentVariableSetupTypeProperties (obbligatorio)

EnvironmentVariableSetupTypeProperties

Name Description Value
variableName Nome della variabile di ambiente. stringa (obbligatorio)
variableValue Valore della variabile di ambiente. stringa (obbligatorio)

IntegrationRuntime

Name Description Value
description Integration runtime descrizione. string
type Impostare su "Managed" per il tipo ManagedIntegrationRuntime. Impostare su 'SelfHosted' per il tipo SelfHostedIntegrationRuntime. 'Managed'
'SelfHosted' (obbligatorio)

IntegrationRuntimeComputeProperties

Name Description Value
dataFlowProperties Data flow proprietà per managed integration runtime. IntegrationRuntimeDataFlowProperties
location La posizione per il managed integration runtime. Le regioni supportate si trovano su /azure/data-factory/data-factory-data-movement-activities string
maxParallelExecutionsPerNode Le esecuzioni parallele massime contano per nodo per il runtime di integration runtime gestita. int

Constraints:
Valore minimo = 1
nodeSize Il requisito di dimensione del nodo per gestire il tempo di integration runtime. string
numberOfNodes Il numero richiesto di nodi per l'integration runtime gestita. int

Constraints:
Valore minimo = 1
vNetProperties Proprietà VNet per l'integration runtime gestita. IntegrationRuntimeVNetProperties

IntegrationRuntimeCustomerVirtualNetwork

Name Description Value
subnetId L'ID della subnet a cui il runtime di integrazione Azure-SSIS si unirà. string

IntegrationRuntimeCustomSetupScriptProperties

Name Description Value
blobContainerUri L'URI del contenitore di blob Azure che contiene lo script di setup personalizzato. string
sasToken Il token SAS del contenitore blob Azure. SecureString

IntegrationRuntimeDataFlowProperties

Name Description Value
computeType Tipo di calcolo del cluster che eseguirà il data flow job. 'ComputeOptimized'
'General'
'MemoryOptimized'
coreCount Conteggio dei core del cluster che eseguirà il data flow job. I valori supportati sono: 8, 16, 32, 48, 80, 144 e 272. int
timeToLive Impostazione time to live (in minuti) del cluster che eseguirà il data flow job. int

Constraints:
Valore minimo = 0

IntegrationRuntimeDataProxyProperties

Name Description Value
connectVia Il riferimento di integration runtime self-ospitato. Riferimento entità
path Il percorso per contenere i dati a stadi nel Blob storage. string
stagingLinkedService Informazioni di riferimento sul servizio collegato di staging. Riferimento entità

IntegrationRuntimeSsisCatalogInfo

Name Description Value
catalogAdminPassword Password dell'account utente amministratore del database del catalogo. SecureString
catalogAdminUserName Nome utente amministratore del database di catalogo. string

Constraints:
Lunghezza minima = 1
Lunghezza massima = 128
catalogPricingTier Piano tariffario per il database di catalogo. I valori validi si potevano trovare in https://azure.microsoft.com/pricing/details/sql-database/ 'Basic'
'Premium'
'PremiumRS'
'Standard'
catalogServerEndpoint URL del server di database del catalogo. string

IntegrationRuntimeSsisProperties

Name Description Value
catalogInfo Informazioni di catalogo per il tempo di integration runtime dedicato gestito. IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties Proprietà personalizzate dello script di setup per un runtime di integration runtime dedicato gestito. IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties Proprietà proxy dati per un runtime di integration runtime dedicato gestito. IntegrationRuntimeDataProxyProperties
edition L'edizione per l'SSIS Integration Runtime 'Enterprise'
'Standard'
expressCustomSetupProperties Configurazione personalizzata senza proprietà di script per un runtime di integrazione runtime SSIS. CustomSetupBase[]
licenseType Tipo di licenza per l'uso di uno scenario di licenza personalizzato. 'BasePrice'
'LicenseIncluded'

IntegrationRuntimeVNetProperties

Name Description Value
publicIPs ID delle risorse degli indirizzi IP pubblici che questa integration runtime utilizzerà. string[]
subnet Il nome della subnet a cui questa integration runtime si unirà. string
subnetId L'ID della subnet a cui verrà collegato il runtime di integrazione di Azure-SSIS. string
vNetId L'ID del VNet a cui questa integration runtime si unirà. string

LicensedComponentSetupTypeProperties

Name Description Value
componentName Nome del componente di terze parti. stringa (obbligatorio)
licenseKey Chiave di licenza per attivare il componente. SecretBase

LinkedIntegrationRuntimeKeyAuthorization

Name Description Value
authorizationType Il tipo di autorizzazione per la condivisione a integration runtime. 'Chiave' (obbligatorio)
key Chiave utilizzata per l'autorizzazione. SecureString (obbligatorio)

LinkedIntegrationRuntimeRbacAuthorization

Name Description Value
authorizationType Il tipo di autorizzazione per la condivisione a integration runtime. 'RBAC' (obbligatorio)
resourceId L'identificatore della risorsa del runtime di integration runtime da condividere. stringa (obbligatorio)

LinkedIntegrationRuntimeType

Name Description Value
authorizationType Impostare su 'Key' per il tipo LinkedIntegrationRuntimeKeyAuthorization. Impostare su "RBAC" per il tipo LinkedIntegrationRuntimeRbacAuthorization. 'Key'
'RBAC' (obbligatorio)

ManagedIntegrationRuntime

Name Description Value
managedVirtualNetwork Integrazione gestita, runtime, rete virtuale gestita. ManagedIntegrationRuntimeManagedVirtualNetworkReference
type Tipo di integration runtime. 'Gestito' (obbligatorio)
typeProperties Proprietà di integration runtime gestite. ManagedIntegrationRuntimeTypeProperties (obbligatorio)

ManagedIntegrationRuntimeManagedVirtualNetworkReference

Name Description Value
id L'id della managed virtual network. string
referenceName Il nome di riferimento della managed virtual network string
type Il tipo di managed virtual network. string

ManagedIntegrationRuntimeTypeProperties

Name Description Value
computeProperties La risorsa di calcolo per il managed integration runtime. IntegrationRuntimeComputeProperties
customerVirtualNetwork Il nome della rete virtuale a cui si unirà il runtime di integrazione Azure-SSIS IntegrationRuntimeCustomerVirtualNetwork
ssisProperties Proprietà SSIS per il runtime di integration gestita. IntegrationRuntimeSsisProperties

SecretBase

Name Description Value
type Impostare su 'SecureString' per il tipo SecureString. 'SecureString' (obbligatorio)

SecureString

Name Description Value
type Tipo del segreto. stringa (obbligatorio)
value Valore della stringa protetta. stringa (obbligatorio)

SecureString

Name Description Value
type Tipo del segreto. 'SecureString' (obbligatorio)
value Valore della stringa protetta. stringa (obbligatorio)

SelfHostedIntegrationRuntime

Name Description Value
type Tipo di integration runtime. 'SelfHosted' (obbligatorio)
typeProperties Quando questa proprietà non è nulla, significa che si tratta di un tempo di integrazione collegata. La proprietà viene utilizzata per access all'integration runtime originale. SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

Name Description Value
linkedInfo Tipo di integration runtime collegato dalla data factory LinkedIntegrationRuntimeType

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa workspaces/integrationRuntimes può essere distribuito con operazioni destinate a:

  • Gruppi di risorse Per un elenco delle proprietà modificate in ogni versione dell'API, vedi il registro modifiche.

Esempi di utilizzo

Esempi di Terraform

Un esempio base di utilizzo di Synapse Azure Integration Runtime.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

variable "sql_administrator_login" {
  type        = string
  description = "The SQL administrator login for the Synapse workspace"
}

variable "sql_administrator_login_password" {
  type        = string
  description = "The SQL administrator login password for the Synapse workspace"
  sensitive   = true
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "storageAccount" {
  type      = "Microsoft.Storage/storageAccounts@2021-09-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "StorageV2"
    properties = {
    }
    sku = {
      name = "Standard_LRS"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

data "azapi_resource_action" "listKeys" {
  type                   = "Microsoft.Storage/storageAccounts@2022-09-01"
  resource_id            = azapi_resource.storageAccount.id
  action                 = "listKeys"
  response_export_values = ["*"]
}

data "azapi_resource" "blobService" {
  type      = "Microsoft.Storage/storageAccounts/blobServices@2022-09-01"
  parent_id = azapi_resource.storageAccount.id
  name      = "default"
}

resource "azapi_resource" "container" {
  type      = "Microsoft.Storage/storageAccounts/blobServices/containers@2022-09-01"
  name      = var.resource_name
  parent_id = data.azapi_resource.blobService.id
  body = {
    properties = {
      metadata = {
        key = "value"
      }
    }
  }
  response_export_values = ["*"]
}

resource "azapi_resource" "workspace" {
  type      = "Microsoft.Synapse/workspaces@2021-06-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  identity {
    type         = "SystemAssigned"
    identity_ids = []
  }
  body = {
    properties = {
      defaultDataLakeStorage = {
        accountUrl = azapi_resource.storageAccount.output.properties.primaryEndpoints.dfs
        filesystem = azapi_resource.container.name
      }

      managedVirtualNetwork         = "default"
      publicNetworkAccess           = "Enabled"
      sqlAdministratorLogin         = var.sql_administrator_login
      sqlAdministratorLoginPassword = var.sql_administrator_login_password
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "integrationRuntime" {
  type      = "Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01-preview"
  parent_id = azapi_resource.workspace.id
  name      = var.resource_name
  body = {
    properties = {
      description = "test"
      type        = "SelfHosted"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Formato risorsa

Per creare un Microsoft. Risorsa Synapse/workspaces/integrationRuntimes, aggiungi il seguente Terraform al tuo template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      description = "string"
      type = "string"
      // For remaining properties, see IntegrationRuntime objects
    }
  }
}

Oggetti LinkedIntegrationRuntimeType

Impostare la proprietà authorizationType per specificare il tipo di oggetto.

Per la chiave, utilizzare:

{
  authorizationType = "Key"
  key = {
    type = "string"
    value = "string"
  }
}

Per RBAC, utilizzare:

{
  authorizationType = "RBAC"
  resourceId = "string"
}

Oggetti CustomSetupBase

Impostare la proprietà tipo di per specificare il tipo di oggetto.

Per CmdkeySetup, usare:

{
  type = "CmdkeySetup"
  typeProperties = {
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    targetName = ?
    userName = ?
  }
}

Per ComponentSetup, utilizzare:

{
  type = "ComponentSetup"
  typeProperties = {
    componentName = "string"
    licenseKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }
}

Per EnvironmentVariableSetup, usare:

{
  type = "EnvironmentVariableSetup"
  typeProperties = {
    variableName = "string"
    variableValue = "string"
  }
}

Oggetti IntegrationRuntime

Impostare la proprietà tipo di per specificare il tipo di oggetto.

Per Managed, utilizzare:

{
  managedVirtualNetwork = {
    id = "string"
    referenceName = "string"
    type = "string"
  }
  type = "Managed"
  typeProperties = {
    computeProperties = {
      dataFlowProperties = {
        computeType = "string"
        coreCount = int
        timeToLive = int
      }
      location = "string"
      maxParallelExecutionsPerNode = int
      nodeSize = "string"
      numberOfNodes = int
      vNetProperties = {
        publicIPs = [
          "string"
        ]
        subnet = "string"
        subnetId = "string"
        vNetId = "string"
      }
    }
    customerVirtualNetwork = {
      subnetId = "string"
    }
    ssisProperties = {
      catalogInfo = {
        catalogAdminPassword = {
          type = "string"
          value = "string"
        }
        catalogAdminUserName = "string"
        catalogPricingTier = "string"
        catalogServerEndpoint = "string"
      }
      customSetupScriptProperties = {
        blobContainerUri = "string"
        sasToken = {
          type = "string"
          value = "string"
        }
      }
      dataProxyProperties = {
        connectVia = {
          referenceName = "string"
          type = "string"
        }
        path = "string"
        stagingLinkedService = {
          referenceName = "string"
          type = "string"
        }
      }
      edition = "string"
      expressCustomSetupProperties = [
        {
          type = "string"
          // For remaining properties, see CustomSetupBase objects
        }
      ]
      licenseType = "string"
    }
  }
}

Per SelfHosted, utilizzare:

{
  type = "SelfHosted"
  typeProperties = {
    linkedInfo = {
      authorizationType = "string"
      // For remaining properties, see LinkedIntegrationRuntimeType objects
    }
  }
}

Oggetti SecretBase

Impostare la proprietà tipo di per specificare il tipo di oggetto.

Per SecureString, utilizzare:

{
  type = "SecureString"
  value = "string"
}

Valori delle proprietà

Microsoft. Synapse/workspaces/integrazioneRuntime.

Name Description Value
name Nome della risorsa stringa (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: workspaces
properties Integration runtime proprietà. IntegrationRuntime (obbligatorio)
type Tipo di risorsa "Microsoft. Sinapsi/spazi di lavoro/integrationRuntimes@2021-06-01"

CmdkeySetup

Name Description Value
type Tipo di installazione personalizzata. 'CmdkeySetup' (obbligatorio)
typeProperties Comando cmdkey proprietà del tipo di installazione personalizzato. CmdkeySetupTypeProperties (obbligatorio)

CmdkeySetupTypeProperties

Name Description Value
password La password dell'access alla fonte dati. SecretBase (obbligatorio)
targetName Il nome del server per l'access alla sorgente dati. qualsiasi (obbligatorio)
userName Il nome utente dell'accesso alla fonte dati. qualsiasi (obbligatorio)

ComponentSetup

Name Description Value
type Tipo di installazione personalizzata. 'ComponentSetup' (obbligatorio)
typeProperties Installare le proprietà del tipo di componente di terze parti. LicensedComponentSetupTypeProperties (obbligatorio)

CustomSetupBase

Name Description Value
type Impostare su 'CmdkeySetup' per il tipo CmdkeySetup. Impostare su 'ComponentSetup' per il tipo ComponentSetup. Impostare su 'EnvironmentVariableSetup' per il tipo EnvironmentVariableSetup. 'CmdkeySetup'
'ComponentSetup'
'EnvironmentVariableSetup' (obbligatorio)

EntityReference

Name Description Value
referenceName Nome di questa entità a cui si fa riferimento. string
type Tipo di questa entità a cui si fa riferimento. 'IntegrationRuntimeReference'
'LinkedServiceReference'

EnvironmentVariableSetup

Name Description Value
type Tipo di installazione personalizzata. 'EnvironmentVariableSetup' (obbligatorio)
typeProperties Aggiungere proprietà del tipo di variabile di ambiente. EnvironmentVariableSetupTypeProperties (obbligatorio)

EnvironmentVariableSetupTypeProperties

Name Description Value
variableName Nome della variabile di ambiente. stringa (obbligatorio)
variableValue Valore della variabile di ambiente. stringa (obbligatorio)

IntegrationRuntime

Name Description Value
description Integration runtime descrizione. string
type Impostare su "Managed" per il tipo ManagedIntegrationRuntime. Impostare su 'SelfHosted' per il tipo SelfHostedIntegrationRuntime. 'Managed'
'SelfHosted' (obbligatorio)

IntegrationRuntimeComputeProperties

Name Description Value
dataFlowProperties Data flow proprietà per managed integration runtime. IntegrationRuntimeDataFlowProperties
location La posizione per il managed integration runtime. Le regioni supportate si trovano su /azure/data-factory/data-factory-data-movement-activities string
maxParallelExecutionsPerNode Le esecuzioni parallele massime contano per nodo per il runtime di integration runtime gestita. int

Constraints:
Valore minimo = 1
nodeSize Il requisito di dimensione del nodo per gestire il tempo di integration runtime. string
numberOfNodes Il numero richiesto di nodi per l'integration runtime gestita. int

Constraints:
Valore minimo = 1
vNetProperties Proprietà VNet per l'integration runtime gestita. IntegrationRuntimeVNetProperties

IntegrationRuntimeCustomerVirtualNetwork

Name Description Value
subnetId L'ID della subnet a cui il runtime di integrazione Azure-SSIS si unirà. string

IntegrationRuntimeCustomSetupScriptProperties

Name Description Value
blobContainerUri L'URI del contenitore di blob Azure che contiene lo script di setup personalizzato. string
sasToken Il token SAS del contenitore blob Azure. SecureString

IntegrationRuntimeDataFlowProperties

Name Description Value
computeType Tipo di calcolo del cluster che eseguirà il data flow job. 'ComputeOptimized'
'General'
'MemoryOptimized'
coreCount Conteggio dei core del cluster che eseguirà il data flow job. I valori supportati sono: 8, 16, 32, 48, 80, 144 e 272. int
timeToLive Impostazione time to live (in minuti) del cluster che eseguirà il data flow job. int

Constraints:
Valore minimo = 0

IntegrationRuntimeDataProxyProperties

Name Description Value
connectVia Il riferimento di integration runtime self-ospitato. Riferimento entità
path Il percorso per contenere i dati a stadi nel Blob storage. string
stagingLinkedService Informazioni di riferimento sul servizio collegato di staging. Riferimento entità

IntegrationRuntimeSsisCatalogInfo

Name Description Value
catalogAdminPassword Password dell'account utente amministratore del database del catalogo. SecureString
catalogAdminUserName Nome utente amministratore del database di catalogo. string

Constraints:
Lunghezza minima = 1
Lunghezza massima = 128
catalogPricingTier Piano tariffario per il database di catalogo. I valori validi si potevano trovare in https://azure.microsoft.com/pricing/details/sql-database/ 'Basic'
'Premium'
'PremiumRS'
'Standard'
catalogServerEndpoint URL del server di database del catalogo. string

IntegrationRuntimeSsisProperties

Name Description Value
catalogInfo Informazioni di catalogo per il tempo di integration runtime dedicato gestito. IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties Proprietà personalizzate dello script di setup per un runtime di integration runtime dedicato gestito. IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties Proprietà proxy dati per un runtime di integration runtime dedicato gestito. IntegrationRuntimeDataProxyProperties
edition L'edizione per l'SSIS Integration Runtime 'Enterprise'
'Standard'
expressCustomSetupProperties Configurazione personalizzata senza proprietà di script per un runtime di integrazione runtime SSIS. CustomSetupBase[]
licenseType Tipo di licenza per l'uso di uno scenario di licenza personalizzato. 'BasePrice'
'LicenseIncluded'

IntegrationRuntimeVNetProperties

Name Description Value
publicIPs ID delle risorse degli indirizzi IP pubblici che questa integration runtime utilizzerà. string[]
subnet Il nome della subnet a cui questa integration runtime si unirà. string
subnetId L'ID della subnet a cui verrà collegato il runtime di integrazione di Azure-SSIS. string
vNetId L'ID del VNet a cui questa integration runtime si unirà. string

LicensedComponentSetupTypeProperties

Name Description Value
componentName Nome del componente di terze parti. stringa (obbligatorio)
licenseKey Chiave di licenza per attivare il componente. SecretBase

LinkedIntegrationRuntimeKeyAuthorization

Name Description Value
authorizationType Il tipo di autorizzazione per la condivisione a integration runtime. 'Chiave' (obbligatorio)
key Chiave utilizzata per l'autorizzazione. SecureString (obbligatorio)

LinkedIntegrationRuntimeRbacAuthorization

Name Description Value
authorizationType Il tipo di autorizzazione per la condivisione a integration runtime. 'RBAC' (obbligatorio)
resourceId L'identificatore della risorsa del runtime di integration runtime da condividere. stringa (obbligatorio)

LinkedIntegrationRuntimeType

Name Description Value
authorizationType Impostare su 'Key' per il tipo LinkedIntegrationRuntimeKeyAuthorization. Impostare su "RBAC" per il tipo LinkedIntegrationRuntimeRbacAuthorization. 'Key'
'RBAC' (obbligatorio)

ManagedIntegrationRuntime

Name Description Value
managedVirtualNetwork Integrazione gestita, runtime, rete virtuale gestita. ManagedIntegrationRuntimeManagedVirtualNetworkReference
type Tipo di integration runtime. 'Gestito' (obbligatorio)
typeProperties Proprietà di integration runtime gestite. ManagedIntegrationRuntimeTypeProperties (obbligatorio)

ManagedIntegrationRuntimeManagedVirtualNetworkReference

Name Description Value
id L'id della managed virtual network. string
referenceName Il nome di riferimento della managed virtual network string
type Il tipo di managed virtual network. string

ManagedIntegrationRuntimeTypeProperties

Name Description Value
computeProperties La risorsa di calcolo per il managed integration runtime. IntegrationRuntimeComputeProperties
customerVirtualNetwork Il nome della rete virtuale a cui si unirà il runtime di integrazione Azure-SSIS IntegrationRuntimeCustomerVirtualNetwork
ssisProperties Proprietà SSIS per il runtime di integration gestita. IntegrationRuntimeSsisProperties

SecretBase

Name Description Value
type Impostare su 'SecureString' per il tipo SecureString. 'SecureString' (obbligatorio)

SecureString

Name Description Value
type Tipo del segreto. stringa (obbligatorio)
value Valore della stringa protetta. stringa (obbligatorio)

SecureString

Name Description Value
type Tipo del segreto. 'SecureString' (obbligatorio)
value Valore della stringa protetta. stringa (obbligatorio)

SelfHostedIntegrationRuntime

Name Description Value
type Tipo di integration runtime. 'SelfHosted' (obbligatorio)
typeProperties Quando questa proprietà non è nulla, significa che si tratta di un tempo di integrazione collegata. La proprietà viene utilizzata per access all'integration runtime originale. SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

Name Description Value
linkedInfo Tipo di integration runtime collegato dalla data factory LinkedIntegrationRuntimeType
  • Last updated on