Diagnostic Settings Category - List

Service:

Monitor

API Version:

2021-05-01-preview

指定したリソースの診断設定カテゴリをListsします。

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

URI パラメーター

名前	/	必須	型	説明
resourceUri	path	True	string	リソースの識別子。
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	DiagnosticSettingsCategoryResourceCollection	診断設定カテゴリに関する詳細情報を取得するための要求が成功しました
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	ユーザー アカウントの借用

例

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

定義

名前	説明
categoryType	診断設定カテゴリの種類。
createdByType	リソースを作成した ID の種類。
DiagnosticSettingsCategoryResource	診断設定カテゴリ リソース。
DiagnosticSettingsCategoryResourceCollection	診断設定カテゴリ リソースのコレクションを表します。
ErrorResponse	エラー応答の形式について説明します。
systemData	リソースの作成と最後の変更に関連するメタデータ。

categoryType

診断設定カテゴリの種類。

名前	型	説明
Logs	string
Metrics	string

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

DiagnosticSettingsCategoryResource

診断設定カテゴリ リソース。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.categoryGroups	string[]	サポートされているカテゴリ グループのコレクション。
properties.categoryType	categoryType	診断設定カテゴリの種類。
systemData	systemData	このリソースに関連するシステム メタデータ。
type	string	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

DiagnosticSettingsCategoryResourceCollection

診断設定カテゴリ リソースのコレクションを表します。

名前	型	説明
value	DiagnosticSettingsCategoryResource[]	診断設定カテゴリ リソースのコレクション。

ErrorResponse

エラー応答の形式について説明します。

名前	型	説明
code	string	エラー コード
message	string	操作が失敗した理由を示すエラー メッセージ。

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。