Logger - Create Or Update
Naplózót hoz létre vagy Frissítések.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerId}?api-version=2022-08-01
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
logger
|
path | True |
string |
Naplózó azonosítója. A API Management szolgáltatáspéldányban egyedinek kell lennie. Regex pattern: |
resource
|
path | True |
string |
Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket. |
service
|
path | True |
string |
A API Management szolgáltatás neve. Regex pattern: |
subscription
|
path | True |
string |
A cél-előfizetés azonosítója. |
api-version
|
query | True |
string |
A művelethez használandó API-verzió. |
Kérelem fejléce
Name | Kötelező | Típus | Description |
---|---|---|---|
If-Match |
string |
Az entitás ETagje. Entitás létrehozásakor nem kötelező, de az entitások frissítésekor kötelező. |
Kérelem törzse
Name | Kötelező | Típus | Description |
---|---|---|---|
properties.loggerType | True |
Naplózó típusa. |
|
properties.credentials |
object |
Az azureEventHub-naplózó eseményközpontjának neve és SendRule kapcsolati karakterlánc. Rendszerállapotkulcs az applicationInsights-naplózóhoz. |
|
properties.description |
string |
Naplózó leírása. |
|
properties.isBuffered |
boolean |
Azt határozza meg, hogy a rekordok pufferelve legyenek-e a naplózóban a közzététel előtt. A rendszer feltételezi, hogy az alapértelmezett érték igaz. |
|
properties.resourceId |
string |
Naplócél Azure-erőforrás-azonosítója (Azure Event Hub-erőforrás vagy Azure-alkalmazás Insights-erőforrás). |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
A meglévő naplózó frissítése sikerült. Headers ETag: string |
|
201 Created |
A naplózó létrehozása sikerült. Headers ETag: string |
|
Other Status Codes |
Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg. |
Biztonság
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | felhasználói fiók megszemélyesítése |
Példák
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
}
}
Definíciók
Name | Description |
---|---|
Error |
Hibamező-szerződés. |
Error |
Hibaválasz. |
Logger |
Naplózó adatai. |
Logger |
Naplózó típusa. |
ErrorFieldContract
Hibamező-szerződés.
Name | Típus | Description |
---|---|---|
code |
string |
Tulajdonságszintű hibakód. |
message |
string |
A tulajdonságszintű hiba emberi olvasásra alkalmas ábrázolása. |
target |
string |
Tulajdonság neve. |
ErrorResponse
Hibaválasz.
Name | Típus | Description |
---|---|---|
error.code |
string |
Szolgáltatás által definiált hibakód. Ez a kód a válaszban megadott HTTP-hibakód alállapotaként szolgál. |
error.details |
Érvényesítési hiba esetén a kérelemben küldött érvénytelen mezők listája. |
|
error.message |
string |
A hiba emberi olvasásra alkalmas ábrázolása. |
LoggerContract
Naplózó adatai.
Name | Típus | Description |
---|---|---|
id |
string |
Az erőforrás teljes erőforrás-azonosítója. Például : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Az erőforrás neve |
properties.credentials |
object |
Az azureEventHub-naplózó eseményközpontjának neve és SendRule kapcsolati karakterlánc. Rendszerállapotkulcs az applicationInsights-naplózóhoz. |
properties.description |
string |
Naplózó leírása. |
properties.isBuffered |
boolean |
Azt határozza meg, hogy a rekordok pufferelve legyenek-e a naplózóban a közzététel előtt. A rendszer feltételezi, hogy az alapértelmezett érték igaz. |
properties.loggerType |
Naplózó típusa. |
|
properties.resourceId |
string |
Naplócél Azure-erőforrás-azonosítója (Azure Event Hub-erőforrás vagy Azure-alkalmazás Insights-erőforrás). |
type |
string |
Az erőforrás típusa. Például"Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts" |
LoggerType
Naplózó típusa.
Name | Típus | Description |
---|---|---|
applicationInsights |
string |
Azure-alkalmazás Insights naplócélként. |
azureEventHub |
string |
Az Azure Event Hub mint naplócél. |
azureMonitor |
string |
Azure Monitor |