Logger - Update
Updates eine vorhandene Protokollierung.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerId}?api-version=2022-08-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
logger
|
path | True |
string |
Protokollierungsbezeichner. Muss im API Management Dienst instance eindeutig sein. RegEx-Muster: |
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. |
Anforderungsheader
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
If-Match | True |
string |
ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für bedingungslose Aktualisierung sein. |
Anforderungstext
Name | Typ | Beschreibung |
---|---|---|
properties.credentials |
object |
Anmeldeinformationen für die Protokollierung. |
properties.description |
string |
Loggerbeschreibung. |
properties.isBuffered |
boolean |
Gibt an, ob Datensätze vor der Veröffentlichung in der Protokollierung gepuffert werden. Der Standardwert wird als true angenommen. |
properties.loggerType |
Protokolliertyp. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Die vorhandene Protokollierung wurde erfolgreich aktualisiert. Header ETag: string |
|
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
ApiManagementUpdateLogger
Beispielanforderung
Beispiel für eine Antwort
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1",
"type": "Microsoft.ApiManagement/service/loggers",
"name": "eh1",
"properties": {
"loggerType": "azureEventHub",
"description": "updating description",
"credentials": {
"connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}"
},
"isBuffered": true
}
}
Definitionen
Name | Beschreibung |
---|---|
Error |
Fehlerfeldvertrag. |
Error |
Fehlerantwort. |
Logger |
Protokollierungsdetails. |
Logger |
Protokolliertyp. |
Logger |
Protokollierungsupdatevertrag. |
ErrorFieldContract
Fehlerfeldvertrag.
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 im Falle eines Überprüfungsfehlers gesendet werden. |
|
error.message |
string |
Lesbare Darstellung des Fehlers. |
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 applicationInsights-Protokollierung. |
properties.description |
string |
Loggerbeschreibung. |
properties.isBuffered |
boolean |
Gibt an, ob Datensätze vor der Veröffentlichung in der Protokollierung gepuffert werden. Der Standardwert wird als true angenommen. |
properties.loggerType |
Protokolliertyp. |
|
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
Protokolliertyp.
Name | Typ | Beschreibung |
---|---|---|
applicationInsights |
string |
Azure-Anwendung Insights als Protokollziel. |
azureEventHub |
string |
Azure Event Hub als Protokollziel. |
azureMonitor |
string |
Azure Monitor |
LoggerUpdateContract
Protokollierungsupdatevertrag.
Name | Typ | Beschreibung |
---|---|---|
properties.credentials |
object |
Anmeldeinformationen für die Protokollierung. |
properties.description |
string |
Loggerbeschreibung. |
properties.isBuffered |
boolean |
Gibt an, ob Datensätze vor der Veröffentlichung in der Protokollierung gepuffert werden. Der Standardwert wird als true angenommen. |
properties.loggerType |
Protokolliertyp. |