Diagnostic - Get

Başvuru

Service:: API Management

API Version:: 2022-08-01

Tanımlayıcısı tarafından belirtilen Tanılamanın ayrıntılarını alır.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
diagnosticId	path	True	string	Tanılama tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Regex pattern: `^[^*#&+:<>?]+$`
resourceGroupName	path	True	string	Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir.
serviceName	path	True	string	API Management hizmetinin adı. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	Hedef aboneliğin kimliği.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	DiagnosticContract	Yanıt gövdesi belirtilen Tanılama varlığını içerir. Headers ETag: string
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Name

Tür

Description

200 OK

DiagnosticContract

Yanıt gövdesi belirtilen Tanılama varlığını içerir.

Headers

ETag: string

Other Status Codes

ErrorResponse

İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

ApiManagementGetDiagnostic

Sample Request

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

Sample Response

Status code:: 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
        }
      }
    }
  }
}

Tanımlar

Name	Description
AlwaysLog	Ne tür iletiler örnekleme ayarlarının uygulanmaması gerektiğini belirtir.
BodyDiagnosticSettings	Gövde günlüğü ayarları.
DataMasking
DataMaskingEntity
DataMaskingMode	Veri maskeleme modu.
DiagnosticContract	Tanılama ayrıntıları.
ErrorFieldContract	Hata Alanı sözleşmesi.
ErrorResponse	Hata Yanıtı.
HttpCorrelationProtocol	Application Insights tanılaması için kullanılacak bağıntı protokollerini ayarlar.
HttpMessageDiagnostic	Http iletisi tanılama ayarları.
OperationNameFormat	Application Insights telemetrileri için İşlem Adı biçimi. Varsayılan Ad'dır.
PipelineDiagnosticSettings	Ağ geçidine gelen/giden HTTP iletileri için tanılama ayarları.
SamplingSettings	Tanılama için örnekleme ayarları.
SamplingType	Örnekleme türü.
Verbosity	İzleme ilkeleri tarafından yayılan izlemelere uygulanan ayrıntı düzeyi.

AlwaysLog

Ne tür iletiler örnekleme ayarlarının uygulanmaması gerektiğini belirtir.

Name	Tür	Description
allErrors	string	Örnekleme ayarlarından bağımsız olarak her zaman tüm hatalı istekleri günlüğe kaydeder.

BodyDiagnosticSettings

Gövde günlüğü ayarları.

Name	Tür	Description
bytes	integer	Günlüğe kaydedilecek istek gövdesi bayt sayısı.

DataMasking

Name	Tür	Description
headers	DataMaskingEntity[]	Üst bilgiler için maskeleme ayarları
queryParams	DataMaskingEntity[]	Url sorgu parametreleri için maskeleme ayarları

DataMaskingEntity

Name	Tür	Description
mode	DataMaskingMode	Veri maskeleme modu.
value	string	Maskeleneceği varlığın adı (örneğin, bir üst bilgi veya sorgu parametresinin adı).

DataMaskingMode

Veri maskeleme modu.

Name	Tür	Description
Hide	string	Varlığın varlığını gizleme.
Mask	string	Bir varlığın değerini maskeler.

DiagnosticContract

Tanılama ayrıntıları.

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Kaynağın adı
properties.alwaysLog	AlwaysLog	Ne tür iletiler örnekleme ayarlarının uygulanmaması gerektiğini belirtir.
properties.backend	PipelineDiagnosticSettings	Arka uçtan gelen/giden HTTP iletileri için tanılama ayarları
properties.frontend	PipelineDiagnosticSettings	Ağ geçidine gelen/giden HTTP iletileri için tanılama ayarları.
properties.httpCorrelationProtocol	HttpCorrelationProtocol	Application Insights tanılaması için kullanılacak bağıntı protokollerini ayarlar.
properties.logClientIp	boolean	ClientIP'yi günlüğe kaydetme. Varsayılan değer false’tur.
properties.loggerId	string	Hedef günlükçü kaynak kimliği.
properties.metrics	boolean	Emit-metric ilkesi aracılığıyla özel ölçümleri yayma. Yalnızca Application Insights tanılama ayarları için geçerlidir.
properties.operationNameFormat	OperationNameFormat	Application Insights telemetrileri için İşlem Adı biçimi. Varsayılan Ad'dır.
properties.sampling	SamplingSettings	Tanılama için örnekleme ayarları.
properties.verbosity	Verbosity	İzleme ilkeleri tarafından yayılan izlemelere uygulanan ayrıntı düzeyi.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

ErrorFieldContract

Hata Alanı sözleşmesi.

Name	Tür	Description
code	string	Özellik düzeyi hata kodu.
message	string	Özellik düzeyi hatanın insan tarafından okunabilir gösterimi.
target	string	Özellik adı.

ErrorResponse

Hata Yanıtı.

Name	Tür	Description
error.code	string	Hizmet tanımlı hata kodu. Bu kod, yanıtta belirtilen HTTP hata kodu için bir alt durum görevi görür.
error.details	ErrorFieldContract[]	Doğrulama hatası durumunda istekte gönderilen geçersiz alanların listesi.
error.message	string	Hatanın insan tarafından okunabilir gösterimi.

HttpCorrelationProtocol

Application Insights tanılaması için kullanılacak bağıntı protokollerini ayarlar.

Name	Tür	Description
Legacy	string	İstek bağıntı verileriyle Request-Id ve Request-Context üst bilgilerini ekleyin. Bkz. https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.
None	string	Bağıntı üst bilgilerini okumayın ve eklemeyin.
W3C	string	İzleme Bağlamı üst bilgilerini ekleme. Bkz. https://w3c.github.io/trace-context.

HttpMessageDiagnostic

Http iletisi tanılama ayarları.

Name	Tür	Description
body	BodyDiagnosticSettings	Gövde günlüğü ayarları.
dataMasking	DataMasking	Veri maskeleme ayarları.
headers	string[]	Günlüğe kaydedilecek HTTP Üst Bilgileri dizisi.

OperationNameFormat

Application Insights telemetrileri için İşlem Adı biçimi. Varsayılan Ad'dır.

Name	Tür	Description
Name	string	API_NAME; rev=API_REVISION - OPERATION_NAME
Url	string	HTTP_VERB URL'si

PipelineDiagnosticSettings

Ağ geçidine gelen/giden HTTP iletileri için tanılama ayarları.

Name	Tür	Description
request	HttpMessageDiagnostic	İstek için tanılama ayarları.
response	HttpMessageDiagnostic	Yanıt için tanılama ayarları.

SamplingSettings

Tanılama için örnekleme ayarları.

Name	Tür	Description
percentage	number	Sabit hızlı örnekleme için örnekleme oranı.
samplingType	SamplingType	Örnekleme türü.

SamplingType

Örnekleme türü.

Name	Tür	Description
fixed	string	Sabit hızlı örnekleme.

Verbosity

İzleme ilkeleri tarafından yayılan izlemelere uygulanan ayrıntı düzeyi.

Name	Tür	Description
error	string	Yalnızca 'önem derecesi' 'error' olarak ayarlanmış izlemeler bu tanılama örneğine bağlı günlükçüye gönderilir.
information	string	'Önem derecesi' 'information' ve 'error' olarak ayarlanmış izlemeler, bu tanılama örneğine bağlı günlükçüye gönderilir.
verbose	string	İzleme ilkeleri tarafından yayılan tüm izlemeler bu tanılama örneğine bağlı günlükçüye gönderilir.

Diagnostic - Get

URI Parametreleri

Yanıtlar

Güvenlik

azure_auth

Scopes

Örnekler

ApiManagementGetDiagnostic

Sample Request

Sample Response

Tanımlar

AlwaysLog

BodyDiagnosticSettings

DataMasking

DataMaskingEntity

DataMaskingMode

DiagnosticContract

ErrorFieldContract

ErrorResponse

HttpCorrelationProtocol

HttpMessageDiagnostic

OperationNameFormat

PipelineDiagnosticSettings

SamplingSettings

SamplingType

Verbosity

Ek kaynaklar