Get-AzSecurityApiCollection

Moduł:

Az.Security Module

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

Składnia

List (domyślnie)

Get-AzSecurityApiCollection
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get

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

List2

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

List1

Get-AzSecurityApiCollection
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity

Get-AzSecurityApiCollection
    -InputObject <ISecurityIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Opis

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

Przykłady

Przykład 1. Pobieranie określonego dołączonego zasobu kolekcji interfejsów API

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

Przykład 2. Wyświetlanie listy dołączonych kolekcji interfejsów API według nazwy usługi

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

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

Przykład 3. Wyświetlanie listy dołączonych kolekcji interfejsów API według subskrypcji

Get-AzSecurityApiCollection

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

Parametry

-ApiId

Identyfikator wersji interfejsu API. Musi być unikatowy w wystąpieniu usługi API Management. Wersja nieaktualna ma ; rev=n jako sufiks, gdzie n jest numerem wersji.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

Get

Position:	Named
Obowiązkowe:	True
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-DefaultProfile

Parametr DefaultProfile nie działa. Użyj parametru SubscriptionId, jeśli jest dostępny, jeśli wykonuje polecenie cmdlet dla innej subskrypcji.

Właściwości parametru

Typ:	PSObject
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	AzureRMContext, AzureCredential

Zestawy parametrów

(All)

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-InputObject

Parametr tożsamości

Właściwości parametru

Typ:	ISecurityIdentity
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

GetViaIdentity

Position:	Named
Obowiązkowe:	True
Wartość z potoku:	True
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-ResourceGroupName

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

Get

Position:	Named
Obowiązkowe:	True
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

List2

Position:	Named
Obowiązkowe:	True
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

List1

Position:	Named
Obowiązkowe:	True
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-ServiceName

Nazwa usługi API Management.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

Get

Position:	Named
Obowiązkowe:	True
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

List2

Position:	Named
Obowiązkowe:	True
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-SubscriptionId

identyfikator subskrypcji Azure

Właściwości parametru

Typ:	String[]
Domyślna wartość:	(Get-AzContext).Subscription.Id
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

List

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

Get

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

List2

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

List1

Position:	Named
Obowiązkowe:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Dane wejściowe

ISecurityIdentity

Dane wyjściowe

IApiCollection