Get-AzApiManagementDiagnostic

Referenz

Modul:: Az.ApiManagement

Rufen Sie Details zur Diagnose ab, die auf Dienstebene oder api-Ebene konfiguriert ist. Diagnosen werden verwendet, um Anforderungen/Antworten vom API-Verwaltungsgateway zu protokollieren.

Syntax

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

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

Beschreibung

Der Get-AzApiManagementDiagnostic ruft Details zu den Diagnose ab, die im Api-Verwaltungsdienst in einem bestimmten Bereich konfiguriert sind.

Beispiele

Beispiel 1: Abrufen aller Diagnose, die im Mandantenbereich konfiguriert sind.

$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

Dieser Befehl ruft alle im Api-Verwaltungsdienst konfigurierten Diagnose ab.

Beispiel 2: Abrufen aller im API-Bereich konfigurierten Diagnose

$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

Dieser Befehl ruft alle Diagnose im echo-api API-Bereich konfiguriert ab.

Beispiel 3: Abrufen der API-Bereichsdiagnose, die durch eine ID angegeben wird

$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

Dieser Befehl ruft die in der API echo-apikonfigurierte applicationinsights Diagnose ab.

Parameter

-ApiId

Bezeichner vorhandener API. Wenn angegeben, wird die API-Bereichsdiagnose zurückgegeben. Diese Parameter sind erforderlich.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Context

Instanz von PsApiManagementContext. Dieser Parameter ist erforderlich.

Type:	PsApiManagementContext
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-DefaultProfile

Anmeldeinformationen, Konto, Mandant und Abonnement für die Kommunikation mit Azure

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DiagnosticId

Bezeichner vorhandener Diagnose. Wenn angegeben, wird eine Produktbereichsrichtlinie zurückgegeben. Diese Parameter sind optional.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceId

Arm-Ressourcenbezeichner einer Diagnose- oder API-Diagnose. Wenn angegeben, wird versucht, die Diagnose anhand des Bezeichners zu finden. Dieser Parameter ist erforderlich.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Eingaben

PsApiManagementContext

String

Ausgaben

PsApiManagementDiagnostic