Diagnostic Settings Category - List

Service:

Monitor

API Version:

2021-05-01-preview

Listas as categorias de configurações de diagnóstico para o recurso especificado.

GET https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/diagnosticSettingsCategories?api-version=2021-05-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceUri	path	True	string	O identificador do recurso.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	DiagnosticSettingsCategoryResourceCollection	Solicitação bem-sucedida para obter mais informações sobre a categoria de configuração de diagnóstico
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Gets the diagnostic setting

Sample Request

HTTP

GET https://management.azure.com/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/Microsoft.Insights/diagnosticSettingsCategories?api-version=2021-05-01-preview

Java

/**
 * Samples for DiagnosticSettingsCategory List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/
     * listDiagnosticSettingsCategories.json
     */
    /**
     * Sample code: Gets the diagnostic setting.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getsTheDiagnosticSetting(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.diagnosticSettings().manager().serviceClient().getDiagnosticSettingsCategories().list(
            "subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6",
            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

Go

package armmonitor_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/monitor/armmonitor"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/969fd0c2634fbcc1975d7abe3749330a5145a97c/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/listDiagnosticSettingsCategories.json
func ExampleDiagnosticSettingsCategoryClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmonitor.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewDiagnosticSettingsCategoryClient().NewListPager("subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6", 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.DiagnosticSettingsCategoryResourceCollection = armmonitor.DiagnosticSettingsCategoryResourceCollection{
		// 	Value: []*armmonitor.DiagnosticSettingsCategoryResource{
		// 		{
		// 			Name: to.Ptr("WorkflowRuntime"),
		// 			Type: to.Ptr("microsoft.insights/diagnosticSettingsCategories"),
		// 			ID: to.Ptr("/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/microsoft.insights/diagnosticSettingsCategories/WorkflowRuntime"),
		// 			Properties: &armmonitor.DiagnosticSettingsCategory{
		// 				CategoryGroups: []*string{
		// 					to.Ptr("allLogs")},
		// 					CategoryType: to.Ptr(armmonitor.CategoryTypeLogs),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("WorkflowMetric"),
		// 				Type: to.Ptr("microsoft.insights/diagnosticSettingsCategories"),
		// 				ID: to.Ptr("/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/microsoft.insights/diagnosticSettingsCategories/WorkflowMetric"),
		// 				Properties: &armmonitor.DiagnosticSettingsCategory{
		// 					CategoryType: to.Ptr(armmonitor.CategoryTypeMetrics),
		// 				},
		// 		}},
		// 	}
	}
}

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 { MonitorClient } = require("@azure/arm-monitor");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists the diagnostic settings categories for the specified resource.
 *
 * @summary Lists the diagnostic settings categories for the specified resource.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/listDiagnosticSettingsCategories.json
 */
async function getsTheDiagnosticSetting() {
  const resourceUri =
    "subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6";
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential);
  const resArray = new Array();
  for await (let item of client.diagnosticSettingsCategory.list(resourceUri)) {
    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.Monitor;

// Generated from example definition: specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/listDiagnosticSettingsCategories.json
// this example is just showing the usage of "DiagnosticSettingsCategory_List" 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 ArmResource created on azure
// for more information of creating ArmResource, please refer to the document of ArmResource

// get the collection of this DiagnosticSettingsCategoryResource
string resourceUri = "subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6";
ResourceIdentifier scopeId = new ResourceIdentifier(string.Format("/{0}", resourceUri));
DiagnosticSettingsCategoryCollection collection = client.GetDiagnosticSettingsCategories(scopeId);

// invoke the operation and iterate over the result
await foreach (DiagnosticSettingsCategoryResource 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
    DiagnosticSettingsCategoryData 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/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/microsoft.insights/diagnosticSettingsCategories/WorkflowRuntime",
      "type": "microsoft.insights/diagnosticSettingsCategories",
      "name": "WorkflowRuntime",
      "properties": {
        "categoryType": "Logs",
        "categoryGroups": [
          "allLogs"
        ]
      }
    },
    {
      "id": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/microsoft.insights/diagnosticSettingsCategories/WorkflowMetric",
      "type": "microsoft.insights/diagnosticSettingsCategories",
      "name": "WorkflowMetric",
      "properties": {
        "categoryType": "Metrics"
      }
    }
  ]
}

Definições

Nome	Description
categoryType	O tipo da categoria de configurações de diagnóstico.
createdByType	O tipo de identidade que criou o recurso.
DiagnosticSettingsCategoryResource	O recurso de categoria de configurações de diagnóstico.
DiagnosticSettingsCategoryResourceCollection	Representa uma coleção de recursos de categoria de configuração de diagnóstico.
ErrorResponse	Descreve o formato da resposta de erro.
systemData	Metadados relativos à criação e à última modificação do recurso.

categoryType

O tipo da categoria de configurações de diagnóstico.

Nome	Tipo	Description
Logs	string
Metrics	string

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DiagnosticSettingsCategoryResource

O recurso de categoria de configurações de 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.categoryGroups	string[]	a coleção de quais grupos de categorias têm suporte.
properties.categoryType	categoryType	O tipo da categoria de configurações de diagnóstico.
systemData	systemData	Os metadados do sistema relacionados a esse recurso.
type	string	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

DiagnosticSettingsCategoryResourceCollection

Representa uma coleção de recursos de categoria de configuração de diagnóstico.

Nome	Tipo	Description
value	DiagnosticSettingsCategoryResource[]	A coleção de recursos de categoria de configurações de diagnóstico.

ErrorResponse

Descreve o formato da resposta de erro.

Nome	Tipo	Description
code	string	Código do erro
message	string	Mensagem de erro indicando por que a operação falhou.

systemData

Metadados relativos à criação e à última modificação do recurso.

Nome	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.