Diagnostic - Get

Odwołanie

Usługa:: API Management

Wersja interfejsu API:: 2022-08-01

Pobiera szczegóły diagnostyki określonej przez jej identyfikator.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
diagnosticId	path	True	string	Identyfikator diagnostyczny. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Wzorzec wyrażenia regularnego: `^[^*#&+:<>?]+$`
resourceGroupName	path	True	string	Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
serviceName	path	True	string	Nazwa usługi API Management. Wzorzec wyrażenia regularnego: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa

Typ

Opis

200 OK

DiagnosticContract

Treść odpowiedzi zawiera określoną jednostkę diagnostyczną.

Nagłówki

ETag: string

Other Status Codes

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ApiManagementGetDiagnostic

Przykładowe żądanie

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

/** 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

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

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

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

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

Przykładowa odpowiedź

Kod stanu:: 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
        }
      }
    }
  }
}

Definicje

Nazwa	Opis
AlwaysLog	Określa, jakiego typu ustawienia próbkowania komunikatów nie powinny być stosowane.
BodyDiagnosticSettings	Ustawienia rejestrowania treści.
DataMasking
DataMaskingEntity
DataMaskingMode	Tryb maskowania danych.
DiagnosticContract	Szczegóły diagnostyczne.
ErrorFieldContract	Błąd Kontrakt pola.
ErrorResponse	Odpowiedź na błąd.
HttpCorrelationProtocol	Ustawia protokół korelacji do użycia na potrzeby diagnostyki usługi Application Insights.
HttpMessageDiagnostic	Ustawienia diagnostyczne komunikatu HTTP.
OperationNameFormat	Format nazwy operacji dla telemetrii usługi Application Insights. Wartość domyślna to Nazwa.
PipelineDiagnosticSettings	Ustawienia diagnostyczne dla przychodzących/wychodzących komunikatów HTTP do bramy.
SamplingSettings	Ustawienia próbkowania dla diagnostyki.
SamplingType	Typ próbkowania.
Verbosity	Poziom szczegółowości stosowany do śladów emitowanych przez zasady śledzenia.

AlwaysLog

Określa, jakiego typu ustawienia próbkowania komunikatów nie powinny być stosowane.

Nazwa	Typ	Opis
allErrors	string	Zawsze rejestruj wszystkie błędne żądanie niezależnie od ustawień próbkowania.

BodyDiagnosticSettings

Ustawienia rejestrowania treści.

Nazwa	Typ	Opis
bytes	integer	Liczba bajtów treści żądania do zarejestrowania.

DataMasking

Nazwa	Typ	Opis
headers	DataMaskingEntity[]	Ustawienia maskowania nagłówków
queryParams	DataMaskingEntity[]	Ustawienia maskowania parametrów zapytania adresu URL

DataMaskingEntity

Nazwa	Typ	Opis
mode	DataMaskingMode	Tryb maskowania danych.
value	string	Nazwa jednostki do maskowania (np. nazwa nagłówka lub parametru zapytania).

DataMaskingMode

Tryb maskowania danych.

Nazwa	Typ	Opis
Hide	string	Ukryj obecność jednostki.
Mask	string	Maskuj wartość jednostki.

DiagnosticContract

Szczegóły diagnostyczne.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties.alwaysLog	AlwaysLog	Określa, jakiego typu ustawienia próbkowania komunikatów nie powinny być stosowane.
properties.backend	PipelineDiagnosticSettings	Ustawienia diagnostyczne dla przychodzących/wychodzących komunikatów HTTP do zaplecza
properties.frontend	PipelineDiagnosticSettings	Ustawienia diagnostyczne dla przychodzących/wychodzących komunikatów HTTP do bramy.
properties.httpCorrelationProtocol	HttpCorrelationProtocol	Ustawia protokół korelacji do użycia na potrzeby diagnostyki usługi Application Insights.
properties.logClientIp	boolean	Zarejestruj element ClientIP. Wartość domyślna to false.
properties.loggerId	string	Identyfikator zasobu docelowego rejestratora.
properties.metrics	boolean	Emituj metryki niestandardowe za pośrednictwem zasad emisji metryk. Dotyczy tylko ustawień diagnostycznych usługi Application Insights.
properties.operationNameFormat	OperationNameFormat	Format nazwy operacji dla telemetrii usługi Application Insights. Wartość domyślna to Nazwa.
properties.sampling	SamplingSettings	Ustawienia próbkowania dla diagnostyki.
properties.verbosity	Verbosity	Poziom szczegółowości stosowany do śladów emitowanych przez zasady śledzenia.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

ErrorFieldContract

Błąd Kontrakt pola.

Nazwa	Typ	Opis
code	string	Kod błędu poziomu właściwości.
message	string	Czytelna dla człowieka reprezentacja błędu na poziomie właściwości.
target	string	Nazwa właściwości.

ErrorResponse

Odpowiedź na błąd.

Nazwa	Typ	Opis
error.code	string	Kod błędu zdefiniowany przez usługę. Ten kod służy jako podstan kodu błędu HTTP określonego w odpowiedzi.
error.details	ErrorFieldContract[]	Lista nieprawidłowych pól jest wysyłana w żądaniu w przypadku błędu walidacji.
error.message	string	Czytelna dla człowieka reprezentacja błędu.

HttpCorrelationProtocol

Ustawia protokół korelacji do użycia na potrzeby diagnostyki usługi Application Insights.

Nazwa	Typ	Opis
Legacy	string	Wstrzykiwanie nagłówków Request-Id i Request-Context przy użyciu danych korelacji żądań. Zobacz: .
None	string	Nie należy odczytywać i wstrzykiwać nagłówków korelacji.
W3C	string	Wstrzykiwanie nagłówków kontekstu śledzenia. Zobacz: .

HttpMessageDiagnostic

Ustawienia diagnostyczne komunikatu HTTP.

Nazwa	Typ	Opis
body	BodyDiagnosticSettings	Ustawienia rejestrowania treści.
dataMasking	DataMasking	Ustawienia maskowania danych.
headers	string[]	Tablica nagłówków HTTP do rejestrowania.

OperationNameFormat

Format nazwy operacji dla telemetrii usługi Application Insights. Wartość domyślna to Nazwa.

Nazwa	Typ	Opis
Name	string	API_NAME; rev=API_REVISION — OPERATION_NAME
Url	string	HTTP_VERB URL

PipelineDiagnosticSettings

Ustawienia diagnostyczne dla przychodzących/wychodzących komunikatów HTTP do bramy.

Nazwa	Typ	Opis
request	HttpMessageDiagnostic	Ustawienia diagnostyczne dla żądania.
response	HttpMessageDiagnostic	Ustawienia diagnostyczne odpowiedzi.

SamplingSettings

Ustawienia próbkowania dla diagnostyki.

Nazwa	Typ	Opis
percentage	number	Częstotliwość próbkowania dla próbkowania o stałej szybkości.
samplingType	SamplingType	Typ próbkowania.

SamplingType

Typ próbkowania.

Nazwa	Typ	Opis
fixed	string	Próbkowanie o stałej szybkości.

Verbosity

Poziom szczegółowości stosowany do śladów emitowanych przez zasady śledzenia.

Nazwa	Typ	Opis
error	string	Tylko ślady o ważności ustawione na wartość "błąd" będą wysyłane do rejestratora dołączonego do tego wystąpienia diagnostycznego.
information	string	Ślady z ustawioną ważnością na "informacje" i "błąd" zostaną wysłane do rejestratora dołączonego do tego wystąpienia diagnostycznego.
verbose	string	Wszystkie ślady emitowane przez zasady śledzenia zostaną wysłane do rejestratora dołączonego do tego wystąpienia diagnostycznego.