Sdílet prostřednictvím

az security api-collection apim

  • Preview
  • Reference

Skupina příkazů az security api-collection je ve verzi Preview a ve vývoji. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Objevte, spravujte a zobrazte přehledy zabezpečení pro kolekce rozhraní API ze služby Azure API Management.

Příkazy

Name Description Typ Stav
az security api-collection apim list

Získá seznam kolekcí rozhraní API, které byly nasazeny do programu Microsoft Defender for API.

 Základ Preview
az security api-collection apim offboard

Offboarding rozhraní API služby Azure API Management z Microsoft Defenderu pro rozhraní API Systém zastaví monitorování operací v rozhraní API služby Azure API Management, aby se zabránilo rušivému chování.

 Základ Preview
az security api-collection apim onboard

Onboarding rozhraní API služby Azure API Management do Microsoft Defenderu pro rozhraní API Systém začne monitorovat operace v rozhraní API pro správu Azure za účelem rušivého chování a poskytne výstrahy pro zjištěné útoky.

 Základ Preview
az security api-collection apim show

Získá rozhraní API služby Azure API Management, pokud je onboardováno do programu Microsoft Defender pro rozhraní API. Pokud je rozhraní API služby Azure API Management nasazené v programu Microsoft Defender pro rozhraní API, systém bude monitorovat operace v rozhraní API služby Azure API Management za účelem rušivého chování a poskytovat výstrahy pro zjištěné útoky.

 Základ Preview
az security api-collection apim wait

Umístěte rozhraní příkazového řádku do stavu čekání, dokud není splněna podmínka.

 Základ Preview

az security api-collection apim list

Upravit
Preview

Skupina příkazů az security api-collection apim je ve verzi Preview a ve vývoji. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Získá seznam kolekcí rozhraní API, které byly nasazeny do programu Microsoft Defender for API.

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

Volitelné parametry

--max-items

Celkový počet položek, které se mají vrátit ve výstupu příkazu Pokud je celkový počet dostupných položek větší než zadaná hodnota, zobrazí se ve výstupu příkazu token. Chcete-li obnovit stránkování, zadejte hodnotu tokenu v --next-token argumentu následného příkazu.

--next-token

Token určující, kde se má stránkování spustit. Toto je hodnota tokenu z dříve zkrácené odpovědi.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--service-name

Název služby API Management.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az security api-collection apim offboard

Upravit
Preview

Skupina příkazů az security api-collection apim je ve verzi Preview a ve vývoji. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Offboarding rozhraní API služby Azure API Management z Microsoft Defenderu pro rozhraní API Systém zastaví monitorování operací v rozhraní API služby Azure API Management, aby se zabránilo rušivému chování.

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

Volitelné parametry

--api-id --name -n

Identifikátor revize rozhraní API. V instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize.

--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--service-name

Název služby API Management.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--yes -y

Nezotvádejte výzvu k potvrzení.

Default value: False
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az security api-collection apim onboard

Upravit
Preview

Skupina příkazů az security api-collection apim je ve verzi Preview a ve vývoji. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Onboarding rozhraní API služby Azure API Management do Microsoft Defenderu pro rozhraní API Systém začne monitorovat operace v rozhraní API pro správu Azure za účelem rušivého chování a poskytne výstrahy pro zjištěné útoky.

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]

Příklady

Onboarding rozhraní API služby Azure API Management do Microsoft Defenderu pro rozhraní API

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

Volitelné parametry

--api-id --name -n

Identifikátor revize rozhraní API. V instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize.

--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--no-wait

Nečekejte na dokončení dlouhotrvající operace.

Přípustné hodnoty: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--service-name

Název služby API Management.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az security api-collection apim show

Upravit
Preview

Skupina příkazů az security api-collection apim je ve verzi Preview a ve vývoji. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Získá rozhraní API služby Azure API Management, pokud je onboardováno do programu Microsoft Defender pro rozhraní API. Pokud je rozhraní API služby Azure API Management nasazené v programu Microsoft Defender pro rozhraní API, systém bude monitorovat operace v rozhraní API služby Azure API Management za účelem rušivého chování a poskytovat výstrahy pro zjištěné útoky.

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

Volitelné parametry

--api-id --name -n

Identifikátor revize rozhraní API. V instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize.

--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--service-name

Název služby API Management.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az security api-collection apim wait

Upravit
Preview

Skupina příkazů az security api-collection apim je ve verzi Preview a ve vývoji. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Umístěte rozhraní příkazového řádku do stavu čekání, dokud není splněna podmínka.

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

Volitelné parametry

--api-id --name -n

Identifikátor revize rozhraní API. V instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize.

--created

Počkejte na vytvoření s 'provisioningState' v 'Succeeded'.

Default value: False
--custom

Počkejte, až podmínka splňuje vlastní dotaz JMESPath. Například provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Počkejte na odstranění.

Default value: False
--exists

Počkejte, až prostředek existuje.

Default value: False
--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--interval

Interval dotazování v sekundách

Default value: 30
--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--service-name

Název služby API Management.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--timeout

Maximální čekání v sekundách.

Default value: 3600
--updated

Počkejte, dokud se neaktualizuje stav zřizování ve stavu Úspěch.

Default value: False
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.