Logger - Create Or Update
Erstellt oder aktualisiert eine Protokollierung
PUT 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 pattern: |
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 pattern: |
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 |
string |
ETag der Entität. Beim Erstellen einer Entität nicht erforderlich, aber beim Aktualisieren einer Entität erforderlich. |
Anforderungstext
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
properties.loggerType | True |
Protokolliertyp. |
|
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.resourceId |
string |
Azure-Ressourcen-ID eines Protokollziels (entweder Azure Event Hub-Ressource oder Azure-Anwendung Insights-Ressource). |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Die vorhandene Protokollierung wurde erfolgreich aktualisiert. Headers ETag: string |
|
201 Created |
Die Protokollierung wurde erfolgreich erstellt. Headers ETag: string |
|
Other Status Codes |
Fehlerantwort mit Beschreibung des Grunds für den Fehler. |
Sicherheit
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
Api |
Api |
ApiManagementCreateAILogger
Sample Request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId?api-version=2022-08-01
{
"properties": {
"loggerType": "applicationInsights",
"description": "adding a new logger",
"credentials": {
"instrumentationKey": "11................a1"
}
}
}
Sample Response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId",
"type": "Microsoft.ApiManagement/service/loggers",
"name": "loggerId",
"properties": {
"loggerType": "applicationInsights",
"description": null,
"credentials": {
"instrumentationKey": "{{5a.......2a}}"
},
"isBuffered": false,
"resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/microsoft.insights/components/airesource"
}
}
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId",
"type": "Microsoft.ApiManagement/service/loggers",
"name": "loggerId",
"properties": {
"loggerType": "applicationInsights",
"description": null,
"credentials": {
"instrumentationKey": "{{5a.......2a}}"
},
"isBuffered": false
}
}
ApiManagementCreateEHLogger
Sample Request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1?api-version=2022-08-01
{
"properties": {
"loggerType": "azureEventHub",
"description": "adding a new logger",
"credentials": {
"name": "hydraeventhub",
"connectionString": "Endpoint=sb://hydraeventhub-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=********="
}
}
}
Sample Response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1",
"type": "Microsoft.ApiManagement/service/loggers",
"name": "eh1",
"properties": {
"loggerType": "azureEventHub",
"description": "adding a new logger",
"credentials": {
"connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}"
},
"isBuffered": true
}
}
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1",
"type": "Microsoft.ApiManagement/service/loggers",
"name": "eh1",
"properties": {
"loggerType": "azureEventHub",
"description": "adding a new logger",
"credentials": {
"connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}"
},
"isBuffered": true
}
}
Definitionen
Name | Beschreibung |
---|---|
Error |
Fehlerfeldvertrag. |
Error |
Fehlerantwort. |
Logger |
Protokollierungsdetails. |
Logger |
Protokolliertyp. |
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 |