Delen via

az security api-collection apim

  • Preview
  • Referentie

Opdrachtgroep 'az security api-collection' is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Ontdek, beheer en bekijk beveiligingsinzichten voor API-verzamelingen vanuit Azure API Management.

Opdracht

Name Description Type Status
az security api-collection apim list

Hiermee haalt u een lijst op met API-verzamelingen die zijn toegevoegd aan Microsoft Defender voor API's.

 Kern Voorbeeld
az security api-collection apim offboard

Offboard an Azure API Management API from Microsoft Defender for APIIs. Het systeem stopt met het bewaken van de bewerkingen in de Azure API Management-API voor intrusief gedrag.

 Kern Voorbeeld
az security api-collection apim onboard

Onboarding van een Azure API Management-API naar Microsoft Defender voor API's. Het systeem begint met het bewaken van de bewerkingen in de Azure Management-API voor intrusief gedrag en biedt waarschuwingen voor aanvallen die zijn gedetecteerd.

 Kern Voorbeeld
az security api-collection apim show

Hiermee haalt u een Azure API Management-API op als deze is toegevoegd aan Microsoft Defender voor API's. Als een Azure API Management-API wordt toegevoegd aan Microsoft Defender voor API's, controleert het systeem de bewerkingen in de Azure API Management-API op intrusief gedrag en geeft het waarschuwingen voor aanvallen die zijn gedetecteerd.

 Kern Voorbeeld
az security api-collection apim wait

Plaats de CLI in een wachtstatus totdat aan een voorwaarde is voldaan.

 Kern Voorbeeld

az security api-collection apim list

Bewerken
Preview

Opdrachtgroep 'az security api-collection apim' is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Hiermee haalt u een lijst op met API-verzamelingen die zijn toegevoegd aan Microsoft Defender voor API's.

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

Optionele parameters

--max-items

Totaal aantal items dat moet worden geretourneerd in de uitvoer van de opdracht. Als het totale aantal beschikbare items groter is dan de opgegeven waarde, wordt een token opgegeven in de uitvoer van de opdracht. Als u paginering wilt hervatten, geeft u de tokenwaarde op in --next-token argument van een volgende opdracht.

--next-token

Token om op te geven waar paginering moet worden gestart. Dit is de tokenwaarde van een eerder afgekapt antwoord.

--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--service-name

De naam van de API Management-service.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az security api-collection apim offboard

Bewerken
Preview

Opdrachtgroep 'az security api-collection apim' is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Offboard an Azure API Management API from Microsoft Defender for APIIs. Het systeem stopt met het bewaken van de bewerkingen in de Azure API Management-API voor intrusief gedrag.

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

Voorbeelden

Onboarding van een Azure API Management-API naar Microsoft Defender voor API's.

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

Optionele parameters

--api-id --name -n

API-revisie-id. Moet uniek zijn in het API Management-service-exemplaar. Niet-huidige herziening heeft ; rev=n als achtervoegsel waarbij n het revisienummer is.

--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--service-name

De naam van de API Management-service.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--yes -y

Niet vragen om bevestiging.

Default value: False
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az security api-collection apim onboard

Bewerken
Preview

Opdrachtgroep 'az security api-collection apim' is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Onboarding van een Azure API Management-API naar Microsoft Defender voor API's. Het systeem begint met het bewaken van de bewerkingen in de Azure Management-API voor intrusief gedrag en biedt waarschuwingen voor aanvallen die zijn gedetecteerd.

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]

Voorbeelden

Onboarding van een Azure API Management-API naar Microsoft Defender voor API's.

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

Optionele parameters

--api-id --name -n

API-revisie-id. Moet uniek zijn in het API Management-service-exemplaar. Niet-huidige herziening heeft ; rev=n als achtervoegsel waarbij n het revisienummer is.

--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

Geaccepteerde waarden: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--service-name

De naam van de API Management-service.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az security api-collection apim show

Bewerken
Preview

Opdrachtgroep 'az security api-collection apim' is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Hiermee haalt u een Azure API Management-API op als deze is toegevoegd aan Microsoft Defender voor API's. Als een Azure API Management-API wordt toegevoegd aan Microsoft Defender voor API's, controleert het systeem de bewerkingen in de Azure API Management-API op intrusief gedrag en geeft het waarschuwingen voor aanvallen die zijn gedetecteerd.

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

Optionele parameters

--api-id --name -n

API-revisie-id. Moet uniek zijn in het API Management-service-exemplaar. Niet-huidige herziening heeft ; rev=n als achtervoegsel waarbij n het revisienummer is.

--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--service-name

De naam van de API Management-service.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az security api-collection apim wait

Bewerken
Preview

Opdrachtgroep 'az security api-collection apim' is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Plaats de CLI in een wachtstatus totdat aan een voorwaarde is voldaan.

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

Optionele parameters

--api-id --name -n

API-revisie-id. Moet uniek zijn in het API Management-service-exemplaar. Niet-huidige herziening heeft ; rev=n als achtervoegsel waarbij n het revisienummer is.

--created

Wacht totdat u 'provisioningState' hebt gemaakt bij 'Succeeded'.

Default value: False
--custom

Wacht tot de voorwaarde voldoet aan een aangepaste JMESPath-query. Bijvoorbeeld provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wacht totdat deze is verwijderd.

Default value: False
--exists

Wacht tot de resource bestaat.

Default value: False
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

--interval

Polling-interval in seconden.

Default value: 30
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--service-name

De naam van de API Management-service.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--timeout

Maximale wachttijd in seconden.

Default value: 3600
--updated

Wacht totdat deze is bijgewerkt met provisioningState op 'Succeeded'.

Default value: False
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.