Api Diagnostic - List By Service

Service:

API Management

API Version:

2021-08-01

Lists all diagnostics of an API.

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

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
apiId	path	True	string	API identifier. Must be unique in the current API Management service instance.
resourceGroupName	path	True	string	The name of the resource group.
serviceName	path	True	string	The name of the API Management service. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Version of the API to be used with the client request.
$filter	query		string	| Field | Usage | Supported operators | Supported functions | |-------------|-------------|-------------|-------------| | name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
$skip	query		integer int32	Number of records to skip.
$top	query		integer int32	Number of records to return.

Responses

Name	Type	Description
200 OK	DiagnosticCollection	Paged Result response of diagnostics for an API.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

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	impersonate your user account

Examples

ApiManagementListApiDiagnostics

Sample request

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for ApiDiagnostic ListByService. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListApiDiagnostics.json
     */
    /**
     * Sample code: ApiManagementListApiDiagnostics.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListApiDiagnostics(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.apiDiagnostics().listByService("rg1", "apimService1", "echo-api", null, null, null, 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_list_api_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.api_diagnostic.list_by_service(
        resource_group_name="rg1",
        service_name="apimService1",
        api_id="echo-api",
    )
    for item in response:
        print(item)


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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListApiDiagnostics.json
func ExampleAPIDiagnosticClient_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.NewAPIDiagnosticClient().NewListByServicePager("rg1", "apimService1", "echo-api", &armapimanagement.APIDiagnosticClientListByServiceOptions{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/apis/diagnostics"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/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 Lists all diagnostics of an API.
 *
 * @summary Lists all diagnostics of an API.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListApiDiagnostics.json
 */
async function apiManagementListApiDiagnostics() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const apiId = "echo-api";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.apiDiagnostic.listByService(
    resourceGroupName,
    serviceName,
    apiId
  )) {
    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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ApiManagement;
using Azure.ResourceManager.ApiManagement.Models;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListApiDiagnostics.json
// this example is just showing the usage of "ApiDiagnostic_ListByService" 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 ApiResource created on azure
// for more information of creating ApiResource, please refer to the document of ApiResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string apiId = "echo-api";
ResourceIdentifier apiResourceId = ApiResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, apiId);
ApiResource api = client.GetApiResource(apiResourceId);

// get the collection of this ApiDiagnosticResource
ApiDiagnosticCollection collection = api.GetApiDiagnostics();

// invoke the operation and iterate over the result
await foreach (ApiDiagnosticResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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/apis/echo-api/diagnostics/applicationinsights",
      "type": "Microsoft.ApiManagement/service/apis/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
            }
          }
        }
      }
    }
  ],
  "count": 1
}

Definitions

Name	Description
AlwaysLog	Specifies for what type of messages sampling settings should not apply.
BodyDiagnosticSettings	Body logging settings.
DataMasking
DataMaskingEntity
DataMaskingMode	Data masking mode.
DiagnosticCollection	Paged Diagnostic list representation.
DiagnosticContract	Diagnostic details.
ErrorFieldContract	Error Field contract.
ErrorResponse	Error Response.
HttpCorrelationProtocol	Sets correlation protocol to use for Application Insights diagnostics.
HttpMessageDiagnostic	Http message diagnostic settings.
OperationNameFormat	The format of the Operation Name for Application Insights telemetries. Default is Name.
PipelineDiagnosticSettings	Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
SamplingSettings	Sampling settings for Diagnostic.
SamplingType	Sampling type.
Verbosity	The verbosity level applied to traces emitted by trace policies.

AlwaysLog

Specifies for what type of messages sampling settings should not apply.

Name	Type	Description
allErrors	string	Always log all erroneous request regardless of sampling settings.

BodyDiagnosticSettings

Body logging settings.

Name	Type	Description
bytes	integer	Number of request body bytes to log.

DataMasking

Name	Type	Description
headers	DataMaskingEntity[]	Masking settings for headers
queryParams	DataMaskingEntity[]	Masking settings for Url query parameters

DataMaskingEntity

Name	Type	Description
mode	DataMaskingMode	Data masking mode.
value	string	The name of an entity to mask (e.g. a name of a header or a query parameter).

DataMaskingMode

Data masking mode.

Name	Type	Description
Hide	string	Hide the presence of an entity.
Mask	string	Mask the value of an entity.

DiagnosticCollection

Paged Diagnostic list representation.

Name	Type	Description
count	integer	Total record count number across all pages.
nextLink	string	Next page link if any.
value	DiagnosticContract[]	Page values.

DiagnosticContract

Diagnostic details.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.alwaysLog	AlwaysLog	Specifies for what type of messages sampling settings should not apply.
properties.backend	PipelineDiagnosticSettings	Diagnostic settings for incoming/outgoing HTTP messages to the Backend
properties.frontend	PipelineDiagnosticSettings	Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
properties.httpCorrelationProtocol	HttpCorrelationProtocol	Sets correlation protocol to use for Application Insights diagnostics.
properties.logClientIp	boolean	Log the ClientIP. Default is false.
properties.loggerId	string	Resource Id of a target logger.
properties.metrics	boolean	Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings.
properties.operationNameFormat	OperationNameFormat	The format of the Operation Name for Application Insights telemetries. Default is Name.
properties.sampling	SamplingSettings	Sampling settings for Diagnostic.
properties.verbosity	Verbosity	The verbosity level applied to traces emitted by trace policies.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ErrorFieldContract

Error Field contract.

Name	Type	Description
code	string	Property level error code.
message	string	Human-readable representation of property-level error.
target	string	Property name.

ErrorResponse

Error Response.

Name	Type	Description
error.code	string	Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
error.details	ErrorFieldContract[]	The list of invalid fields send in request, in case of validation error.
error.message	string	Human-readable representation of the error.

HttpCorrelationProtocol

Sets correlation protocol to use for Application Insights diagnostics.

Name	Type	Description
Legacy	string	Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.
None	string	Do not read and inject correlation headers.
W3C	string	Inject Trace Context headers. See https://w3c.github.io/trace-context.

HttpMessageDiagnostic

Http message diagnostic settings.

Name	Type	Description
body	BodyDiagnosticSettings	Body logging settings.
dataMasking	DataMasking	Data masking settings.
headers	string[]	Array of HTTP Headers to log.

OperationNameFormat

The format of the Operation Name for Application Insights telemetries. Default is Name.

Name	Type	Description
Name	string	API_NAME;rev=API_REVISION - OPERATION_NAME
Url	string	HTTP_VERB URL

PipelineDiagnosticSettings

Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.

Name	Type	Description
request	HttpMessageDiagnostic	Diagnostic settings for request.
response	HttpMessageDiagnostic	Diagnostic settings for response.

SamplingSettings

Sampling settings for Diagnostic.

Name	Type	Description
percentage	number	Rate of sampling for fixed-rate sampling.
samplingType	SamplingType	Sampling type.

SamplingType

Sampling type.

Name	Type	Description
fixed	string	Fixed-rate sampling.

Verbosity

The verbosity level applied to traces emitted by trace policies.

Name	Type	Description
error	string	Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance.
information	string	Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance.
verbose	string	All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance.