Atualiza a configuração de auditoria do projeto especificado
Visualização pública: o subcomando atlas api, gerado automaticamente a partir da API de administração do MongoDB Atlas , oferece cobertura completa da API de administração e está atualmente em visualização pública (forneça feedback em https://feedback.mongodb.com/ fóruns/930808-atlas-cli). Os recursos da API de administração têm seu próprio ciclo de vida de versão, que você pode verificar por meio do link de documentação do endpoint da API fornecido.
Para usar esse comando, você deve se autenticar com uma conta de usuário ou uma chave de API com a role de proprietário do projeto.
Sintaxe
atlas auditing update [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
--auditAuthorizationSuccess | false | Sinalizador que indica se alguém definiu a auditoria para acompanhar as autenticações bem-sucedidas. Isso se aplica somente ao filtro de auditar "atype" : "authCheck". Definir esse parâmetro como verdadeiro degrada o desempenho do cluster. | |
--auditFilter | string | false | documento JSON que especifica quais eventos dever ser gravados. Use uma barra invertida () para evitar caracteres que possam impedir a análise, como aspas simples ou double . Mutuamente exclusivo com --file. |
--enabled | false | Sinalizador que indica se alguém habilitou a auditoria do banco de dados para o projeto especificado. | |
-f, --file | string | false | Caminho para um arquivo de configuração JSON opcional que define filtros de auditoria. Para saber mais sobre arquivos de configuração de auditoria para o Atlas CLI, consulte https://www.mongodb.com/pt-br/docs/atlas/database-auditing/#example-auditing-filters Mutualmente exclusivo com --auditFilter. |
-h, --help | false | ajuda para atualização | |
-o, --output | string | false | Formato de saída. Os valores válidos são JSON, json-path, go-template ou go-template-file. Para ver o resultado completo, use a opção -o JSON. |
--projectId | string | false | String hexadecimal que identifica o projeto a ser usado. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente. |
Opções herdadas
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
-P, --profile | string | false | Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Saída
Se o comando for bem-sucedido, a CLI retornará uma saída semelhante à amostra a seguir. Os valores entre colchetes representam seus valores.
Auditing configuration successfully updated.
Exemplos
# Audit all authentication events for known users: atlas auditing update --auditFilter '{"atype": "authenticate"}'
# Audit all authentication events for known user via a configuration file: atlas auditing update -f filter.json