Diagnostic - List By Service

Service:

API Management

API-versie:

2021-08-01

Een lijst met alle diagnostische gegevens van het API Management service-exemplaar.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep.
serviceName	path	True	string	De naam van de API Management service. Regex-patroon: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
api-version	query	True	string	Versie van de API die moet worden gebruikt met de clientaanvraag.
$filter	query		string	| Veld | Gebruik | Ondersteunde operators | Ondersteunde functies | |-------------|-------------|-------------|-------------| | naam | filteren | ge, le, eq, ne, gt, lt | subtekenreeks, bevat, begintmet, eindigtmet |
$skip	query		integer int32	Aantal records dat moet worden overgeslagen.
$top	query		integer int32	Het aantal te retourneren records.

Antwoorden

Name	Type	Description
200 OK	DiagnosticCollection	Paged Resultaatantwoord van diagnostische gegevens.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

ApiManagementListDiagnostics

Voorbeeldaanvraag

HTTP

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

Java

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

Python

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

Go

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

JavaScript

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

dotnet

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

Voorbeeldrespons

Statuscode:

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
}

Definities

Name	Description
AlwaysLog	Hiermee geeft u op voor welk type berichten steekproefinstellingen niet van toepassing moeten zijn.
BodyDiagnosticSettings	Instellingen voor logboekregistratie van lichamen.
DataMasking
DataMaskingEntity
DataMaskingMode	Gegevensmaskeringsmodus.
DiagnosticCollection	Weergave van de diagnostische lijst met pagina's.
DiagnosticContract	Diagnostische gegevens.
ErrorFieldContract	Fout Veldcontract.
ErrorResponse	Foutreactie.
HttpCorrelationProtocol	Hiermee stelt u het correlatieprotocol in dat moet worden gebruikt voor diagnostische gegevens van Application Insights.
HttpMessageDiagnostic	Diagnostische instellingen voor HTTP-berichten.
OperationNameFormat	De indeling van de bewerkingsnaam voor Application Insights-telemetrieën. De standaardwaarde is Naam.
PipelineDiagnosticSettings	Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de gateway.
SamplingSettings	Steekproefinstellingen voor Diagnostische gegevens.
SamplingType	Steekproeftype.
Verbosity	Het uitgebreidheidsniveau dat wordt toegepast op traceringen die worden verzonden door traceringsbeleid.

AlwaysLog

Hiermee geeft u op voor welk type berichten steekproefinstellingen niet van toepassing moeten zijn.

Name	Type	Description
allErrors	string	Meld altijd alle onjuiste aanvragen, ongeacht de steekproefinstellingen.

BodyDiagnosticSettings

Instellingen voor logboekregistratie van lichamen.

Name	Type	Description
bytes	integer	Aantal bytes van de aanvraagbody dat moet worden geregistreerd.

DataMasking

Name	Type	Description
headers	DataMaskingEntity[]	Maskeringsinstellingen voor kopteksten
queryParams	DataMaskingEntity[]	Maskeringsinstellingen voor URL-queryparameters

DataMaskingEntity

Name	Type	Description
mode	DataMaskingMode	Gegevensmaskeringsmodus.
value	string	De naam van een entiteit die moet worden gemaskeerd (bijvoorbeeld een naam van een header of een queryparameter).

DataMaskingMode

Gegevensmaskeringsmodus.

Name	Type	Description
Hide	string	De aanwezigheid van een entiteit verbergen.
Mask	string	Masker de waarde van een entiteit.

DiagnosticCollection

Weergave van de diagnostische lijst met pagina's.

Name	Type	Description
count	integer	Totaal aantal records voor alle pagina's.
nextLink	string	Koppeling naar volgende pagina, indien aanwezig.
value	DiagnosticContract[]	Paginawaarden.

DiagnosticContract

Diagnostische gegevens.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.alwaysLog	AlwaysLog	Hiermee geeft u op voor welk type berichten steekproefinstellingen niet van toepassing moeten zijn.
properties.backend	PipelineDiagnosticSettings	Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de back-end
properties.frontend	PipelineDiagnosticSettings	Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de gateway.
properties.httpCorrelationProtocol	HttpCorrelationProtocol	Hiermee stelt u het correlatieprotocol in dat moet worden gebruikt voor diagnostische gegevens van Application Insights.
properties.logClientIp	boolean	Registreer de ClientIP. De standaardinstelling is onwaar.
properties.loggerId	string	Resource-id van een doellogboekregistratie.
properties.metrics	boolean	Aangepaste metrische gegevens verzenden via beleid voor metrische gegevens verzenden. Alleen van toepassing op diagnostische instellingen van Application Insights.
properties.operationNameFormat	OperationNameFormat	De indeling van de bewerkingsnaam voor Application Insights-telemetrieën. De standaardwaarde is Naam.
properties.sampling	SamplingSettings	Steekproefinstellingen voor Diagnostische gegevens.
properties.verbosity	Verbosity	Het uitgebreidheidsniveau dat wordt toegepast op traceringen die worden verzonden door traceringsbeleid.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

ErrorFieldContract

Fout Veldcontract.

Name	Type	Description
code	string	Foutcode op eigenschapsniveau.
message	string	Door mensen leesbare weergave van fout op eigenschapsniveau.
target	string	Naam van eigenschap.

ErrorResponse

Foutreactie.

Name	Type	Description
error.code	string	Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord.
error.details	ErrorFieldContract[]	De lijst met ongeldige velden verzenden in aanvraag, in het geval van een validatiefout.
error.message	string	Door mensen leesbare weergave van de fout.

HttpCorrelationProtocol

Hiermee stelt u het correlatieprotocol in dat moet worden gebruikt voor diagnostische gegevens van Application Insights.

Name	Type	Description
Legacy	string	Injecteer Request-Id en Request-Context headers met aanvraagcorrelatiegegevens. Zie https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.
None	string	Lees en injecteer geen correlatieheaders.
W3C	string	Contextheaders voor traceren injecteren. Zie https://w3c.github.io/trace-context.

HttpMessageDiagnostic

Diagnostische instellingen voor HTTP-berichten.

Name	Type	Description
body	BodyDiagnosticSettings	Instellingen voor logboekregistratie van lichamen.
dataMasking	DataMasking	Instellingen voor gegevensmaskering.
headers	string[]	Matrix van HTTP-headers om te registreren.

OperationNameFormat

De indeling van de bewerkingsnaam voor Application Insights-telemetrieën. De standaardwaarde is Naam.

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

PipelineDiagnosticSettings

Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de gateway.

Name	Type	Description
request	HttpMessageDiagnostic	Diagnostische instellingen voor aanvraag.
response	HttpMessageDiagnostic	Diagnostische instellingen voor antwoord.

SamplingSettings

Steekproefinstellingen voor Diagnostische gegevens.

Name	Type	Description
percentage	number	Frequentie van steekproeven voor steekproeven met vaste frequentie.
samplingType	SamplingType	Steekproeftype.

SamplingType

Steekproeftype.

Name	Type	Description
fixed	string	Steekproeven met vaste frequentie.

Verbosity

Het uitgebreidheidsniveau dat wordt toegepast op traceringen die worden verzonden door traceringsbeleid.

Name	Type	Description
error	string	Alleen traceringen met 'ernst' ingesteld op 'fout' worden verzonden naar de logboekregistratie die is gekoppeld aan dit diagnostische exemplaar.
information	string	Traceringen met 'ernst' ingesteld op 'information' en 'error' worden verzonden naar de logboekregistratie die is gekoppeld aan dit diagnostische exemplaar.
verbose	string	Alle traceringen die door traceringsbeleid worden verzonden, worden verzonden naar de logboekregistratie die is gekoppeld aan dit diagnostische exemplaar.