Logger - Create Or Update
Crée ou met à jour un enregistreur.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerId}?api-version=2021-08-01
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
logger
|
path | True |
string |
Identificateur de l’enregistreur d’événements. Doit être unique dans le instance de service Gestion des API. Modèle d’expression régulière: |
resource
|
path | True |
string |
Nom du groupe de ressources. |
service
|
path | True |
string |
Nom du service Gestion des API. Modèle d’expression régulière: |
subscription
|
path | True |
string |
Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service. |
api-version
|
query | True |
string |
Version de l’API à utiliser avec la demande du client. |
En-tête de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
If-Match |
string |
ETag de l’entité. Non obligatoire lors de la création d’une entité, mais obligatoire lors de la mise à jour d’une entité. |
Corps de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
properties.loggerType | True |
Type d’enregistreur d’événements. |
|
properties.credentials |
object |
Le nom et la chaîne de connexion SendRule du hub d’événements pour l’enregistreur d’événements azureEventHub. Clé d’instrumentation pour l’enregistreur d’événements applicationInsights. |
|
properties.description |
string |
Description de l’enregistreur d’événements. |
|
properties.isBuffered |
boolean |
Indique si les enregistrements sont mis en mémoire tampon dans l’enregistreur d’événements avant la publication. La valeur par défaut est supposée être true. |
|
properties.resourceId |
string |
ID de ressource Azure d’une cible de journal (ressource Azure Event Hub ou ressource Azure Application Insights). |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
L’enregistreur d’événements existant a été correctement mis à jour. En-têtes ETag: string |
|
201 Created |
L’enregistreur d’événements a été créé avec succès. En-têtes ETag: string |
|
Other Status Codes |
Réponse d’erreur décrivant la raison de l’échec de l’opération. |
Sécurité
azure_auth
Flux OAuth2 Azure Active Directory.
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
Nom | Description |
---|---|
user_impersonation | Emprunter l’identité de votre compte d’utilisateur |
Exemples
Api |
Api |
ApiManagementCreateAILogger
Exemple de requête
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"
}
}
}
Exemple de réponse
{
"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
Exemple de requête
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=********="
}
}
}
Exemple de réponse
{
"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
}
}
Définitions
Nom | Description |
---|---|
Error |
Contrat de champ d’erreur. |
Error |
Réponse d’erreur. |
Logger |
Détails de l’enregistreur d’événements. |
Logger |
Type d’enregistreur d’événements. |
ErrorFieldContract
Contrat de champ d’erreur.
Nom | Type | Description |
---|---|---|
code |
string |
Code d'erreur de niveau propriété. |
message |
string |
Représentation lisible par l’homme de l’erreur au niveau des propriétés. |
target |
string |
Nom de propriété. |
ErrorResponse
Réponse d’erreur.
Nom | Type | Description |
---|---|---|
error.code |
string |
Code d'erreur défini par le service. Ce code sert de sous-état pour le code d'erreur HTTP spécifié dans la réponse. |
error.details |
Liste des champs non valides envoyés dans la demande, en cas d’erreur de validation. |
|
error.message |
string |
Représentation contrôlable de visu de l’erreur. |
LoggerContract
Détails de l’enregistreur d’événements.
Nom | Type | Description |
---|---|---|
id |
string |
ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
nom de la ressource. |
properties.credentials |
object |
Le nom et la chaîne de connexion SendRule du hub d’événements pour l’enregistreur d’événements azureEventHub. Clé d’instrumentation pour l’enregistreur d’événements applicationInsights. |
properties.description |
string |
Description de l’enregistreur d’événements. |
properties.isBuffered |
boolean |
Indique si les enregistrements sont mis en mémoire tampon dans l’enregistreur d’événements avant la publication. La valeur par défaut est supposée être true. |
properties.loggerType |
Type d’enregistreur d’événements. |
|
properties.resourceId |
string |
ID de ressource Azure d’une cible de journal (ressource Azure Event Hub ou ressource Azure Application Insights). |
type |
string |
Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » |
LoggerType
Type d’enregistreur d’événements.
Nom | Type | Description |
---|---|---|
applicationInsights |
string |
Azure Application Insights comme destination du journal. |
azureEventHub |
string |
Azure Event Hub comme destination du journal. |
azureMonitor |
string |
Azure Monitor |