Microsoft. Synapse workspaces/integrationRuntimes 2021-03-01

Definice zdroje Bicep

Typ prostředku workspaces/integrationRuntimes je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Příklady použití

Vzorky Bicepsu

Základní příklad nasazení 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'
    }
  }
}

Ověřené moduly Azure

K nasazení tohoto typu prostředku je možné použít následující ověřené moduly Azure.

Module Description
Azure Synapse Analytics Workspace - Integration Runtime AVM Child Module for Azure Synapse Analytics Workspace - Integration Runtime

Formát prostředku

Vytvořit Microsoft. Synapse/workspaces/integrationRuntimes resource – přidejte následující Bicep do své šablony.

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

Objekty IntegrationRuntime

Nastavte typ vlastnost určit typ objektu.

Pro Spravované použijte:

{
  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'
      }
    }
    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'
    }
  }
}

V případě SelfHosted použijte:

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

Objekty SecretBase

Nastavte typ vlastnost určit typ objektu.

Pro SecureString použijte:

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

Objekty CustomSetupBase

Nastavte typ vlastnost určit typ objektu.

Pro Cmdkeysetup použijte:

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

Pro ComponentSetup použijte:

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

Pro EnvironmentVariableSetup použijte:

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

Objekty LinkedIntegrationRuntimeType

Nastavte vlastnost authorizationType tak, aby určovala typ objektu.

Pro klíč použijte:

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

Pro RBAC použijte:

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

Hodnoty vlastností

Microsoft. Synapse/workspaces/integrationRuntime

Name Description Value
name Název prostředku řetězec (povinné)
nadřazený objekt V Bicep můžete specifikovat rodičovský zdroj pro poddaný zdroj. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Pro více informací viz Child resource outside parent resource.
Symbolický název prostředku typu: pracovních prostorů
properties Integration runtime vlastnosti. IntegrationRuntime (povinné)

CmdkeySetup

Name Description Value
typ Typ vlastní instalace. 'CmdkeySetup' (povinné)
typeProperties Vlastnosti vlastního typu nastavení příkazu Cmdkey CmdkeySetupTypeProperties (povinné)

CmdkeySetupTypeProperties

Name Description Value
heslo Heslo pro data source access. SecretBase (povinné)
targetName Název serveru pro data source access. libovolný (povinné)
userName Uživatelské jméno data source access. libovolný (povinné)

ComponentSetup

Name Description Value
typ Typ vlastní instalace. 'ComponentSetup' (povinné)
typeProperties Nainstalujte vlastnosti typu komponenty třetí strany. LicensedComponentSetupTypeProperties (povinné)

CustomSetupBase

Name Description Value
typ Nastavte na 'CmdkeySetup' pro typ CmdkeySetup. Nastavte na "ComponentSetup" pro typ ComponentSetup. Nastavte na "EnvironmentVariableSetup" pro typ EnvironmentVariableSetup. 'CmdkeySetup'
'ComponentSetup'
'EnvironmentVariableSetup' (povinné)

EntityReference

Name Description Value
referenceName Název této odkazované entity. řetězec
typ Typ této odkazované entity. 'IntegrationRuntimeReference'
'LinkedServiceReference'

EnvironmentVariableSetup

Name Description Value
typ Typ vlastní instalace. 'EnvironmentVariableSetup' (povinné)
typeProperties Přidejte vlastnosti typu proměnné prostředí. EnvironmentVariableSetupTypeProperties (povinné)

EnvironmentVariableSetupTypeProperties

Name Description Value
variableName Název proměnné prostředí. řetězec (povinné)
variableValue Hodnota proměnné prostředí. řetězec (povinné)

IntegrationRuntime

Name Description Value
description Integration runtime popis. řetězec
typ Nastavte na "Managed" pro typ ManagedIntegrationRuntime. Nastavte na "SelfHosted" pro typ SelfHostedIntegrationRuntime. 'Managed'
"S vlastním hostitelem" (povinné)

IntegrationRuntimeComputeProperties

Name Description Value
dataFlowProperties Vlastnosti Data flow pro řízenou integration runtime. IntegrationRuntimeDataFlowProperties
poloha Místo pro řízenou integration runtime. Podporované regiony lze nalézt na /azure/data-factory/data-factory-data-movement-activities řetězec
maxParallelExecutionsPerNode Maximální počet paralelních provedení se počítá na uzel pro řízenou integration runtime. int

Constraints:
Minimální hodnota = 1
nodeSize Požadavek na velikost uzlu pro řízenou integration runtime. řetězec
numberOfNodes Požadovaný počet uzlů pro řízenou integration runtime. int

Constraints:
Minimální hodnota = 1
vNetProperties Vlastnosti VNetu pro řízenou integration runtime. IntegrationRuntimeVNetProperties

IntegrationRuntimeCustomSetupScriptProperties

Name Description Value
blobContainerUri URI Azure blob kontejneru, který obsahuje vlastní setup skript. řetězec
sasToken SAS token Azure blob kontejneru. SecureString

IntegrationRuntimeDataFlowProperties

Name Description Value
computeType Typ výpočtu clusteru, který vykoná data flow úlohu. 'ComputeOptimized'
'General'
'MemoryOptimized'
coreCount Počet jader clusteru, který bude vykonávat data flow úlohu. Podporované hodnoty jsou: 8, 16, 32, 48, 80, 144 a 272. int
timeToLive Nastavení clusteru Time to Live (v minutách), které spustí data flow job. int

Constraints:
Minimální hodnota = 0

IntegrationRuntimeDataProxyProperties

Name Description Value
connectVia Odkaz na self-hostovanou integration runtime. Odkaz na entitu
cesta Cesta k uložení postupně uspořádaných dat do Blob storage. řetězec
stagingLinkedService Referenční informace k pracovní propojené službě. Odkaz na entitu

IntegrationRuntimeSsisCatalogInfo

Name Description Value
catalogAdminPassword Heslo uživatelskéhoúčtuhohohoho SecureString
catalogAdminUserName Uživatelské jméno správce databáze katalogu. string

Constraints:
Minimální délka = 1
Maximální délka = 128
catalogPricingTier Cenová úroveň databáze katalogu. Platné hodnoty lze nalézt v https://azure.microsoft.com/pricing/details/sql-database/ 'Basic'
'Premium'
'PremiumRS'
'Standard'
catalogServerEndpoint Adresa URL databázového serveru katalogu. řetězec

IntegrationRuntimeSsisProperties

Name Description Value
catalogInfo Katalogové informace pro spravovaný dedikovaný integration runtime. IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties Vlastní vlastnosti setup skriptu pro spravovaný dedikovaný integration runtime. IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties Vlastnosti datového proxy pro řízený dedikovaný integration runtime. IntegrationRuntimeDataProxyProperties
edition Edice pro SSIS Integration Runtime 'Enterprise'
'Standard'
expressCustomSetupProperties Vlastní nastavení bez vlastností skriptu pro integration runtime se SSIS. CustomSetupBase[]
licenseType Typ licence pro přenesení vlastního scénáře licence. 'BasePrice'
'LicenseIncluded'

IntegrationRuntimeVNetProperties

Name Description Value
publicIPs Resource ID veřejných IP adres, které bude tato integration runtime využívat. string[]
podsíť Název podsítě, ke které se tento integration runtime připojí. řetězec
subnetId ID podsítě, ke které bude připojeno toto runtime pro integraci Azure-SSIS. řetězec
vNetId ID VNetu, ke kterému se tato integration runtime připojí. řetězec

LicensedComponentSetupTypeProperties

Name Description Value
componentName Název komponenty třetí strany. řetězec (povinné)
licenseKey Licenční klíč pro aktivaci komponenty. SecretBase

LinkedIntegrationRuntimeKeyAuthorization

Name Description Value
authorizationType Typ autorizace pro sdílení integration runtime. "Klíč" (povinné)
klíč Klíč použitý k autorizaci. SecureString (povinné)

LinkedIntegrationRuntimeRbacAuthorization

Name Description Value
authorizationType Typ autorizace pro sdílení integration runtime. "RBAC" (povinné)
resourceId Identifikátor zdroje integration runtime, který má být sdílen. řetězec (povinné)

LinkedIntegrationRuntimeType

Name Description Value
authorizationType Nastavte na "Klíč" pro typ LinkedIntegrationRuntimeKeyAuthorization. Nastavte na RBAC pro typ LinkedIntegrationRuntimeRbacAuthorization. 'Key'
"RBAC" (povinné)

ManagedIntegrationRuntime

Name Description Value
typ Typ integration runtime. Spravované (povinné)
typeProperties Spravované vlastnosti integration runtime. ManagedIntegrationRuntimeTypeProperties (povinné)

ManagedIntegrationRuntimeTypeProperties

Name Description Value
computeProperties Výpočetní zdroj pro řízenou integration runtime. IntegrationRuntimeComputeProperties
ssisProperties Vlastnosti SSIS pro řízenou integration runtime. IntegrationRuntimeSsisProperties

SecretBase

Name Description Value
typ Nastavte na 'SecureString' pro typ SecureString. 'SecureString' (povinné)

SecureString

Name Description Value
typ Typ tajného kódu. řetězec (povinné)
value Hodnota zabezpečeného řetězce řetězec (povinné)

SecureString

Name Description Value
typ Typ tajného kódu. 'SecureString' (povinné)
value Hodnota zabezpečeného řetězce řetězec (povinné)

SelfHostedIntegrationRuntime

Name Description Value
typ Typ integration runtime. "S vlastním hostitelem" (povinné)
typeProperties Pokud tato vlastnost není null, znamená to, že se jedná o propojenou integration runtime. Vlastnost se používá k access k původnímu integration runtime. SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

Name Description Value
linkedInfo Typ propojené integration runtime z data factory LinkedIntegrationRuntimeType

Definice prostředku šablony ARM

Typ prostředku workspaces/integrationRuntimes je možné nasadit s operacemi, které cílí:

Příklady použití

Formát prostředku

Vytvořit Microsoft. Synapse/workspaces/integrationRuntimes resource – přidejte do šablony následující JSON.

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

Objekty IntegrationRuntime

Nastavte typ vlastnost určit typ objektu.

Pro Spravované použijte:

{
  "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"
      }
    },
    "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"
    }
  }
}

V případě SelfHosted použijte:

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

Objekty SecretBase

Nastavte typ vlastnost určit typ objektu.

Pro SecureString použijte:

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

Objekty CustomSetupBase

Nastavte typ vlastnost určit typ objektu.

Pro Cmdkeysetup použijte:

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

Pro ComponentSetup použijte:

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

Pro EnvironmentVariableSetup použijte:

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

Objekty LinkedIntegrationRuntimeType

Nastavte vlastnost authorizationType tak, aby určovala typ objektu.

Pro klíč použijte:

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

Pro RBAC použijte:

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

Hodnoty vlastností

Microsoft. Synapse/workspaces/integrationRuntime

Name Description Value
apiVersion Verze rozhraní API '2021-03-01'
name Název prostředku řetězec (povinné)
properties Integration runtime vlastnosti. IntegrationRuntime (povinné)
typ Typ prostředku 'Microsoft. Synapse/workspaces/integrationRuntime'

CmdkeySetup

Name Description Value
typ Typ vlastní instalace. 'CmdkeySetup' (povinné)
typeProperties Vlastnosti vlastního typu nastavení příkazu Cmdkey CmdkeySetupTypeProperties (povinné)

CmdkeySetupTypeProperties

Name Description Value
heslo Heslo pro data source access. SecretBase (povinné)
targetName Název serveru pro data source access. libovolný (povinné)
userName Uživatelské jméno data source access. libovolný (povinné)

ComponentSetup

Name Description Value
typ Typ vlastní instalace. 'ComponentSetup' (povinné)
typeProperties Nainstalujte vlastnosti typu komponenty třetí strany. LicensedComponentSetupTypeProperties (povinné)

CustomSetupBase

Name Description Value
typ Nastavte na 'CmdkeySetup' pro typ CmdkeySetup. Nastavte na "ComponentSetup" pro typ ComponentSetup. Nastavte na "EnvironmentVariableSetup" pro typ EnvironmentVariableSetup. 'CmdkeySetup'
'ComponentSetup'
'EnvironmentVariableSetup' (povinné)

EntityReference

Name Description Value
referenceName Název této odkazované entity. řetězec
typ Typ této odkazované entity. 'IntegrationRuntimeReference'
'LinkedServiceReference'

EnvironmentVariableSetup

Name Description Value
typ Typ vlastní instalace. 'EnvironmentVariableSetup' (povinné)
typeProperties Přidejte vlastnosti typu proměnné prostředí. EnvironmentVariableSetupTypeProperties (povinné)

EnvironmentVariableSetupTypeProperties

Name Description Value
variableName Název proměnné prostředí. řetězec (povinné)
variableValue Hodnota proměnné prostředí. řetězec (povinné)

IntegrationRuntime

Name Description Value
description Integration runtime popis. řetězec
typ Nastavte na "Managed" pro typ ManagedIntegrationRuntime. Nastavte na "SelfHosted" pro typ SelfHostedIntegrationRuntime. 'Managed'
"S vlastním hostitelem" (povinné)

IntegrationRuntimeComputeProperties

Name Description Value
dataFlowProperties Vlastnosti Data flow pro řízenou integration runtime. IntegrationRuntimeDataFlowProperties
poloha Místo pro řízenou integration runtime. Podporované regiony lze nalézt na /azure/data-factory/data-factory-data-movement-activities řetězec
maxParallelExecutionsPerNode Maximální počet paralelních provedení se počítá na uzel pro řízenou integration runtime. int

Constraints:
Minimální hodnota = 1
nodeSize Požadavek na velikost uzlu pro řízenou integration runtime. řetězec
numberOfNodes Požadovaný počet uzlů pro řízenou integration runtime. int

Constraints:
Minimální hodnota = 1
vNetProperties Vlastnosti VNetu pro řízenou integration runtime. IntegrationRuntimeVNetProperties

IntegrationRuntimeCustomSetupScriptProperties

Name Description Value
blobContainerUri URI Azure blob kontejneru, který obsahuje vlastní setup skript. řetězec
sasToken SAS token Azure blob kontejneru. SecureString

IntegrationRuntimeDataFlowProperties

Name Description Value
computeType Typ výpočtu clusteru, který vykoná data flow úlohu. 'ComputeOptimized'
'General'
'MemoryOptimized'
coreCount Počet jader clusteru, který bude vykonávat data flow úlohu. Podporované hodnoty jsou: 8, 16, 32, 48, 80, 144 a 272. int
timeToLive Nastavení clusteru Time to Live (v minutách), které spustí data flow job. int

Constraints:
Minimální hodnota = 0

IntegrationRuntimeDataProxyProperties

Name Description Value
connectVia Odkaz na self-hostovanou integration runtime. Odkaz na entitu
cesta Cesta k uložení postupně uspořádaných dat do Blob storage. řetězec
stagingLinkedService Referenční informace k pracovní propojené službě. Odkaz na entitu

IntegrationRuntimeSsisCatalogInfo

Name Description Value
catalogAdminPassword Heslo uživatelskéhoúčtuhohohoho SecureString
catalogAdminUserName Uživatelské jméno správce databáze katalogu. string

Constraints:
Minimální délka = 1
Maximální délka = 128
catalogPricingTier Cenová úroveň databáze katalogu. Platné hodnoty lze nalézt v https://azure.microsoft.com/pricing/details/sql-database/ 'Basic'
'Premium'
'PremiumRS'
'Standard'
catalogServerEndpoint Adresa URL databázového serveru katalogu. řetězec

IntegrationRuntimeSsisProperties

Name Description Value
catalogInfo Katalogové informace pro spravovaný dedikovaný integration runtime. IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties Vlastní vlastnosti setup skriptu pro spravovaný dedikovaný integration runtime. IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties Vlastnosti datového proxy pro řízený dedikovaný integration runtime. IntegrationRuntimeDataProxyProperties
edition Edice pro SSIS Integration Runtime 'Enterprise'
'Standard'
expressCustomSetupProperties Vlastní nastavení bez vlastností skriptu pro integration runtime se SSIS. CustomSetupBase[]
licenseType Typ licence pro přenesení vlastního scénáře licence. 'BasePrice'
'LicenseIncluded'

IntegrationRuntimeVNetProperties

Name Description Value
publicIPs Resource ID veřejných IP adres, které bude tato integration runtime využívat. string[]
podsíť Název podsítě, ke které se tento integration runtime připojí. řetězec
subnetId ID podsítě, ke které bude připojeno toto runtime pro integraci Azure-SSIS. řetězec
vNetId ID VNetu, ke kterému se tato integration runtime připojí. řetězec

LicensedComponentSetupTypeProperties

Name Description Value
componentName Název komponenty třetí strany. řetězec (povinné)
licenseKey Licenční klíč pro aktivaci komponenty. SecretBase

LinkedIntegrationRuntimeKeyAuthorization

Name Description Value
authorizationType Typ autorizace pro sdílení integration runtime. "Klíč" (povinné)
klíč Klíč použitý k autorizaci. SecureString (povinné)

LinkedIntegrationRuntimeRbacAuthorization

Name Description Value
authorizationType Typ autorizace pro sdílení integration runtime. "RBAC" (povinné)
resourceId Identifikátor zdroje integration runtime, který má být sdílen. řetězec (povinné)

LinkedIntegrationRuntimeType

Name Description Value
authorizationType Nastavte na "Klíč" pro typ LinkedIntegrationRuntimeKeyAuthorization. Nastavte na RBAC pro typ LinkedIntegrationRuntimeRbacAuthorization. 'Key'
"RBAC" (povinné)

ManagedIntegrationRuntime

Name Description Value
typ Typ integration runtime. Spravované (povinné)
typeProperties Spravované vlastnosti integration runtime. ManagedIntegrationRuntimeTypeProperties (povinné)

ManagedIntegrationRuntimeTypeProperties

Name Description Value
computeProperties Výpočetní zdroj pro řízenou integration runtime. IntegrationRuntimeComputeProperties
ssisProperties Vlastnosti SSIS pro řízenou integration runtime. IntegrationRuntimeSsisProperties

SecretBase

Name Description Value
typ Nastavte na 'SecureString' pro typ SecureString. 'SecureString' (povinné)

SecureString

Name Description Value
typ Typ tajného kódu. řetězec (povinné)
value Hodnota zabezpečeného řetězce řetězec (povinné)

SecureString

Name Description Value
typ Typ tajného kódu. 'SecureString' (povinné)
value Hodnota zabezpečeného řetězce řetězec (povinné)

SelfHostedIntegrationRuntime

Name Description Value
typ Typ integration runtime. "S vlastním hostitelem" (povinné)
typeProperties Pokud tato vlastnost není null, znamená to, že se jedná o propojenou integration runtime. Vlastnost se používá k access k původnímu integration runtime. SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

Name Description Value
linkedInfo Typ propojené integration runtime z data factory LinkedIntegrationRuntimeType

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku workspaces/integrationRuntimes je možné nasadit s operacemi, které cílí:

  • Skupiny zdrojů Pro seznam změněných vlastností v každé verzi API viz log změn.

Příklady použití

Ukázky Terraformu

Základní příklad nasazení 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    = ["*"]
}

Formát prostředku

Vytvořit Microsoft. Synapse/workspaces/integrationRuntimes resource – přidejte následující Terraform do své šablony.

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

Objekty IntegrationRuntime

Nastavte typ vlastnost určit typ objektu.

Pro Spravované použijte:

{
  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"
      }
    }
    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"
    }
  }
}

V případě SelfHosted použijte:

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

Objekty SecretBase

Nastavte typ vlastnost určit typ objektu.

Pro SecureString použijte:

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

Objekty CustomSetupBase

Nastavte typ vlastnost určit typ objektu.

Pro Cmdkeysetup použijte:

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

Pro ComponentSetup použijte:

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

Pro EnvironmentVariableSetup použijte:

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

Objekty LinkedIntegrationRuntimeType

Nastavte vlastnost authorizationType tak, aby určovala typ objektu.

Pro klíč použijte:

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

Pro RBAC použijte:

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

Hodnoty vlastností

Microsoft. Synapse/workspaces/integrationRuntime

Name Description Value
name Název prostředku řetězec (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: pracovních prostorů
properties Integration runtime vlastnosti. IntegrationRuntime (povinné)
typ Typ prostředku "Microsoft. Synapse/pracovní prostory/integrationRuntimes@2021-03-01"

CmdkeySetup

Name Description Value
typ Typ vlastní instalace. 'CmdkeySetup' (povinné)
typeProperties Vlastnosti vlastního typu nastavení příkazu Cmdkey CmdkeySetupTypeProperties (povinné)

CmdkeySetupTypeProperties

Name Description Value
heslo Heslo pro data source access. SecretBase (povinné)
targetName Název serveru pro data source access. libovolný (povinné)
userName Uživatelské jméno data source access. libovolný (povinné)

ComponentSetup

Name Description Value
typ Typ vlastní instalace. 'ComponentSetup' (povinné)
typeProperties Nainstalujte vlastnosti typu komponenty třetí strany. LicensedComponentSetupTypeProperties (povinné)

CustomSetupBase

Name Description Value
typ Nastavte na 'CmdkeySetup' pro typ CmdkeySetup. Nastavte na "ComponentSetup" pro typ ComponentSetup. Nastavte na "EnvironmentVariableSetup" pro typ EnvironmentVariableSetup. 'CmdkeySetup'
'ComponentSetup'
'EnvironmentVariableSetup' (povinné)

EntityReference

Name Description Value
referenceName Název této odkazované entity. řetězec
typ Typ této odkazované entity. 'IntegrationRuntimeReference'
'LinkedServiceReference'

EnvironmentVariableSetup

Name Description Value
typ Typ vlastní instalace. 'EnvironmentVariableSetup' (povinné)
typeProperties Přidejte vlastnosti typu proměnné prostředí. EnvironmentVariableSetupTypeProperties (povinné)

EnvironmentVariableSetupTypeProperties

Name Description Value
variableName Název proměnné prostředí. řetězec (povinné)
variableValue Hodnota proměnné prostředí. řetězec (povinné)

IntegrationRuntime

Name Description Value
description Integration runtime popis. řetězec
typ Nastavte na "Managed" pro typ ManagedIntegrationRuntime. Nastavte na "SelfHosted" pro typ SelfHostedIntegrationRuntime. 'Managed'
"S vlastním hostitelem" (povinné)

IntegrationRuntimeComputeProperties

Name Description Value
dataFlowProperties Vlastnosti Data flow pro řízenou integration runtime. IntegrationRuntimeDataFlowProperties
poloha Místo pro řízenou integration runtime. Podporované regiony lze nalézt na /azure/data-factory/data-factory-data-movement-activities řetězec
maxParallelExecutionsPerNode Maximální počet paralelních provedení se počítá na uzel pro řízenou integration runtime. int

Constraints:
Minimální hodnota = 1
nodeSize Požadavek na velikost uzlu pro řízenou integration runtime. řetězec
numberOfNodes Požadovaný počet uzlů pro řízenou integration runtime. int

Constraints:
Minimální hodnota = 1
vNetProperties Vlastnosti VNetu pro řízenou integration runtime. IntegrationRuntimeVNetProperties

IntegrationRuntimeCustomSetupScriptProperties

Name Description Value
blobContainerUri URI Azure blob kontejneru, který obsahuje vlastní setup skript. řetězec
sasToken SAS token Azure blob kontejneru. SecureString

IntegrationRuntimeDataFlowProperties

Name Description Value
computeType Typ výpočtu clusteru, který vykoná data flow úlohu. 'ComputeOptimized'
'General'
'MemoryOptimized'
coreCount Počet jader clusteru, který bude vykonávat data flow úlohu. Podporované hodnoty jsou: 8, 16, 32, 48, 80, 144 a 272. int
timeToLive Nastavení clusteru Time to Live (v minutách), které spustí data flow job. int

Constraints:
Minimální hodnota = 0

IntegrationRuntimeDataProxyProperties

Name Description Value
connectVia Odkaz na self-hostovanou integration runtime. Odkaz na entitu
cesta Cesta k uložení postupně uspořádaných dat do Blob storage. řetězec
stagingLinkedService Referenční informace k pracovní propojené službě. Odkaz na entitu

IntegrationRuntimeSsisCatalogInfo

Name Description Value
catalogAdminPassword Heslo uživatelskéhoúčtuhohohoho SecureString
catalogAdminUserName Uživatelské jméno správce databáze katalogu. string

Constraints:
Minimální délka = 1
Maximální délka = 128
catalogPricingTier Cenová úroveň databáze katalogu. Platné hodnoty lze nalézt v https://azure.microsoft.com/pricing/details/sql-database/ 'Basic'
'Premium'
'PremiumRS'
'Standard'
catalogServerEndpoint Adresa URL databázového serveru katalogu. řetězec

IntegrationRuntimeSsisProperties

Name Description Value
catalogInfo Katalogové informace pro spravovaný dedikovaný integration runtime. IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties Vlastní vlastnosti setup skriptu pro spravovaný dedikovaný integration runtime. IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties Vlastnosti datového proxy pro řízený dedikovaný integration runtime. IntegrationRuntimeDataProxyProperties
edition Edice pro SSIS Integration Runtime 'Enterprise'
'Standard'
expressCustomSetupProperties Vlastní nastavení bez vlastností skriptu pro integration runtime se SSIS. CustomSetupBase[]
licenseType Typ licence pro přenesení vlastního scénáře licence. 'BasePrice'
'LicenseIncluded'

IntegrationRuntimeVNetProperties

Name Description Value
publicIPs Resource ID veřejných IP adres, které bude tato integration runtime využívat. string[]
podsíť Název podsítě, ke které se tento integration runtime připojí. řetězec
subnetId ID podsítě, ke které bude připojeno toto runtime pro integraci Azure-SSIS. řetězec
vNetId ID VNetu, ke kterému se tato integration runtime připojí. řetězec

LicensedComponentSetupTypeProperties

Name Description Value
componentName Název komponenty třetí strany. řetězec (povinné)
licenseKey Licenční klíč pro aktivaci komponenty. SecretBase

LinkedIntegrationRuntimeKeyAuthorization

Name Description Value
authorizationType Typ autorizace pro sdílení integration runtime. "Klíč" (povinné)
klíč Klíč použitý k autorizaci. SecureString (povinné)

LinkedIntegrationRuntimeRbacAuthorization

Name Description Value
authorizationType Typ autorizace pro sdílení integration runtime. "RBAC" (povinné)
resourceId Identifikátor zdroje integration runtime, který má být sdílen. řetězec (povinné)

LinkedIntegrationRuntimeType

Name Description Value
authorizationType Nastavte na "Klíč" pro typ LinkedIntegrationRuntimeKeyAuthorization. Nastavte na RBAC pro typ LinkedIntegrationRuntimeRbacAuthorization. 'Key'
"RBAC" (povinné)

ManagedIntegrationRuntime

Name Description Value
typ Typ integration runtime. Spravované (povinné)
typeProperties Spravované vlastnosti integration runtime. ManagedIntegrationRuntimeTypeProperties (povinné)

ManagedIntegrationRuntimeTypeProperties

Name Description Value
computeProperties Výpočetní zdroj pro řízenou integration runtime. IntegrationRuntimeComputeProperties
ssisProperties Vlastnosti SSIS pro řízenou integration runtime. IntegrationRuntimeSsisProperties

SecretBase

Name Description Value
typ Nastavte na 'SecureString' pro typ SecureString. 'SecureString' (povinné)

SecureString

Name Description Value
typ Typ tajného kódu. řetězec (povinné)
value Hodnota zabezpečeného řetězce řetězec (povinné)

SecureString

Name Description Value
typ Typ tajného kódu. 'SecureString' (povinné)
value Hodnota zabezpečeného řetězce řetězec (povinné)

SelfHostedIntegrationRuntime

Name Description Value
typ Typ integration runtime. "S vlastním hostitelem" (povinné)
typeProperties Pokud tato vlastnost není null, znamená to, že se jedná o propojenou integration runtime. Vlastnost se používá k access k původnímu integration runtime. SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

Name Description Value
linkedInfo Typ propojené integration runtime z data factory LinkedIntegrationRuntimeType