Partilhar via

Get-AzSecurityApiCollection

Módulo:
Az.Security Module

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

List (Predefinição) 

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>]

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.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

Get
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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.

Propriedades dos parâmetros

Tipo:PSObject
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:AzureRMContext, AzureCredential

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-InputObject

Parâmetro de identidade

Propriedades dos parâmetros

Tipo:ISecurityIdentity
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

GetViaIdentity
Position:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-ResourceGroupName

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

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

Get
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
List2
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
List1
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-ServiceName

O nome do serviço de Gerenciamento de API.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

Get
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
List2
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-SubscriptionId

Id de subscrição do Azure

Propriedades dos parâmetros

Tipo:

String[]

Default value:(Get-AzContext).Subscription.Id
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

List
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
Get
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
List2
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
List1
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

ISecurityIdentity

Saídas

IApiCollection