Diagnostic - List By Service

リファレンス

Service:: API Management

API Version:: 2022-08-01

API Management サービスインスタンスのすべての診断を一覧表示します。

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

With optional parameters:

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースグループの名前。名前の大文字と小文字は区別されます。
serviceName	path	True	string	API Management サービスの名前。 Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	ターゲットサブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。
$filter	query		string	\|フィールド \|使用法 \|サポートされている演算子 \|サポートされている関数 \| \|-------------\|-------------\|-------------\|-------------\| \|name \|filter \|ge、le、eq、ne、gt、lt \|substringof、contains、startswith、endswith \|
$skip	query		integer int32	スキップするレコードの数。
$top	query		integer int32	返されるレコードの数。

応答

名前	型	説明
200 OK	DiagnosticCollection	診断の Paged Result 応答。
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

ApiManagementListDiagnostics

Sample Request

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

/** Samples for Diagnostic ListByService. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-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, 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_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/2022-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

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

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

Sample Response

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

定義

名前	説明
AlwaysLog	適用しないメッセージサンプリング設定の種類を指定します。
BodyDiagnosticSettings	本文ログの設定。
DataMasking
DataMaskingEntity
DataMaskingMode	データマスクモード。
DiagnosticCollection	ページ診断リストの表現。
DiagnosticContract	診断の詳細。
ErrorFieldContract	エラーフィールドコントラクト。
ErrorResponse	エラー応答。
HttpCorrelationProtocol	Application Insights 診断に使用する関連付けプロトコルを設定します。
HttpMessageDiagnostic	Http メッセージ診断設定。
OperationNameFormat	Application Insights テレメトリの操作名の形式。既定値は Name です。
PipelineDiagnosticSettings	ゲートウェイへの受信/送信 HTTP メッセージの診断設定。
SamplingSettings	診断のサンプリング設定。
SamplingType	サンプリングの種類。
Verbosity	トレースポリシーによって出力されるトレースに適用される詳細レベル。

AlwaysLog

適用しないメッセージサンプリング設定の種類を指定します。

名前	型	説明
allErrors	string	サンプリング設定に関係なく、常にすべての誤った要求をログに記録します。

BodyDiagnosticSettings

本文ログの設定。

名前	型	説明
bytes	integer	ログに記録する要求本文のバイト数。

DataMasking

名前	型	説明
headers	DataMaskingEntity[]	ヘッダーのマスク設定
queryParams	DataMaskingEntity[]	URL クエリパラメーターのマスク設定

DataMaskingEntity

名前	型	説明
mode	DataMaskingMode	データマスクモード。
value	string	マスクするエンティティの名前 (ヘッダーの名前やクエリパラメーターなど)。

DataMaskingMode

データマスクモード。

名前	型	説明
Hide	string	エンティティの存在を非表示にします。
Mask	string	エンティティの値をマスクします。

DiagnosticCollection

ページ診断リストの表現。

名前	型	説明
count	integer	すべてのページの合計レコード数。
nextLink	string	次のページリンク (存在する場合)。
value	DiagnosticContract[]	ページ値。

DiagnosticContract

診断の詳細。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /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	ターゲットロガーのリソース ID。
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

エラーフィールドコントラクト。

名前	型	説明
code	string	プロパティレベルのエラーコード。
message	string	プロパティレベルエラーの人間が判読できる表現。
target	string	プロパティ名。

ErrorResponse

エラー応答。

名前	型	説明
error.code	string	サービスによって定義されたエラーコード。このコードは、応答に指定された HTTP エラーコードのサブステータスとして機能します。
error.details	ErrorFieldContract[]	検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。
error.message	string	人が判読できるエラーの表現。

HttpCorrelationProtocol

Application Insights 診断に使用する関連付けプロトコルを設定します。

名前	型	説明
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 メッセージ診断設定。

名前	型	説明
body	BodyDiagnosticSettings	本文ログの設定。
dataMasking	DataMasking	データマスクの設定。
headers	string[]	ログに記録する HTTP ヘッダーの配列。

OperationNameFormat

Application Insights テレメトリの操作名の形式。既定値は Name です。

名前	型	説明
Name	string	API_NAME;rev=API_REVISION - OPERATION_NAME
Url	string	HTTP_VERB URL

PipelineDiagnosticSettings

ゲートウェイへの受信/送信 HTTP メッセージの診断設定。

名前	型	説明
request	HttpMessageDiagnostic	要求の診断設定。
response	HttpMessageDiagnostic	応答の診断設定。

SamplingSettings

診断のサンプリング設定。

名前	型	説明
percentage	number	固定レートサンプリングのサンプリングレート。
samplingType	SamplingType	サンプリングの種類。

SamplingType

サンプリングの種類。

名前	型	説明
fixed	string	固定レートサンプリング。

Verbosity

トレースポリシーによって出力されるトレースに適用される詳細レベル。

名前	型	説明
error	string	'severity' が 'error' に設定されているトレースのみが、この診断インスタンスにアタッチされたロガーに送信されます。
information	string	'severity' が 'information' と 'error' に設定されているトレースは、この診断インスタンスにアタッチされているロガーに送信されます。
verbose	string	トレースポリシーによって出力されるすべてのトレースは、この診断インスタンスにアタッチされているロガーに送信されます。

Diagnostic - List By Service

URI パラメーター

応答

セキュリティ

azure_auth

Scopes

例

ApiManagementListDiagnostics

Sample Request

Sample Response

定義

AlwaysLog

BodyDiagnosticSettings

DataMasking

DataMaskingEntity

DataMaskingMode

DiagnosticCollection

DiagnosticContract

ErrorFieldContract

ErrorResponse

HttpCorrelationProtocol

HttpMessageDiagnostic

OperationNameFormat

PipelineDiagnosticSettings

SamplingSettings

SamplingType

Verbosity

その他のリソース