Freigeben über


Invoke-AzSecurityApiCollectionApimOnboard

Integrieren Sie eine Azure API-Verwaltungs-API in Microsoft Defender für APIs. Das System beginnt mit der Überwachung der Vorgänge innerhalb der Azure-Verwaltungs-API für aufdringliche Verhaltensweisen und stellt Warnungen für erkannte Angriffe bereit.

Syntax

Invoke-AzSecurityApiCollectionApimOnboard
      -ApiId <String>
      -ResourceGroupName <String>
      -ServiceName <String>
      [-SubscriptionId <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Invoke-AzSecurityApiCollectionApimOnboard
      -InputObject <ISecurityIdentity>
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Beschreibung

Integrieren Sie eine Azure API-Verwaltungs-API in Microsoft Defender für APIs. Das System beginnt mit der Überwachung der Vorgänge innerhalb der Azure-Verwaltungs-API für aufdringliche Verhaltensweisen und stellt Warnungen für erkannte Angriffe bereit.

Beispiele

Beispiel 1: Onboarding einer Azure API-Verwaltungs-API in Microsoft Defender für APIs.

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

Parameter

-ApiId

API-Revisionsbezeichner. Muss in der API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-AsJob

Ausführen des Befehls als Auftrag

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

Typ:SwitchParameter
Aliase:cf
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-DefaultProfile

Der Parameter DefaultProfile ist nicht funktionsfähig. Verwenden Sie den Parameter "SubscriptionId", wenn sie verfügbar ist, wenn Sie das Cmdlet für ein anderes Abonnement ausführen.

Typ:PSObject
Aliase:AzureRMContext, AzureCredential
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-InputObject

Identity-Parameter

Typ:ISecurityIdentity
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-NoWait

Asynchrones Ausführen des Befehls

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ResourceGroupName

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ServiceName

Der Name des API-Verwaltungsdiensts.

Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-SubscriptionId

Azure-Abonnement-ID

Typ:String
Position:Named
Standardwert:(Get-AzContext).Subscription.Id
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Typ:SwitchParameter
Aliase:wi
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

Eingaben

ISecurityIdentity

Ausgaben

IApiCollection