Azure Blob

Permite a configuração de um Blob storage da Azure para receber os arquivos gerados a partir das mensagens trafegadas.

Parâmetros

Parâmetros aceitos para esse tipo de sindicância de destino:

Campo
Descrição
Valor

azure_blob.container

Nome do container

Tipo: string Obrigatório

azure_blob.credential

Credenciais de acesso ao storage

Tipo: object Obrigatório

azure_blob.credential.storage_account

Nome da conta do storage

Tipo: string Obrigatório se storage_connection_string = ""

azure_blob.credential.storage_connection_string

String de conexão com o storage

Tipo: string

azure_blob.credential.storage_access_key

Chave de acesso ao storage

Tipo: string Obrigatório se (storage_connection_string = "" && storage_sas_token == "")

azure_blob.credential.storage_sas_token

Token de acesso ao storage

Tipo: string Obrigatório se (storage_connection_string = "" && storage_sas_token == "")

azure_blob.file

Dados do arquivo a ser gerado

Tipo: object Valor padrão: {}

azure_blob.file.path

Caminho do arquivo gerado

Tipo: string Valor padrão: -

azure_blob.file.extension

Extensão do arquivo gerado

Tipo: enum[csv json] Valor padrão: csv

azure_blob.file.separator

Separador do arquivo gerado - caso necessário

Tipo: string Valor padrão: ;

azure_blob.file.max_size_mb

Tamanho máximo em MB do arquivo gerado

Tipo: int[1-100] Valor padrão: 100

azure_blob.file.period

Períodos de geração/envio dos arquivos para o storage

Tipo: enum[1m 1h 2h 3h 4h 6h 8h 12h 1d] Valor padrão: 1d

azure_blob.file.schema

Esquema de campos do arquivo resultante. A ordem dos campos é respeitada.

Tipo: list Valor padrão: {}

azure_blob.file.schema.name

Nome do campo

Tipo: string Obrigatório

Requisição

curl --location '<HOST>/v1/configs' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <ACCESS-TOKEN>' \
  --data '{
    "output": {
      "type": "AZURE_BLOB",
      "azure_blob": {
        "container": "CONTAINER",
        "credential": {
          "storage_account": "STORAGE_ACCOUNT",
          "storage_connection_string": "STORAGE_CONNECTION_STRING",
          "storage_access_key": "STORAGE_ACCESS_KEY",
          "storage_sas_token": "STORAGE_SAS_TOKEN"
        },
        "file": {
          "path": "folder/file.csv",
          "extension": "csv",
          "separator": ";",
          "max_size_mb": 100
        }
      }
    }
  }'

Resposta

A resposta desse endpoint será no seguinte formato:

{
  "id": "FIREHOSE-ID",
  "output": {
    "type": "AZURE_BLOB",
    "azure_blob": {
      "container": "CONTAINER",
      "credential": {
        "storage_account": "STORAGE_ACCOUNT",
        "storage_connection_string": "*",
        "storage_access_key": "*",
        "storage_sas_token": "*"
      },
      "file": {
        "path": "folder/file.csv",
        "extension": "csv",
        "separator": ";",
        "max_size_mb": 100
      }
    }
  }
}

Last updated