Dela via


Get-AzSecurityApiCollection

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 i Microsoft Defender för API:er övervakar systemet åtgärderna i Azure API Management API för påträngande beteenden och tillhandahåller aviseringar för attacker som har identifierats.

Syntax

Get-AzSecurityApiCollection
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzSecurityApiCollection
   -ApiId <String>
   -ResourceGroupName <String>
   -ServiceName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzSecurityApiCollection
   -ResourceGroupName <String>
   -ServiceName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzSecurityApiCollection
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzSecurityApiCollection
   -InputObject <ISecurityIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

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 i Microsoft Defender för API:er övervakar systemet åtgärderna i Azure API Management API för påträngande beteenden och tillhandahåller aviseringar för attacker som har identifierats.

Exempel

Exempel 1: Hämta en specifik registrerad API-samlingsresurs

Get-AzSecurityApiCollection -ResourceGroupName apicollectionstests -ServiceName "demoapimservice2" -ApiId "echo-api"

BaseUrl                                      : https://demoapimservice2.azure-api.net/echo
DiscoveredVia                                : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/apicollectionstests/providers/Microsoft.ApiManagement/service/demoapim
                                               service2
DisplayName                                  : Echo API
Id                                           : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/apicollectionstests/providers/Microsoft.ApiManagement/service/demoapim
                                               service2/providers/Microsoft.Security/apiCollections/echo-api
Name                                         : echo-api
NumberOfApiEndpoint                          : 6
NumberOfApiEndpointsWithSensitiveDataExposed : 0
NumberOfExternalApiEndpoint                  : 0
NumberOfInactiveApiEndpoint                  : 6
NumberOfUnauthenticatedApiEndpoint           : 0
ProvisioningState                            : Succeeded
ResourceGroupName                            : apicollectionstests
SensitivityLabel                             :
Type                                         : microsoft.security/apicollections

Exempel 2: Lista registrerade API-samlingar efter tjänstnamn

Get-AzSecurityApiCollection -ResourceGroupName "apicollectionstests" -ServiceName "demoapimservice2"

Name       ResourceGroupName
----       -----------------
echo-api   apicollectionstests
echo-api-2 apicollectionstests

Exempel 3: Lista inbyggda API-samlingar efter prenumeration

Get-AzSecurityApiCollection

Name       ResourceGroupName
----       -----------------
echo-api   apicollectionstests
echo-api-2 apicollectionstests

Parametrar

-ApiId

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.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-DefaultProfile

Parametern DefaultProfile fungerar inte. Använd parametern SubscriptionId när den är tillgänglig om du kör cmdleten mot en annan prenumeration.

Typ:PSObject
Alias:AzureRMContext, AzureCredential
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-InputObject

Identitetsparameter

Typ:ISecurityIdentity
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ResourceGroupName

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-ServiceName

Namnet på API Management-tjänsten.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-SubscriptionId

Azure-prenumerations-ID

Typ:String[]
Position:Named
Standardvärde:(Get-AzContext).Subscription.Id
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

Indata

ISecurityIdentity

Utdata

IApiCollection