Get-AzApiManagementDiagnostic

Referência

Módulo:: Az.ApiManagement

Obtenha detalhes do Diagnóstico configurado no nível de serviço ou no Nível de Api. Os diagnósticos são usados para registrar solicitações/respostas do gateway de Gerenciamento de Api.

Sintaxe

Get-AzApiManagementDiagnostic
   -Context <PsApiManagementContext>
   [-DiagnosticId <String>]
   [-ApiId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzApiManagementDiagnostic
   -ResourceId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

O Get-AzApiManagementDiagnostic obtém detalhes dos diagnósticos configurados no serviço de gerenciamento de Api em um determinado escopo.

Exemplos

Exemplo 1: Obtenha todo o diagnóstico configurado no escopo do locatário.

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementDiagnostic -Context $apimContext

DiagnosticId                 : applicationinsights
ApiId                        :
AlwaysLog                    : allErrors
LoggerId                     : backendapisachinc
EnableHttpCorrelationHeaders : True
SamplingSetting              : Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSamplingSetting
FrontendSetting              :
BackendSetting               :
Id                           : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/diagnostics/applicationinsights
ResourceGroupName            : Api-Default-WestUS
ServiceName                  : contoso

DiagnosticId                 : azuremonitor
ApiId                        :
AlwaysLog                    :
LoggerId                     : azuremonitor
EnableHttpCorrelationHeaders :
SamplingSetting              : Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSamplingSetting
FrontendSetting              :
BackendSetting               : 
Id                           : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/diagnostics/azuremonitor
ResourceGroupName            : Api-Default-WestUS
ServiceName                  : contoso

Este comando obtém todos os diagnósticos configurados no serviço de Gerenciamento de Api.

Exemplo 2: Obter todos os diagnósticos configurados no escopo da API

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementDiagnostic -Context $apimContext -ApiId "echo-api"

DiagnosticId                 : applicationinsights
ApiId                        : echo-api
AlwaysLog                    : allErrors
LoggerId                     : backendapisachinc
EnableHttpCorrelationHeaders : True
SamplingSetting              : Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSamplingSetting
FrontendSetting              : Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementPipelineDiagnosticSetting
BackendSetting               : Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementPipelineDiagnosticSetting
Id                           : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/apis/echo-api/diagnostics/applicationinsights
ResourceGroupName            : Api-Default-WestUS
ServiceName                  : contoso

Este comando obtém todos os diagnósticos configurados no escopo da echo-api API

Exemplo 3: Obter o diagnóstico de escopo de API especificado por um Id

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementDiagnostic -Context $apimContext -ApiId "echo-api" -DiagnosticId "applicationinsights"

DiagnosticId                 : applicationinsights
ApiId                        : echo-api
AlwaysLog                    : allErrors
LoggerId                     : backendapisachinc
EnableHttpCorrelationHeaders : True
SamplingSetting              : Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSamplingSetting
FrontendSetting              :
BackendSetting               :
Id                           : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/diagnostics/applicationinsights
ResourceGroupName            : Api-Default-WestUS
ServiceName                  : contoso

Este comando obtém o applicationinsights diagnóstico configurado na api echo-api.

Parâmetros

-ApiId

Identificador da API existente. Se especificado, retornará o diagnóstico do escopo da API. Este parâmetro é obrigatório.

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

-Context

Instância de PsApiManagementContext. Este parâmetro é obrigatório.

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

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o Azure.

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

-DiagnosticId

Identificador do diagnóstico existente. Se especificado, retornará a política de escopo do produto. Este parâmetro é opcional.

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

-ResourceId

Arm Resource Identifier de um diagnóstico ou diagnóstico de API. Se especificado tentará encontrar o diagnóstico pelo identificador. Este parâmetro é obrigatório.

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

Entradas

PsApiManagementContext

String

Saídas

PsApiManagementDiagnostic

Partilhar via