Logger - List By Service
Listet eine Auflistung der Protokollierungen in der angegebenen Dienstinstanz auf
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers?api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
resource
|
path | True |
string |
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet. |
service
|
path | True |
string |
Der Name des API Management-Diensts. RegEx-Muster: |
subscription
|
path | True |
string |
Hierbei handelt es sich um die ID des Zielabonnements. |
api-version
|
query | True |
string |
Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version. |
$filter
|
query |
string |
| Feld | Nutzung | Unterstützte Operatoren | Unterstützte Funktionen | |
|
$skip
|
query |
integer int32 |
Die Anzahl der zu überspringenden Datensätze. |
|
$top
|
query |
integer int32 |
Die Anzahl der zurückzugebenden Datensätze. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Listet eine Auflistung von Protokollierungsentitäten auf. |
|
Other Status Codes |
Fehlerantwort mit Beschreibung des Grunds für den Fehler. |
Sicherheit
azure_auth
Azure Active Directory OAuth2-Flow.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
ApiManagementListLoggers
Beispielanforderung
Beispiel für eine Antwort
{
"value": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/azuremonitor",
"type": "Microsoft.ApiManagement/service/loggers",
"name": "azuremonitor",
"properties": {
"loggerType": "azureMonitor",
"isBuffered": true
}
},
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/vvktest",
"type": "Microsoft.ApiManagement/service/loggers",
"name": "vvktest",
"properties": {
"loggerType": "applicationInsights",
"credentials": {
"instrumentationKey": "{{Logger-Credentials-5b1a17ef2b3f91153004b10d}}"
},
"isBuffered": true
}
},
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/applicationinsights",
"type": "Microsoft.ApiManagement/service/loggers",
"name": "applicationinsights",
"properties": {
"loggerType": "applicationInsights",
"description": "miaoappinsight",
"credentials": {
"instrumentationKey": "{{Logger-Credentials-5b2056062b3f911ae84a3069}}"
},
"isBuffered": true
}
}
],
"count": 3,
"nextLink": ""
}
Definitionen
Name | Beschreibung |
---|---|
Error |
Fehler Feldvertrag. |
Error |
Fehlerantwort. |
Logger |
Darstellung der Auslagerungsprotokollierungsliste. |
Logger |
Protokollierungsdetails. |
Logger |
Protokollierungstyp. |
ErrorFieldContract
Fehler Feldvertrag.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Fehlercode auf Eigenschaftsebene. |
message |
string |
Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene. |
target |
string |
Der Eigenschaftsname. |
ErrorResponse
Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
error.code |
string |
Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode. |
error.details |
Die Liste der ungültigen Felder, die in der Anforderung gesendet werden, im Falle eines Validierungsfehlers. |
|
error.message |
string |
Lesbare Darstellung des Fehlers. |
LoggerCollection
Darstellung der Auslagerungsprotokollierungsliste.
Name | Typ | Beschreibung |
---|---|---|
count |
integer |
Gesamtzahl der Datensätze auf allen Seiten. |
nextLink |
string |
Link zur nächsten Seite, falls vorhanden. |
value |
Protokollierungswerte. |
LoggerContract
Protokollierungsdetails.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Der Name der Ressource |
properties.credentials |
object |
Der Name und sendRule Verbindungszeichenfolge des Event Hubs für die azureEventHub-Protokollierung. Instrumentierungsschlüssel für die applicationInsights-Protokollierung. |
properties.description |
string |
Protokollierungsbeschreibung. |
properties.isBuffered |
boolean |
Gibt an, ob Datensätze vor der Veröffentlichung in der Protokollierung gepuffert werden. Es wird davon ausgegangen, dass der Standardwert true ist. |
properties.loggerType |
Protokollierungstyp. |
|
properties.resourceId |
string |
Azure-Ressourcen-ID eines Protokollziels (entweder Azure Event Hub-Ressource oder Azure-Anwendung Insights-Ressource). |
type |
string |
Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" |
LoggerType
Protokollierungstyp.
Name | Typ | Beschreibung |
---|---|---|
applicationInsights |
string |
Azure-Anwendung Insights als Protokollziel. |
azureEventHub |
string |
Azure Event Hub als Protokollziel. |
azureMonitor |
string |
Azure Monitor |