Share via

az security api-collection apim

  • Pré-visualizar
  • Referência

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

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

Comandos

Name Description Tipo Estado
az security api-collection apim list

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

 Principal Pré-visualizar
az security api-collection apim offboard

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

 Principal Pré-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 dentro da API de Gerenciamento do Azure em busca de comportamentos intrusivos e fornecerá alertas para ataques que foram detetados.

 Principal Pré-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 for APIs, o sistema monitorará as operações dentro da API de Gerenciamento de API do Azure em busca de comportamentos intrusivos e fornecerá alertas para ataques que foram detetados.

 Principal Pré-visualizar
az security api-collection apim wait

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

 Principal Pré-visualizar

az security api-collection apim list

Editar
Pré-visualizar

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

Obtém uma lista de coleções de APIs que foram integradas ao Microsoft Defender for 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 por onde começar a paginar. Este é o valor de token de uma resposta truncada anteriormente.

--resource-group -g

o 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 de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az security api-collection apim offboard

Editar
Pré-visualizar

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

Offboard uma API de Gerenciamento de API do Azure do Microsoft Defender para APIs. O sistema deixará de monitorar as operações dentro da 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 da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

--ids

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

--resource-group -g

o 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

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--yes -y

Não solicite confirmação.

valor predefinido: False
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az security api-collection apim onboard

Editar
Pré-visualizar

O grupo de comandos 'az security api-collection apim' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: 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 dentro da API de Gerenciamento do Azure em busca de comportamentos intrusivos e fornecerá alertas para ataques que foram detetados.

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 da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

--ids

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

--no-wait

Não espere que a operação de longa duração termine.

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

o 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

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az security api-collection apim show

Editar
Pré-visualizar

O grupo de comandos 'az security api-collection apim' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: 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 for APIs, o sistema monitorará as operações dentro da API de Gerenciamento de API do Azure em busca de comportamentos intrusivos e fornecerá alertas para ataques que foram detetados.

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 da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

--ids

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

--resource-group -g

o 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

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az security api-collection apim wait

Editar
Pré-visualizar

O grupo de comandos 'az security api-collection apim' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: 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 da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

--created

Aguarde até ser criado com 'provisioningState' em 'Succeeded'.

valor predefinido: 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 predefinido: False
--exists

Aguarde até que o recurso exista.

valor predefinido: False
--ids

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

--interval

Intervalo de sondagem em segundos.

valor predefinido: 30
--resource-group -g

o 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

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--timeout

Espera máxima em segundos.

valor predefinido: 3600
--updated

Aguarde até ser atualizado com provisioningState em 'Succeeded'.

valor predefinido: False
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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