az security api-collection apim

  • Förhandsgranskning

Kommandogruppen az security api-collection finns i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Identifiera, hantera och visa säkerhetsinsikter för API-samlingar från Azure API Management.

Kommandon

Name Description Typ Status
az security api-collection apim list

Hämtar en lista över API-samlingar som har registrerats för Microsoft Defender för API:er.

 Core Preview
az security api-collection apim offboard

Avregistrera ett Azure API Management-API från Microsoft Defender för API:er. Systemet slutar övervaka åtgärderna i Azure API Management-API:et för påträngande beteenden.

 Core Preview
az security api-collection apim onboard

Registrera ett Azure API Management API för att Microsoft Defender för API:er. Systemet börjar övervaka åtgärderna i API:et Azure Management för påträngande beteenden och tillhandahåller aviseringar för attacker som har identifierats.

 Core Preview
az security api-collection apim show

Hämtar ett Azure API Management API om det har registrerats för Microsoft Defender för API:er. Om ett Azure API Management API registreras för att Microsoft Defender för API:er övervakar systemet åtgärderna i Azure API Management-API:et för påträngande beteenden och tillhandahåller aviseringar för attacker som har identifierats.

 Core Preview
az security api-collection apim wait

Placera CLI i vänteläge tills ett villkor uppfylls.

 Core Preview

az security api-collection apim list

Redigera
Förhandsgranskning

Kommandogruppen az security api-collection apim finns i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Hämtar en lista över API-samlingar som har registrerats för Microsoft Defender för API:er.

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

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--max-items

Totalt antal objekt som ska returneras i kommandots utdata. Om det totala antalet tillgängliga objekt är mer än det angivna värdet anges en token i kommandots utdata. Om du vill återuppta sidnumreringen anger du tokenvärdet i --next-token argument för ett efterföljande kommando.

Egenskap Värde
Parametergrupp: Pagination Arguments
--next-token

Token för att ange var sidnumrering ska börja. Detta är tokenvärdet från ett tidigare trunkerat svar.

Egenskap Värde
Parametergrupp: Pagination Arguments
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--service-name

Namnet på API Management-tjänsten.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az security api-collection apim offboard

Redigera
Förhandsgranskning

Kommandogruppen az security api-collection apim finns i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Avregistrera ett Azure API Management-API från Microsoft Defender för API:er. Systemet slutar övervaka åtgärderna i Azure API Management-API:et för påträngande beteenden.

az security api-collection apim offboard [--acquire-policy-token]
                                         [--api-id --name]
                                         [--change-reference]
                                         [--ids]
                                         [--resource-group]
                                         [--service-name]
                                         [--subscription]
                                         [--yes]

Exempel

Registrera ett Azure API Management API för att Microsoft Defender för API:er.

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

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--api-id --name -n

API-revisionsidentifierare. Måste vara unikt i API Management-tjänstinstansen. Icke-aktuell revision har ; rev=n som ett suffix där n är revisionsnumret.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--service-name

Namnet på API Management-tjänsten.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--yes -y

Fråga inte efter bekräftelse.

Egenskap Värde
Standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az security api-collection apim onboard

Redigera
Förhandsgranskning

Kommandogruppen az security api-collection apim finns i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Registrera ett Azure API Management API för att Microsoft Defender för API:er. Systemet börjar övervaka åtgärderna i API:et Azure Management för påträngande beteenden och tillhandahåller aviseringar för attacker som har identifierats.

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

Exempel

Registrera ett Azure API Management API för att Microsoft Defender för API:er.

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

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--api-id --name -n

API-revisionsidentifierare. Måste vara unikt i API Management-tjänstinstansen. Icke-aktuell revision har ; rev=n som ett suffix där n är revisionsnumret.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

Egenskap Värde
Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--service-name

Namnet på API Management-tjänsten.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap Värde
Parametergrupp: Resource Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az security api-collection apim show

Redigera
Förhandsgranskning

Kommandogruppen az security api-collection apim finns i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Hämtar ett Azure API Management API om det har registrerats för Microsoft Defender för API:er. Om ett Azure API Management API registreras för att Microsoft Defender för API:er övervakar systemet åtgärderna i Azure API Management-API:et för påträngande beteenden och tillhandahåller aviseringar för attacker som har identifierats.

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

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--api-id --name -n

API-revisionsidentifierare. Måste vara unikt i API Management-tjänstinstansen. Icke-aktuell revision har ; rev=n som ett suffix där n är revisionsnumret.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--service-name

Namnet på API Management-tjänsten.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap Värde
Parametergrupp: Resource Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az security api-collection apim wait

Redigera
Förhandsgranskning

Kommandogruppen az security api-collection apim finns i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Placera CLI i vänteläge tills ett villkor uppfylls.

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

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--api-id --name -n

API-revisionsidentifierare. Måste vara unikt i API Management-tjänstinstansen. Icke-aktuell revision har ; rev=n som ett suffix där n är revisionsnumret.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--created

Vänta tills du har skapat med "provisioningState" på "Lyckades".

Egenskap Värde
Parametergrupp: Wait Condition Arguments
Standardvärde: False
--custom

Vänta tills villkoret uppfyller en anpassad JMESPath-fråga. T.ex. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Egenskap Värde
Parametergrupp: Wait Condition Arguments
--deleted

Vänta tills den har tagits bort.

Egenskap Värde
Parametergrupp: Wait Condition Arguments
Standardvärde: False
--exists

Vänta tills resursen finns.

Egenskap Värde
Parametergrupp: Wait Condition Arguments
Standardvärde: False
--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--interval

Avsökningsintervall i sekunder.

Egenskap Värde
Parametergrupp: Wait Condition Arguments
Standardvärde: 30
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--service-name

Namnet på API Management-tjänsten.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap Värde
Parametergrupp: Resource Id Arguments
--timeout

Maximal väntetid i sekunder.

Egenskap Värde
Parametergrupp: Wait Condition Arguments
Standardvärde: 3600
--updated

Vänta tills det har uppdaterats med provisioningState på Lyckades.

Egenskap Värde
Parametergrupp: Wait Condition Arguments
Standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False