Logger - Create Or Update
Hiermee maakt u een logboekregistratielogboek of Updates.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerId}?api-version=2021-08-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
logger
|
path | True |
string |
Logger-id. Moet uniek zijn in het API Management service-exemplaar. Regex-patroon: |
resource
|
path | True |
string |
De naam van de resourcegroep. |
service
|
path | True |
string |
De naam van de API Management service. Regex-patroon: |
subscription
|
path | True |
string |
Abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep. |
api-version
|
query | True |
string |
Versie van de API die moet worden gebruikt met de clientaanvraag. |
Aanvraagkoptekst
Name | Vereist | Type | Description |
---|---|---|---|
If-Match |
string |
ETag van de entiteit. Niet vereist bij het maken van een entiteit, maar vereist bij het bijwerken van een entiteit. |
Aanvraagbody
Name | Vereist | Type | Description |
---|---|---|---|
properties.loggerType | True |
Type logger. |
|
properties.credentials |
object |
De naam en SendRule verbindingsreeks van de Event Hub voor azureEventHub-logboekregistratie. Instrumentatiesleutel voor applicationInsights-logboekregistratie. |
|
properties.description |
string |
Beschrijving van logboekregistratie. |
|
properties.isBuffered |
boolean |
Hiermee wordt aangegeven of records in de logboekregistratie worden gebufferd voordat ze worden gepubliceerd. Standaard wordt ervan uitgegaan dat deze waar is. |
|
properties.resourceId |
string |
Azure-resource-id van een logboekdoel (Azure Event Hub-resource of Azure-toepassing Insights-resource). |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
De bestaande logboekregistratie is bijgewerkt. Kopteksten ETag: string |
|
201 Created |
Logger is gemaakt. Kopteksten ETag: string |
|
Other Status Codes |
Foutreactie waarin wordt beschreven waarom de bewerking is mislukt. |
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom.
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
Name | Description |
---|---|
user_impersonation | uw gebruikersaccount imiteren |
Voorbeelden
Api |
Api |
ApiManagementCreateAILogger
Voorbeeldaanvraag
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId?api-version=2021-08-01
{
"properties": {
"loggerType": "applicationInsights",
"description": "adding a new logger",
"credentials": {
"instrumentationKey": "11................a1"
}
}
}
Voorbeeldrespons
{
"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
Voorbeeldaanvraag
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1?api-version=2021-08-01
{
"properties": {
"loggerType": "azureEventHub",
"description": "adding a new logger",
"credentials": {
"name": "hydraeventhub",
"connectionString": "Endpoint=sb://hydraeventhub-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=********="
}
}
}
Voorbeeldrespons
{
"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
}
}
Definities
Name | Description |
---|---|
Error |
Fout Veldcontract. |
Error |
Foutreactie. |
Logger |
Details van de logboekregistratie. |
Logger |
Type logger. |
ErrorFieldContract
Fout Veldcontract.
Name | Type | Description |
---|---|---|
code |
string |
Foutcode op eigenschapsniveau. |
message |
string |
Door mensen leesbare weergave van fout op eigenschapsniveau. |
target |
string |
Naam van eigenschap. |
ErrorResponse
Foutreactie.
Name | Type | Description |
---|---|---|
error.code |
string |
Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord. |
error.details |
De lijst met ongeldige velden verzenden in aanvraag, in het geval van een validatiefout. |
|
error.message |
string |
Door mensen leesbare weergave van de fout. |
LoggerContract
Details van de logboekregistratie.
Name | Type | Description |
---|---|---|
id |
string |
Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
De naam van de resource |
properties.credentials |
object |
De naam en SendRule verbindingsreeks van de Event Hub voor azureEventHub-logboekregistratie. Instrumentatiesleutel voor applicationInsights-logboekregistratie. |
properties.description |
string |
Beschrijving van logboekregistratie. |
properties.isBuffered |
boolean |
Hiermee wordt aangegeven of records in de logboekregistratie worden gebufferd voordat ze worden gepubliceerd. Standaard wordt ervan uitgegaan dat deze waar is. |
properties.loggerType |
Type logger. |
|
properties.resourceId |
string |
Azure-resource-id van een logboekdoel (Azure Event Hub-resource of Azure-toepassing Insights-resource). |
type |
string |
Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts' |
LoggerType
Type logger.
Name | Type | Description |
---|---|---|
applicationInsights |
string |
Azure-toepassing Insights als logboekbestemming. |
azureEventHub |
string |
Azure Event Hub als logboekbestemming. |
azureMonitor |
string |
Azure Monitor |