Workspace Logger - Create Or Update

Référence

Service:: API Management

Version d'API:: 2024-05-01

Crée ou met à jour un enregistreur d’événements.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/loggers/{loggerId}?api-version=2024-05-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
loggerId	path	True	string maxLength: 256 pattern: ^[^*#&+:<>?]+$	Identificateur de l’enregistreur d’événements. Doit être unique dans l’instance du service Gestion des API.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nom du service Gestion des API.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identificateur de l’espace de travail. Doit être unique dans l’instance actuelle du service Gestion des API.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

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	LoggerType	Type d’enregistreur d’événements.
properties.credentials		object	Nom et 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 maxLength: 256	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	LoggerContract	L’enregistreur d’événements existant a été correctement mis à jour. En-têtes ETag: string
201 Created	LoggerContract	L’enregistreur d’événements a été créé avec succès. En-têtes ETag: string
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Nom

Type

Description

200 OK

LoggerContract

L’enregistreur d’événements existant a été correctement mis à jour.

En-têtes

ETag: string

201 Created

LoggerContract

L’enregistreur d’événements a été créé avec succès.

En-têtes

ETag: string

Other Status Codes

ErrorResponse

Réponse d’erreur décrivant pourquoi l’opération a échoué.

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

ApiManagementCreateWorkspaceAILogger

ApiManagementCreateWorkspaceEHLogger

ApiManagementCreateWorkspaceAILogger

Exemple de requête

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/loggerId?api-version=2024-05-01

{
  "properties": {
    "loggerType": "applicationInsights",
    "description": "adding a new logger",
    "credentials": {
      "instrumentationKey": "11................a1"
    }
  }
}

Exemple de réponse

Code d’état:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/loggerId",
  "type": "Microsoft.ApiManagement/service/workspaces/loggers",
  "name": "loggerId",
  "properties": {
    "loggerType": "applicationInsights",
    "description": null,
    "credentials": {
      "instrumentationKey": "{{5a.......2a}}"
    },
    "isBuffered": false,
    "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.insights/components/airesource"
  }
}

Code d’état:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/loggerId",
  "type": "Microsoft.ApiManagement/service/workspaces/loggers",
  "name": "loggerId",
  "properties": {
    "loggerType": "applicationInsights",
    "description": null,
    "credentials": {
      "instrumentationKey": "{{5a.......2a}}"
    },
    "isBuffered": false
  }
}

ApiManagementCreateWorkspaceEHLogger

Exemple de requête

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/eh1?api-version=2024-05-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

Code d’état:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/eh1",
  "type": "Microsoft.ApiManagement/service/workspaces/loggers",
  "name": "eh1",
  "properties": {
    "loggerType": "azureEventHub",
    "description": "adding a new logger",
    "credentials": {
      "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}"
    },
    "isBuffered": true
  }
}

Code d’état:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/eh1",
  "type": "Microsoft.ApiManagement/service/workspaces/loggers",
  "name": "eh1",
  "properties": {
    "loggerType": "azureEventHub",
    "description": "adding a new logger",
    "credentials": {
      "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}"
    },
    "isBuffered": true
  }
}

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
LoggerContract	Détails de l’enregistreur d’événements.
LoggerType	Type d’enregistreur d’événements.

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

LoggerContract

Object

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	Nom et 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 maxLength: 256	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	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

Énumération

Type d’enregistreur d’événements.

Valeur	Description
applicationInsights	Azure Application Insights comme destination du journal.
azureEventHub	Azure Event Hub comme destination du journal.
azureMonitor	Azure Monitor

Partager via

Workspace Logger - Create Or Update

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

ApiManagementCreateWorkspaceAILogger

Exemple de requête

Exemple de réponse

ApiManagementCreateWorkspaceEHLogger

Exemple de requête

Exemple de réponse

Définitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LoggerContract

LoggerType

Ressources supplémentaires