Partager via

Logger - List By Service

  • Référence
Service:
API Management
API Version:
2022-08-01

Répertorie une collection d’enregistreurs d’événements dans l’instance de service spécifié.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers?api-version=2022-08-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01

Paramètres URI

Nom Dans Obligatoire Type Description
resourceGroupName
 path True

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.
serviceName
 path True

string

Nom du service Gestion des API.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

ID de l’abonnement cible.
api-version
 query True

string

Version de l’API à utiliser pour cette opération.
$filter
 query

string

| Champ | Utilisation | Opérateurs pris en charge | Fonctions prises en charge |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| loggerType | filter | eq | |
| resourceId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
$skip
 query

integer

int32

Nombre d'enregistrements à ignorer.
$top
 query

integer

int32

Nombre d’enregistrements à renvoyer.

Réponses

Nom Type Description
200 OK

LoggerCollection

Répertorie une collection d’entités Logger.
Other Status Codes

ErrorResponse

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
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

ApiManagementListLoggers

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers?api-version=2022-08-01

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/azuremonitor",
      "type": "Microsoft.ApiManagement/service/loggers",
      "name": "azuremonitor",
      "properties": {
        "loggerType": "azureMonitor",
        "isBuffered": true
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/vvktest",
      "type": "Microsoft.ApiManagement/service/loggers",
      "name": "vvktest",
      "properties": {
        "loggerType": "applicationInsights",
        "credentials": {
          "instrumentationKey": "{{Logger-Credentials-5b1a17ef2b3f91153004b10d}}"
        },
        "isBuffered": true
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/applicationinsights",
      "type": "Microsoft.ApiManagement/service/loggers",
      "name": "applicationinsights",
      "properties": {
        "loggerType": "applicationInsights",
        "description": "miaoappinsight",
        "credentials": {
          "instrumentationKey": "{{Logger-Credentials-5b2056062b3f911ae84a3069}}"
        },
        "isBuffered": true
      }
    }
  ],
  "count": 3,
  "nextLink": ""
}

Définitions

Nom Description
ErrorFieldContract

Contrat champ d’erreur.
ErrorResponse

Réponse d’erreur.
LoggerCollection

Représentation de la liste de l’enregistreur d’événements paginés.
LoggerContract

Détails de l’enregistreur d’événements.
LoggerType

Type d’enregistreur d’événements.

ErrorFieldContract

Contrat 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 de la propriété.
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

ErrorFieldContract[]

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.

LoggerCollection

Représentation de la liste de l’enregistreur d’événements paginés.

Nom Type Description
count

integer

Nombre total d’enregistrements sur toutes les pages.
nextLink

string

Lien de page suivante, le cas échéant.
value

LoggerContract[]

Valeurs de l’enregistreur d’événements.

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 l’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

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 de journal.
azureMonitor

string

Azure Monitor