Partager via


az security api-collection apim

Le groupe de commandes « az security api-collection » est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Découvrez, gérez et affichez des insights de sécurité pour les collections d’API à partir de Gestion des API Azure.

Commandes

Nom Description Type État
az security api-collection apim list

Obtient la liste des collections d’API qui ont été intégrées à Microsoft Defender pour les API.

Core Preview
az security api-collection apim offboard

Offboard an Azure Gestion des API API from Microsoft Defender for API. Le système cesse de surveiller les opérations dans l’API Gestion des API Azure pour les comportements intrusifs.

Core Preview
az security api-collection apim onboard

Intégrez une API Gestion des API Azure à Microsoft Defender pour les API. Le système démarre la surveillance des opérations au sein de l’API Gestion Azure pour les comportements intrusifs et fournit des alertes pour les attaques détectées.

Core Preview
az security api-collection apim show

Obtient une API Gestion des API Azure si elle a été intégrée à Microsoft Defender pour les API. Si une API Gestion des API Azure est intégrée à Microsoft Defender pour LES API, le système surveille les opérations au sein de l’API Gestion des API Azure pour détecter les comportements intrusifs et fournit des alertes pour les attaques détectées.

Core Preview
az security api-collection apim wait

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition soit remplie.

Core Preview

az security api-collection apim list

Préversion

Le groupe de commandes « az security api-collection apim » est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Obtient la liste des collections d’API qui ont été intégrées à Microsoft Defender pour les API.

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

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--max-items

Nombre total d’éléments à retourner dans la sortie de la commande. Si le nombre total d’éléments disponibles est supérieur à la valeur spécifiée, un jeton est fourni dans la sortie de la commande. Pour reprendre la pagination, fournissez la valeur du jeton dans --next-token argument d’une commande suivante.

Propriété Valeur
Groupe de paramètres: Pagination Arguments
--next-token

Jeton pour spécifier où commencer la pagination. Il s’agit de la valeur du jeton d’une réponse tronquée précédemment.

Propriété Valeur
Groupe de paramètres: Pagination Arguments
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--service-name

Nom du service Gestion des API.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az security api-collection apim offboard

Préversion

Le groupe de commandes « az security api-collection apim » est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Offboard an Azure Gestion des API API from Microsoft Defender for API. Le système cesse de surveiller les opérations dans l’API Gestion des API Azure pour les comportements intrusifs.

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

Exemples

Intégrez une API Gestion des API Azure à Microsoft Defender pour les API.

az security api-collection apim offboard --resource-group MyResourceGroup --service-name MyApiManagementServiceName --api-id echo-api

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--api-id --name -n

Identificateur de révision d’API. Doit être unique dans l’instance du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--service-name

Nom du service Gestion des API.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--yes -y

N’invitez pas à confirmer.

Propriété Valeur
Valeur par défaut: False
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az security api-collection apim onboard

Préversion

Le groupe de commandes « az security api-collection apim » est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Intégrez une API Gestion des API Azure à Microsoft Defender pour les API. Le système démarre la surveillance des opérations au sein de l’API Gestion Azure pour les comportements intrusifs et fournit des alertes pour les attaques détectées.

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

Exemples

Intégrez une API Gestion des API Azure à Microsoft Defender pour les API.

az security api-collection apim onboard --resource-group MyResourceGroup --service-name MyApiManagementServiceName --api-id echo-api

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--api-id --name -n

Identificateur de révision d’API. Doit être unique dans l’instance du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Propriété Valeur
Valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--service-name

Nom du service Gestion des API.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az security api-collection apim show

Préversion

Le groupe de commandes « az security api-collection apim » est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Obtient une API Gestion des API Azure si elle a été intégrée à Microsoft Defender pour les API. Si une API Gestion des API Azure est intégrée à Microsoft Defender pour LES API, le système surveille les opérations au sein de l’API Gestion des API Azure pour détecter les comportements intrusifs et fournit des alertes pour les attaques détectées.

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

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--api-id --name -n

Identificateur de révision d’API. Doit être unique dans l’instance du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--service-name

Nom du service Gestion des API.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az security api-collection apim wait

Préversion

Le groupe de commandes « az security api-collection apim » est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition soit remplie.

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

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--api-id --name -n

Identificateur de révision d’API. Doit être unique dans l’instance du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--created

Attendez la création avec « provisioningState » sur « Succeeded ».

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
Valeur par défaut: False
--custom

Attendez que la condition réponde à une requête JMESPath personnalisée. Par exemple, provisioningState !='InProgress', instanceView.statuses[ ?code=='PowerState/running'].

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
--deleted

Attendez la suppression.

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
Valeur par défaut: False
--exists

Attendez que la ressource existe.

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
Valeur par défaut: False
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--interval

Intervalle d’interrogation en secondes.

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
Valeur par défaut: 30
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--service-name

Nom du service Gestion des API.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--timeout

Délai maximal d’attente en secondes.

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
Valeur par défaut: 3600
--updated

Attendez la mise à jour avec provisioningState sur « Réussi ».

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
Valeur par défaut: False
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False