Partager via

az security api-collection apim

  • Préversion
  • Référence

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

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

Commandes

Nom Description Type Statut
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 Aperçu
az security api-collection apim offboard

Offboard an Azure Gestion des API API from Microsoft Defender for API. Le système arrête la surveillance des opérations au sein de l’API Azure Gestion des API pour les comportements intrusifs.

 Core Aperçu
az security api-collection apim onboard

Intégrez une API Azure Gestion des API à 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 Aperçu
az security api-collection apim show

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

 Core Aperçu
az security api-collection apim wait

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

 Core Aperçu

az security api-collection apim list

Modifier
Préversion

Le groupe de commandes « az security api-collection apim » est en préversion et en cours de développement. Référence et niveaux 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

--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 l’argument d’une commande suivante.

--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.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--service-name

Nom du service Gestion des API.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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

az security api-collection apim offboard

Modifier
Préversion

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

Offboard an Azure Gestion des API API from Microsoft Defender for API. Le système arrête la surveillance des opérations au sein de l’API Azure Gestion des API pour les comportements intrusifs.

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

Paramètres facultatifs

--api-id --name -n

Identificateur de révision d’API. Doit être unique dans l’instance de 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.

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). 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 ».

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--service-name

Nom du service Gestion des API.

--subscription

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

--yes -y

Ne pas demander de confirmation.

valeur par défaut: False
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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

az security api-collection apim onboard

Modifier
Préversion

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

Intégrez une API Azure Gestion des API à 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]
                                        [--ids]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--resource-group]
                                        [--service-name]
                                        [--subscription]

Exemples

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

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

Paramètres facultatifs

--api-id --name -n

Identificateur de révision d’API. Doit être unique dans l’instance de 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.

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). 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 ».

--no-wait

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

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 en utilisant az configure --defaults group=<name>.

--service-name

Nom du service Gestion des API.

--subscription

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

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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

az security api-collection apim show

Modifier
Préversion

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

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

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

Paramètres facultatifs

--api-id --name -n

Identificateur de révision d’API. Doit être unique dans l’instance de 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.

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). 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 ».

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--service-name

Nom du service Gestion des API.

--subscription

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

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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

az security api-collection apim wait

Modifier
Préversion

Le groupe de commandes « az security api-collection apim » est en préversion et en cours de développement. Référence et niveaux 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]
                                     [--created]
                                     [--custom]
                                     [--deleted]
                                     [--exists]
                                     [--ids]
                                     [--interval]
                                     [--resource-group]
                                     [--service-name]
                                     [--subscription]
                                     [--timeout]
                                     [--updated]

Paramètres facultatifs

--api-id --name -n

Identificateur de révision d’API. Doit être unique dans l’instance de 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.

--created

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

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'].

--deleted

Attendez la suppression.

valeur par défaut: False
--exists

Attendez que la ressource existe.

valeur par défaut: False
--ids

Un ou plusieurs ID de ressource (délimités par des espaces). 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 ».

--interval

Intervalle d’interrogation en secondes.

valeur par défaut: 30
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--service-name

Nom du service Gestion des API.

--subscription

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

--timeout

Délai maximal d’attente en secondes.

valeur par défaut: 3600
--updated

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

valeur par défaut: False
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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