Logger - Create Or Update
Crea o Aggiornamenti un logger.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerId}?api-version=2022-08-01
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
logger
|
path | True |
string |
Identificatore del logger. Deve essere univoco nell'istanza del servizio Gestione API. Criterio di espressione regolare: |
resource
|
path | True |
string |
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole. |
service
|
path | True |
string |
Nome del servizio di Gestione API. Criterio di espressione regolare: |
subscription
|
path | True |
string |
ID della sottoscrizione di destinazione. |
api-version
|
query | True |
string |
Versione dell'API da usare per questa operazione. |
Intestazione della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
If-Match |
string |
ETag dell'entità. Non obbligatorio durante la creazione di un'entità, ma necessario durante l'aggiornamento di un'entità. |
Corpo della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
properties.loggerType | True |
Tipo logger. |
|
properties.credentials |
object |
Il nome e sendRule stringa di connessione dell'hub eventi per il logger azureEventHub. Chiave di strumentazione per il logger applicationInsights. |
|
properties.description |
string |
Descrizione del logger. |
|
properties.isBuffered |
boolean |
Indica se i record vengono memorizzati nel buffer nel logger prima della pubblicazione. Si presuppone che il valore predefinito sia true. |
|
properties.resourceId |
string |
ID risorsa di Azure di una destinazione di log (risorsa hub eventi di Azure o risorsa di Insights applicazione Azure). |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Il logger esistente è stato aggiornato correttamente. Intestazioni ETag: string |
|
201 Created |
Logger è stato creato correttamente. Intestazioni ETag: string |
|
Other Status Codes |
Risposta di errore che descrive il motivo per cui l'operazione non è riuscita. |
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory.
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/authorize
Ambiti
Nome | Descrizione |
---|---|
user_impersonation | rappresentare l'account utente |
Esempio
Api |
Api |
ApiManagementCreateAILogger
Esempio di richiesta
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"
}
}
}
Risposta di esempio
{
"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
Esempio di richiesta
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=********="
}
}
}
Risposta di esempio
{
"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
}
}
Definizioni
Nome | Descrizione |
---|---|
Error |
Contratto campo di errore. |
Error |
Risposta errore. |
Logger |
Dettagli del logger. |
Logger |
Tipo logger. |
ErrorFieldContract
Contratto campo di errore.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Codice di errore a livello di proprietà. |
message |
string |
Rappresentazione leggibile dell'errore a livello di proprietà. |
target |
string |
Nome della proprietà. |
ErrorResponse
Risposta errore.
Nome | Tipo | Descrizione |
---|---|---|
error.code |
string |
Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta. |
error.details |
Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida. |
|
error.message |
string |
Rappresentazione leggibile dell'errore. |
LoggerContract
Dettagli del logger.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
nome della risorsa. |
properties.credentials |
object |
Il nome e sendRule stringa di connessione dell'hub eventi per il logger azureEventHub. Chiave di strumentazione per il logger applicationInsights. |
properties.description |
string |
Descrizione del logger. |
properties.isBuffered |
boolean |
Indica se i record vengono memorizzati nel buffer nel logger prima della pubblicazione. Si presuppone che il valore predefinito sia true. |
properties.loggerType |
Tipo logger. |
|
properties.resourceId |
string |
ID risorsa di Azure di una destinazione di log (risorsa hub eventi di Azure o risorsa di Insights applicazione Azure). |
type |
string |
Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |
LoggerType
Tipo logger.
Nome | Tipo | Descrizione |
---|---|---|
applicationInsights |
string |
applicazione Azure Insights come destinazione del log. |
azureEventHub |
string |
Hub eventi di Azure come destinazione del log. |
azureMonitor |
string |
Monitoraggio di Azure |