Diagnostic - List By Service

Referência

Serviço:: API Management

Versão da API:: 2022-08-01

Lista todos os diagnósticos da instância do serviço de Gerenciamento de API.

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
serviceName	path	True	string	O nome do serviço Gerenciamento de API. Padrão Regex: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.
$filter	query		string	\| Campo \| Uso \| Operadores com suporte \| Funções com suporte \| \|-------------\|-------------\|-------------\|-------------\| \| name \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \|
$skip	query		integer int32	Número de registros a serem ignorados.
$top	query		integer int32	Número de registros a serem retornados.

Respostas

Nome	Tipo	Description
200 OK	DiagnosticCollection	Resposta de resultado paginada de diagnóstico.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ApiManagementListDiagnostics

Solicitação de exemplo

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

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/ApiManagementListDiagnostics.json
// this example is just showing the usage of "Diagnostic_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 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 and iterate over the result
await foreach (ApiManagementDiagnosticResource 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

Resposta de exemplo

Código de status:: 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
}

Definições

Nome	Description
AlwaysLog	Especifica para que tipo de mensagens as configurações de amostragem não devem ser aplicadas.
BodyDiagnosticSettings	Configurações de registro em log de corpo.
DataMasking
DataMaskingEntity
DataMaskingMode	Modo de mascaramento de dados.
DiagnosticCollection	Representação de lista de diagnóstico paginado.
DiagnosticContract	Detalhes do diagnóstico.
ErrorFieldContract	Contrato de campo de erro.
ErrorResponse	Resposta de erro.
HttpCorrelationProtocol	Define o protocolo de correlação a ser usado para o Application Insights diagnóstico.
HttpMessageDiagnostic	Configurações de diagnóstico de mensagem http.
OperationNameFormat	O formato do Nome da Operação para telemetrias do Application Insights. O padrão é Nome.
PipelineDiagnosticSettings	Configurações de diagnóstico para mensagens HTTP de entrada/saída para o Gateway.
SamplingSettings	Configurações de amostragem para Diagnóstico.
SamplingType	Tipo de amostragem.
Verbosity	O nível de detalhamento aplicado a rastreamentos emitidos por políticas de rastreamento.

AlwaysLog

Especifica para que tipo de mensagens as configurações de amostragem não devem ser aplicadas.

Nome	Tipo	Description
allErrors	string	Sempre registre todas as solicitações errôneas, independentemente das configurações de amostragem.

BodyDiagnosticSettings

Configurações de registro em log de corpo.

Nome	Tipo	Description
bytes	integer	Número de bytes do corpo da solicitação a serem registrados.

DataMasking

Nome	Tipo	Description
headers	DataMaskingEntity[]	Configurações de mascaramento para cabeçalhos
queryParams	DataMaskingEntity[]	Configurações de mascaramento para parâmetros de consulta url

DataMaskingEntity

Nome	Tipo	Description
mode	DataMaskingMode	Modo de mascaramento de dados.
value	string	O nome de uma entidade a ser mascarada (por exemplo, um nome de um cabeçalho ou um parâmetro de consulta).

DataMaskingMode

Modo de mascaramento de dados.

Nome	Tipo	Description
Hide	string	Ocultar a presença de uma entidade.
Mask	string	Mascarar o valor de uma entidade.

DiagnosticCollection

Representação de lista de diagnóstico paginado.

Nome	Tipo	Description
count	integer	Número total de contagem de registros em todas as páginas.
nextLink	string	Próximo link da página, se houver.
value	DiagnosticContract[]	Valores de página.

DiagnosticContract

Detalhes do diagnóstico.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.alwaysLog	AlwaysLog	Especifica para que tipo de mensagens as configurações de amostragem não devem ser aplicadas.
properties.backend	PipelineDiagnosticSettings	Configurações de diagnóstico para mensagens HTTP de entrada/saída para o back-end
properties.frontend	PipelineDiagnosticSettings	Configurações de diagnóstico para mensagens HTTP de entrada/saída para o Gateway.
properties.httpCorrelationProtocol	HttpCorrelationProtocol	Define o protocolo de correlação a ser usado para o Application Insights diagnóstico.
properties.logClientIp	boolean	Registre o ClientIP em log. O padrão é false.
properties.loggerId	string	ID de recurso de um agente de destino.
properties.metrics	boolean	Emita métricas personalizadas por meio da política de métrica de emissão. Aplicável somente às configurações de diagnóstico do Application Insights.
properties.operationNameFormat	OperationNameFormat	O formato do Nome da Operação para telemetrias do Application Insights. O padrão é Nome.
properties.sampling	SamplingSettings	Configurações de amostragem para Diagnóstico.
properties.verbosity	Verbosity	O nível de detalhamento aplicado a rastreamentos emitidos por políticas de rastreamento.
type	string	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ErrorFieldContract

Contrato de campo de erro.

Nome	Tipo	Description
code	string	Código de erro no nível da propriedade.
message	string	Representação legível por humanos do erro no nível da propriedade.
target	string	Nome da propriedade.

ErrorResponse

Resposta de erro.

Nome	Tipo	Description
error.code	string	Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta.
error.details	ErrorFieldContract[]	A lista de campos inválidos enviados na solicitação, em caso de erro de validação.
error.message	string	Representação legível ao olho humano do erro.

HttpCorrelationProtocol

Define o protocolo de correlação a ser usado para o Application Insights diagnóstico.

Nome	Tipo	Description
Legacy	string	Injete cabeçalhos de Request-Id e Request-Context com dados de correlação de solicitação. Consulte https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.
None	string	Não leia e injete cabeçalhos de correlação.
W3C	string	Injetar cabeçalhos de contexto de rastreamento. Consulte https://w3c.github.io/trace-context.

HttpMessageDiagnostic

Configurações de diagnóstico de mensagem http.

Nome	Tipo	Description
body	BodyDiagnosticSettings	Configurações de registro em log de corpo.
dataMasking	DataMasking	Configurações de mascaramento de dados.
headers	string[]	Matriz de cabeçalhos HTTP para registrar.

OperationNameFormat

O formato do Nome da Operação para telemetrias do Application Insights. O padrão é Nome.

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

PipelineDiagnosticSettings

Configurações de diagnóstico para mensagens HTTP de entrada/saída para o Gateway.

Nome	Tipo	Description
request	HttpMessageDiagnostic	Configurações de diagnóstico para solicitação.
response	HttpMessageDiagnostic	Configurações de diagnóstico para resposta.

SamplingSettings

Configurações de amostragem para Diagnóstico.

Nome	Tipo	Description
percentage	number	Taxa de amostragem para amostragem de taxa fixa.
samplingType	SamplingType	Tipo de amostragem.

SamplingType

Tipo de amostragem.

Nome	Tipo	Description
fixed	string	Amostragem de taxa fixa.

Verbosity

O nível de detalhamento aplicado a rastreamentos emitidos por políticas de rastreamento.

Nome	Tipo	Description
error	string	Somente rastreamentos com 'severidade' definido como 'error' serão enviados para o agente anexado a essa instância de diagnóstico.
information	string	Rastreamentos com 'severidade' definido como 'information' e 'error' serão enviados para o agente anexado a essa instância de diagnóstico.
verbose	string	Todos os rastreamentos emitidos pelas políticas de rastreamento serão enviados ao agente anexado a essa instância de diagnóstico.