Microsoft. Workspaces de trabalho/integração Runtimes do Synapse

Definição de recurso Bicep

O tipo de recurso workspaces/integrationRuntimes pode ser implantado com operações direcionadas:

  • Grupos de recursos - Veja grupos de recursos c1

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Exemplos de uso

Amostras de Bicep

Um exemplo básico de implantação do 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 de recurso

Para criar uma Microsoft. Synapse/workspaces/integrationRuntimes, adicione o seguinte Bicep ao seu modelo.

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

Objetos LinkedIntegrationRuntimeType

Defina a propriedade authorizationType para especificar o tipo de objeto.

Para Chave, use:

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

Para RBAC, use:

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

Objetos CustomSetupBase

Defina a propriedade tipo para especificar o tipo de objeto.

Para CmdkeySetup, use:

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

Para ComponentSetup, use:

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

Para EnvironmentVariableSetup, use:

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

Objetos IntegrationRuntime

Defina a propriedade tipo para especificar o tipo de objeto.

Para Gerenciado, use:

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

Para SelfHosted, use:

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

Objetos SecretBase

Defina a propriedade tipo para especificar o tipo de objeto.

Para SecureString, use:

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

Valores de propriedade

Microsoft. Synapse/workspaces/integrationRuntimes

Name Description Value
name O nome do recurso cadeia de caracteres (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para mais informações, veja Child resource externo do pai.		 Nome simbólico para o recurso do tipo: workspaces
properties Propriedades do runtime de integração. IntegrationRuntime (obrigatório)

CmdkeySetup

Name Description Value
tipo O tipo de configuração personalizada. 'CmdkeySetup' (obrigatório)
typeProperties Propriedades do tipo de configuração personalizada do comando Cmdkey. CmdkeySetupTypeProperties (obrigatório)

CmdkeySetupTypeProperties

Name Description Value
senha A senha do acesso à fonte de dados. SecretBase (obrigatório)
targetName O nome do servidor para o access à fonte de dados. qualquer (obrigatório)
userName O nome de usuário do access à fonte de dados. qualquer (obrigatório)

ComponentSetup

Name Description Value
tipo O tipo de configuração personalizada. 'ComponentSetup' (obrigatório)
typeProperties Instale propriedades de tipo de componente de terceiros. LicensedComponentSetupTypeProperties (obrigatório)

CustomSetupBase

Name Description Value
tipo Defina como 'CmdkeySetup' para o tipo CmdkeySetup. Defina como 'ComponentSetup' para o tipo ComponentSetup. Defina como 'EnvironmentVariableSetup' para o tipo EnvironmentVariableSetup. 'CmdkeySetup'
'ComponentSetup'
'EnvironmentVariableSetup' (obrigatório)

EntityReference

Name Description Value
referenceName O nome dessa entidade referenciada. cadeia
tipo O tipo dessa entidade referenciada. 'IntegrationRuntimeReference'
'LinkedServiceReference'

EnvironmentVariableSetup

Name Description Value
tipo O tipo de configuração personalizada. 'EnvironmentVariableSetup' (obrigatório)
typeProperties Adicionar propriedades de tipo de variável de ambiente. EnvironmentVariableSetupTypeProperties (obrigatório)

EnvironmentVariableSetupTypeProperties

Name Description Value
variableName O nome da variável de ambiente. cadeia de caracteres (obrigatório)
variableValue O valor da variável de ambiente. cadeia de caracteres (obrigatório)

IntegrationRuntime

Name Description Value
description Descrição do runtime de integração. cadeia
tipo Defina como 'Managed' para o tipo ManagedIntegrationRuntime. Defina como 'SelfHosted' para o tipo SelfHostedIntegrationRuntime. 'Managed'
'SelfHosted' (obrigatório)

IntegrationRuntimeComputeProperties

Name Description Value
dataFlowProperties Data flow propriedades para integration runtime gerenciada. IntegrationRuntimeDataFlowProperties
local O local para integration runtime gerenciada. As regiões suportadas podiam ser encontradas em /azure/data-factory/data-factory-data-movement-activities cadeia
maxParallelExecutionsPerNode As execuções paralelas máximas contam por nó para integration runtime gerenciada. int

Constraints:
Valor mínimo = 1
nodeSize O requisito de tamanho do nó para gerenciar o integration runtime. cadeia
numberOfNodes O número necessário de nós para integration runtime gerenciada. int

Constraints:
Valor mínimo = 1
vNetProperties Propriedades do VNet para integration runtime gerenciada. IntegrationRuntimeVNetProperties

IntegrationRuntimeCustomerVirtualNetwork

Name Description Value
subnetId O ID da sub-rede à qual o runtime de integração do Azure-SSIS irá se juntar. cadeia

IntegrationRuntimeCustomSetupScriptProperties

Name Description Value
blobContainerUri O URI do contêiner de blob do Azure que contém o script de configuração personalizado. cadeia
sasToken O token SAS do contêiner de blob do Azure. SecureString

IntegrationRuntimeDataFlowProperties

Name Description Value
computeType Tipo de cálculo do cluster que executará o trabalho de data flow. 'ComputeOptimized'
'General'
'MemoryOptimized'
coreCount Contagem de núcleos do cluster que executará o trabalho de data flow. Os valores com suporte são: 8, 16, 32, 48, 80, 144 e 272. int
timeToLive Configuração de tempo para viver (em minutos) do cluster, que executará o data flow job. int

Constraints:
Valor mínimo = 0

IntegrationRuntimeDataProxyProperties

Name Description Value
connectVia A referência de integration runtime auto-hospedada. Referência da entidade
caminho O caminho para conter os dados em estágio no Blob storage. cadeia
stagingLinkedService A referência de serviço vinculado de preparo. Referência da entidade

IntegrationRuntimeSsisCatalogInfo

Name Description Value
catalogAdminPassword A senha da conta de usuário do administrador do banco de dados do catálogo. SecureString
catalogAdminUserName O nome de usuário do administrador do banco de dados do catálogo. string

Constraints:
Comprimento mínimo = 1
Comprimento máximo = 128
catalogPricingTier O tipo de preço do banco de dados do catálogo. Os valores válidos podiam ser encontrados em https://azure.microsoft.com/pricing/details/sql-database/ 'Basic'
'Premium'
'PremiumRS'
'Standard'
catalogServerEndpoint A URL do servidor de banco de dados do catálogo. cadeia

IntegrationRuntimeSsisProperties

Name Description Value
catalogInfo Informações de catálogo para integration runtime dedicado gerenciado. IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties Propriedades personalizadas de scripts de configuração para um integration runtime dedicado gerenciado. IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties Propriedades proxy de dados para um integration runtime dedicado gerenciado. IntegrationRuntimeDataProxyProperties
edition A edição para o SSIS Integration Runtime 'Enterprise'
'Standard'
expressCustomSetupProperties Configuração personalizada sem propriedades de script para um tempo de integração runtime com SSIS. CustomSetupBase[]
licenseType Tipo de licença para trazer seu próprio cenário de licença. 'BasePrice'
'LicenseIncluded'

IntegrationRuntimeVNetProperties

Name Description Value
publicIPs IDs de recursos dos endereços IP públicos que esse integration runtime irá usar. string[]
sub-rede O nome da sub-rede que essa integration runtime irá se juntar. cadeia
subnetId O ID da sub-rede, à qual este runtime de integração Azure-SSIS será conectado. cadeia
vNetId O ID do VNet que esse tempo de integração runtime irá se juntar. cadeia

LicensedComponentSetupTypeProperties

Name Description Value
componentName O nome do componente de terceiros. cadeia de caracteres (obrigatório)
licenseKey A chave de licença para ativar o componente. SecretBase

LinkedIntegrationRuntimeKeyAuthorization

Name Description Value
authorizationType O tipo de autorização para compartilhamento em integration runtime. 'Chave' (obrigatório)
chave A chave usada para autorização. SecureString (obrigatório)

LinkedIntegrationRuntimeRbacAuthorization

Name Description Value
authorizationType O tipo de autorização para compartilhamento em integration runtime. 'RBAC' (obrigatório)
resourceId O identificador de recurso do integration runtime a ser compartilhado. cadeia de caracteres (obrigatório)

LinkedIntegrationRuntimeType

Name Description Value
authorizationType Defina como 'Key' para o tipo LinkedIntegrationRuntimeKeyAuthorization. Defina como 'RBAC' para o tipo LinkedIntegrationRuntimeRbacAuthorization. 'Key'
'RBAC' (obrigatório)

ManagedIntegrationRuntime

Name Description Value
managedVirtualNetwork Rede virtual virtual gerenciada de integração runtime. ManagedIntegrationRuntimeManagedVirtualNetworkReference
tipo Tipo de integration runtime. 'Gerenciado' (obrigatório)
typeProperties Propriedades gerenciadas de integration runtime. ManagedIntegrationRuntimeTypeProperties (obrigatório)

ManagedIntegrationRuntimeManagedVirtualNetworkReference

Name Description Value
id O id da rede virtual gerenciada. cadeia
referenceName O nome de referência da managed virtual network cadeia
tipo O tipo de rede virtual gerenciada. cadeia

ManagedIntegrationRuntimeTypeProperties

Name Description Value
computeProperties O recurso de computação para integration runtime gerenciada. IntegrationRuntimeComputeProperties
customerVirtualNetwork O nome da rede virtual à qual o runtime de integração do Azure-SSIS irá se juntar IntegrationRuntimeCustomerVirtualNetwork
ssisProperties Propriedades SSIS para integration runtime gerenciada. IntegrationRuntimeSsisProperties

SecretBase

Name Description Value
tipo Defina como 'SecureString' para o tipo SecureString. 'SecureString' (obrigatório)

SecureString

Name Description Value
tipo Tipo do segredo. cadeia de caracteres (obrigatório)
value Valor da cadeia de caracteres segura. cadeia de caracteres (obrigatório)

SecureString

Name Description Value
tipo Tipo do segredo. 'SecureString' (obrigatório)
value Valor da cadeia de caracteres segura. cadeia de caracteres (obrigatório)

SelfHostedIntegrationRuntime

Name Description Value
tipo Tipo de integration runtime. 'SelfHosted' (obrigatório)
typeProperties Quando essa propriedade não é nula, significa que é uma integration runtime ligada. A propriedade é usada para acessar o tempo de integração runtime original. SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

Name Description Value
linkedInfo Tipo de integration runtime vinculado a partir da data factory LinkedIntegrationRuntimeType

Definição de recurso de modelo do ARM

O tipo de recurso workspaces/integrationRuntimes pode ser implantado com operações direcionadas:

Exemplos de uso

Formato de recurso

Para criar uma Microsoft. Synapse/workspaces/integrationRuntimes, adicione o JSON a seguir ao seu modelo.

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

Objetos LinkedIntegrationRuntimeType

Defina a propriedade authorizationType para especificar o tipo de objeto.

Para Chave, use:

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

Para RBAC, use:

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

Objetos CustomSetupBase

Defina a propriedade tipo para especificar o tipo de objeto.

Para CmdkeySetup, use:

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

Para ComponentSetup, use:

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

Para EnvironmentVariableSetup, use:

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

Objetos IntegrationRuntime

Defina a propriedade tipo para especificar o tipo de objeto.

Para Gerenciado, use:

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

Para SelfHosted, use:

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

Objetos SecretBase

Defina a propriedade tipo para especificar o tipo de objeto.

Para SecureString, use:

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

Valores de propriedade

Microsoft. Synapse/workspaces/integrationRuntimes

Name Description Value
apiVersion A versão da API '2021-06-01'
name O nome do recurso cadeia de caracteres (obrigatório)
properties Propriedades do runtime de integração. IntegrationRuntime (obrigatório)
tipo O tipo de recurso 'Microsoft. Synapse/workspaces/integrationRuntimes'

CmdkeySetup

Name Description Value
tipo O tipo de configuração personalizada. 'CmdkeySetup' (obrigatório)
typeProperties Propriedades do tipo de configuração personalizada do comando Cmdkey. CmdkeySetupTypeProperties (obrigatório)

CmdkeySetupTypeProperties

Name Description Value
senha A senha do acesso à fonte de dados. SecretBase (obrigatório)
targetName O nome do servidor para o access à fonte de dados. qualquer (obrigatório)
userName O nome de usuário do access à fonte de dados. qualquer (obrigatório)

ComponentSetup

Name Description Value
tipo O tipo de configuração personalizada. 'ComponentSetup' (obrigatório)
typeProperties Instale propriedades de tipo de componente de terceiros. LicensedComponentSetupTypeProperties (obrigatório)

CustomSetupBase

Name Description Value
tipo Defina como 'CmdkeySetup' para o tipo CmdkeySetup. Defina como 'ComponentSetup' para o tipo ComponentSetup. Defina como 'EnvironmentVariableSetup' para o tipo EnvironmentVariableSetup. 'CmdkeySetup'
'ComponentSetup'
'EnvironmentVariableSetup' (obrigatório)

EntityReference

Name Description Value
referenceName O nome dessa entidade referenciada. cadeia
tipo O tipo dessa entidade referenciada. 'IntegrationRuntimeReference'
'LinkedServiceReference'

EnvironmentVariableSetup

Name Description Value
tipo O tipo de configuração personalizada. 'EnvironmentVariableSetup' (obrigatório)
typeProperties Adicionar propriedades de tipo de variável de ambiente. EnvironmentVariableSetupTypeProperties (obrigatório)

EnvironmentVariableSetupTypeProperties

Name Description Value
variableName O nome da variável de ambiente. cadeia de caracteres (obrigatório)
variableValue O valor da variável de ambiente. cadeia de caracteres (obrigatório)

IntegrationRuntime

Name Description Value
description Descrição do runtime de integração. cadeia
tipo Defina como 'Managed' para o tipo ManagedIntegrationRuntime. Defina como 'SelfHosted' para o tipo SelfHostedIntegrationRuntime. 'Managed'
'SelfHosted' (obrigatório)

IntegrationRuntimeComputeProperties

Name Description Value
dataFlowProperties Data flow propriedades para integration runtime gerenciada. IntegrationRuntimeDataFlowProperties
local O local para integration runtime gerenciada. As regiões suportadas podiam ser encontradas em /azure/data-factory/data-factory-data-movement-activities cadeia
maxParallelExecutionsPerNode As execuções paralelas máximas contam por nó para integration runtime gerenciada. int

Constraints:
Valor mínimo = 1
nodeSize O requisito de tamanho do nó para gerenciar o integration runtime. cadeia
numberOfNodes O número necessário de nós para integration runtime gerenciada. int

Constraints:
Valor mínimo = 1
vNetProperties Propriedades do VNet para integration runtime gerenciada. IntegrationRuntimeVNetProperties

IntegrationRuntimeCustomerVirtualNetwork

Name Description Value
subnetId O ID da sub-rede à qual o runtime de integração do Azure-SSIS irá se juntar. cadeia

IntegrationRuntimeCustomSetupScriptProperties

Name Description Value
blobContainerUri O URI do contêiner de blob do Azure que contém o script de configuração personalizado. cadeia
sasToken O token SAS do contêiner de blob do Azure. SecureString

IntegrationRuntimeDataFlowProperties

Name Description Value
computeType Tipo de cálculo do cluster que executará o trabalho de data flow. 'ComputeOptimized'
'General'
'MemoryOptimized'
coreCount Contagem de núcleos do cluster que executará o trabalho de data flow. Os valores com suporte são: 8, 16, 32, 48, 80, 144 e 272. int
timeToLive Configuração de tempo para viver (em minutos) do cluster, que executará o data flow job. int

Constraints:
Valor mínimo = 0

IntegrationRuntimeDataProxyProperties

Name Description Value
connectVia A referência de integration runtime auto-hospedada. Referência da entidade
caminho O caminho para conter os dados em estágio no Blob storage. cadeia
stagingLinkedService A referência de serviço vinculado de preparo. Referência da entidade

IntegrationRuntimeSsisCatalogInfo

Name Description Value
catalogAdminPassword A senha da conta de usuário do administrador do banco de dados do catálogo. SecureString
catalogAdminUserName O nome de usuário do administrador do banco de dados do catálogo. string

Constraints:
Comprimento mínimo = 1
Comprimento máximo = 128
catalogPricingTier O tipo de preço do banco de dados do catálogo. Os valores válidos podiam ser encontrados em https://azure.microsoft.com/pricing/details/sql-database/ 'Basic'
'Premium'
'PremiumRS'
'Standard'
catalogServerEndpoint A URL do servidor de banco de dados do catálogo. cadeia

IntegrationRuntimeSsisProperties

Name Description Value
catalogInfo Informações de catálogo para integration runtime dedicado gerenciado. IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties Propriedades personalizadas de scripts de configuração para um integration runtime dedicado gerenciado. IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties Propriedades proxy de dados para um integration runtime dedicado gerenciado. IntegrationRuntimeDataProxyProperties
edition A edição para o SSIS Integration Runtime 'Enterprise'
'Standard'
expressCustomSetupProperties Configuração personalizada sem propriedades de script para um tempo de integração runtime com SSIS. CustomSetupBase[]
licenseType Tipo de licença para trazer seu próprio cenário de licença. 'BasePrice'
'LicenseIncluded'

IntegrationRuntimeVNetProperties

Name Description Value
publicIPs IDs de recursos dos endereços IP públicos que esse integration runtime irá usar. string[]
sub-rede O nome da sub-rede que essa integration runtime irá se juntar. cadeia
subnetId O ID da sub-rede, à qual este runtime de integração Azure-SSIS será conectado. cadeia
vNetId O ID do VNet que esse tempo de integração runtime irá se juntar. cadeia

LicensedComponentSetupTypeProperties

Name Description Value
componentName O nome do componente de terceiros. cadeia de caracteres (obrigatório)
licenseKey A chave de licença para ativar o componente. SecretBase

LinkedIntegrationRuntimeKeyAuthorization

Name Description Value
authorizationType O tipo de autorização para compartilhamento em integration runtime. 'Chave' (obrigatório)
chave A chave usada para autorização. SecureString (obrigatório)

LinkedIntegrationRuntimeRbacAuthorization

Name Description Value
authorizationType O tipo de autorização para compartilhamento em integration runtime. 'RBAC' (obrigatório)
resourceId O identificador de recurso do integration runtime a ser compartilhado. cadeia de caracteres (obrigatório)

LinkedIntegrationRuntimeType

Name Description Value
authorizationType Defina como 'Key' para o tipo LinkedIntegrationRuntimeKeyAuthorization. Defina como 'RBAC' para o tipo LinkedIntegrationRuntimeRbacAuthorization. 'Key'
'RBAC' (obrigatório)

ManagedIntegrationRuntime

Name Description Value
managedVirtualNetwork Rede virtual virtual gerenciada de integração runtime. ManagedIntegrationRuntimeManagedVirtualNetworkReference
tipo Tipo de integration runtime. 'Gerenciado' (obrigatório)
typeProperties Propriedades gerenciadas de integration runtime. ManagedIntegrationRuntimeTypeProperties (obrigatório)

ManagedIntegrationRuntimeManagedVirtualNetworkReference

Name Description Value
id O id da rede virtual gerenciada. cadeia
referenceName O nome de referência da managed virtual network cadeia
tipo O tipo de rede virtual gerenciada. cadeia

ManagedIntegrationRuntimeTypeProperties

Name Description Value
computeProperties O recurso de computação para integration runtime gerenciada. IntegrationRuntimeComputeProperties
customerVirtualNetwork O nome da rede virtual à qual o runtime de integração do Azure-SSIS irá se juntar IntegrationRuntimeCustomerVirtualNetwork
ssisProperties Propriedades SSIS para integration runtime gerenciada. IntegrationRuntimeSsisProperties

SecretBase

Name Description Value
tipo Defina como 'SecureString' para o tipo SecureString. 'SecureString' (obrigatório)

SecureString

Name Description Value
tipo Tipo do segredo. cadeia de caracteres (obrigatório)
value Valor da cadeia de caracteres segura. cadeia de caracteres (obrigatório)

SecureString

Name Description Value
tipo Tipo do segredo. 'SecureString' (obrigatório)
value Valor da cadeia de caracteres segura. cadeia de caracteres (obrigatório)

SelfHostedIntegrationRuntime

Name Description Value
tipo Tipo de integration runtime. 'SelfHosted' (obrigatório)
typeProperties Quando essa propriedade não é nula, significa que é uma integration runtime ligada. A propriedade é usada para acessar o tempo de integração runtime original. SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

Name Description Value
linkedInfo Tipo de integration runtime vinculado a partir da data factory LinkedIntegrationRuntimeType

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso workspaces/integrationRuntimes pode ser implantado com operações direcionadas:

Exemplos de uso

Exemplos do Terraform

Um exemplo básico de implantação do 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 de recurso

Para criar uma Microsoft. Synapse/workspaces/integrationRuntimes, adicione o seguinte Terraform ao seu modelo.

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

Objetos LinkedIntegrationRuntimeType

Defina a propriedade authorizationType para especificar o tipo de objeto.

Para Chave, use:

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

Para RBAC, use:

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

Objetos CustomSetupBase

Defina a propriedade tipo para especificar o tipo de objeto.

Para CmdkeySetup, use:

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

Para ComponentSetup, use:

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

Para EnvironmentVariableSetup, use:

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

Objetos IntegrationRuntime

Defina a propriedade tipo para especificar o tipo de objeto.

Para Gerenciado, use:

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

Para SelfHosted, use:

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

Objetos SecretBase

Defina a propriedade tipo para especificar o tipo de objeto.

Para SecureString, use:

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

Valores de propriedade

Microsoft. Synapse/workspaces/integrationRuntimes

Name Description Value
name O nome do recurso cadeia de caracteres (obrigatório)
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: workspaces
properties Propriedades do runtime de integração. IntegrationRuntime (obrigatório)
tipo O tipo de recurso "Microsoft. Sinapse/espaços de trabalho/integrationRuntimes@2021-06-01"

CmdkeySetup

Name Description Value
tipo O tipo de configuração personalizada. 'CmdkeySetup' (obrigatório)
typeProperties Propriedades do tipo de configuração personalizada do comando Cmdkey. CmdkeySetupTypeProperties (obrigatório)

CmdkeySetupTypeProperties

Name Description Value
senha A senha do acesso à fonte de dados. SecretBase (obrigatório)
targetName O nome do servidor para o access à fonte de dados. qualquer (obrigatório)
userName O nome de usuário do access à fonte de dados. qualquer (obrigatório)

ComponentSetup

Name Description Value
tipo O tipo de configuração personalizada. 'ComponentSetup' (obrigatório)
typeProperties Instale propriedades de tipo de componente de terceiros. LicensedComponentSetupTypeProperties (obrigatório)

CustomSetupBase

Name Description Value
tipo Defina como 'CmdkeySetup' para o tipo CmdkeySetup. Defina como 'ComponentSetup' para o tipo ComponentSetup. Defina como 'EnvironmentVariableSetup' para o tipo EnvironmentVariableSetup. 'CmdkeySetup'
'ComponentSetup'
'EnvironmentVariableSetup' (obrigatório)

EntityReference

Name Description Value
referenceName O nome dessa entidade referenciada. cadeia
tipo O tipo dessa entidade referenciada. 'IntegrationRuntimeReference'
'LinkedServiceReference'

EnvironmentVariableSetup

Name Description Value
tipo O tipo de configuração personalizada. 'EnvironmentVariableSetup' (obrigatório)
typeProperties Adicionar propriedades de tipo de variável de ambiente. EnvironmentVariableSetupTypeProperties (obrigatório)

EnvironmentVariableSetupTypeProperties

Name Description Value
variableName O nome da variável de ambiente. cadeia de caracteres (obrigatório)
variableValue O valor da variável de ambiente. cadeia de caracteres (obrigatório)

IntegrationRuntime

Name Description Value
description Descrição do runtime de integração. cadeia
tipo Defina como 'Managed' para o tipo ManagedIntegrationRuntime. Defina como 'SelfHosted' para o tipo SelfHostedIntegrationRuntime. 'Managed'
'SelfHosted' (obrigatório)

IntegrationRuntimeComputeProperties

Name Description Value
dataFlowProperties Data flow propriedades para integration runtime gerenciada. IntegrationRuntimeDataFlowProperties
local O local para integration runtime gerenciada. As regiões suportadas podiam ser encontradas em /azure/data-factory/data-factory-data-movement-activities cadeia
maxParallelExecutionsPerNode As execuções paralelas máximas contam por nó para integration runtime gerenciada. int

Constraints:
Valor mínimo = 1
nodeSize O requisito de tamanho do nó para gerenciar o integration runtime. cadeia
numberOfNodes O número necessário de nós para integration runtime gerenciada. int

Constraints:
Valor mínimo = 1
vNetProperties Propriedades do VNet para integration runtime gerenciada. IntegrationRuntimeVNetProperties

IntegrationRuntimeCustomerVirtualNetwork

Name Description Value
subnetId O ID da sub-rede à qual o runtime de integração do Azure-SSIS irá se juntar. cadeia

IntegrationRuntimeCustomSetupScriptProperties

Name Description Value
blobContainerUri O URI do contêiner de blob do Azure que contém o script de configuração personalizado. cadeia
sasToken O token SAS do contêiner de blob do Azure. SecureString

IntegrationRuntimeDataFlowProperties

Name Description Value
computeType Tipo de cálculo do cluster que executará o trabalho de data flow. 'ComputeOptimized'
'General'
'MemoryOptimized'
coreCount Contagem de núcleos do cluster que executará o trabalho de data flow. Os valores com suporte são: 8, 16, 32, 48, 80, 144 e 272. int
timeToLive Configuração de tempo para viver (em minutos) do cluster, que executará o data flow job. int

Constraints:
Valor mínimo = 0

IntegrationRuntimeDataProxyProperties

Name Description Value
connectVia A referência de integration runtime auto-hospedada. Referência da entidade
caminho O caminho para conter os dados em estágio no Blob storage. cadeia
stagingLinkedService A referência de serviço vinculado de preparo. Referência da entidade

IntegrationRuntimeSsisCatalogInfo

Name Description Value
catalogAdminPassword A senha da conta de usuário do administrador do banco de dados do catálogo. SecureString
catalogAdminUserName O nome de usuário do administrador do banco de dados do catálogo. string

Constraints:
Comprimento mínimo = 1
Comprimento máximo = 128
catalogPricingTier O tipo de preço do banco de dados do catálogo. Os valores válidos podiam ser encontrados em https://azure.microsoft.com/pricing/details/sql-database/ 'Basic'
'Premium'
'PremiumRS'
'Standard'
catalogServerEndpoint A URL do servidor de banco de dados do catálogo. cadeia

IntegrationRuntimeSsisProperties

Name Description Value
catalogInfo Informações de catálogo para integration runtime dedicado gerenciado. IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties Propriedades personalizadas de scripts de configuração para um integration runtime dedicado gerenciado. IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties Propriedades proxy de dados para um integration runtime dedicado gerenciado. IntegrationRuntimeDataProxyProperties
edition A edição para o SSIS Integration Runtime 'Enterprise'
'Standard'
expressCustomSetupProperties Configuração personalizada sem propriedades de script para um tempo de integração runtime com SSIS. CustomSetupBase[]
licenseType Tipo de licença para trazer seu próprio cenário de licença. 'BasePrice'
'LicenseIncluded'

IntegrationRuntimeVNetProperties

Name Description Value
publicIPs IDs de recursos dos endereços IP públicos que esse integration runtime irá usar. string[]
sub-rede O nome da sub-rede que essa integration runtime irá se juntar. cadeia
subnetId O ID da sub-rede, à qual este runtime de integração Azure-SSIS será conectado. cadeia
vNetId O ID do VNet que esse tempo de integração runtime irá se juntar. cadeia

LicensedComponentSetupTypeProperties

Name Description Value
componentName O nome do componente de terceiros. cadeia de caracteres (obrigatório)
licenseKey A chave de licença para ativar o componente. SecretBase

LinkedIntegrationRuntimeKeyAuthorization

Name Description Value
authorizationType O tipo de autorização para compartilhamento em integration runtime. 'Chave' (obrigatório)
chave A chave usada para autorização. SecureString (obrigatório)

LinkedIntegrationRuntimeRbacAuthorization

Name Description Value
authorizationType O tipo de autorização para compartilhamento em integration runtime. 'RBAC' (obrigatório)
resourceId O identificador de recurso do integration runtime a ser compartilhado. cadeia de caracteres (obrigatório)

LinkedIntegrationRuntimeType

Name Description Value
authorizationType Defina como 'Key' para o tipo LinkedIntegrationRuntimeKeyAuthorization. Defina como 'RBAC' para o tipo LinkedIntegrationRuntimeRbacAuthorization. 'Key'
'RBAC' (obrigatório)

ManagedIntegrationRuntime

Name Description Value
managedVirtualNetwork Rede virtual virtual gerenciada de integração runtime. ManagedIntegrationRuntimeManagedVirtualNetworkReference
tipo Tipo de integration runtime. 'Gerenciado' (obrigatório)
typeProperties Propriedades gerenciadas de integration runtime. ManagedIntegrationRuntimeTypeProperties (obrigatório)

ManagedIntegrationRuntimeManagedVirtualNetworkReference

Name Description Value
id O id da rede virtual gerenciada. cadeia
referenceName O nome de referência da managed virtual network cadeia
tipo O tipo de rede virtual gerenciada. cadeia

ManagedIntegrationRuntimeTypeProperties

Name Description Value
computeProperties O recurso de computação para integration runtime gerenciada. IntegrationRuntimeComputeProperties
customerVirtualNetwork O nome da rede virtual à qual o runtime de integração do Azure-SSIS irá se juntar IntegrationRuntimeCustomerVirtualNetwork
ssisProperties Propriedades SSIS para integration runtime gerenciada. IntegrationRuntimeSsisProperties

SecretBase

Name Description Value
tipo Defina como 'SecureString' para o tipo SecureString. 'SecureString' (obrigatório)

SecureString

Name Description Value
tipo Tipo do segredo. cadeia de caracteres (obrigatório)
value Valor da cadeia de caracteres segura. cadeia de caracteres (obrigatório)

SecureString

Name Description Value
tipo Tipo do segredo. 'SecureString' (obrigatório)
value Valor da cadeia de caracteres segura. cadeia de caracteres (obrigatório)

SelfHostedIntegrationRuntime

Name Description Value
tipo Tipo de integration runtime. 'SelfHosted' (obrigatório)
typeProperties Quando essa propriedade não é nula, significa que é uma integration runtime ligada. A propriedade é usada para acessar o tempo de integração runtime original. SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

Name Description Value
linkedInfo Tipo de integration runtime vinculado a partir da data factory LinkedIntegrationRuntimeType
  • Last updated on