Diagnostic - List By Service

Référence

Service:: API Management

Version d'API:: 2021-08-01

Répertorie tous les diagnostics de l’instance de service de gestion des API.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics?api-version=2021-08-01

Avec des paramètres facultatifs:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics?$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 cliente.
$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 \|
$skip	query		integer int32	Nombre d'enregistrements à ignorer.
$top	query		integer int32	Nombre d’enregistrements à renvoyer.

Réponses

Nom	Type	Description
200 OK	DiagnosticCollection	Réponse de résultat paginée de diagnostics.
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

ApiManagementListDiagnostics

Exemple de requête

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

import com.azure.core.util.Context;

/** Samples for Diagnostic ListByService. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListDiagnostics.json
     */
    /**
     * Sample code: ApiManagementListDiagnostics.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListDiagnostics(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.diagnostics().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_diagnostics.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.diagnostic.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/ApiManagementListDiagnostics.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/ApiManagementListDiagnostics.json
func ExampleDiagnosticClient_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.NewDiagnosticClient().NewListByServicePager("rg1", "apimService1", &armapimanagement.DiagnosticClientListByServiceOptions{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.DiagnosticCollection = armapimanagement.DiagnosticCollection{
		// 	Count: to.Ptr[int64](1),
		// 	Value: []*armapimanagement.DiagnosticContract{
		// 		{
		// 			Name: to.Ptr("applicationinsights"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/diagnostics"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights"),
		// 			Properties: &armapimanagement.DiagnosticContractProperties{
		// 				AlwaysLog: to.Ptr(armapimanagement.AlwaysLogAllErrors),
		// 				Backend: &armapimanagement.PipelineDiagnosticSettings{
		// 					Response: &armapimanagement.HTTPMessageDiagnostic{
		// 						Body: &armapimanagement.BodyDiagnosticSettings{
		// 							Bytes: to.Ptr[int32](0),
		// 						},
		// 						Headers: []*string{
		// 						},
		// 					},
		// 					Request: &armapimanagement.HTTPMessageDiagnostic{
		// 						Body: &armapimanagement.BodyDiagnosticSettings{
		// 							Bytes: to.Ptr[int32](0),
		// 						},
		// 						Headers: []*string{
		// 						},
		// 					},
		// 				},
		// 				Frontend: &armapimanagement.PipelineDiagnosticSettings{
		// 					Response: &armapimanagement.HTTPMessageDiagnostic{
		// 						Body: &armapimanagement.BodyDiagnosticSettings{
		// 							Bytes: to.Ptr[int32](0),
		// 						},
		// 						Headers: []*string{
		// 						},
		// 					},
		// 					Request: &armapimanagement.HTTPMessageDiagnostic{
		// 						Body: &armapimanagement.BodyDiagnosticSettings{
		// 							Bytes: to.Ptr[int32](0),
		// 						},
		// 						Headers: []*string{
		// 						},
		// 					},
		// 				},
		// 				HTTPCorrelationProtocol: to.Ptr(armapimanagement.HTTPCorrelationProtocolLegacy),
		// 				LogClientIP: to.Ptr(true),
		// 				LoggerID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest"),
		// 				Sampling: &armapimanagement.SamplingSettings{
		// 					Percentage: to.Ptr[float64](100),
		// 					SamplingType: to.Ptr(armapimanagement.SamplingTypeFixed),
		// 				},
		// 				Verbosity: to.Ptr(armapimanagement.VerbosityInformation),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("azuremonitor"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/diagnostics"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/azuremonitor"),
		// 			Properties: &armapimanagement.DiagnosticContractProperties{
		// 				LogClientIP: to.Ptr(true),
		// 				LoggerID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/azuremonitor"),
		// 				Sampling: &armapimanagement.SamplingSettings{
		// 					Percentage: to.Ptr[float64](100),
		// 					SamplingType: to.Ptr(armapimanagement.SamplingTypeFixed),
		// 				},
		// 			},
		// 	}},
		// }
	}
}

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 all diagnostics of the API Management service instance.
 *
 * @summary Lists all diagnostics of the API Management service instance.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListDiagnostics.json
 */
async function apiManagementListDiagnostics() {
  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.diagnostic.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/ApiManagementListDiagnostics.json
// this example is just showing the usage of "Diagnostic_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 ApiManagementDiagnosticResource
ApiManagementDiagnosticCollection collection = apiManagementService.GetApiManagementDiagnostics();

// invoke the operation and iterate over the result
await foreach (ApiManagementDiagnosticResource 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
    DiagnosticContractData 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/diagnostics/applicationinsights",
      "type": "Microsoft.ApiManagement/service/diagnostics",
      "name": "applicationinsights",
      "properties": {
        "alwaysLog": "allErrors",
        "httpCorrelationProtocol": "Legacy",
        "verbosity": "information",
        "logClientIp": true,
        "loggerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest",
        "sampling": {
          "samplingType": "fixed",
          "percentage": 100
        },
        "frontend": {
          "request": {
            "headers": [],
            "body": {
              "bytes": 0
            }
          },
          "response": {
            "headers": [],
            "body": {
              "bytes": 0
            }
          }
        },
        "backend": {
          "request": {
            "headers": [],
            "body": {
              "bytes": 0
            }
          },
          "response": {
            "headers": [],
            "body": {
              "bytes": 0
            }
          }
        }
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/azuremonitor",
      "type": "Microsoft.ApiManagement/service/diagnostics",
      "name": "azuremonitor",
      "properties": {
        "logClientIp": true,
        "loggerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/azuremonitor",
        "sampling": {
          "samplingType": "fixed",
          "percentage": 100
        }
      }
    }
  ],
  "count": 1
}

Définitions

Nom	Description
AlwaysLog	Spécifie le type de paramètres d’échantillonnage des messages qui ne doivent pas s’appliquer.
BodyDiagnosticSettings	Paramètres de journalisation du corps.
DataMasking
DataMaskingEntity
DataMaskingMode	Mode masquage des données.
DiagnosticCollection	Représentation de liste de diagnostic paginée.
DiagnosticContract	Détails du diagnostic.
ErrorFieldContract	Contrat champ d’erreur.
ErrorResponse	Réponse d’erreur.
HttpCorrelationProtocol	Définit le protocole de corrélation à utiliser pour les diagnostics Application Insights.
HttpMessageDiagnostic	Paramètres de diagnostic des messages Http.
OperationNameFormat	Format du nom de l’opération pour les télémetries Application Insights. La valeur par défaut est Name.
PipelineDiagnosticSettings	Paramètres de diagnostic pour les messages HTTP entrants/sortants vers la passerelle.
SamplingSettings	Paramètres d’échantillonnage pour diagnostic.
SamplingType	Type d’échantillonnage.
Verbosity	Niveau de détail appliqué aux traces émises par les stratégies de suivi.

AlwaysLog

Spécifie le type de paramètres d’échantillonnage des messages qui ne doivent pas s’appliquer.

Nom	Type	Description
allErrors	string	Consignez toujours toutes les demandes erronées, quels que soient les paramètres d’échantillonnage.

BodyDiagnosticSettings

Paramètres de journalisation du corps.

Nom	Type	Description
bytes	integer	Nombre d’octets du corps de la requête à consigner.

DataMasking

Nom	Type	Description
headers	DataMaskingEntity[]	Paramètres de masquage des en-têtes
queryParams	DataMaskingEntity[]	Paramètres de masquage pour les paramètres de requête d’URL

DataMaskingEntity

Nom	Type	Description
mode	DataMaskingMode	Mode masquage des données.
value	string	Nom d’une entité à masquer (par exemple, le nom d’un en-tête ou d’un paramètre de requête).

DataMaskingMode

Mode masquage des données.

Nom	Type	Description
Hide	string	Masquer la présence d’une entité.
Mask	string	Masquez la valeur d’une entité.

DiagnosticCollection

Représentation de liste de diagnostic paginée.

Nom	Type	Description
count	integer	Nombre total d’enregistrements sur toutes les pages.
nextLink	string	Lien de page suivante, le cas échéant.
value	DiagnosticContract[]	Valeurs de page.

DiagnosticContract

Détails du diagnostic.

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.alwaysLog	AlwaysLog	Spécifie le type de paramètres d’échantillonnage des messages qui ne doivent pas s’appliquer.
properties.backend	PipelineDiagnosticSettings	Paramètres de diagnostic pour les messages HTTP entrants/sortants vers le serveur principal
properties.frontend	PipelineDiagnosticSettings	Paramètres de diagnostic pour les messages HTTP entrants/sortants vers la passerelle.
properties.httpCorrelationProtocol	HttpCorrelationProtocol	Définit le protocole de corrélation à utiliser pour les diagnostics Application Insights.
properties.logClientIp	boolean	Consignez le ClientIP. La valeur par défaut est false.
properties.loggerId	string	ID de ressource d’un enregistreur d’événements cible.
properties.metrics	boolean	Émettre des métriques personnalisées via une stratégie de métrique d’émission. Applicable uniquement aux paramètres de diagnostic Application Insights.
properties.operationNameFormat	OperationNameFormat	Format du nom de l’opération pour les télémetries Application Insights. La valeur par défaut est Name.
properties.sampling	SamplingSettings	Paramètres d’échantillonnage pour diagnostic.
properties.verbosity	Verbosity	Niveau de détail appliqué aux traces émises par les stratégies de suivi.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

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.

HttpCorrelationProtocol

Définit le protocole de corrélation à utiliser pour les diagnostics Application Insights.

Nom	Type	Description
Legacy	string	Injectez des en-têtes Request-Id et Request-Context avec des données de corrélation de requête. Consultez https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.
None	string	Ne lisez pas et n’injectez pas d’en-têtes de corrélation.
W3C	string	Injecter des en-têtes de contexte de trace. Consultez https://w3c.github.io/trace-context.

HttpMessageDiagnostic

Paramètres de diagnostic des messages Http.

Nom	Type	Description
body	BodyDiagnosticSettings	Paramètres de journalisation du corps.
dataMasking	DataMasking	Paramètres de masquage des données.
headers	string[]	Tableau d’en-têtes HTTP à journaliser.

OperationNameFormat

Format du nom de l’opération pour les télémetries Application Insights. La valeur par défaut est Name.

Nom	Type	Description
Name	string	API_NAME ; rev=API_REVISION - OPERATION_NAME
Url	string	HTTP_VERB URL

PipelineDiagnosticSettings

Paramètres de diagnostic pour les messages HTTP entrants/sortants vers la passerelle.

Nom	Type	Description
request	HttpMessageDiagnostic	Paramètres de diagnostic pour la demande.
response	HttpMessageDiagnostic	Paramètres de diagnostic pour la réponse.

SamplingSettings

Paramètres d’échantillonnage pour diagnostic.

Nom	Type	Description
percentage	number	Taux d’échantillonnage pour l’échantillonnage à taux fixe.
samplingType	SamplingType	Type d’échantillonnage.

SamplingType

Type d’échantillonnage.

Nom	Type	Description
fixed	string	Échantillonnage à taux fixe.

Verbosity

Niveau de détail appliqué aux traces émises par les stratégies de suivi.

Nom	Type	Description
error	string	Seules les traces dont la valeur « gravité » est définie sur « error » sont envoyées à l’enregistreur d’événements attaché à cette instance de diagnostic.
information	string	Les traces dont la valeur « severity » est définie sur « information » et « error » sont envoyées à l’enregistreur d’événements associé à ce instance de diagnostic.
verbose	string	Toutes les traces émises par les stratégies de suivi seront envoyées au journal attaché à ce instance de diagnostic.