Logger - Create Or Update
Skapar eller Uppdateringar en loggare.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerId}?api-version=2022-08-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
logger
|
path | True |
string |
Loggningsidentifierare. Måste vara unikt i API Management tjänstinstans. Reguljärt uttrycksmönster: |
resource
|
path | True |
string |
Namnet på resursgruppen. Namnet är skiftlägesokänsligt. |
service
|
path | True |
string |
Namnet på API Management-tjänsten. Reguljärt uttrycksmönster: |
subscription
|
path | True |
string |
ID för målprenumerationen. |
api-version
|
query | True |
string |
Den API-version som ska användas för den här åtgärden. |
Begärandehuvud
Name | Obligatorisk | Typ | Description |
---|---|---|---|
If-Match |
string |
ETag för entiteten. Krävs inte när du skapar en entitet, men krävs vid uppdatering av en entitet. |
Begärandetext
Name | Obligatorisk | Typ | Description |
---|---|---|---|
properties.loggerType | True |
Loggningstyp. |
|
properties.credentials |
object |
Namn och SendRule-anslutningssträng för händelsehubben för azureEventHub-loggaren. Instrumentationsnyckel för applicationInsights-loggare. |
|
properties.description |
string |
Beskrivning av loggare. |
|
properties.isBuffered |
boolean |
Om poster buffrats i loggaren före publicering. Standardvärdet antas vara sant. |
|
properties.resourceId |
string |
Azure-resurs-ID för ett loggmål (antingen Azure Event Hub-resurs eller Azure Application Insights-resurs). |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Den befintliga loggaren har uppdaterats. Sidhuvuden ETag: string |
|
201 Created |
Loggaren har skapats. Sidhuvuden ETag: string |
|
Other Status Codes |
Felsvar som beskriver varför åtgärden misslyckades. |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow.
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto |
Exempel
Api |
Api |
ApiManagementCreateAILogger
Exempelbegäran
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"
}
}
}
Exempelsvar
{
"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
Exempelbegäran
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=********="
}
}
}
Exempelsvar
{
"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
}
}
Definitioner
Name | Description |
---|---|
Error |
Fel fältkontrakt. |
Error |
Felsvar. |
Logger |
Loggningsinformation. |
Logger |
Loggningstyp. |
ErrorFieldContract
Fel fältkontrakt.
Name | Typ | Description |
---|---|---|
code |
string |
Felkod på egenskapsnivå. |
message |
string |
Mänsklig läsbar representation av fel på egenskapsnivå. |
target |
string |
Egenskapsnamn. |
ErrorResponse
Felsvar.
Name | Typ | Description |
---|---|---|
error.code |
string |
Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret. |
error.details |
Listan över ogiltiga fält som skickas i begäran, vid valideringsfel. |
|
error.message |
string |
Mänsklig läsbar representation av felet. |
LoggerContract
Loggningsinformation.
Name | Typ | Description |
---|---|---|
id |
string |
Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Namnet på resursen |
properties.credentials |
object |
Namn och SendRule-anslutningssträng för händelsehubben för azureEventHub-loggaren. Instrumentationsnyckel för applicationInsights-loggare. |
properties.description |
string |
Beskrivning av loggare. |
properties.isBuffered |
boolean |
Om poster buffrats i loggaren före publicering. Standardvärdet antas vara sant. |
properties.loggerType |
Loggningstyp. |
|
properties.resourceId |
string |
Azure-resurs-ID för ett loggmål (antingen Azure Event Hub-resurs eller Azure Application Insights-resurs). |
type |
string |
Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" |
LoggerType
Loggningstyp.
Name | Typ | Description |
---|---|---|
applicationInsights |
string |
Azure Application Insights som loggmål. |
azureEventHub |
string |
Azure Event Hub som loggmål. |
azureMonitor |
string |
Azure Monitor |