Udostępnij przez

az security api-collection apim

  • Wersja zapoznawcza

Grupa poleceń "az security api-collection" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Odnajdywanie i wyświetlanie szczegółowych informacji o zabezpieczeniach dla kolekcji interfejsów API z usługi Azure API Management oraz zarządzanie nimi.

Polecenia

Nazwa Opis Typ Stan
az security api-collection apim list

Pobiera listę kolekcji interfejsów API, które zostały dołączone do usługi Microsoft Defender dla interfejsów API.

 Core Preview
az security api-collection apim offboard

Odłączanie interfejsu API usługi Azure API Management z poziomu interfejsów API usługi Microsoft Defender dla interfejsów API. System przestanie monitorować operacje w interfejsie API usługi Azure API Management pod kątem niepożądanych zachowań.

 Core Preview
az security api-collection apim onboard

Dołączanie interfejsu API usługi Azure API Management do usługi Microsoft Defender dla interfejsów API. System rozpocznie monitorowanie operacji w interfejsie API usługi Azure Management pod kątem niepożądanych zachowań i zapewnia alerty dotyczące wykrytych ataków.

 Core Preview
az security api-collection apim show

Pobiera interfejs API usługi Azure API Management, jeśli został on dołączony do usługi Microsoft Defender dla interfejsów API. Jeśli interfejs API usługi Azure API Management jest dołączany do usługi Microsoft Defender dla interfejsów API, system będzie monitorować operacje w interfejsie API usługi Azure API Management pod kątem niepożądanych zachowań i dostarczać alerty dotyczące wykrytych ataków.

 Core Preview
az security api-collection apim wait

Umieść interfejs wiersza polecenia w stanie oczekiwania do momentu spełnienia warunku.

 Core Preview

az security api-collection apim list

Edytuj
Wersja zapoznawcza

Grupa poleceń "az security api-collection apim" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Pobiera listę kolekcji interfejsów API, które zostały dołączone do usługi Microsoft Defender dla interfejsów API.

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

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--max-items

Łączna liczba elementów do zwrócenia w danych wyjściowych polecenia. Jeśli łączna liczba dostępnych elementów jest większa niż określona wartość, token jest udostępniany w danych wyjściowych polecenia. Aby wznowić stronicowanie, podaj wartość tokenu w --next-token argumentu kolejnego polecenia.

Właściwość Wartość
Grupa parametrów: Pagination Arguments
--next-token

Token do określenia, gdzie rozpocząć stronicowanie. Jest to wartość tokenu z wcześniej obciętej odpowiedzi.

Właściwość Wartość
Grupa parametrów: Pagination Arguments
--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

--service-name

Nazwa usługi API Management.

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az security api-collection apim offboard

Edytuj
Wersja zapoznawcza

Grupa poleceń "az security api-collection apim" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Odłączanie interfejsu API usługi Azure API Management z poziomu interfejsów API usługi Microsoft Defender dla interfejsów API. System przestanie monitorować operacje w interfejsie API usługi Azure API Management pod kątem niepożądanych zachowań.

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

Przykłady

Dołączanie interfejsu API usługi Azure API Management do usługi Microsoft Defender dla interfejsów API.

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

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--api-id --name -n

Identyfikator poprawki interfejsu API. Musi być unikatowa w wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--service-name

Nazwa usługi API Management.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--yes -y

Nie monituj o potwierdzenie.

Właściwość Wartość
Domyślna wartość: False
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az security api-collection apim onboard

Edytuj
Wersja zapoznawcza

Grupa poleceń "az security api-collection apim" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Dołączanie interfejsu API usługi Azure API Management do usługi Microsoft Defender dla interfejsów API. System rozpocznie monitorowanie operacji w interfejsie API usługi Azure Management pod kątem niepożądanych zachowań i zapewnia alerty dotyczące wykrytych ataków.

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]

Przykłady

Dołączanie interfejsu API usługi Azure API Management do usługi Microsoft Defender dla interfejsów API.

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

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--api-id --name -n

Identyfikator poprawki interfejsu API. Musi być unikatowa w wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--no-wait

Nie czekaj na zakończenie długotrwałej operacji.

Właściwość Wartość
Dopuszczalne wartości: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--service-name

Nazwa usługi API Management.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az security api-collection apim show

Edytuj
Wersja zapoznawcza

Grupa poleceń "az security api-collection apim" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Pobiera interfejs API usługi Azure API Management, jeśli został on dołączony do usługi Microsoft Defender dla interfejsów API. Jeśli interfejs API usługi Azure API Management jest dołączany do usługi Microsoft Defender dla interfejsów API, system będzie monitorować operacje w interfejsie API usługi Azure API Management pod kątem niepożądanych zachowań i dostarczać alerty dotyczące wykrytych ataków.

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

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--api-id --name -n

Identyfikator poprawki interfejsu API. Musi być unikatowa w wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--service-name

Nazwa usługi API Management.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az security api-collection apim wait

Edytuj
Wersja zapoznawcza

Grupa poleceń "az security api-collection apim" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Umieść interfejs wiersza polecenia w stanie oczekiwania do momentu spełnienia warunku.

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

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--api-id --name -n

Identyfikator poprawki interfejsu API. Musi być unikatowa w wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--created

Zaczekaj na utworzenie polecenia "provisioningState" o godzinie "Succeeded".

Właściwość Wartość
Grupa parametrów: Wait Condition Arguments
Domyślna wartość: False
--custom

Poczekaj, aż warunek spełnia niestandardowe zapytanie JMESPath. Np. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Właściwość Wartość
Grupa parametrów: Wait Condition Arguments
--deleted

Poczekaj na usunięcie.

Właściwość Wartość
Grupa parametrów: Wait Condition Arguments
Domyślna wartość: False
--exists

Zaczekaj, aż zasób istnieje.

Właściwość Wartość
Grupa parametrów: Wait Condition Arguments
Domyślna wartość: False
--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--interval

Interwał sondowania w sekundach.

Właściwość Wartość
Grupa parametrów: Wait Condition Arguments
Domyślna wartość: 30
--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--service-name

Nazwa usługi API Management.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--timeout

Maksymalny czas oczekiwania w sekundach.

Właściwość Wartość
Grupa parametrów: Wait Condition Arguments
Domyślna wartość: 3600
--updated

Zaczekaj na zaktualizowanie stanu provisioningState o 'Powodzenie'.

Właściwość Wartość
Grupa parametrów: Wait Condition Arguments
Domyślna wartość: False
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False