Diagnostic - Get

Dienst:

API Management

API-Version:

2022-08-01

Ruft die Details der Diagnose ab, die durch den Bezeichner angegeben wird.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
diagnosticId	path	True	string	Diagnosebezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein. RegEx-Muster: ^[^*#&+:<>?]+$
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string	Der Name des API Management-Diensts. RegEx-Muster: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	DiagnosticContract	Der Antworttext enthält die angegebene Diagnoseentität. Header ETag: string
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

ApiManagementGetDiagnostic

Beispielanforderung

HTTP

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

Java

/** Samples for Diagnostic Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetDiagnostic.json
     */
    /**
     * Sample code: ApiManagementGetDiagnostic.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementGetDiagnostic(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .diagnostics()
            .getWithResponse("rg1", "apimService1", "applicationinsights", com.azure.core.util.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_get_diagnostic.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.get(
        resource_group_name="rg1",
        service_name="apimService1",
        diagnostic_id="applicationinsights",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetDiagnostic.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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetDiagnostic.json
func ExampleDiagnosticClient_Get() {
	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)
	}
	res, err := clientFactory.NewDiagnosticClient().Get(ctx, "rg1", "apimService1", "applicationinsights", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DiagnosticContract = 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](100),
	// 				},
	// 				Headers: []*string{
	// 				},
	// 			},
	// 			Request: &armapimanagement.HTTPMessageDiagnostic{
	// 				Body: &armapimanagement.BodyDiagnosticSettings{
	// 					Bytes: to.Ptr[int32](100),
	// 				},
	// 				Headers: []*string{
	// 				},
	// 			},
	// 		},
	// 		Frontend: &armapimanagement.PipelineDiagnosticSettings{
	// 			Response: &armapimanagement.HTTPMessageDiagnostic{
	// 				Body: &armapimanagement.BodyDiagnosticSettings{
	// 					Bytes: to.Ptr[int32](100),
	// 				},
	// 				Headers: []*string{
	// 				},
	// 			},
	// 			Request: &armapimanagement.HTTPMessageDiagnostic{
	// 				Body: &armapimanagement.BodyDiagnosticSettings{
	// 					Bytes: to.Ptr[int32](100),
	// 				},
	// 				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),
	// 		},
	// 	},
	// }
}

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 Gets the details of the Diagnostic specified by its identifier.
 *
 * @summary Gets the details of the Diagnostic specified by its identifier.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetDiagnostic.json
 */
async function apiManagementGetDiagnostic() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const diagnosticId = "applicationinsights";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.diagnostic.get(resourceGroupName, serviceName, diagnosticId);
  console.log(result);
}

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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetDiagnostic.json
// this example is just showing the usage of "Diagnostic_Get" 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
string diagnosticId = "applicationinsights";
NullableResponse<ApiManagementDiagnosticResource> response = await collection.GetIfExistsAsync(diagnosticId);
ApiManagementDiagnosticResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // the variable result 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 = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Beispiel für eine Antwort

Statuscode:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights",
  "type": "Microsoft.ApiManagement/service/diagnostics",
  "name": "applicationinsights",
  "properties": {
    "alwaysLog": "allErrors",
    "httpCorrelationProtocol": "Legacy",
    "logClientIp": true,
    "loggerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest",
    "sampling": {
      "samplingType": "fixed",
      "percentage": 100
    },
    "frontend": {
      "request": {
        "headers": [],
        "body": {
          "bytes": 100
        }
      },
      "response": {
        "headers": [],
        "body": {
          "bytes": 100
        }
      }
    },
    "backend": {
      "request": {
        "headers": [],
        "body": {
          "bytes": 100
        }
      },
      "response": {
        "headers": [],
        "body": {
          "bytes": 100
        }
      }
    }
  }
}

Definitionen

Name	Beschreibung
AlwaysLog	Gibt an, für welchen Typ von Nachrichten Samplingeinstellungen nicht gelten sollen.
BodyDiagnosticSettings	Einstellungen für die Textprotokollierung.
DataMasking
DataMaskingEntity
DataMaskingMode	Datenmaskierungsmodus.
DiagnosticContract	Diagnosedetails.
ErrorFieldContract	Fehlerfeldvertrag.
ErrorResponse	Fehlerantwort.
HttpCorrelationProtocol	Legt das Korrelationsprotokoll fest, das für Application Insights Diagnose verwendet werden soll.
HttpMessageDiagnostic	Diagnoseeinstellungen für HTTP-Nachrichten.
OperationNameFormat	Das Format des Vorgangsnamens für Application Insights-Telemetriedaten. Der Standardwert ist Name.
PipelineDiagnosticSettings	Diagnoseeinstellungen für eingehende/ausgehende HTTP-Nachrichten an das Gateway.
SamplingSettings	Samplingeinstellungen für Diagnose.
SamplingType	Stichprobentyp.
Verbosity	Die Ausführlichkeitsebene, die auf Ablaufverfolgungen angewendet wird, die von Ablaufverfolgungsrichtlinien ausgegeben werden.

AlwaysLog

Gibt an, für welchen Typ von Nachrichten Samplingeinstellungen nicht gelten sollen.

Name	Typ	Beschreibung
allErrors	string	Protokollieren Sie immer alle fehlerhaften Anforderungen unabhängig von den Samplingeinstellungen.

BodyDiagnosticSettings

Einstellungen für die Textprotokollierung.

Name	Typ	Beschreibung
bytes	integer	Anzahl der zu protokollierenden Anforderungstextbytes.

DataMasking

Name	Typ	Beschreibung
headers	DataMaskingEntity[]	Maskierungseinstellungen für Kopfzeilen
queryParams	DataMaskingEntity[]	Maskierungseinstellungen für URL-Abfrageparameter

DataMaskingEntity

Name	Typ	Beschreibung
mode	DataMaskingMode	Datenmaskierungsmodus.
value	string	Der Name einer zu maskierenden Entität (z. B. ein Name eines Headers oder eines Abfrageparameters).

DataMaskingMode

Datenmaskierungsmodus.

Name	Typ	Beschreibung
Hide	string	Blenden Sie das Vorhandensein einer Entität aus.
Mask	string	Maskierung des Werts einer Entität.

DiagnosticContract

Diagnosedetails.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.alwaysLog	AlwaysLog	Gibt an, für welchen Typ von Nachrichten Samplingeinstellungen nicht gelten sollen.
properties.backend	PipelineDiagnosticSettings	Diagnoseeinstellungen für eingehende/ausgehende HTTP-Nachrichten an das Back-End
properties.frontend	PipelineDiagnosticSettings	Diagnoseeinstellungen für eingehende/ausgehende HTTP-Nachrichten an das Gateway.
properties.httpCorrelationProtocol	HttpCorrelationProtocol	Legt das Korrelationsprotokoll fest, das für Application Insights Diagnose verwendet werden soll.
properties.logClientIp	boolean	Protokollieren Sie die ClientIP. Der Standardwert ist "false".
properties.loggerId	string	Ressourcen-ID einer Zielprotokollierung.
properties.metrics	boolean	Geben Sie benutzerdefinierte Metriken über eine emit-Metrikrichtlinie aus. Gilt nur für Application Insights-Diagnoseeinstellungen.
properties.operationNameFormat	OperationNameFormat	Das Format des Vorgangsnamens für Application Insights-Telemetriedaten. Der Standardwert ist Name.
properties.sampling	SamplingSettings	Samplingeinstellungen für Diagnose.
properties.verbosity	Verbosity	Die Ausführlichkeitsebene, die auf Ablaufverfolgungen angewendet wird, die von Ablaufverfolgungsrichtlinien ausgegeben werden.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ErrorFieldContract

Fehlerfeldvertrag.

Name	Typ	Beschreibung
code	string	Fehlercode auf Eigenschaftsebene.
message	string	Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene.
target	string	Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
error.code	string	Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.
error.details	ErrorFieldContract[]	Die Liste der ungültigen Felder, die im Falle eines Überprüfungsfehlers gesendet werden.
error.message	string	Lesbare Darstellung des Fehlers.

HttpCorrelationProtocol

Legt das Korrelationsprotokoll fest, das für Application Insights Diagnose verwendet werden soll.

Name	Typ	Beschreibung
Legacy	string	Fügen Sie Request-Id- und Request-Context-Header mit Anforderungskorrelationsdaten ein. Siehe https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.
None	string	Lesen und einfügen Sie keine Korrelationsheader.
W3C	string	Einfügen von Ablaufverfolgungskontextheadern. Siehe https://w3c.github.io/trace-context.

HttpMessageDiagnostic

Diagnoseeinstellungen für HTTP-Nachrichten.

Name	Typ	Beschreibung
body	BodyDiagnosticSettings	Einstellungen für die Textprotokollierung.
dataMasking	DataMasking	Datenmaskierungseinstellungen.
headers	string[]	Array von zu protokollierenden HTTP-Headern.

OperationNameFormat

Das Format des Vorgangsnamens für Application Insights-Telemetriedaten. Der Standardwert ist Name.

Name	Typ	Beschreibung
Name	string	API_NAME; rev=API_REVISION – OPERATION_NAME
Url	string	HTTP_VERB URL

PipelineDiagnosticSettings

Diagnoseeinstellungen für eingehende/ausgehende HTTP-Nachrichten an das Gateway.

Name	Typ	Beschreibung
request	HttpMessageDiagnostic	Diagnoseeinstellungen für die Anforderung.
response	HttpMessageDiagnostic	Diagnoseeinstellungen für die Antwort.

SamplingSettings

Samplingeinstellungen für Diagnose.

Name	Typ	Beschreibung
percentage	number	Stichprobenrate für Stichprobenentnahme mit fester Rate.
samplingType	SamplingType	Stichprobentyp.

SamplingType

Stichprobentyp.

Name	Typ	Beschreibung
fixed	string	Stichprobenentnahme mit fester Rate.

Verbosity

Die Ausführlichkeitsebene, die auf Ablaufverfolgungen angewendet wird, die von Ablaufverfolgungsrichtlinien ausgegeben werden.

Name	Typ	Beschreibung
error	string	Nur Ablaufverfolgungen, deren Schweregrad auf "Fehler" festgelegt ist, werden an die Protokollierung gesendet, die dieser Diagnose-instance zugeordnet ist.
information	string	Ablaufverfolgungen, deren Schweregrad auf "Informationen" und "Fehler" festgelegt ist, werden an die Protokollierung gesendet, die diesem Diagnose-instance zugeordnet ist.
verbose	string	Alle Ablaufverfolgungen, die von Ablaufverfolgungsrichtlinien ausgegeben werden, werden an die Protokollierung gesendet, die dieser Diagnose-instance angefügt ist.