Azion CLI connector
Comandos da Azion CLI que criam, listam, descrevem, atualizam e excluem connectors, com cada flag e o arquivo JSON que os comandos leem.
Os comandos connector da Azion CLI criam, listam, descrevem, atualizam e excluem connectors, os objetos que guardam onde e como uma aplicação alcança uma origem, o servidor que guarda o seu conteúdo. Um connector é criado e alterado a partir de um arquivo JSON, nunca com uma flag por configuração. As opções que todo comando aceita, como --format, --out e -y, estão em Opções globais.
Criar
azion create connector cria um connector a partir de um arquivo JSON e do tipo que você passa:
| Flag | Curta | Tipo | Padrão | Descrição |
|---|---|---|---|---|
--file | — | string | — | Obrigatório. Caminho de um arquivo JSON com os atributos do connector. Use - para ler o JSON da entrada padrão. Sem essa flag, o comando pergunta o caminho. |
--type | — | string | — | Obrigatório. Tipo do connector: http, storage ou live_ingest. Sem essa flag, o comando pergunta o tipo, mesmo quando o arquivo traz "type". |
A CLI envia qualquer valor de --type para a API sem verificá-lo. Um valor fora dos três, como ftp, falha com um erro do servidor que não nomeia o tipo:
Este arquivo, my-connector.json, descreve um connector do tipo http chamado my-connector que envia requisições para httpbin.org:
Este comando cria o connector a partir do arquivo:
O comando imprime o ID do connector:
Listar
azion list connector imprime os connectors da sua conta, 50 em cada página por padrão:
| Flag | Curta | Tipo | Padrão | Descrição |
|---|---|---|---|---|
--details | — | — | — | Adiciona as colunas LAST EDITOR e LAST MODIFIED às colunas ID, NAME, TYPE e ACTIVE. |
--filter | — | string | — | Nome pelo qual a lista é filtrada. |
--order-by | — | string | — | Campo pelo qual a lista é ordenada, como id ou name. |
--page | — | int | 1 | Número da página a retornar. |
--page-size | — | int | 50 | Número de connectors em cada página. |
Este comando retorna a primeira página de uma lista dividida em páginas de dois connectors:
O comando imprime uma linha por connector, com o tipo dele:
Descrever
azion describe connector imprime as configurações de um connector:
| Flag | Curta | Tipo | Padrão | Descrição |
|---|---|---|---|---|
--connector-id | — | int | — | ID do connector a descrever. |
Este comando descreve o connector com ID 123475:
O comando imprime o ID, o nome, a última alteração, o estado e o tipo do connector. A linha Language guarda o tipo:
Com --format json, o comando imprime o objeto completo: active, attributes, created_at, id, is_versioned, last_editor, last_modified, name, product_version, type, version, version_id e version_state. Em um connector do tipo http, attributes guarda addresses, connection_options e modules.
Atualizar
azion update connector altera o nome, o estado ou as configurações de um connector. O comando não tem uma flag por configuração, então as alterações vêm de um arquivo JSON:
| Flag | Curta | Tipo | Padrão | Descrição |
|---|---|---|---|---|
--connector-id | — | int | — | ID do connector a atualizar. |
--file | — | string | — | Caminho de um arquivo JSON com os atributos do connector. Use - para ler o JSON da entrada padrão. |
--type | — | string | — | Obrigatório. Tipo do connector: http, storage ou live_ingest. Sem essa flag, o comando pergunta o tipo, mesmo quando o arquivo traz "type". |
O arquivo traz o connector inteiro, como na criação. Um arquivo só com os campos a alterar, como name e active, é recusado antes que qualquer requisição seja enviada:
Este arquivo, my-connector-update.json, renomeia o connector para my-connector-renamed e repete todos os outros atributos com que ele foi criado:
Este comando aplica o arquivo ao connector com ID 123475:
O comando imprime o ID do connector atualizado:
Excluir
azion delete connector exclui um connector:
| Flag | Curta | Tipo | Padrão | Descrição |
|---|---|---|---|---|
--connector-id | — | int | — | ID do connector a excluir. |
Este comando exclui o connector com ID 123475:
O comando confirma a exclusão:
Usar um arquivo JSON
azion create connector e azion update connector leem o connector de um arquivo JSON com --file, e os dois também recebem --type na linha de comando. O arquivo guarda name, active, type e attributes. Um connector do tipo http traz addresses e connection_options em attributes; os tipos storage e live_ingest trazem outros atributos.
A API preenche com o valor padrão cada campo que o arquivo deixa de fora. Um arquivo com um address e três opções de conexão produz este connector, como azion describe connector --connector-id 123475 --format json o imprime:
Cada endereço recebe http_port 80 e https_port 443, e Load Balancer e Origin Shield ficam desativados. Para cada campo de cada tipo, com o intervalo e o padrão dele, consulte Configurações de connector.