Invoke-AzSecurityApiCollectionApimOnboard
Dołączanie interfejsu API usługi Azure API Management do usługi Microsoft Defender dla interfejsów API.
System rozpocznie monitorowanie operacji w interfejsie API usługi Azure Management pod kątem niepożądanych zachowań i zapewnia alerty dotyczące wykrytych ataków.
Składnia
Azure (domyślnie)
Invoke-AzSecurityApiCollectionApimOnboard
-ApiId <String>
-ResourceGroupName <String>
-ServiceName <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
AzureViaIdentity
Invoke-AzSecurityApiCollectionApimOnboard
-InputObject <ISecurityIdentity>
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Opis
Dołączanie interfejsu API usługi Azure API Management do usługi Microsoft Defender dla interfejsów API.
System rozpocznie monitorowanie operacji w interfejsie API usługi Azure Management pod kątem niepożądanych zachowań i zapewnia alerty dotyczące wykrytych ataków.
Przykłady
Przykład 1. Dołączanie interfejsu API usługi Azure API Management do usługi Microsoft Defender dla interfejsów API.
Invoke-AzSecurityApiCollectionApimOnboard -ResourceGroupName "apicollectionstests" -ServiceName "demoapimservice2" -ApiId "echo-api-2"
BaseUrl : https://demoapimservice2.azure-api.net
DiscoveredVia : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/apicollectionstests/providers/Microsoft.ApiManagement/service/demoapimservice2
DisplayName : Echo API 2
Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/apicollectionstests/providers/Microsoft.ApiManagement/service/demoapimservice2/providers/Microsoft.Security/apiCollections/ech
o-api-2
Name : echo-api-2
NumberOfApiEndpoint : 0
NumberOfApiEndpointsWithSensitiveDataExposed : 0
NumberOfExternalApiEndpoint : 0
NumberOfInactiveApiEndpoint : 0
NumberOfUnauthenticatedApiEndpoint : 0
ProvisioningState : Succeeded
ResourceGroupName : apicollectionstests
SensitivityLabel :
Type : microsoft.security/apicollections
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
Azure
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
-AsJob
Uruchamianie polecenia jako zadania
Właściwości parametru
Typ: SwitchParameter
Domyślna wartość: None
Obsługuje symbole wieloznaczne: False
DontShow: False
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
-Confirm
Prosi o potwierdzenie przed uruchomieniem cmdletu.
Właściwości parametru
Typ: SwitchParameter
Domyślna wartość: None
Obsługuje symbole wieloznaczne: False
DontShow: False
Aliasy: por
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
-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
Parametr tożsamości
Typ: ISecurityIdentity
Domyślna wartość: None
Obsługuje symbole wieloznaczne: False
DontShow: False
AzureViaIdentity
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
-NoWait
Uruchom polecenie asynchronicznie
Właściwości parametru
Typ: SwitchParameter
Domyślna wartość: None
Obsługuje symbole wieloznaczne: False
DontShow: False
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
-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
Azure
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
Azure
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
Azure
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
-WhatIf
Pokazuje, co się stanie, jeśli polecenie cmdlet zostanie uruchomione.
Cmdlet nie jest uruchomiony.
Właściwości parametru
Typ: SwitchParameter
Domyślna wartość: None
Obsługuje symbole wieloznaczne: False
DontShow: False
Aliasy: Wi
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
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 wyjściowe