SQL Server Integration Services (SSIS) Ferramentas de DevOps Extensão Azure DevOps

A extensão SSIS DevOps Tools está disponível no Azure DevOps Marketplace. SSIS DevOps suporta Azure DevOps Services, Azure DevOps Server 2019 e versões superiores.

Se você não tem uma organização Azure DevOps, primeiro inscreva-se no Azure Pipelines e depois adicione a extensão SSIS DevOps Tools seguindo os passos.

As Ferramentas DevOps do SSIS incluem a tarefa de compilação do SSIS , a tarefa de lançamento do SSIS Deploy e a tarefa de configuração do catálogo do SSIS.

  • A tarefa de construção do SSIS suporta a construção de arquivos dtproj no modelo de implantação de projeto ou modelo de implantação de pacotes.

  • A tarefa SSIS Deploy dá suporte à implantação de um ou vários arquivos .ispac no catálogo SSIS local e no Azure-SSIS IR, ou de arquivos SSISDeploymentManifest e seus arquivos associados para um compartilhamento de arquivos local ou do Azure.

  • A tarefa de configuração do Catálogo SSIS suporta a configuração da pasta/projeto/ambiente do Catálogo SSIS com um arquivo de configuração em formato JSON. Esta tarefa suporta os seguintes cenários:

    • Pasta
      • Crie uma pasta.
      • Atualize a descrição da pasta.
    • Projeto
      • Configure o valor dos parâmetros, tanto o valor literal quanto o valor referenciado são suportados.
      • Adicione referências ao ambiente.
    • Meio ambiente
      • Crie ambiente.
      • Atualize a descrição do ambiente.
      • Criar ou atualizar variável de ambiente.

Tarefa de construção do SSIS

tarefa de compilação

Properties

Caminho do projeto

Caminho da pasta ou arquivo do projeto a ser construído. Se um caminho de pasta for especificado, a tarefa de compilação do SSIS vai buscar recursivamente todos os arquivos dtproj sob essa pasta e construir todos.

O caminho do Project não pode ser vazio, definido como . para construir a partir da pasta raiz do repositório.

Configuração do projeto

Nome da configuração do projeto a ser usada para build. Se não for fornecido, ele é padrão para a primeira configuração definida do projeto em cada arquivo dtproj.

Caminho de saída

Caminho de uma pasta separada para salvar os resultados do build, que podem ser publicados como artefatos de compilação por meio da tarefa publicar artefatos de compilação.

Limitações e problemas conhecidos

  • A tarefa de build do SSIS depende do Visual Studio e do designer do SSIS, os quais são obrigatórios nos agentes de build. Assim, para executar a tarefa de compilação do SSIS no pipeline:

    • para agentes hospedados na Microsoft, você deve escolher uma imagem disponível que inclua a extensão Visual Studio e SQL Server Integration Services, por exemplo, Windows-2022. Consulte a documentação dos agentes hospedados pela Microsoft para obter detalhes sobre os softwares incluídos nas imagens disponíveis.
    • para agentes autohospedados, instale o Visual Studio e o SSIS designer (seja VS2022 + extensão SSIS Projects, ou VS2019 + extensão SSIS Projects) em agentes auto-hospedados.

  • Para criar projetos do SSIS usando componentes prontos para uso (incluindo o feature pack do SSIS para o Azure e outros componentes de terceiros), os componentes prontos para uso precisam ser instalados no computador em que o agente de pipeline está em execução. Para o agente hospedado na Microsoft, o usuário pode adicionar uma tarefa PowerShell Script ou Command Line Script para baixar e instalar os componentes antes da execução da tarefa SSIS Build. Abaixo está o script de exemplo do PowerShell para instalar o Azure Feature Pack:

wget -Uri https://download.microsoft.com/download/E/E/0/EE0CB6A0-4105-466D-A7CA-5E39FA9AB128/SsisAzureFeaturePack_2017_x86.msi -OutFile AFP.msi

start -Wait -FilePath msiexec -Args "/i AFP.msi /quiet /l* log.txt"

cat log.txt
  • Níveis de proteção EncryptSensitiveWithPassword e EncryptAllWithPassword não são suportados pela tarefa de build do SSIS. Verifique se todos os projetos do SSIS na base de código não estão usando esses dois níveis de proteção ou se a tarefa Build do SSIS interromperá a resposta e atingirá o tempo limite durante a execução.

Tarefa de compilação do SSIS versão 1.*

Melhorias na versão 1.*:

  • Remova a dependência do Visual Studio e do designer SSIS. A tarefa de compilação pode rodar em agentes hospedados pela Microsoft ou em agentes auto-hospedados com o sistema operacional Windows e o framework .NET 4.6.2 ou superior.

  • Não há necessidade de instalar componentes prontos para uso.

  • Suporta o nível de proteção EncryptionWithPassword e EncryptionAllWithPassword.

Limitações e problemas conhecidos

  • A versão 1.* da tarefa de build do SSIS não suporta a construção do projeto SSIS contendo pacote SSIS com assinatura digital.

Propriedades somente da versão 1.*

Senha do projeto

Senha do projeto SSIS e seus pacotes. Esse argumento só é válido quando o nível de proteção do projeto E pacotes do SSIS é EncryptSensitiveWithPassword ou EncryptAllWithPassword. Para o modelo de implantação de pacote, todos os pacotes devem compartilhar a mesma senha especificada por esse argumento.

Remover dados sensíveis

Converta o nível de proteção do projeto SSIS para DontSaveSensitive se esse valor for verdadeiro. Quando o nível de proteção é EncrypteSensitiveWithPassword ou EncryptAllWithPassword, o argumento Project Password deve ser definido corretamente. Essa opção só é válida para o modelo de implantação de projeto.

Tarefa de implantação do SSIS

Tarefa de implantação

Properties

Caminho de origem

Caminho de origem dos arquivos ISPAC ou SSISDeploymentManifest que você quer implantar. Esse caminho pode ser um caminho de pasta ou um caminho de arquivo.

Tipo de destino

Tipo de destino. Atualmente, a tarefa de implantação do SSIS suporta dois tipos:

  • Sistema de Arquivos: Implante arquivos SSISDeploymentManifest e seus arquivos associados em um sistema de arquivos especificado. Tanto o compartilhamento de arquivos on-premises quanto o compartilhamento de arquivos do Azure são suportados.
  • SSISDB: Implantar arquivos ISPAC em um catálogo SSIS especificado, que pode ser hospedado em SQL Server ou Azure-SSIS Integration Runtime locais.

Servidor de destino

Nome do Mecanismo de Banco de Dados de destino. Pode ser o nome de um SQL Server on-premiss, Banco de Dados SQL do Azure ou Instância Gerenciada de SQL do Azure. Essa propriedade só é visível quando o tipo de destino é SSISDB.

Caminho de destino

Caminho da pasta de destino no qual o arquivo de origem será implantado. Por exemplo:

  • /SSISDB/<folderName>
  • \\<nomeDaMáquina>\<nomeDaPastaCompartilhada>\<nomeDaSubpastaOpcional>

A tarefa SSIS Deploy criará a pasta e a subpasta caso não existam.

Tipo de autenticação

Tipo de autenticação para acessar o servidor de destino especificado. Essa propriedade só é visível quando o tipo de Destino é SSISDB. Em geral, abaixo são suportados os tipos de autenticação:

  • Autenticação do Windows
  • Autenticação do SQL Server
  • Active Directory – Senha
  • Active Directory – Integrado

Mas se um tipo específico de autenticação é suportado depende do tipo de servidor de destino e do tipo de agente. A matriz detalhada de suporte é apresentada na tabela abaixo.

Tipo de servidor de destino Agente hospedado pela Microsoft Agente auto-hospedado
SQL Server on-premises ou VM N/A Autenticação do Windows
SQL do Azure Autenticação do SQL Server
Active Directory – Senha		 Autenticação do SQL Server
Active Directory - Senha
Active Directory – Integrado

Nome de domínio

Nome de domínio para acessar o sistema de arquivos especificado. Essa propriedade só é visível quando o tipo de destino é Sistema de Arquivos. Você pode deixá-lo vazio quando a conta de usuário que executa o agente auto-hospedado tiver recebido acesso de leitura/escrita ao caminho de destino especificado.

Nome de usuário

Nome de usuário para acessar o sistema de arquivos especificado ou SSISDB. Essa propriedade é visível quando o tipo de destino é Sistema de Arquivos ou o tipo de Autenticação é Autenticação SQL Server ou Active Directory - Senha. Você pode deixá-lo vazio quando o tipo de destino for sistema de arquivos, desde que a conta de usuário para executar o agente auto-hospedado tenha permissão de leitura e gravação no caminho de destino especificado.

Senha

Senha para acessar o sistema de arquivos especificado ou SSISDB. Essa propriedade é visível quando o tipo de destino é sistema de arquivos ou o tipo de autenticação é autenticação SQL Server ou Active Directory - senha. Você poderá deixá-la vazia quando o tipo de destino for sistema de arquivos e a conta de usuário usada para executar o agente auto-hospedado receber acesso de leitura/gravação ao caminho de destino especificado.

Sobrescreva projetos existentes ou arquivos SSISDeploymentManifest com os mesmos nomes

Especifique se deseja sobrescrever os projetos existentes ou os arquivos SSISDeploymentManifest com os mesmos nomes. Se 'Não', a tarefa de implantação do SSIS pulará a implantação desses projetos ou arquivos.

Continuar a implantação quando ocorrer erro

Especifique se deve continuar a implantação para projetos ou arquivos restantes quando ocorrer um erro. Se 'Não', a tarefa de implantação do SSIS parará imediatamente quando ocorrer um erro.

Limitações e problemas conhecidos

A tarefa de implantação do SSIS atualmente não suporta os seguintes cenários:

  • Configuração do ambiente no catálogo SSIS.
  • Implantar ISPAC no Azure SQL Server ou Instância Gerenciada de SQL do Azure, que permitem apenas autenticação multifator.
  • Implantação de pacotes no MSDB ou no Repositório de Pacotes do SSIS.
  • Se você instalar a extensão SSIS DevOps Tools no Azure DevOps Server, pode ver a mensagem "O tamanho do pacote de extensão excede o tamanho máximo do pacote." Para resolver o problema, complete os seguintes passos:
    1. Conecte-se à instância local SQL Server e selecione o Gallery_Configuration do banco de dados.
    2. Execute uma consulta INSERT INTO dbo.tbl_RegistryItems VALUES (1,'#\Configuration\Service\Gallery\LargeExtensionUpload\SSIS\','MaxPackageSizeMB\',50). Mude 50 para um número maior se a extensão for maior que 50 MBs.
    3. Depois de executar a consulta, reinicie o Serviços de Informações da Internet. Tente novamente enviar a extensão.
    4. Se o erro persistir, por favor, entre em contato com a equipe de suporte do SQL Server.

Tarefa de implantação do SSIS versão 1.*

Melhorias na versão 1.*:

  • Suporta o nível de proteção EncryptionWithPassword e EncryptionAllWithPassword.

Propriedades somente da versão 1.*

Senha do projeto

Senha para descriptografar os arquivos ISPAC ou DTSX. Esse argumento só é válido quando o nível de proteção é EncryptSensitiveWithPassword ou EncryptAllWithPassword.

Tarefa de configuração do Catálogo SSIS

tarefa de configuração de catálogo

Properties

Fonte do arquivo de configuração

Fonte do arquivo JSON de configuração do catálogo SSIS. Pode ser "Caminho do arquivo" ou "Embutido".

Consulte detalhes sobre como definir JSON de configuração:

Caminho do arquivo JSON de configuração

Caminho do arquivo JSON de configuração do catálogo SSIS. Essa propriedade só é visível ao selecionar "Caminho do arquivo" como fonte do arquivo de configuração.

Para usar variáveis de pipeline em um arquivo JSON de configuração, você precisa adicionar uma tarefa de Transformação de Arquivo antes dessa tarefa para substituir valores de configuração por variáveis de pipeline. Para mais informações, veja substituição de variáveis JSON.

JSON de configuração embutido

JSON embutido de configuração do catálogo do SSIS. Essa propriedade só é visível ao selecionar "Inline" como fonte do arquivo de configuração. As variáveis do pipeline podem ser usadas diretamente.

Reverter configuração quando ocorrer um erro

Se a configuração feita por esse erro deve ser revertida quando um erro ocorrer.

Servidor de destino

Nome do Mecanismo de Banco de Dados alvo. Pode ser o nome de um SQL Server on-premiss, Banco de Dados SQL do Azure ou Instância Gerenciada de SQL do Azure.

Tipo de autenticação

Tipo de autenticação para acessar o servidor alvo especificado. Em geral, abaixo são suportados os tipos de autenticação:

  • Autenticação do Windows
  • Autenticação do SQL Server
  • Active Directory – Senha
  • Active Directory – Integrado

Mas se um tipo específico de autenticação é suportado depende do tipo de servidor de destino e do tipo de agente. A matriz detalhada de suporte é apresentada na tabela abaixo.

Tipo de servidor de destino Agente hospedado pela Microsoft Agente auto-hospedado
SQL Server on-premises ou VM N/A Autenticação do Windows
SQL do Azure Autenticação do SQL Server
Active Directory – Senha		 Autenticação do SQL Server
Active Directory - Senha
Active Directory – Integrado

Nome de usuário

Nome de usuário para acessar o SQL Server de destino. Essa propriedade só é visível quando o tipo de Autenticação é SQL Server Authentication ou Active Directory - Senha.

Senha

Senha para acessar o SQL Server de destino. Essa propriedade só é visível quando o tipo de Autenticação é SQL Server Authentication ou Active Directory - Senha.

Definir configuração JSON

O esquema JSON de configuração possui três camadas:

  • catálogo
  • pasta
  • Projeto e Meio Ambiente

Esquema de configuração do catálogo

Um exemplo de JSON de configuração inline

{
  "folders": [
    {
      "name": "devopsdemo",
      "description": "devops demo folder",
      "projects": [
        {
          "name": "catalog devops",
          "parameters": [
            {
              "name": "password",
              "container": "Package.dtsx",
              "value": "passwd",
              "valueType": "referenced"
            },
            {
              "name": "serverName",
              "container": "catalog devops",
              "value": "localhost",
              "valueType": "literal"
            }
          ],
          "references": [
            {
              "environmentName": "test",
              "environmentFolder": "devopsdemo"
            },
            {
              "environmentName": "test",
              "environmentFolder": "."
            }
          ]
        }
      ],
      "environments": [
        {
          "name": "test",
          "description": "test",
          "variables": [
            {
              "name": "passwd",
              "type": "string",
              "description": "",
              "value": "$(SSISDBServerAdminPassword)",
              "sensitive": true
            },
            {
              "name": "serverName",
              "type": "string",
              "description": "",
              "value": "$(TargetServerName)",
              "sensitive": false
            }
          ]
        }
      ]
    }
  ]
}

Esquema JSON

Atributos do Catálogo
Property Description Observações
pastas Um array de objetos de pasta. Cada objeto contém informações de configuração para uma pasta de catálogo. Veja Atributos de Pasta para o esquema de um objeto de pasta.
Atributos da Pasta
Property Description Observações
nome Nome da pasta do catálogo. A pasta será criada caso não exista.
description Descrição da pasta do catálogo. O valor de nulo será ignorado.
projects Uma variedade de objetos de projeto. Cada objeto contém informações de configuração para um projeto. Veja Project Attributes para o esquema de um objeto de projeto.
environments Uma variedade de objetos do ambiente. Cada objeto contém informações de configuração para um ambiente. Veja Atributos do Ambiente para o esquema de um objeto do ambiente.
Atributos do Project
Property Description Observações
nome Nome do projeto. O objeto de projeto será ignorado se o projeto não existir na pasta pai.
parameters Uma matriz de objetos de parâmetro. Cada objeto contém informações de configuração para um parâmetro. Veja Atributos de Parâmetro, o esquema de um objeto de parâmetro.
Referências Um array de objetos de referência. Cada objeto representa uma referência ambiental ao projeto alvo. Veja Atributos de Referência para o esquema de um objeto de referência.
Atributos de Parâmetro
Property Description Observações
nome Nome do parâmetro.
  • O parâmetro pode ser um parâmetro de projeto ou um parâmetro de pacote.
  • O parâmetro é pulado se ele não existir.
  • Se o parâmetro for uma propriedade de um gerenciador de conexões, o nome deverá estar no formato CM.<Nome do Gerenciador de Conexões>.<Nome da Propriedade>.
    		•
    contêiner Contêiner do parâmetro.
  • Se o parâmetro for um parâmetro do projeto, o contêiner deve ser o nome do projeto.
  • Se for um parâmetro de pacote, o contêiner deve ser o nome do pacote com a extensão .dtsx .
    		•
    value Valor do parâmetro.
  • Quando valueType é referenciado: o valor é uma referência a uma variável de ambiente no tipo cadeia de caracteres.
  • Quando valueType é literal: Este atributo aceita quaisquer valores JSON booleanos válidos, numéricos e strings.
  • O valor será convertido para o tipo de parâmetro alvo. Ocorrerá um erro se não for possível converter.
  • O valor de nulo é inválido. A tarefa pula esse objeto de parâmetro e dá um aviso.
    		•
    valueType Tipo do valor do parâmetro. Tipos válidos são:
    literal: O atributo valor representa um valor literal.
    referenciado: O atributo valor representa uma referência a uma variável de ambiente.
    Atributos de referência
    Property Description Observações
    environmentFolder Nome da pasta do ambiente. A pasta será criada caso não exista.
    O valor pode ser ".", que representa a pasta raiz do projeto e se refere ao ambiente.
    environmentName Nome do ambiente referenciado. O ambiente especificado será criado caso não exista.
    Atributos do Ambiente
    Property Description Observações
    nome Nome do ambiente. O ambiente será criado se não existir.
    description Descrição do ambiente. O valor de nulo será ignorado.
    variables Um array de objetos variáveis. Cada objeto contém informações de configuração para uma variável de ambiente. Veja Atributos da Variável para o esquema de um objeto variável.
    Atributos das variáveis
    Property Description Observações
    nome Nome da variável ambiente. A variável ambiente será criada se não existir.
    tipo Tipo de dado da variável ambiente. Tipos válidos são:
    booleano
    Byte
    datetime
    decimal
    duplo
    int16
    int32
    int64
    sbyte
    Único
    string
    uint32
    uint64
    description Descrição da variável ambiente. O valor de nulo será ignorado.
    value Valor da variável de ambiente. Este atributo suporta qualquer valor JSON válido do tipo booleano, numérico e string.
    O valor será convertido para o tipo especificado pelo atributo do tipo . O erro ocorrerá se a conversão falhar.
    O valor de nulo é inválido. A tarefa pula esse objeto da variável de ambiente e dá um aviso.
    confidencial Se o valor da variável ambiente é sensível. Entradas válidas são:
    true
    falso

    Notas de lançamento

    Versão 1.0.6

    Data de lançamento: 1º de setembro de 2021

    • Versão de GA (disponibilidade geral).

    Versão 1.0.5

    Data de lançamento: 2 de junho de 2021

    • Corrigido um problema em que, às vezes, a Tarefa de Build do SSIS da versão 1.* falhava ao compilar projetos/pacotes com o nível de proteção EncryptSensitiveWithPassword ou EncryptAllWithPassword com o erro "O IV (vetor de inicialização) especificado não corresponde ao tamanho do bloco para este algoritmo".
    • Removido o conteúdo JSON no log da tarefa de Configuração do Catálogo do SSIS quando a "Origem do arquivo de configuração" é "Caminho do arquivo".

    Versão 1.0.4

    Data de Lançamento: 21 de abril de 2021

    • SSIS Build Task versão 1.* (Prévia)
      • Remova a dependência do Visual Studio e do designer SSIS. A tarefa de compilação pode rodar em agentes hospedados pela Microsoft ou em agentes auto-hospedados com o sistema operacional Windows e o framework .NET 4.6.2 ou superior.
      • Não há necessidade de instalar componentes prontos para uso.
      • Suporta o nível de proteção EncryptionWithPassword e EncryptionAllWithPassword.
    • Tarefa de implantação SSIS versão 1.* (Prévia)
      • Suporta o nível de proteção EncryptionWithPassword e EncryptionAllWithPassword.

    Versão 1.0.3

    Data de Lançamento: 21 de outubro de 2020

    • Permitir especificar o sufixo da cadeia de conexão para a tarefa de Implantação do SSIS e a tarefa de Configuração do Catálogo do SSIS.

    Versão 1.0.2

    Data de Lançamento: 26 de maio de 2020

    • Corrigido um problema de que a tarefa de Configuração do Catálogo do SSIS pode falhar em alguns casos após o trabalho de configuração ser concluído.

    Versão 1.0.1

    Data de lançamento: 9 de maio de 2020

    • Corrigido um problema de que a tarefa de build do SSIS sempre constrói toda a solução mesmo que apenas um arquivo dtproj seja especificado como caminho do projeto.

    Versão 1.0.0

    Data de Lançamento: 8 de maio de 2020

    • Versão de GA (disponibilidade geral).
    • Adicionada uma restrição de versão mínima do framework .NET no agente. Atualmente, a versão mínima do framework .NET é a 4.6.2.
    • Descrição refinada da tarefa SSIS Build e da tarefa SSIS Deploy.

    Prévia da Versão 0.2.0

    Data de Lançamento: 31 de março de 2020

    • Adicionar tarefa de configuração do Catálogo SSIS.

    Versão 0.1.3 Versão prévia

    Data de Lançamento: 19 de janeiro de 2020

    • Corrigido um problema que impedia o ISPAC de ser implantado caso o nome original do arquivo fosse alterado.

    Versão 0.1.2 Versão prévia

    Data de Lançamento: 13 de janeiro de 2020

    • Adicionadas informações de exceção mais detalhadas no registro de tarefas SSIS Deploy quando o tipo de destino é SSISDB.
    • Foi corrigido o caminho de destino de exemplo no texto de ajuda do caminho de destino da propriedade da tarefa de implantação do SSIS.

    Versão 0.1.1 Versão prévia

    Data de Lançamento: 6 de janeiro de 2020

    • Adicionada uma restrição de exigência mínima de versão do agente. Atualmente, a versão com agente mínimo desse produto é a 2.144.0.
    • Corrigi um texto de exibição incorreto para a tarefa de implantação do SSIS.
    • Refinamos algumas mensagens de erro.

    Versão 0.1.0 Versão prévia

    Data de Lançamento: 5 de dezembro de 2019

    Lançamento inicial das ferramentas SSIS DevOps. Esta é uma versão de pré-visualização.

    Conteúdo relacionado

    • Última atualização em