Partilhar via


Get-AzSecurityApiCollection

Obtém uma API de Gerenciamento de API do Azure se ela tiver sido integrada ao Microsoft Defender para APIs. Se uma API de Gerenciamento de API do Azure estiver integrada ao Microsoft Defender for APIs, o sistema monitorará as operações dentro da API de Gerenciamento de API do Azure em busca de comportamentos intrusivos e fornecerá alertas para ataques que foram detetados.

Sintaxe

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

Obtém uma API de Gerenciamento de API do Azure se ela tiver sido integrada ao Microsoft Defender para APIs. Se uma API de Gerenciamento de API do Azure estiver integrada ao Microsoft Defender for APIs, o sistema monitorará as operações dentro da API de Gerenciamento de API do Azure em busca de comportamentos intrusivos e fornecerá alertas para ataques que foram detetados.

Exemplos

Exemplo 1: Obter um recurso específico de coleta de api integrado

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

Exemplo 2: Listar coleções de api integradas por nome de serviço

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

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

Exemplo 3: Listar coleções de api integradas por assinatura

Get-AzSecurityApiCollection

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

Parâmetros

-ApiId

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

Tipo:String
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-DefaultProfile

O parâmetro DefaultProfile não é funcional. Use o parâmetro SubscriptionId quando disponível se estiver executando o cmdlet em uma assinatura diferente.

Tipo:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-InputObject

Parâmetro de identidade

Tipo:ISecurityIdentity
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-ResourceGroupName

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

Tipo:String
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ServiceName

O nome do serviço de Gerenciamento de API.

Tipo:String
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-SubscriptionId

ID de assinatura do Azure

Tipo:String[]
Position:Named
Default value:(Get-AzContext).Subscription.Id
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

Entradas

Saídas