Diagnostic - Get

服務:

API Management

API 版本:

2022-08-01

取得其識別碼所指定的診斷詳細數據。

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

URI 參數

名稱	位於	必要	類型	Description
diagnosticId	path	True	string	診斷標識碼。 目前 API 管理 服務實例中必須是唯一的。 Regex 模式: ^[^*#&+:<>?]+$
resourceGroupName	path	True	string	資源群組的名稱。 名稱不區分大小寫。
serviceName	path	True	string	API 管理 服務的名稱。 Regex 模式: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	用於此作業的 API 版本。

回應

名稱	類型	Description
200 OK	DiagnosticContract	響應主體包含指定的診斷實體。 標題 ETag: string
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

ApiManagementGetDiagnostic

範例要求

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

範例回覆

狀態碼:

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
        }
      }
    }
  }
}

定義

名稱	Description
AlwaysLog	指定不應該套用何種類型的訊息取樣設定。
BodyDiagnosticSettings	本文記錄設定。
DataMasking
DataMaskingEntity
DataMaskingMode	數據遮罩模式。
DiagnosticContract	診斷詳細數據。
ErrorFieldContract	錯誤欄位合約。
ErrorResponse	錯誤回應。
HttpCorrelationProtocol	設定要用於Application Insights診斷的相互關聯通訊協定。
HttpMessageDiagnostic	Http 訊息診斷設定。
OperationNameFormat	Application Insights 遙測的作業名稱格式。 預設值為 Name。
PipelineDiagnosticSettings	傳入/傳出 HTTP 訊息至閘道的診斷設定。
SamplingSettings	診斷的取樣設定。
SamplingType	取樣類型。
Verbosity	套用至追蹤原則所發出之追蹤的詳細資訊層級。

AlwaysLog

指定不應該套用何種類型的訊息取樣設定。

名稱	類型	Description
allErrors	string	不論取樣設定為何，一律記錄所有錯誤的要求。

BodyDiagnosticSettings

本文記錄設定。

名稱	類型	Description
bytes	integer	要記錄的要求本文字節數目。

DataMasking

名稱	類型	Description
headers	DataMaskingEntity[]	標頭的遮罩設定
queryParams	DataMaskingEntity[]	URL 查詢參數的遮罩設定

DataMaskingEntity

名稱	類型	Description
mode	DataMaskingMode	數據遮罩模式。
value	string	要遮罩 (實體的名稱，例如標頭的名稱或查詢參數) 。

DataMaskingMode

數據遮罩模式。

名稱	類型	Description
Hide	string	隱藏實體的存在。
Mask	string	遮罩實體的值。

DiagnosticContract

診斷詳細數據。

名稱	類型	Description
id	string	資源的完整資源識別碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	資源的名稱
properties.alwaysLog	AlwaysLog	指定不應該套用何種類型的訊息取樣設定。
properties.backend	PipelineDiagnosticSettings	連入/傳出 HTTP 訊息至後端的診斷設定
properties.frontend	PipelineDiagnosticSettings	傳入/傳出 HTTP 訊息至閘道的診斷設定。
properties.httpCorrelationProtocol	HttpCorrelationProtocol	設定要用於Application Insights診斷的相互關聯通訊協定。
properties.logClientIp	boolean	記錄 ClientIP。 預設值為 false。
properties.loggerId	string	目標記錄器的資源識別碼。
properties.metrics	boolean	透過發出計量原則發出自定義計量。 僅適用於 Application Insights 診斷設定。
properties.operationNameFormat	OperationNameFormat	Application Insights 遙測的作業名稱格式。 預設值為 Name。
properties.sampling	SamplingSettings	診斷的取樣設定。
properties.verbosity	Verbosity	套用至追蹤原則所發出之追蹤的詳細資訊層級。
type	string	資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

ErrorFieldContract

錯誤欄位合約。

名稱	類型	Description
code	string	屬性層級錯誤碼。
message	string	人類可讀取的屬性層級錯誤表示法。
target	string	屬性名稱。

ErrorResponse

錯誤回應。

名稱	類型	Description
error.code	string	服務定義的錯誤碼。 此代碼會作為回應中指定之 HTTP 錯誤碼的子狀態。
error.details	ErrorFieldContract[]	在驗證錯誤時，要求中傳送的無效欄位清單。
error.message	string	人類可閱讀的錯誤表示法。

HttpCorrelationProtocol

設定要用於Application Insights診斷的相互關聯通訊協定。

名稱	類型	Description
Legacy	string	使用要求相互關聯數據插入 Request-Id 和 Request-Context 標頭。 請參閱 https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md。
None	string	請勿讀取並插入相互關聯標頭。
W3C	string	插入追蹤內容標頭。 請參閱 https://w3c.github.io/trace-context。

HttpMessageDiagnostic

Http 訊息診斷設定。

名稱	類型	Description
body	BodyDiagnosticSettings	本文記錄設定。
dataMasking	DataMasking	數據遮罩設定。
headers	string[]	要記錄的 HTTP 標頭陣列。

OperationNameFormat

Application Insights 遙測的作業名稱格式。 預設值為 Name。

名稱	類型	Description
Name	string	API_NAME;rev=API_REVISION - OPERATION_NAME
Url	string	HTTP_VERB URL

PipelineDiagnosticSettings

傳入/傳出 HTTP 訊息至閘道的診斷設定。

名稱	類型	Description
request	HttpMessageDiagnostic	要求的診斷設定。
response	HttpMessageDiagnostic	回應的診斷設定。

SamplingSettings

診斷的取樣設定。

名稱	類型	Description
percentage	number	固定速率取樣的取樣率。
samplingType	SamplingType	取樣類型。

SamplingType

取樣類型。

名稱	類型	Description
fixed	string	固定速率取樣。

Verbosity

套用至追蹤原則所發出之追蹤的詳細資訊層級。

名稱	類型	Description
error	string	只有設定為 『error』 的追蹤才會傳送至附加至此診斷實例的記錄器。
information	string	將 『severity』 設定為 'information' 和 'error' 的追蹤會傳送至附加至此診斷實例的記錄器。
verbose	string	追蹤原則發出的所有追蹤都會傳送至附加至此診斷實例的記錄器。