Compartilhar via


SFTP – SSH

O SFTP (Protocolo de Transferência de Arquivo SSH) é um protocolo de rede que fornece acesso a arquivos, transferência de arquivo e gerenciamento de arquivos em qualquer fluxo de dados confiável. Ele foi projetado pelo IETF (Internet Engineering Task Force) como uma extensão do protocolo SSH (Secure Shell protocol) versão 2.0 para fornecer recursos seguros de transferência de arquivo.

Esse conector está disponível nos seguintes produtos e regiões:

Service Class Regions
Copilot Studio Standard Todas as regiões do Power Automate , exceto as seguintes:
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões de Aplicativos Lógicos
Power Apps Standard Todas as regiões do Power Apps , exceto as seguintes:
     - Departamento de Defesa dos EUA (DoD)
Power Automate Standard Todas as regiões do Power Automate , exceto as seguintes:
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Microsoft
URL Suporte do Microsoft LogicApps
Suporte do Microsoft Power Automate
Suporte do Microsoft Power Apps
Metadados do conector
Publicador Microsoft

Guia de instruções do conector

Este artigo descreve as operações do conector gerenciado SFTP-SSH, que está disponível para Aplicativos Lógicos do Azure, Power Automate e Power Apps. O conector interno do SFTP está disponível apenas para fluxos de trabalho do aplicativo lógico Standard nos Aplicativos Lógicos do Azure. Para obter mais informações, consulte Conectar-se a um servidor SFTP usando SSH nos Aplicativos Lógicos do Azure e referência de conector interno do SFTP para Aplicativos Lógicos do Azure.

Diferenças do conector gerenciado do SFTP preterido

Em comparação com o conector gerenciado do SFTP preterido, o conector gerenciado SFTP-SSH fornece os seguintes recursos principais:

  • Usa a biblioteca SSH.NET, que é uma biblioteca SSH (Secure Shell) de software livre que dá suporte ao .NET.

  • Fornece a ação Criar pasta , que cria uma pasta no caminho especificado no servidor SFTP.

  • Fornece a ação Renomear arquivo , que renomeia um arquivo no servidor SFTP.

  • Armazena em cache a conexão com o servidor SFTP por até 1 hora. Essa funcionalidade melhora o desempenho e reduz a frequência com que o conector tenta se conectar ao servidor. Para definir a duração desse comportamento de cache, edite a propriedade ClientAliveInterval na configuração SSH no servidor SFTP.

Autenticação e permissões

  • Ao criar uma conexão com o servidor SFTP, você precisa fornecer seu endereço de servidor SFTP, credenciais de conta, uma chave privada SSH e a senha da chave privada SSH. Se sua plataforma der suporte ao carregamento de arquivos grandes usando o agrupamento, você também precisará de acesso de leitura e gravação para a pasta raiz no servidor SFTP.

  • O conector SFTP-SSH dá suporte à autenticação de chave privada e à autenticação de senha. No entanto, o conector SFTP-SSH dá suporte apenas aos seguintes formatos de chave privada, algoritmos de troca de chaves, algoritmos de criptografia e impressões digitais:

    • Formatos de chave privada: chaves RSA (Rivest Shamir Adleman) e DSA (Algoritmo de Assinatura Digital) em formatos OpenSSH e ssh.com. Se a chave privada estiver no formato de arquivo PuTTY (.ppk), primeiro converta a chave no formato de arquivo OpenSSH (.pem).
    • Algoritmos de troca de chaves:
      • curve25519-sha256
      • curve25519-sha256@libssh.org
      • ecdh-sha2-nistp256
      • ecdh-sha2-nistp384
      • ecdh-sha2-nistp521
      • diffie-hellman-group-exchange-sha256
      • diffie-hellman-group-exchange-sha1
      • diffie-hellman-group16-sha512
      • diffie-hellman-group14-sha256
      • diffie-hellman-group14-sha1
      • diffie-hellman-group1-sha1
    • Algoritmos de criptografia:
      • aes256-ctr
      • 3des-cbc
      • aes128-cbc
      • aes192-cbc
      • aes256-cbc
      • blowfish-cbc
      • twofish-cbc
      • twofish192-cbc
      • twofish128-cbc
      • twofish256-cbc
      • arcfour
      • arcfour128
      • arcfour256
      • cast128-cbc
      • aes128-ctr
      • aes192-ctr
    • Algoritmos de chave de host:
      • ssh-rsa
      • ssh-dss
      • ssh-ed25519
      • ecdsa-sha2-nistp256
      • ecdsa-sha2-nistp384
      • ecdsa-sha2-nistp521
    • Impressão digital: MD5. Para obter mais informações, consulte Localizar a impressão digital MD5.
  • Ao fornecer sua chave privada SSH para sua conexão, não insira ou edite manualmente a chave, o que pode causar falha na conexão. Em vez disso, copie a chave do arquivo de chave privada SSH e cole essa chave na caixa de informações de conexão.

    Para copiar e colar corretamente sua chave privada SSH, siga estas etapas.

    1. Abra o arquivo de chave privada SSH em qualquer editor de texto. Essas etapas continuam usando o Bloco de Notas como exemplo.

    2. No Bloco de Notas, no menu Editar , selecione tudo. (Pressione Ctrl + A)

    3. No menu Editar , selecione Copiar.

    4. Na caixa de informações de conexão SFTP-SSH, cole a chave copiada completa na propriedade de chave privada SSH , que dá suporte a várias linhas. Não insira ou edite manualmente a chave.

    5. Depois de concluir a inserção dos detalhes da conexão, selecione Criar.

Converter chave baseada em PuTTY em OpenSSH

O formato PuTTY e o formato OpenSSH usam extensões de nome de arquivo diferentes. O formato PuTTY usa a extensão de nome de arquivo .ppk ou PuTTY Private Key. O formato OpenSSH usa a extensão de nome de arquivo .pem ou Email Avançado de Privacidade. Se sua chave privada estiver no formato PuTTY e você precisar usar o formato OpenSSH, primeiro converta a chave no formato OpenSSH seguindo estas etapas:

  • Sistema operacional baseado em Unix

    1. Se você não tiver as ferramentas puTTY instaladas em seu sistema, faça isso agora, por exemplo:

      sudo apt-get install -y putty

    2. Execute o seguinte comando, que cria um arquivo que você pode usar com o conector SFTP-SSH:

      puttygen <path-to-private-key-file-in-PuTTY-format> -O private-openssh -o <path-to-private-key-file-in-OpenSSH-format>

      Por exemplo

      puttygen /tmp/sftp/my-private-key-putty.ppk -O private-openssh -o /tmp/sftp/my-private-key-openssh.pem

  • Sistema operacional Windows

    1. Se você ainda não fez isso, baixe a ferramenta mais recente do Gerador puTTY (puttygen.exe) e abra a ferramenta.

    2. Na ferramenta Gerador de Chaves puTTY (puttygen.exe), em Ações, selecione Carregar.

    3. Navegue até o arquivo de chave privada no formato PuTTY e selecione Abrir.

    4. No menu Conversões , selecione Exportar chave OpenSSH.

    5. Salve o arquivo de chave privada com a extensão de nome do arquivo .pem .

Localizar a impressão digital do MD5

O conector SFTP-SSH rejeitará uma conexão se a impressão digital do servidor SFTP e a impressão digital esperada não corresponderem. Para obter a impressão digital MD5, que é uma sequência com 16 pares de dígitos hexadecimais delimitados por dois-pontos, tente as opções a seguir.

Você tem a chave

A chave MD5 é uma cadeia de caracteres de 47 caracteres delimitada por dois-pontos. Para obter a impressão digital MD5 quando você tiver a chave, você pode usar ferramentas como ssh-keygen.

Por exemplo, em um prompt do Bash, insira o seguinte comando:

ssh-keygen -l -f id_rsa.pub -E md5

Você não tem a chave

Para obter uma impressão digital MD5 quando você não tiver uma chave, você pode usar a ferramenta de diálogo informações de protocolo e servidor mais recente do WinSCP ou usar a ferramenta configuração puTTY em vez disso:

  1. Na ferramenta Configuração do PuTTY (putty.exe), na janela Categoria, expandaas chaves do HostSSH> de Conexão>.

  2. Na preferência do algoritmo de chave de host, abra a lista de políticas de seleção de algoritmo e verifique se a RSA aparece na parte superior.

  3. Se a RSA não aparecer na parte superior, selecione RSA e selecione Up até que a RSA se mova para a parte superior.

  4. Conecte-se ao servidor SFTP com o PuTTY. Depois que a conexão for criada, quando o alerta de segurança PUTTY for exibido, selecione Mais informações.

    Observação

    Se o alerta de segurança não aparecer, tente limpar a entrada SshHostKeys . Abra o editor do Registro do Windows e navegue até a seguinte entrada:

    Computer\HKEY_CURRENT_USER\Software\SimonTatham\PuTTY\SshHostKeys

  5. Após o PuTTY: informações sobre a caixa de chave de host do servidor são exibidas, localize a propriedade de impressão digital MD5 e copie o valor da cadeia de caracteres de 47 caracteres, que se parece com o exemplo a seguir:

    **:**:**:**:**:**:**:**:**:**:**:**:**:**:**:**

Problemas conhecidos e limitações com gatilhos

  • Os gatilhos do conector gerenciado do SFTP podem apresentar resultados ausentes, incompletos ou atrasados.

    • Resultados faltando

      Os gatilhos SFTP funcionam sondando ou verificando o sistema de arquivos SFTP e procurando todos os arquivos que foram alterados desde a última pesquisa. Gatilhos de conector gerenciado SFTP comparam versões de arquivo usando o último carimbo de data/hora modificado do arquivo.

      Se você criar, adicionar ou atualizar o arquivo com um carimbo de data/hora anterior ao carimbo de data/hora da última modificação, o gatilho do conector gerenciado SFTP não detectará esse arquivo.

      Portanto, se você usar uma ferramenta externa ou cliente que cria, adiciona ou atualiza arquivos no servidor SFTP, certifique-se de desabilitar qualquer recurso na ferramenta ou cliente que preserve o último carimbo de data/hora modificado de um arquivo.

      A tabela a seguir lista algumas ferramentas comumente usadas que preservam esse carimbo de data/hora e as etapas para desabilitar esse recurso:

      Cliente SFTP Ação
      WinSCP Vá para Opções>>Transferência de Transferência>Editar Preservar> carimbode data/>horaDesabilitar.
      FileZilla Vá para Transferir>carimbos de data/hora de preservação de arquivos> transferidosDesabilite.
    • Resultados incompletos ou atrasados

      Quando um gatilho SFTP verifica se há um arquivo recém-criado, adicionado ou atualizado, o gatilho também verifica se o arquivo está concluído. Por exemplo, um arquivo pode ter alterações em andamento quando o gatilho verifica o servidor SFTP. Para evitar o retorno de um arquivo incompleto, o gatilho observa o carimbo de data/hora do arquivo, mas não retorna imediatamente o arquivo. Em vez disso, o gatilho retorna o arquivo somente quando o gatilho verifica o servidor novamente.

      Às vezes, esse comportamento pode causar um atraso que dura quase o dobro do intervalo de sondagem do gatilho. Devido a esse comportamento, se você desabilitar a configuração Split On do gatilho SFTP, o gatilho SFTP poderá não retornar todos os arquivos ao mesmo tempo.

Limitações e problemas gerais conhecidos

  • O conector gerenciado SFTP-SSH atualmente não dá suporte aos seguintes servidores SFTP:

    • Akamai NetStorage
    • FileMage Gateway
    • Paisagem global
    • IBM DataPower
    • MessageWay
    • OpenText Secure MFT
    • OpenText GXS
    • SFTP para Armazenamento de Blobs do Azure
    • Servidor de Transferência de Arquivo Seguro do VShell
    • AWS SFTP
  • Use pastas SFTP separadas para processamento e carregamento de arquivos.

    Use pastas separadas no servidor SFTP para o gatilho para monitorar arquivos para processamento e para armazenar arquivos carregados. Caso contrário, o gatilho não será acionado e se comportará de forma imprevisível. Por exemplo, o gatilho pode ignorar um número aleatório de arquivos que precisam de processamento.

    Essa limitação significa que você precisa de uma maneira de mover arquivos entre essas pastas. Se você encontrar esse problema, remova os arquivos da pasta monitorada e use uma pasta diferente para armazenar arquivos carregados.

  • Para gerenciar a carga em serviços de conector gerenciado de vários locatários compartilhados, o conector SFTP-SSH gerenciado pode criar várias conexões do mesmo endereço IP de origem, ou seja, o endereço IP do conector, para o destino, que é o servidor SFTP. Algumas regiões de baixo tráfego podem usar apenas três instâncias de máquina virtual por trás do endereço IP do conector, o que significa que essas regiões podem criar no máximo três conexões. Outras regiões podem usar até 20 conexões porque têm o mesmo número de máquinas virtuais por trás do endereço IP do conector.

    Se o servidor SFTP limitar o número de conexões, o servidor poderá não funcionar bem com o conector SFTP-SSH gerenciado. No entanto, você pode criar um fluxo de trabalho de aplicativo lógico Standard que usa as operações SFTP internas. Você pode controlar os limites de expansão e, como resultado, o número de conexões.

  • Se você encontrar problemas de interoperabilidade do pacote de criptografia entre o SFTP-SSH conector gerenciado e o servidor SFTP, tente criar um fluxo de trabalho do aplicativo lógico Standard e use as operações internas do SFTP. As operações internas do SFTP dão suporte a uma gama maior de conjuntos de criptografia.

  • Esse conector pode enviar uma solicitação no-op para o back-end.

Agrupamento

  • Nos Aplicativos Lógicos do Azure e no Power Automate, as ações de conector de SFTP-SSH gerenciadas a seguir dão suporte ao agrupamento, em que uma ação pode habilitar o tratamento de arquivos grandes em partes menores. Para obter mais informações sobre o agrupamento nos Aplicativos Lógicos do Azure, consulte [Manipular mensagens grandes usando agrupamento]](/azure/logic-apps/logic-apps-handle-large-messages).

    Ação Suporte a agrupamento Substituir o suporte ao tamanho da parte
    Copiar arquivo Não Não aplicável
    Criar arquivo Yes Yes
    Criar pasta Não aplicável Não aplicável
    Excluir arquivo Não aplicável Não aplicável
    Extrair arquivo morto para pasta Não aplicável Não aplicável
    Obter conteúdo do arquivo Yes Yes
    Obter conteúdo do arquivo usando o caminho Yes Yes
    Obter metadados de arquivo Não aplicável Não aplicável
    Obter metadados de arquivo usando o caminho Não aplicável Não aplicável
    Listar arquivos na pasta Não aplicável Não aplicável
    Renomear arquivo Não aplicável Não aplicável
    Atualizar arquivo Não Não aplicável

    SFTP-SSH ações que dão suporte ao agrupamento podem manipular arquivos de até 1 GB, enquanto as ações SFTP-SSH que não dão suporte ao agrupamento podem manipular arquivos de até 50 MB. O tamanho da parte padrão é de 15 MB. No entanto, esse tamanho pode mudar dinamicamente, começando de 5 MB e aumentando gradualmente para o máximo de 50 MB. O dimensionamento dinâmico baseia-se em fatores como latência de rede, tempo de resposta do servidor e assim por diante.

    Você pode substituir esse comportamento adaptável ao especificar um tamanho de parte constante a ser usado. Esse tamanho pode variar de 5 MB a 50 MB. Por exemplo, suponha que você tenha um arquivo de 45 MB e uma rede que possa dar suporte a esse tamanho de arquivo sem latência. O agrupamento adaptável resulta em várias chamadas, em vez dessa chamada. Para reduzir o número de chamadas, você pode tentar definir um tamanho de bloco de 50 MB. Em um cenário diferente, se o fluxo de trabalho do aplicativo lógico estiver atingindo o tempo limite, por exemplo, ao usar partes de 15 MB, você poderá tentar reduzir o tamanho para 5 MB.

    O tamanho da parte está associado a uma conexão. Esse atributo significa que você pode usar a mesma conexão para ambas as ações que dão suporte a agrupamentos e ações que não dão suporte a agrupamento. Nesse caso, o tamanho da parte para ações que dão suporte a agrupamento varia de 5 MB a 50 MB.

    Para substituir o comportamento adaptável padrão que o agrupamento usa em uma ação SFTP-SSH, você pode especificar um tamanho de parte constante de 5 MB a 50 MB.

    1. No designer, no canto superior direito da ação SFTP-SSH, selecione o botão de reticências (...) e selecione Configurações.

    2. Em Transferência de Conteúdo, na propriedade Tamanho da parte, insira um valor inteiro de 5 para 50.

    3. Depois de concluir, selecione Concluído.

  • SFTP-SSH gatilhos não dão suporte ao agrupamento de mensagens. Quando dispara o conteúdo do arquivo de solicitação, eles selecionam apenas arquivos de 15 MB ou menores. Para obter arquivos maiores que 15 MB, siga este padrão em vez disso:

    1. Use um gatilho SFTP-SSH que retorna apenas as propriedades do arquivo. Esses gatilhos têm nomes que incluem a descrição (somente propriedades).

    2. Siga o gatilho com a ação SFTP-SSH Obter conteúdo do arquivo . Essa ação lê o arquivo completo e usa implicitamente o agrupamento de mensagens.

Resolução de problemas

Erro 401: "401 Não autorizado"

Esse erro pode acontecer porque você não tem as credenciais ou permissões corretas. Para obter mais informações, consulte Autenticação e permissões.

Erro 404: "Uma referência foi feita a um arquivo ou pasta que não existe"

Esse erro pode acontecer quando você usa a ação Criar arquivo . Quando a ação cria um arquivo no servidor SFTP, a ação também envia automaticamente uma chamada ao servidor SFTP para obter os metadados do arquivo.

Se você mover imediatamente o arquivo recém-criado antes que a chamada possa obter os metadados, o arquivo não existirá mais no local esperado e você receberá uma mensagem de erro 404, uma referência foi feita a um arquivo ou pasta que não existe.

Se você não puder evitar ou atrasar a movimentação do arquivo, ignore a leitura dos metadados do arquivo após a criação do arquivo seguindo estas etapas:

  1. Na ação Criar arquivo , abra a lista Adicionar novo parâmetro , selecione a propriedade Obter todos os metadados de arquivo e defina o valor como Não.

  2. Se você precisar desse metadados de arquivo mais tarde, poderá usar a ação Obter metadados de arquivo .

Erro 504: "Falha na tentativa de conexão porque a parte conectada não respondeu corretamente após um período de tempo ou falha na conexão estabelecida porque o host conectado não respondeu" ou "A solicitação ao servidor SFTP levou mais de '00:00:30' segundos"

Esse erro pode ocorrer quando você não conseguir estabelecer uma conexão com o servidor SFTP com êxito. Pode haver diferentes razões para esse problema, portanto, tente estas opções de solução de problemas:

  • O tempo limite da conexão é de 20 segundos. Verifique se o servidor SFTP tem bom desempenho e dispositivos intermediários, como firewalls, não estão adicionando sobrecarga.

  • Verifique se o servidor SFTP coloca um limite no número de conexões de cada endereço IP. Qualquer limite desse tipo dificulta a comunicação entre o conector e o servidor SFTP. Remova esse limite.

  • Se você tiver um firewall configurado, adicione os endereços IP do conector gerenciado para sua região à lista aprovada.

  • Se o erro ocorrer intermitentemente, altere a configuração de política de repetição na ação SFTP-SSH para uma contagem de repetição maior do que as quatro tentativas padrão.

  • Para reduzir o custo de estabelecimento de conexão, na configuração SSH do servidor SFTP, aumente a propriedade ClientAliveInterval para cerca de uma hora.

  • Examine o log do servidor SFTP para verificar se as chamadas enviadas ao servidor SFTP chegam com êxito, para obter mais informações sobre o problema de conectividade, você também pode executar um rastreamento de rede no firewall e no servidor SFTP.

Limites Gerais

Nome Value
Número máximo de megabytes sendo transferidos para/do conector dentro de um intervalo de tempo de largura de banda (por conexão) 1000
Intervalo de tempo de largura de banda (em milissegundos) 60000

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:

Default Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
Endereço do servidor host cadeia Endereço do servidor host Verdade
Nome de usuário cadeia Nome de usuário Verdade
Senha secureString Senha
Chave privada SSH secureString Chave privada SSH (o conteúdo do arquivo deve ser fornecido inteiramente como está, no formato multilinha)
Frase secreta de chave privada SSH secureString Frase secreta de chave privada SSH (se a chave privada estiver protegida por uma frase secreta)
Número da porta int Número da porta SFTP (exemplo: 22)
Desabilitar a validação da chave de host SSH bool Desabilitar a validação da chave de host SSH? (True/False)
Impressão de dedo da chave do host SSH cadeia Impressão de dedo da chave do host SSH
Caminho da pasta raiz cadeia Caminho da pasta raiz.

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 150 60 segundos

Ações

Atualizar arquivo

Esta operação atualiza o conteúdo do arquivo.

Copiar arquivo

Esta operação copia um arquivo.

Criar arquivo

Esta operação carrega um arquivo.

Criar uma pasta

Essa operação cria uma nova pasta.

Excluir arquivo

Essa operação exclui um arquivo.

Extrair arquivo morto para pasta

Esta operação extrai um arquivo morto em uma pasta (exemplo: .zip).

Listar arquivos na pasta

Essa operação obtém arquivos contidos em uma pasta.

Listar arquivos na pasta raiz

Essa operação obtém os arquivos na pasta raiz.

Obter conteúdo do arquivo

Essa operação obtém o conteúdo do arquivo usando a ID do arquivo.

Obter conteúdo do arquivo usando o caminho

Essa operação obtém o conteúdo do arquivo usando o caminho do arquivo.

Obter metadados de arquivo usando o caminho

Esta operação obtém metadados de arquivo usando o caminho do arquivo.

Obter metadados do arquivo

Esta operação obtém metadados de arquivo usando a ID do arquivo.

Renomear arquivo

Esta operação renomeia um arquivo.

Atualizar arquivo

Esta operação atualiza o conteúdo do arquivo.

Parâmetros

Nome Chave Obrigatório Tipo Description
File
id True string

Especificar o arquivo

Conteúdo do ficheiro
body True binary

Conteúdo do arquivo a ser atualizado

Obter todos os metadados de arquivo
ReadFileMetadataFromServer boolean

Obtenha todos os metadados de arquivo do servidor SFTP após a conclusão da criação do arquivo. Se isso for falso, algumas propriedades de metadados poderão não ser retornadas, como a hora da última modificação, etc.

Retornos

Metadados de blob

Corpo
BlobMetadata

Copiar arquivo

Esta operação copia um arquivo.

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho do arquivo de origem
source True string

Caminho para o arquivo de origem

Caminho do arquivo de destino
destination True string

Caminho para o arquivo de destino, incluindo o nome do arquivo

Sobrescrever?
overwrite boolean

Substitui o arquivo de destino se definido como 'true'

Obter todos os metadados de arquivo
ReadFileMetadataFromServer boolean

Obtenha todos os metadados de arquivo do servidor SFTP após a conclusão da criação do arquivo. Se isso for falso, algumas propriedades de metadados poderão não ser retornadas, como a hora da última modificação, etc.

Retornos

Metadados de blob

Corpo
BlobMetadata

Criar arquivo

Esta operação carrega um arquivo.

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da pasta
folderPath True string

Caminho exclusivo da pasta

Nome do arquivo
name True string

Nome do arquivo

Conteúdo do ficheiro
body True binary

Conteúdo do arquivo a ser criado

Obter todos os metadados de arquivo
ReadFileMetadataFromServer boolean

Obtenha todos os metadados de arquivo do servidor SFTP após a conclusão da criação do arquivo. Se isso for falso, algumas propriedades de metadados poderão não ser retornadas, como a hora da última modificação, etc.

Retornos

Metadados de blob

Corpo
BlobMetadata

Criar uma pasta

Essa operação cria uma nova pasta.

Parâmetros

Nome Chave Obrigatório Tipo Description
Pasta
folderPath True string

Selecionar uma pasta

Nome
name True string

Nome da pasta

Retornos

Metadados de blob

Corpo
BlobMetadata

Excluir arquivo

Essa operação exclui um arquivo.

Parâmetros

Nome Chave Obrigatório Tipo Description
File
id True string

Especificar o arquivo

Ignorar exclusão se o arquivo não for encontrado
SkipDeleteIfFileNotFoundOnServer boolean

Ignora a exclusão se um arquivo não for encontrado sem ação de falha.

Extrair arquivo morto para pasta

Esta operação extrai um arquivo morto em uma pasta (exemplo: .zip).

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho do arquivo de arquivo de origem
source True string

Caminho para o arquivo morto

Caminho da pasta de destino
destination True string

Caminho para a pasta de destino

Sobrescrever?
overwrite boolean

Substitui os arquivos de destino se definido como 'true'

Retornos

Listar arquivos na pasta

Essa operação obtém arquivos contidos em uma pasta.

Parâmetros

Nome Chave Obrigatório Tipo Description
Pasta
id True string

Especificar a pasta

Retornos

Listar arquivos na pasta raiz

Essa operação obtém os arquivos na pasta raiz.

Retornos

Obter conteúdo do arquivo

Essa operação obtém o conteúdo do arquivo usando a ID do arquivo.

Parâmetros

Nome Chave Obrigatório Tipo Description
File
id True string

Especificar a ID do arquivo

Inferir tipo de conteúdo
inferContentType boolean

Inferir o tipo de conteúdo com base na extensão

Retornos

O conteúdo do ficheiro.

Conteúdo do arquivo
binary

Obter conteúdo do arquivo usando o caminho

Essa operação obtém o conteúdo do arquivo usando o caminho do arquivo.

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho do arquivo
path True string

Caminho exclusivo do arquivo

Inferir tipo de conteúdo
inferContentType boolean

Inferir o tipo de conteúdo com base na extensão

Retornos

O conteúdo do ficheiro.

Conteúdo do arquivo
binary

Obter metadados de arquivo usando o caminho

Esta operação obtém metadados de arquivo usando o caminho do arquivo.

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho do arquivo
path True string

Caminho exclusivo do arquivo

Retornos

Metadados de blob

Corpo
BlobMetadata

Obter metadados do arquivo

Esta operação obtém metadados de arquivo usando a ID do arquivo.

Parâmetros

Nome Chave Obrigatório Tipo Description
File
id True string

Especificar a ID do arquivo

Retornos

Metadados de blob

Corpo
BlobMetadata

Renomear arquivo

Esta operação renomeia um arquivo.

Parâmetros

Nome Chave Obrigatório Tipo Description
File
id True string

Selecionar um arquivo

Novo nome
newName True string

Novo nome para o arquivo

Obter todos os metadados de arquivo
ReadFileMetadataFromServer boolean

Obtenha todos os metadados de arquivo do servidor SFTP após a conclusão da criação do arquivo. Se isso for falso, algumas propriedades de metadados poderão não ser retornadas, como a hora da última modificação, etc.

Retornos

Representa a resposta de metadados de conjuntos de dados de blob

Gatilhos

Quando os arquivos são adicionados ou modificados (somente propriedades)

Essa operação dispara um fluxo quando um arquivo é adicionado ou modificado em uma pasta. Esse gatilho buscará apenas os metadados do arquivo. Para obter o conteúdo do arquivo, você pode usar a operação "Obter conteúdo do arquivo". O gatilho depende da hora da última modificação de um arquivo. Se um arquivo estiver sendo criado por um cliente de terceiros, a preservação da hora da última modificação deverá ser desabilitada no cliente. O gatilho não será acionado se um arquivo for adicionado/atualizado em uma subpasta. Se for necessário disparar em subpastas, vários gatilhos deverão ser criados.

Quando um arquivo é adicionado ou modificado

Essa operação dispara um fluxo quando um arquivo é adicionado ou modificado em uma pasta. O gatilho buscará os metadados do arquivo, bem como o conteúdo do arquivo. O gatilho depende da hora da última modificação de um arquivo. Se um arquivo estiver sendo criado por um cliente de terceiros, a preservação da hora da última modificação deverá ser desabilitada no cliente. Arquivos maiores que 50 megabytes são ignorados pelo gatilho. O gatilho não será acionado se um arquivo for adicionado/atualizado em uma subpasta. Se for necessário disparar em subpastas, vários gatilhos deverão ser criados.

Quando os arquivos são adicionados ou modificados (somente propriedades)

Essa operação dispara um fluxo quando um arquivo é adicionado ou modificado em uma pasta. Esse gatilho buscará apenas os metadados do arquivo. Para obter o conteúdo do arquivo, você pode usar a operação "Obter conteúdo do arquivo". O gatilho depende da hora da última modificação de um arquivo. Se um arquivo estiver sendo criado por um cliente de terceiros, a preservação da hora da última modificação deverá ser desabilitada no cliente. O gatilho não será acionado se um arquivo for adicionado/atualizado em uma subpasta. Se for necessário disparar em subpastas, vários gatilhos deverão ser criados.

Parâmetros

Nome Chave Obrigatório Tipo Description
Pasta
folderId True string

Selecionar uma pasta

Número de arquivos a serem retornados
maxFileCount integer

Número de arquivos retornados do gatilho (1 a 100)

Retornos

Metadados de blob

Lista de arquivos
BlobMetadata

Quando um arquivo é adicionado ou modificado

Essa operação dispara um fluxo quando um arquivo é adicionado ou modificado em uma pasta. O gatilho buscará os metadados do arquivo, bem como o conteúdo do arquivo. O gatilho depende da hora da última modificação de um arquivo. Se um arquivo estiver sendo criado por um cliente de terceiros, a preservação da hora da última modificação deverá ser desabilitada no cliente. Arquivos maiores que 50 megabytes são ignorados pelo gatilho. O gatilho não será acionado se um arquivo for adicionado/atualizado em uma subpasta. Se for necessário disparar em subpastas, vários gatilhos deverão ser criados.

Parâmetros

Nome Chave Obrigatório Tipo Description
Pasta
folderId True string

Especificar uma pasta

Incluir conteúdo do arquivo
includeFileContent boolean

Se definido como true, o conteúdo do arquivo também será recuperado junto com a resposta do gatilho

Inferir tipo de conteúdo
inferContentType boolean

Inferir o tipo de conteúdo com base na extensão

Retornos

O conteúdo do ficheiro.

Conteúdo do arquivo
binary

Definições

BlobMetadata

Metadados de blob

Nome Caminho Tipo Description
ID
Id string

A ID exclusiva do arquivo ou pasta.

Nome
Name string

O nome do arquivo ou pasta.

DisplayName
DisplayName string

O nome de exibição do arquivo ou pasta.

Caminho
Path string

O caminho do arquivo ou pasta.

LastModified
LastModified date-time

A data e a hora em que o arquivo ou a pasta foi modificado pela última vez.

Tamanho
Size integer

O tamanho do arquivo ou pasta.

Tipo de Mídia
MediaType string

O tipo de mídia do arquivo ou pasta.

IsFolder
IsFolder boolean

Um valor booliano (true, false) para indicar se o blob é ou não uma pasta.

Etag
ETag string

A etag do arquivo ou pasta.

FileLocator
FileLocator string

O filelocator do arquivo ou pasta.

BlobMetadataResponse

Representa a resposta de metadados de conjuntos de dados de blob

Nome Caminho Tipo Description
ID
Id string

A ID exclusiva do arquivo ou pasta.

Nome
Name string

O nome do arquivo ou pasta.

DisplayName
DisplayName string

O nome de exibição do arquivo ou pasta.

Caminho
Path string

O caminho do arquivo ou pasta.

LastModified
LastModified date-time

A data e a hora em que o arquivo ou a pasta foi modificado pela última vez.

Tamanho
Size integer

O tamanho do arquivo ou pasta.

Tipo de Mídia
MediaType string

O tipo de mídia do arquivo ou pasta.

IsFolder
IsFolder boolean

Um valor booliano (true, false) para indicar se o blob é ou não uma pasta.

Etag
ETag string

A etag do arquivo ou pasta.

FileLocator
FileLocator string

O filelocator do arquivo ou pasta.

binário

Esse é o tipo de dados básico 'binary'.