Logger - List By Service

Référence

Service:: API Management

Version d'API:: 2021-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=2021-08-01

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources.
serviceName	path	True	string	Nom du service Gestion des API. Modèle d’expression régulière: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	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.
$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
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

ApiManagementListLoggers

Exemple de requête

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

import com.azure.core.util.Context;

/** Samples for Logger ListByService. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListLoggers.json
     */
    /**
     * Sample code: ApiManagementListLoggers.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListLoggers(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.loggers().listByService("rg1", "apimService1", null, null, null, Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_list_loggers.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.logger.list_by_service(
        resource_group_name="rg1",
        service_name="apimService1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListLoggers.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListLoggers.json
func ExampleLoggerClient_NewListByServicePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewLoggerClient().NewListByServicePager("rg1", "apimService1", &armapimanagement.LoggerClientListByServiceOptions{Filter: nil,
		Top:  nil,
		Skip: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.LoggerCollection = armapimanagement.LoggerCollection{
		// 	Count: to.Ptr[int64](3),
		// 	Value: []*armapimanagement.LoggerContract{
		// 		{
		// 			Name: to.Ptr("azuremonitor"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/loggers"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/azuremonitor"),
		// 			Properties: &armapimanagement.LoggerContractProperties{
		// 				IsBuffered: to.Ptr(true),
		// 				LoggerType: to.Ptr(armapimanagement.LoggerTypeAzureMonitor),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("vvktest"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/loggers"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/vvktest"),
		// 			Properties: &armapimanagement.LoggerContractProperties{
		// 				Credentials: map[string]*string{
		// 					"instrumentationKey": to.Ptr("{{Logger-Credentials-5b1a17ef2b3f91153004b10d}}"),
		// 				},
		// 				IsBuffered: to.Ptr(true),
		// 				LoggerType: to.Ptr(armapimanagement.LoggerTypeApplicationInsights),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("applicationinsights"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/loggers"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/applicationinsights"),
		// 			Properties: &armapimanagement.LoggerContractProperties{
		// 				Description: to.Ptr("miaoappinsight"),
		// 				Credentials: map[string]*string{
		// 					"instrumentationKey": to.Ptr("{{Logger-Credentials-5b2056062b3f911ae84a3069}}"),
		// 				},
		// 				IsBuffered: to.Ptr(true),
		// 				LoggerType: to.Ptr(armapimanagement.LoggerTypeApplicationInsights),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists a collection of loggers in the specified service instance.
 *
 * @summary Lists a collection of loggers in the specified service instance.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListLoggers.json
 */
async function apiManagementListLoggers() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.logger.listByService(resourceGroupName, serviceName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ApiManagement;
using Azure.ResourceManager.ApiManagement.Models;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListLoggers.json
// this example is just showing the usage of "Logger_ListByService" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// get the collection of this ApiManagementLoggerResource
ApiManagementLoggerCollection collection = apiManagementService.GetApiManagementLoggers();

// invoke the operation and iterate over the result
await foreach (ApiManagementLoggerResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ApiManagementLoggerData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:: 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 de champ d’erreur.
ErrorResponse	Réponse d’erreur.
LoggerCollection	Représentation de liste d’enregistreurs d’événements paginés.
LoggerContract	Détails de l’enregistreur d’événements.
LoggerType	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	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 liste d’enregistreurs d’événements paginés.

Nom	Type	Description
count	integer	Nombre total d’enregistrements sur toutes les pages.
nextLink	string	Lien de la 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 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	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