Compartilhar via

az sentinel metadata

Note

Essa referência faz parte da extensão sentinela da CLI do Azure (versão 2.37.0 ou superior). A extensão instalará automaticamente na primeira vez que você executar um comando metadados do az sentinel. Saiba mais sobre extensões.

Gerenciar metadados com sentinela.

Comandos

Nome Description Tipo Status
az sentinel metadata create

Criar metadados.

 Extension Experimental
az sentinel metadata delete

Excluir metadados.

 Extension Experimental
az sentinel metadata list

Lista de todos os metadados.

 Extension Experimental
az sentinel metadata show

Obtenha metadados.

 Extension Experimental
az sentinel metadata update

Atualizar metadados.

 Extension Experimental

az sentinel metadata create

Habilitação

Este comando é experimental e está em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Criar metadados.

az sentinel metadata create --metadata-name --name
                            --resource-group
                            --workspace-name
                            [--author]
                            [--categories]
                            [--content-id]
                            [--content-schema-version]
                            [--custom-version]
                            [--dependencies]
                            [--etag]
                            [--first-publish-date]
                            [--icon]
                            [--kind {AnalyticsRule, AnalyticsRuleTemplate, AutomationRule, AzureFunction, DataConnector, DataType, HuntingQuery, InvestigationQuery, LogicAppsCustomConnector, Parser, Playbook, PlaybookTemplate, Solution, Watchlist, WatchlistTemplate, Workbook, WorkbookTemplate}]
                            [--last-publish-date]
                            [--parent-id]
                            [--preview-images]
                            [--preview-images-dark]
                            [--providers]
                            [--source]
                            [--support]
                            [--threat-tactics]
                            [--threat-techniques]
                            [--version]

Parâmetros Exigidos

--metadata-name --name -n

O nome dos metadados.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--workspace-name -w
Habilitação

O nome do espaço de trabalho.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--author

O criador do item de conteúdo. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--categories

Categorias para o item de conteúdo da solução dão suporte à sintaxe abreviada, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--content-id

ID estática para o conteúdo. Usado para identificar dependências e conteúdo de soluções ou comunidade. Codificado/estático para conteúdo e soluções prontos para uso. Dinâmico para criado pelo usuário. Esse é o nome do recurso.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--content-schema-version

Versão do esquema do conteúdo. Pode ser usado para distinguir entre fluxos diferentes com base na versão do esquema.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--custom-version

A versão personalizada do conteúdo. Um texto gratuito opcional.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--dependencies

Dependências do item de conteúdo, quais outros itens de conteúdo ele precisa para funcionar. Pode descrever dependências mais complexas usando uma estrutura recursiva/aninhada. Para uma única dependência, uma ID/tipo/versão pode ser fornecida ou operador/critérios para formatos complexos. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--etag

Etag do recurso do azure.

Propriedade Valor
Grupo de parâmetros: Metadata Arguments
--first-publish-date

Primeiro item de conteúdo da solução de data de publicação.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--icon

O identificador do ícone. essa ID pode ser buscada posteriormente no modelo de solução.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--kind

O tipo de conteúdo para o qual os metadados servem.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Valores aceitos: AnalyticsRule, AnalyticsRuleTemplate, AutomationRule, AzureFunction, DataConnector, DataType, HuntingQuery, InvestigationQuery, LogicAppsCustomConnector, Parser, Playbook, PlaybookTemplate, Solution, Watchlist, WatchlistTemplate, Workbook, WorkbookTemplate
--last-publish-date

Última data de publicação do item de conteúdo da solução.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--parent-id

ID completa do recurso pai do item de conteúdo para o qual os metadados são. Essa é a ID de recurso completa, incluindo o escopo (assinatura e grupo de recursos).

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--preview-images

Visualizar nomes de arquivo de imagem. Elas serão retiradas dos artefatos de solução compatíveis com sintaxe de taquigrafia, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--preview-images-dark

Visualizar nomes de arquivo de imagem. Eles serão retirados dos artefatos da solução. usado para o suporte a temas escuros dão suporte à sintaxe abreviada, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--providers

Os provedores para o item de conteúdo da solução dão suporte à sintaxe abreviada, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--source

Fonte do conteúdo. Foi aqui/como ele foi criado. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--support

Informações de suporte para os metadados - tipo, nome, informações de contato Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--threat-tactics

As táticas que o recurso aborda dão suporte à sintaxe de taquigrafia, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--threat-techniques

As técnicas que o recurso aborda, elas precisam ser alinhadas com as táticas que estão sendo usadas dão suporte à sintaxe de taquigrafia, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--version

Versão do conteúdo. O formato padrão e recomendado é numérico (por exemplo, 1, 1.0, 1.0.0, 1.0.0.0), seguindo as práticas recomendadas do modelo do ARM. Também pode ser qualquer cadeia de caracteres, mas não podemos garantir nenhuma verificação de versão.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az sentinel metadata delete

Habilitação

Este comando é experimental e está em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Excluir metadados.

az sentinel metadata delete [--ids]
                            [--metadata-name --name]
                            [--resource-group]
                            [--subscription]
                            [--workspace-name]
                            [--yes]

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--metadata-name --name -n

O nome dos metadados.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--workspace-name -w
Habilitação

O nome do espaço de trabalho.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--yes -y

Não solicite confirmação.

Propriedade Valor
Valor padrão: False
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az sentinel metadata list

Habilitação

Este comando é experimental e está em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Lista de todos os metadados.

az sentinel metadata list --resource-group
                          --workspace-name
                          [--filter]
                          [--orderby]
                          [--skip]
                          [--top]

Parâmetros Exigidos

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--workspace-name -w
Habilitação

O nome do espaço de trabalho.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--filter

Filtra os resultados, com base em uma condição booliana. Optional.

--orderby

Classifica os resultados. Optional.

--skip

Usado para ignorar n elementos na consulta OData (deslocamento). Retorna um nextLink para a próxima página de resultados se houver algum restante.

--top

Retorna apenas os primeiros n resultados. Optional.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az sentinel metadata show

Habilitação

Este comando é experimental e está em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Obtenha metadados.

az sentinel metadata show [--ids]
                          [--metadata-name --name]
                          [--resource-group]
                          [--subscription]
                          [--workspace-name]

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--metadata-name --name -n

O nome dos metadados.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--workspace-name -w
Habilitação

O nome do espaço de trabalho.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az sentinel metadata update

Habilitação

Este comando é experimental e está em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Atualizar metadados.

az sentinel metadata update [--add]
                            [--author]
                            [--categories]
                            [--content-id]
                            [--content-schema-version]
                            [--custom-version]
                            [--dependencies]
                            [--etag]
                            [--first-publish-date]
                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                            [--icon]
                            [--ids]
                            [--kind {AnalyticsRule, AnalyticsRuleTemplate, AutomationRule, AzureFunction, DataConnector, DataType, HuntingQuery, InvestigationQuery, LogicAppsCustomConnector, Parser, Playbook, PlaybookTemplate, Solution, Watchlist, WatchlistTemplate, Workbook, WorkbookTemplate}]
                            [--last-publish-date]
                            [--metadata-name --name]
                            [--parent-id]
                            [--preview-images]
                            [--preview-images-dark]
                            [--providers]
                            [--remove]
                            [--resource-group]
                            [--set]
                            [--source]
                            [--subscription]
                            [--support]
                            [--threat-tactics]
                            [--threat-techniques]
                            [--version]
                            [--workspace-name]

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valor de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--author

O criador do item de conteúdo. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--categories

Categorias para o item de conteúdo da solução dão suporte à sintaxe abreviada, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--content-id

ID estática para o conteúdo. Usado para identificar dependências e conteúdo de soluções ou comunidade. Codificado/estático para conteúdo e soluções prontos para uso. Dinâmico para criado pelo usuário. Esse é o nome do recurso.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--content-schema-version

Versão do esquema do conteúdo. Pode ser usado para distinguir entre fluxos diferentes com base na versão do esquema.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--custom-version

A versão personalizada do conteúdo. Um texto gratuito opcional.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--dependencies

Dependências do item de conteúdo, quais outros itens de conteúdo ele precisa para funcionar. Pode descrever dependências mais complexas usando uma estrutura recursiva/aninhada. Para uma única dependência, uma ID/tipo/versão pode ser fornecida ou operador/critérios para formatos complexos. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--etag

Etag do recurso do azure.

Propriedade Valor
Grupo de parâmetros: Metadata Arguments
--first-publish-date

Primeiro item de conteúdo da solução de data de publicação.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--force-string

Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter em JSON.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--icon

O identificador do ícone. essa ID pode ser buscada posteriormente no modelo de solução.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--kind

O tipo de conteúdo para o qual os metadados servem.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Valores aceitos: AnalyticsRule, AnalyticsRuleTemplate, AutomationRule, AzureFunction, DataConnector, DataType, HuntingQuery, InvestigationQuery, LogicAppsCustomConnector, Parser, Playbook, PlaybookTemplate, Solution, Watchlist, WatchlistTemplate, Workbook, WorkbookTemplate
--last-publish-date

Última data de publicação do item de conteúdo da solução.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--metadata-name --name -n

O nome dos metadados.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--parent-id

ID completa do recurso pai do item de conteúdo para o qual os metadados são. Essa é a ID de recurso completa, incluindo o escopo (assinatura e grupo de recursos).

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--preview-images

Visualizar nomes de arquivo de imagem. Elas serão retiradas dos artefatos de solução compatíveis com sintaxe de taquigrafia, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--preview-images-dark

Visualizar nomes de arquivo de imagem. Eles serão retirados dos artefatos da solução. usado para o suporte a temas escuros dão suporte à sintaxe abreviada, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--providers

Os provedores para o item de conteúdo da solução dão suporte à sintaxe abreviada, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--source

Fonte do conteúdo. Foi aqui/como ele foi criado. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--support

Informações de suporte para os metadados - tipo, nome, informações de contato Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--threat-tactics

As táticas que o recurso aborda dão suporte à sintaxe de taquigrafia, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--threat-techniques

As técnicas que o recurso aborda, elas precisam ser alinhadas com as táticas que estão sendo usadas dão suporte à sintaxe de taquigrafia, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--version

Versão do conteúdo. O formato padrão e recomendado é numérico (por exemplo, 1, 1.0, 1.0.0, 1.0.0.0), seguindo as práticas recomendadas do modelo do ARM. Também pode ser qualquer cadeia de caracteres, mas não podemos garantir nenhuma verificação de versão.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--workspace-name -w
Habilitação

O nome do espaço de trabalho.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False