Partilhar via

Áreas de trabalho do Microsoft.Synapse/integrationRuntimes 2021-06-01

  • Artigo

Definição de recurso do Bicep

O tipo de recurso workspaces/integrationRuntimes pode ser implementado com operações que visam:

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

Formato do recurso

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

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

Objetos IntegrationRuntime

Defina a propriedade tipo para especificar o tipo de objeto.

Para Gerido, utilize:

  type: 'Managed'
  managedVirtualNetwork: {
    id: 'string'
    referenceName: 'string'
    type: 'string'
  }
  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, utilize:

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

Objetos CustomSetupBase

Defina a propriedade tipo para especificar o tipo de objeto.

Para CmdkeySetup, utilize:

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

Para ComponentSetup, utilize:

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

Para EnvironmentVariableSetup, utilize:

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

Objetos SecretBase

Defina a propriedade tipo para especificar o tipo de objeto.

Para SecureString, utilize:

  type: 'SecureString'
  value: 'string'

Objetos LinkedIntegrationRuntimeType

Defina a propriedade authorizationType para especificar o tipo de objeto.

Para Chave, utilize:

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

Para RBAC, utilize:

  authorizationType: 'RBAC'
  resourceId: 'string'

Valores de propriedade

áreas de trabalho/integrationRuntimes

Nome Descrição Valor
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados no Bicep.		 cadeia (obrigatório)
principal No Bicep, pode especificar o recurso principal de um recurso subordinado. Só precisa de adicionar esta propriedade quando o recurso subordinado for declarado fora do recurso principal.

Para obter mais informações, veja Recurso subordinado fora do recurso principal.		 Nome simbólico para recurso do tipo: áreas de trabalho
propriedades Propriedades do runtime de integração. IntegrationRuntime (obrigatório)

IntegrationRuntime

Nome Descrição Valor
descrição Descrição do runtime de integração. string
tipo Definir o tipo de objeto Gerido
SelfHosted (obrigatório)

ManagedIntegrationRuntime

Nome Descrição Valor
tipo Tipo de runtime de integração. "Gerido" (obrigatório)
managedVirtualNetwork Rede virtual gerida do runtime de integração gerida. ManagedIntegrationRuntimeManagedVirtualNetworkRefere...
typeProperties Propriedades do runtime de integração gerida. ManagedIntegrationRuntimeTypeProperties (obrigatório)

ManagedIntegrationRuntimeManagedVirtualNetworkRefere...

Nome Descrição Valor
ID O ID da rede virtual gerida. string
referenceName O nome de referência da rede virtual gerida string
tipo O tipo de rede virtual gerida. string

ManagedIntegrationRuntimeTypeProperties

Nome Descrição Valor
computeProperties O recurso de computação para o runtime de integração gerida. IntegrationRuntimeComputeProperties
customerVirtualNetwork O nome da rede virtual à qual o runtime de integração do Azure-SSIS será associado IntegrationRuntimeCustomerVirtualNetwork
ssisProperties Propriedades do SSIS para o runtime de integração gerida. IntegrationRuntimeSsisProperties

IntegrationRuntimeComputeProperties

Nome Descrição Valor
dataFlowProperties Propriedades do fluxo de dados para o runtime de integração gerido. IntegrationRuntimeDataFlowProperties
localização A localização do runtime de integração gerido. As regiões suportadas podem ser encontradas em /azure/data-factory/data-factory-data-movement-activities string
maxParallelExecutionsPerNode Contagem máxima de execuções paralelas por nó para o runtime de integração gerido. int
nodeSize O requisito de tamanho do nó para o runtime de integração gerido. string
numberOfNodes O número necessário de nós para o runtime de integração gerido. int
vNetProperties Propriedades da VNet para o runtime de integração gerido. IntegrationRuntimeVNetProperties

IntegrationRuntimeDataFlowProperties

Nome Descrição Valor
computeType Tipo de computação do cluster que irá executar a tarefa de fluxo de dados. "ComputeOptimized"
"Geral"
"MemoryOptimized"
coreCount Contagem de núcleos do cluster que irá executar a tarefa de fluxo de dados. Os valores suportados são: 8, 16, 32, 48, 80, 144 e 272. int
timeToLive Definição time to live (em minutos) do cluster que irá executar a tarefa de fluxo de dados. int

IntegrationRuntimeVNetProperties

Nome Descrição Valor
publicIPs IDs de recursos dos endereços IP públicos que este runtime de integração irá utilizar. string[]
sub-rede O nome da sub-rede a que este runtime de integração será associado. string
subnetId O ID da sub-rede ao qual este runtime de integração do Azure-SSIS será associado. string
vNetId O ID da VNet à qual este runtime de integração será associado. string

IntegrationRuntimeCustomerVirtualNetwork

Nome Descrição Valor
subnetId O ID da sub-rede à qual o runtime de integração do Azure-SSIS será associado. string

IntegrationRuntimeSsisProperties

Nome Descrição Valor
catalogInfo Informações de catálogo para o runtime de integração dedicado gerido. IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties Propriedades do script de configuração personalizada para um runtime de integração dedicado gerido. IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties Propriedades de proxy de dados para um runtime de integração dedicado gerido. IntegrationRuntimeDataProxyProperties
edição A edição do SSIS Integration Runtime "Empresa"
'Standard'
expressCustomSetupProperties Configuração personalizada sem propriedades de script para um runtime de integração do SSIS. CustomSetupBase[]
licenseType Tipo de licença para trazer o seu próprio cenário de licença. "Preço Base"
"LicenseIncluded"

IntegrationRuntimeSsisCatalogInfo

Nome Descrição Valor
catalogAdminPassword A palavra-passe da conta de utilizador administrador da base de dados do catálogo. SecureString
catalogAdminUserName O nome de utilizador administrador da base de dados de catálogo. string
catalogPricingTier O escalão de preço da base de dados do catálogo. Os valores válidos podem ser encontrados em https://azure.microsoft.com/pricing/details/sql-database/ "Básico"
"Premium"
"PremiumRS"
'Standard'
catalogServerEndpoint O URL do servidor da base de dados do catálogo. string

SecureString

Nome Descrição Valor
tipo Tipo de segredo. cadeia (obrigatório)
valor Valor da cadeia segura. cadeia (obrigatório)

IntegrationRuntimeCustomSetupScriptProperties

Nome Descrição Valor
blobContainerUri O URI do contentor de blobs do Azure que contém o script de configuração personalizada. string
sasToken O token de SAS do contentor de blobs do Azure. SecureString

IntegrationRuntimeDataProxyProperties

Nome Descrição Valor
connectVia A referência do runtime de integração autoalojado. EntityReference
caminho O caminho para conter os dados faseados no armazenamento de Blobs. string
stagingLinkedService A referência do serviço ligado de teste. EntityReference

EntityReference

Nome Descrição Valor
referenceName O nome desta entidade referenciada. string
tipo O tipo desta entidade referenciada. "IntegrationRuntimeReference"
"LinkedServiceReference"

CustomSetupBase

Nome Descrição Valor
tipo Definir o tipo de objeto CmdkeySetup
ComponentSetup
EnvironmentVariableSetup (obrigatório)

CmdkeySetup

Nome Descrição Valor
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

Nome Descrição Valor
palavra-passe A palavra-passe do acesso à origem de dados. SecretBase (obrigatório)
targetName O nome do servidor do acesso à origem de dados. Para Bicep, pode utilizar a função any( ). (obrigatório)
userName O nome de utilizador do acesso à origem de dados. Para Bicep, pode utilizar a função any( ). (obrigatório)

SecretBase

Nome Descrição Valor
tipo Definir o tipo de objeto SecureString (obrigatório)

ComponentSetup

Nome Descrição Valor
tipo O tipo de configuração personalizada. "ComponentSetup" (obrigatório)
typeProperties Instale propriedades do tipo de componente de terceiros. LicensedComponentSetupTypeProperties (obrigatório)

LicensedComponentSetupTypeProperties

Nome Descrição Valor
componentName O nome do componente de terceiros. cadeia (obrigatório)
licenseKey A chave de licença para ativar o componente. SecretBase

EnvironmentVariableSetup

Nome Descrição Valor
tipo O tipo de configuração personalizada. "EnvironmentVariableSetup" (obrigatório)
typeProperties Adicionar propriedades do tipo de variável de ambiente. EnvironmentVariableSetupTypeProperties (obrigatório)

EnvironmentVariableSetupTypeProperties

Nome Descrição Valor
variableName O nome da variável de ambiente. cadeia (obrigatório)
variableValue O valor da variável de ambiente. cadeia (obrigatório)

SelfHostedIntegrationRuntime

Nome Descrição Valor
tipo Tipo de runtime de integração. "SelfHosted" (obrigatório)
typeProperties Quando esta propriedade não é nula, significa que se trata de um runtime de integração ligado. A propriedade é utilizada para aceder ao runtime de integração original. SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

Nome Descrição Valor
linkedInfo Tipo de runtime de integração ligado da fábrica de dados LinkedIntegrationRuntimeType

LinkedIntegrationRuntimeType

Nome Descrição Valor
authorizationType Definir o tipo de objeto Chave
RBAC (obrigatório)

LinkedIntegrationRuntimeKeyAuthorization

Nome Descrição Valor
authorizationType O tipo de autorização para a partilha do runtime de integração. "Chave" (obrigatório)
key A chave utilizada para autorização. SecureString (obrigatório)

LinkedIntegrationRuntimeRbacAuthorization

Nome Descrição Valor
authorizationType O tipo de autorização para a partilha do runtime de integração. "RBAC" (obrigatório)
resourceId O identificador de recurso do runtime de integração a ser partilhado. cadeia (obrigatório)

Definição de recurso do modelo arm

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

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

Formato do recurso

Para criar um recurso Microsoft.Synapse/workspaces/integrationRuntimes, adicione o seguinte JSON 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 IntegrationRuntime

Defina a propriedade type para especificar o tipo de objeto.

Para Gerido, utilize:

  "type": "Managed",
  "managedVirtualNetwork": {
    "id": "string",
    "referenceName": "string",
    "type": "string"
  },
  "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, utilize:

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

Objetos CustomSetupBase

Defina a propriedade type para especificar o tipo de objeto.

Para CmdkeySetup, utilize:

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

Para ComponentSetup, utilize:

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

Para EnvironmentVariableSetup, utilize:

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

Objetos SecretBase

Defina a propriedade type para especificar o tipo de objeto.

Para SecureString, utilize:

  "type": "SecureString",
  "value": "string"

Objetos LinkedIntegrationRuntimeType

Defina a propriedade authorizationType para especificar o tipo de objeto.

Para Chave, utilize:

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

Para RBAC, utilize:

  "authorizationType": "RBAC",
  "resourceId": "string"

Valores de propriedade

áreas de trabalho/integrationRuntimes

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.Synapse/workspaces/integrationRuntimes"
apiVersion A versão da API de recursos '2021-06-01'
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados em modelos do ARM JSON.		 cadeia (obrigatório)
propriedades Propriedades do runtime de integração. IntegrationRuntime (obrigatório)

IntegrationRuntime

Nome Descrição Valor
descrição Descrição do runtime de integração. string
tipo Definir o tipo de objeto Gerido
SelfHosted (obrigatório)

ManagedIntegrationRuntime

Nome Descrição Valor
tipo Tipo de runtime de integração. "Gerido" (obrigatório)
managedVirtualNetwork Rede virtual gerida do runtime de integração gerida. ManagedIntegrationRuntimeManagedVirtualNetworkRefere...
typeProperties Propriedades do runtime de integração gerida. ManagedIntegrationRuntimeTypeProperties (obrigatório)

ManagedIntegrationRuntimeManagedVirtualNetworkRefere...

Nome Descrição Valor
ID O ID da rede virtual gerida. string
referenceName O nome de referência da rede virtual gerida string
tipo O tipo de rede virtual gerida. string

ManagedIntegrationRuntimeTypeProperties

Nome Descrição Valor
computeProperties O recurso de computação para o runtime de integração gerida. IntegrationRuntimeComputeProperties
customerVirtualNetwork O nome da rede virtual à qual o runtime de integração do Azure-SSIS será associado IntegrationRuntimeCustomerVirtualNetwork
ssisProperties Propriedades do SSIS para o runtime de integração gerida. IntegrationRuntimeSsisProperties

IntegrationRuntimeComputeProperties

Nome Descrição Valor
dataFlowProperties Propriedades do fluxo de dados para o runtime de integração gerida. IntegrationRuntimeDataFlowProperties
localização A localização do runtime de integração gerida. As regiões suportadas podem ser encontradas em /azure/data-factory/data-factory-data-movement-activities string
maxParallelExecutionsPerNode Contagem máxima de execuções paralelas por nó para o runtime de integração gerida. int
nodeSize O requisito de tamanho do nó para o runtime de integração gerido. string
numberOfNodes O número necessário de nós para o runtime de integração gerida. int
vNetProperties Propriedades da VNet para o runtime de integração gerida. IntegrationRuntimeVNetProperties

IntegrationRuntimeDataFlowProperties

Nome Descrição Valor
computeType Tipo de computação do cluster que irá executar a tarefa de fluxo de dados. "ComputeOptimized"
"Geral"
"MemoryOptimized"
coreCount Contagem de núcleos do cluster que irá executar a tarefa de fluxo de dados. Os valores suportados são: 8, 16, 32, 48, 80, 144 e 272. int
timeToLive Definição time to live (em minutos) do cluster que irá executar a tarefa de fluxo de dados. int

IntegrationRuntimeVNetProperties

Nome Descrição Valor
publicIPs IDs de recursos dos endereços IP públicos que este runtime de integração irá utilizar. string[]
sub-rede O nome da sub-rede a que este runtime de integração será associado. string
subnetId O ID da sub-rede ao qual este runtime de integração do Azure-SSIS será associado. string
vNetId O ID da VNet à qual este runtime de integração será associado. string

IntegrationRuntimeCustomerVirtualNetwork

Nome Descrição Valor
subnetId O ID da sub-rede à qual o runtime de integração do Azure-SSIS será associado. string

IntegrationRuntimeSsisProperties

Nome Descrição Valor
catalogInfo Informações de catálogo para o runtime de integração dedicado gerido. IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties Propriedades do script de configuração personalizada para um runtime de integração dedicado gerido. IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties Propriedades de proxy de dados para um runtime de integração dedicado gerido. IntegrationRuntimeDataProxyProperties
edição A edição do SSIS Integration Runtime "Empresa"
'Standard'
expressCustomSetupProperties Configuração personalizada sem propriedades de script para um runtime de integração do SSIS. CustomSetupBase[]
licenseType Tipo de licença para trazer o seu próprio cenário de licença. "Preço Base"
"LicenseIncluded"

IntegrationRuntimeSsisCatalogInfo

Nome Descrição Valor
catalogAdminPassword A palavra-passe da conta de utilizador administrador da base de dados do catálogo. SecureString
catalogAdminUserName O nome de utilizador administrador da base de dados de catálogo. string
catalogPricingTier O escalão de preço da base de dados do catálogo. Os valores válidos podem ser encontrados em https://azure.microsoft.com/pricing/details/sql-database/ "Básico"
"Premium"
"PremiumRS"
'Standard'
catalogServerEndpoint O URL do servidor da base de dados do catálogo. string

SecureString

Nome Descrição Valor
tipo Tipo de segredo. cadeia (obrigatório)
valor Valor da cadeia segura. cadeia (obrigatório)

IntegrationRuntimeCustomSetupScriptProperties

Nome Descrição Valor
blobContainerUri O URI do contentor de blobs do Azure que contém o script de configuração personalizada. string
sasToken O token de SAS do contentor de blobs do Azure. SecureString

IntegrationRuntimeDataProxyProperties

Nome Descrição Valor
connectVia A referência do runtime de integração autoalojado. EntityReference
caminho O caminho para conter os dados faseados no armazenamento de Blobs. string
stagingLinkedService A referência do serviço ligado de teste. EntityReference

EntityReference

Nome Descrição Valor
referenceName O nome desta entidade referenciada. string
tipo O tipo desta entidade referenciada. "IntegrationRuntimeReference"
"LinkedServiceReference"

CustomSetupBase

Nome Descrição Valor
tipo Definir o tipo de objeto CmdkeySetup
ComponentSetup
EnvironmentVariableSetup (obrigatório)

CmdkeySetup

Nome Descrição Valor
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

Nome Descrição Valor
palavra-passe A palavra-passe do acesso à origem de dados. SecretBase (obrigatório)
targetName O nome do servidor do acesso à origem de dados.
userName O nome de utilizador do acesso à origem de dados.

SecretBase

Nome Descrição Valor
tipo Definir o tipo de objeto SecureString (obrigatório)

ComponentSetup

Nome Descrição Valor
tipo O tipo de configuração personalizada. "ComponentSetup" (obrigatório)
typeProperties Instale propriedades do tipo de componente de terceiros. LicensedComponentSetupTypeProperties (obrigatório)

LicensedComponentSetupTypeProperties

Nome Descrição Valor
componentName O nome do componente de terceiros. cadeia (obrigatório)
licenseKey A chave de licença para ativar o componente. SecretBase

EnvironmentVariableSetup

Nome Descrição Valor
tipo O tipo de configuração personalizada. "EnvironmentVariableSetup" (obrigatório)
typeProperties Adicionar propriedades do tipo de variável de ambiente. EnvironmentVariableSetupTypeProperties (obrigatório)

EnvironmentVariableSetupTypeProperties

Nome Descrição Valor
variableName O nome da variável de ambiente. cadeia (obrigatório)
variableValue O valor da variável de ambiente. cadeia (obrigatório)

SelfHostedIntegrationRuntime

Nome Descrição Valor
tipo Tipo de runtime de integração. "SelfHosted" (obrigatório)
typeProperties Quando esta propriedade não é nula, significa que se trata de um runtime de integração ligado. A propriedade é utilizada para aceder ao runtime de integração original. SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

Nome Descrição Valor
linkedInfo Tipo de runtime de integração ligado a partir da fábrica de dados LinkedIntegrationRuntimeType

LinkedIntegrationRuntimeType

Nome Descrição Valor
authorizationType Definir o tipo de objeto Chave
RBAC (obrigatório)

LinkedIntegrationRuntimeKeyAuthorization

Nome Descrição Valor
authorizationType O tipo de autorização para a partilha do runtime de integração. "Chave" (obrigatório)
key A chave utilizada para autorização. SecureString (obrigatório)

LinkedIntegrationRuntimeRbacAuthorization

Nome Descrição Valor
authorizationType O tipo de autorização para a partilha do runtime de integração. "RBAC" (obrigatório)
resourceId O identificador de recursos do runtime de integração a partilhar. cadeia (obrigatório)

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

O tipo de recurso workspaces/integrationRuntimes pode ser implementado com operações que visam:

  • Grupos de recursos

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

Formato do recurso

Para criar um recurso 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 = jsonencode({
    properties = {
      description = "string"
      type = "string"
      // For remaining properties, see IntegrationRuntime objects
    }
  })
}

Objetos IntegrationRuntime

Defina a propriedade tipo para especificar o tipo de objeto.

Para Gerido, utilize:

  type = "Managed"
  managedVirtualNetwork = {
    id = "string"
    referenceName = "string"
    type = "string"
  }
  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, utilize:

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

Objetos CustomSetupBase

Defina a propriedade tipo para especificar o tipo de objeto.

Para CmdkeySetup, utilize:

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

Para ComponentSetup, utilize:

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

Para EnvironmentVariableSetup, utilize:

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

Objetos SecretBase

Defina a propriedade tipo para especificar o tipo de objeto.

Para SecureString, utilize:

  type = "SecureString"
  value = "string"

Objetos LinkedIntegrationRuntimeType

Defina a propriedade authorizationType para especificar o tipo de objeto.

Para Chave, utilize:

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

Para RBAC, utilize:

  authorizationType = "RBAC"
  resourceId = "string"

Valores de propriedade

áreas de trabalho/integrationRuntimes

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01"
name O nome do recurso cadeia (obrigatório)
parent_id O ID do recurso que é o principal para este recurso. ID para recurso do tipo: áreas de trabalho
propriedades Propriedades do runtime de integração. IntegrationRuntime (obrigatório)

IntegrationRuntime

Nome Descrição Valor
descrição Descrição do runtime de integração. string
tipo Definir o tipo de objeto Gerido
SelfHosted (obrigatório)

ManagedIntegrationRuntime

Nome Descrição Valor
tipo Tipo de runtime de integração. "Gerido" (obrigatório)
managedVirtualNetwork Rede virtual gerida do runtime de integração gerida. ManagedIntegrationRuntimeManagedVirtualNetworkRefere...
typeProperties Propriedades do runtime de integração gerida. ManagedIntegrationRuntimeTypeProperties (obrigatório)

ManagedIntegrationRuntimeManagedVirtualNetworkRefere...

Nome Descrição Valor
ID O ID da rede virtual gerida. string
referenceName O nome de referência da rede virtual gerida string
tipo O tipo de rede virtual gerida. string

ManagedIntegrationRuntimeTypeProperties

Nome Descrição Valor
computeProperties O recurso de computação para o runtime de integração gerida. IntegrationRuntimeComputeProperties
customerVirtualNetwork O nome da rede virtual à qual o runtime de integração do Azure-SSIS será associado IntegrationRuntimeCustomerVirtualNetwork
ssisProperties Propriedades do SSIS para o runtime de integração gerida. IntegrationRuntimeSsisProperties

IntegrationRuntimeComputeProperties

Nome Descrição Valor
dataFlowProperties Propriedades do fluxo de dados para o runtime de integração gerida. IntegrationRuntimeDataFlowProperties
localização A localização do runtime de integração gerida. As regiões suportadas podem ser encontradas em /azure/data-factory/data-factory-data-movement-activities string
maxParallelExecutionsPerNode Contagem máxima de execuções paralelas por nó para o runtime de integração gerida. int
nodeSize O requisito de tamanho do nó para o runtime de integração gerido. string
numberOfNodes O número necessário de nós para o runtime de integração gerida. int
vNetProperties Propriedades da VNet para o runtime de integração gerida. IntegrationRuntimeVNetProperties

IntegrationRuntimeDataFlowProperties

Nome Descrição Valor
computeType Tipo de computação do cluster que irá executar a tarefa de fluxo de dados. "ComputeOptimized"
"Geral"
"MemoryOptimized"
coreCount Contagem de núcleos do cluster que irá executar a tarefa de fluxo de dados. Os valores suportados são: 8, 16, 32, 48, 80, 144 e 272. int
timeToLive Hora de viver (em minutos) definição do cluster que irá executar a tarefa de fluxo de dados. int

IntegrationRuntimeVNetProperties

Nome Descrição Valor
publicIPs IDs de recursos dos endereços IP públicos que este runtime de integração irá utilizar. cadeia[]
sub-rede O nome da sub-rede que este runtime de integração irá associar. string
subnetId O ID da sub-rede ao qual este runtime de integração do Azure-SSIS será associado. string
vNetId O ID da VNet ao qual este runtime de integração será associado. string

IntegrationRuntimeCustomerVirtualNetwork

Nome Descrição Valor
subnetId O ID da sub-rede ao qual o runtime de integração do Azure-SSIS será associado. string

IntegrationRuntimeSsisProperties

Nome Descrição Valor
catalogInfo Informações de catálogo para o runtime de integração dedicado gerido. IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties Propriedades personalizadas do script de configuração para um runtime de integração dedicado gerido. IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties Propriedades de proxy de dados para um runtime de integração dedicado gerido. IntegrationRuntimeDataProxyProperties
edição A edição do SSIS Integration Runtime "Empresa"
"Standard"
expressCustomSetupProperties Configuração personalizada sem propriedades de script para um runtime de integração do SSIS. CustomSetupBase[]
licenseType Tipo de licença para trazer o seu próprio cenário de licença. "Preço Base"
"LicenseIncluded"

IntegrationRuntimeSsisCatalogInfo

Nome Descrição Valor
catalogAdminPassword A palavra-passe da conta de utilizador administrador da base de dados do catálogo. SecureString
catalogAdminUserName O nome de utilizador administrador da base de dados de catálogo. string
catalogPricingTier O escalão de preço da base de dados do catálogo. Os valores válidos podem ser encontrados em https://azure.microsoft.com/pricing/details/sql-database/ "Básico"
"Premium"
"PremiumRS"
"Standard"
catalogServerEndpoint O URL do servidor da base de dados do catálogo. string

SecureString

Nome Descrição Valor
tipo Tipo de segredo. cadeia (obrigatório)
valor Valor da cadeia segura. cadeia (obrigatório)

IntegrationRuntimeCustomSetupScriptProperties

Nome Descrição Valor
blobContainerUri O URI do contentor de blobs do Azure que contém o script de configuração personalizada. string
sasToken O token de SAS do contentor de blobs do Azure. SecureString

IntegrationRuntimeDataProxyProperties

Nome Descrição Valor
connectVia A referência do runtime de integração autoalojado. EntityReference
caminho O caminho para conter os dados faseados no armazenamento de Blobs. string
stagingLinkedService A referência do serviço ligado de teste. EntityReference

EntityReference

Nome Descrição Valor
referenceName O nome desta entidade referenciada. string
tipo O tipo desta entidade referenciada. "IntegrationRuntimeReference"
"LinkedServiceReference"

CustomSetupBase

Nome Descrição Valor
tipo Definir o tipo de objeto CmdkeySetup
ComponentSetup
EnvironmentVariableSetup (obrigatório)

CmdkeySetup

Nome Descrição Valor
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

Nome Descrição Valor
palavra-passe A palavra-passe do acesso à origem de dados. SecretBase (obrigatório)
targetName O nome do servidor do acesso à origem de dados.
userName O nome de utilizador do acesso à origem de dados.

SecretBase

Nome Descrição Valor
tipo Definir o tipo de objeto SecureString (obrigatório)

ComponentSetup

Nome Descrição Valor
tipo O tipo de configuração personalizada. "ComponentSetup" (obrigatório)
typeProperties Instale propriedades do tipo de componente de terceiros. LicensedComponentSetupTypeProperties (obrigatório)

LicensedComponentSetupTypeProperties

Nome Descrição Valor
componentName O nome do componente de terceiros. cadeia (obrigatório)
licenseKey A chave de licença para ativar o componente. SecretBase

EnvironmentVariableSetup

Nome Descrição Valor
tipo O tipo de configuração personalizada. "EnvironmentVariableSetup" (obrigatório)
typeProperties Adicionar propriedades do tipo de variável de ambiente. EnvironmentVariableSetupTypeProperties (obrigatório)

EnvironmentVariableSetupTypeProperties

Nome Descrição Valor
variableName O nome da variável de ambiente. cadeia (obrigatório)
variableValue O valor da variável de ambiente. cadeia (obrigatório)

SelfHostedIntegrationRuntime

Nome Descrição Valor
tipo Tipo de runtime de integração. "SelfHosted" (obrigatório)
typeProperties Quando esta propriedade não é nula, significa que se trata de um runtime de integração ligado. A propriedade é utilizada para aceder ao runtime de integração original. SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

Nome Descrição Valor
linkedInfo Tipo de runtime de integração ligado da fábrica de dados LinkedIntegrationRuntimeType

LinkedIntegrationRuntimeType

Nome Descrição Valor
authorizationType Definir o tipo de objeto Chave
RBAC (obrigatório)

LinkedIntegrationRuntimeKeyAuthorization

Nome Descrição Valor
authorizationType O tipo de autorização para a partilha do runtime de integração. "Chave" (obrigatório)
key A chave utilizada para autorização. SecureString (obrigatório)

LinkedIntegrationRuntimeRbacAuthorization

Nome Descrição Valor
authorizationType O tipo de autorização para a partilha do runtime de integração. "RBAC" (obrigatório)
resourceId O identificador de recurso do runtime de integração a ser partilhado. cadeia (obrigatório)