Compartilhar via

az security api-collection apim

  • Versão Prévia
  • Referência

O grupo de comandos 'az security api-collection' está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Descubra, gerencie e exiba insights de segurança para coleções de API do Gerenciamento de API do Azure.

Comandos

Nome Description Tipo Status
az security api-collection apim list

Obtém uma lista de coleções de API que foram integradas ao Microsoft Defender para APIs.

 Núcleo Visualizar
az security api-collection apim offboard

Exclua uma API de Gerenciamento de API do Azure do Microsoft Defender para APIs. O sistema deixará de monitorar as operações na API de Gerenciamento de API do Azure em busca de comportamentos intrusivos.

 Núcleo Visualizar
az security api-collection apim onboard

Integre uma API de Gerenciamento de API do Azure ao Microsoft Defender para APIs. O sistema começará a monitorar as operações na API de Gerenciamento do Azure em busca de comportamentos intrusivos e fornecerá alertas para ataques detectados.

 Núcleo Visualizar
az security api-collection apim show

Obtém uma API de Gerenciamento de API do Azure se ela tiver sido integrada ao Microsoft Defender para APIs. Se uma API de Gerenciamento de API do Azure estiver integrada ao Microsoft Defender para APIs, o sistema monitorará as operações na API de Gerenciamento de API do Azure em busca de comportamentos intrusivos e fornecerá alertas para ataques detectados.

 Núcleo Visualizar
az security api-collection apim wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

 Núcleo Visualizar

az security api-collection apim list

Editar
Versão Prévia

O grupo de comandos 'az security api-collection apim' está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Obtém uma lista de coleções de API que foram integradas ao Microsoft Defender para APIs.

az security api-collection apim list [--max-items]
                                     [--next-token]
                                     [--resource-group]
                                     [--service-name]

Parâmetros Opcionais

--max-items

Número total de itens a serem retornados na saída do comando. Se o número total de itens disponíveis for maior do que o valor especificado, um token será fornecido na saída do comando. Para retomar a paginação, forneça o valor do token no --next-token argumento de um comando subsequente.

--next-token

Token para especificar onde iniciar a paginação. Esse é o valor de token de uma resposta truncada anteriormente.

--resource-group -g

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

--service-name

O nome do serviço de Gerenciamento de API.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az security api-collection apim offboard

Editar
Versão Prévia

O grupo de comandos 'az security api-collection apim' está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Exclua uma API de Gerenciamento de API do Azure do Microsoft Defender para APIs. O sistema deixará de monitorar as operações na API de Gerenciamento de API do Azure em busca de comportamentos intrusivos.

az security api-collection apim offboard [--api-id]
                                         [--ids]
                                         [--resource-group]
                                         [--service-name]
                                         [--subscription]
                                         [--yes]

Parâmetros Opcionais

--api-id --name -n

Identificador de revisão de API. Deve ser exclusivo na instância do serviço de Gerenciamento de API. Revisão não corrente tem ; rev=n como um sufixo onde n é o número da revisão.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--resource-group -g

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

--service-name

O nome do serviço de Gerenciamento de API.

--subscription

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

--yes -y

Não solicite confirmação.

valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az security api-collection apim onboard

Editar
Versão Prévia

O grupo de comandos 'az security api-collection apim' está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Integre uma API de Gerenciamento de API do Azure ao Microsoft Defender para APIs. O sistema começará a monitorar as operações na API de Gerenciamento do Azure em busca de comportamentos intrusivos e fornecerá alertas para ataques detectados.

az security api-collection apim onboard [--api-id]
                                        [--ids]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--resource-group]
                                        [--service-name]
                                        [--subscription]

Exemplos

Integre uma API de Gerenciamento de API do Azure ao Microsoft Defender para APIs.

az security api-collections create --resource-group MyResourceGroup --service-name MyApiServiceName --api-id EchoApi

Parâmetros Opcionais

--api-id --name -n

Identificador de revisão de API. Deve ser exclusivo na instância do serviço de Gerenciamento de API. Revisão não corrente tem ; rev=n como um sufixo onde n é o número da revisão.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--no-wait

Não aguarde a conclusão da operação de execução longa.

valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--service-name

O nome do serviço de Gerenciamento de API.

--subscription

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

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az security api-collection apim show

Editar
Versão Prévia

O grupo de comandos 'az security api-collection apim' está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Obtém uma API de Gerenciamento de API do Azure se ela tiver sido integrada ao Microsoft Defender para APIs. Se uma API de Gerenciamento de API do Azure estiver integrada ao Microsoft Defender para APIs, o sistema monitorará as operações na API de Gerenciamento de API do Azure em busca de comportamentos intrusivos e fornecerá alertas para ataques detectados.

az security api-collection apim show [--api-id]
                                     [--ids]
                                     [--resource-group]
                                     [--service-name]
                                     [--subscription]

Parâmetros Opcionais

--api-id --name -n

Identificador de revisão de API. Deve ser exclusivo na instância do serviço de Gerenciamento de API. Revisão não corrente tem ; rev=n como um sufixo onde n é o número da revisão.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--resource-group -g

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

--service-name

O nome do serviço de Gerenciamento de API.

--subscription

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

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az security api-collection apim wait

Editar
Versão Prévia

O grupo de comandos 'az security api-collection apim' está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Coloque a CLI em um estado de espera até que uma condição seja atendida.

az security api-collection apim wait [--api-id]
                                     [--created]
                                     [--custom]
                                     [--deleted]
                                     [--exists]
                                     [--ids]
                                     [--interval]
                                     [--resource-group]
                                     [--service-name]
                                     [--subscription]
                                     [--timeout]
                                     [--updated]

Parâmetros Opcionais

--api-id --name -n

Identificador de revisão de API. Deve ser exclusivo na instância do serviço de Gerenciamento de API. Revisão não corrente tem ; rev=n como um sufixo onde n é o número da revisão.

--created

Aguarde até criar com 'provisioningState' em 'Succeeded'.

valor padrão: False
--custom

Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Aguarde até ser excluído.

valor padrão: False
--exists

Aguarde até que o recurso exista.

valor padrão: False
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--interval

Intervalo de sondagem em segundos.

valor padrão: 30
--resource-group -g

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

--service-name

O nome do serviço de Gerenciamento de API.

--subscription

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

--timeout

Espera máxima em segundos.

valor padrão: 3600
--updated

Aguarde até que seja atualizado com provisioningState em 'Succeeded'.

valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.