Freigeben über

az security api-collection apim

  • Vorschau
  • Referenz

Die Befehlsgruppe "az security api-collection" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Entdecken, Verwalten und Anzeigen von Sicherheitseinblicken für API-Sammlungen aus Azure API Management.

Befehle

Name Beschreibung Typ Status
az security api-collection apim list

Ruft eine Liste der API-Auflistungen ab, die in Microsoft Defender für APIs integriert wurden.

 Kern Vorschau
az security api-collection apim offboard

Offboarden einer Azure API-Verwaltungs-API von Microsoft Defender für APIs. Das System beendet die Überwachung der Vorgänge innerhalb der Azure API-Verwaltungs-API für intrusive Verhaltensweisen.

 Kern Vorschau
az security api-collection apim onboard

Integrieren Sie eine Azure API-Verwaltungs-API in Microsoft Defender für APIs. Das System beginnt mit der Überwachung der Vorgänge innerhalb der Azure-Verwaltungs-API für aufdringliche Verhaltensweisen und stellt Warnungen für erkannte Angriffe bereit.

 Kern Vorschau
az security api-collection apim show

Ruft eine Azure API-Verwaltungs-API ab, wenn sie in Microsoft Defender für APIs integriert wurde. Wenn eine Azure API-Verwaltungs-API in Microsoft Defender für APIs integriert ist, überwacht das System die Vorgänge innerhalb der Azure API-Verwaltungs-API auf aufdringliche Verhaltensweisen und stellt Warnungen für erkannte Angriffe bereit.

 Kern Vorschau
az security api-collection apim wait

Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung erfüllt ist.

 Kern Vorschau

az security api-collection apim list

Bearbeiten
Vorschau

Die Befehlsgruppe "az security api-collection apim" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Ruft eine Liste der API-Auflistungen ab, die in Microsoft Defender für APIs integriert wurden.

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

Optionale Parameter

--max-items

Die Gesamtanzahl der Elemente, die in der Ausgabe des Befehls zurückgegeben werden sollen. Wenn die Gesamtanzahl der verfügbaren Elemente größer als der angegebene Wert ist, wird ein Token in der Ausgabe des Befehls bereitgestellt. Um die Paginierung fortzusetzen, geben Sie den Tokenwert in --next-token Argument eines nachfolgenden Befehls an.

--next-token

Token, das angibt, wo die Paginierung beginnen soll. Dies ist der Tokenwert aus einer zuvor abgeschnittenen Antwort.

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--service-name

Der Name des API-Verwaltungsdiensts.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

az security api-collection apim offboard

Bearbeiten
Vorschau

Die Befehlsgruppe "az security api-collection apim" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Offboarden einer Azure API-Verwaltungs-API von Microsoft Defender für APIs. Das System beendet die Überwachung der Vorgänge innerhalb der Azure API-Verwaltungs-API für intrusive Verhaltensweisen.

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

Beispiele

Integrieren Sie eine Azure API-Verwaltungs-API in Microsoft Defender für APIs.

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

Optionale Parameter

--api-id --name -n

API-Revisionsbezeichner. Muss in der API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--service-name

Der Name des API-Verwaltungsdiensts.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--yes -y

Zur Bestätigung nicht auffordern.

Standardwert: False
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

az security api-collection apim onboard

Bearbeiten
Vorschau

Die Befehlsgruppe "az security api-collection apim" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Integrieren Sie eine Azure API-Verwaltungs-API in Microsoft Defender für APIs. Das System beginnt mit der Überwachung der Vorgänge innerhalb der Azure-Verwaltungs-API für aufdringliche Verhaltensweisen und stellt Warnungen für erkannte Angriffe bereit.

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]

Beispiele

Integrieren Sie eine Azure API-Verwaltungs-API in Microsoft Defender für APIs.

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

Optionale Parameter

--api-id --name -n

API-Revisionsbezeichner. Muss in der API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

Zulässige Werte: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--service-name

Der Name des API-Verwaltungsdiensts.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

az security api-collection apim show

Bearbeiten
Vorschau

Die Befehlsgruppe "az security api-collection apim" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Ruft eine Azure API-Verwaltungs-API ab, wenn sie in Microsoft Defender für APIs integriert wurde. Wenn eine Azure API-Verwaltungs-API in Microsoft Defender für APIs integriert ist, überwacht das System die Vorgänge innerhalb der Azure API-Verwaltungs-API auf aufdringliche Verhaltensweisen und stellt Warnungen für erkannte Angriffe bereit.

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

Optionale Parameter

--api-id --name -n

API-Revisionsbezeichner. Muss in der API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--service-name

Der Name des API-Verwaltungsdiensts.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

az security api-collection apim wait

Bearbeiten
Vorschau

Die Befehlsgruppe "az security api-collection apim" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung erfüllt ist.

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

Optionale Parameter

--api-id --name -n

API-Revisionsbezeichner. Muss in der API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

--created

Warten Sie, bis sie mit 'provisioningState' unter 'Succeeded' erstellt wurde.

Standardwert: False
--custom

Warten Sie, bis die Bedingung eine benutzerdefinierte JMESPath-Abfrage erfüllt. Beispiel: provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Warten Sie, bis sie gelöscht wurde.

Standardwert: False
--exists

Warten Sie, bis die Ressource vorhanden ist.

Standardwert: False
--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

--interval

Abrufintervall in Sekunden.

Standardwert: 30
--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--service-name

Der Name des API-Verwaltungsdiensts.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--timeout

Maximale Wartezeit in Sekunden.

Standardwert: 3600
--updated

Warten Sie, bis sie mit provisioningState unter 'Succeeded' aktualisiert wurde.

Standardwert: False
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.