Log Profiles - List

Service:

Monitor

API Version:

2016-03-01

ログ プロファイルを一覧表示します。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/logprofiles?api-version=2016-03-01

URI パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string	ターゲット サブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	LogProfileCollection	ログ プロファイルを一覧表示する要求が成功しました

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

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

例

List log profiles

Sample Request

HTTP

GET https://management.azure.com/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/providers/Microsoft.Insights/logprofiles?api-version=2016-03-01

Java

/**
 * Samples for LogProfiles List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/listLogProfile.json
     */
    /**
     * Sample code: List log profiles.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listLogProfiles(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.diagnosticSettings().manager().serviceClient().getLogProfiles().list(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/stable/2016-03-01/examples/listLogProfile.json
func ExampleLogProfilesClient_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.NewLogProfilesClient().NewListPager(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.LogProfileCollection = armmonitor.LogProfileCollection{
		// 	Value: []*armmonitor.LogProfileResource{
		// 		{
		// 			Name: to.Ptr("default"),
		// 			Type: to.Ptr(""),
		// 			ID: to.Ptr("/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/providers/microsoft.insights/logprofiles/default"),
		// 			Location: to.Ptr(""),
		// 			Properties: &armmonitor.LogProfileProperties{
		// 				Categories: []*string{
		// 					to.Ptr("Delete"),
		// 					to.Ptr("Write"),
		// 					to.Ptr("Action")},
		// 					Locations: []*string{
		// 						to.Ptr("global")},
		// 						RetentionPolicy: &armmonitor.RetentionPolicy{
		// 							Days: to.Ptr[int32](3),
		// 							Enabled: to.Ptr(true),
		// 						},
		// 						ServiceBusRuleID: to.Ptr(""),
		// 						StorageAccountID: to.Ptr("/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/JohnKemTest/providers/Microsoft.Storage/storageAccounts/johnkemtest8162"),
		// 					},
		// 				},
		// 				{
		// 					Name: to.Ptr("default2"),
		// 					Type: to.Ptr(""),
		// 					ID: to.Ptr("/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/providers/microsoft.insights/logprofiles/default2"),
		// 					Location: to.Ptr(""),
		// 					Properties: &armmonitor.LogProfileProperties{
		// 						Categories: []*string{
		// 							to.Ptr("Delete"),
		// 							to.Ptr("Write"),
		// 							to.Ptr("Action")},
		// 							Locations: []*string{
		// 								to.Ptr("global")},
		// 								RetentionPolicy: &armmonitor.RetentionPolicy{
		// 									Days: to.Ptr[int32](15),
		// 									Enabled: to.Ptr(true),
		// 								},
		// 								ServiceBusRuleID: to.Ptr(""),
		// 								StorageAccountID: to.Ptr("/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/JohnKemTest/providers/Microsoft.Storage/storageAccounts/johnkemtest8165"),
		// 							},
		// 					}},
		// 				}
	}
}

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 List the log profiles.
 *
 * @summary List the log profiles.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/listLogProfile.json
 */
async function listLogProfiles() {
  const subscriptionId =
    process.env["MONITOR_SUBSCRIPTION_ID"] || "df602c9c-7aa0-407d-a6fb-eb20c8bd1192";
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.logProfiles.list()) {
    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;
using Azure.ResourceManager.Monitor.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/listLogProfile.json
// this example is just showing the usage of "LogProfiles_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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "df602c9c-7aa0-407d-a6fb-eb20c8bd1192";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// get the collection of this LogProfileResource
LogProfileCollection collection = subscriptionResource.GetLogProfiles();

// invoke the operation and iterate over the result
await foreach (LogProfileResource 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
    LogProfileData 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/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/providers/microsoft.insights/logprofiles/default",
      "type": "",
      "name": "default",
      "location": "",
      "tags": null,
      "properties": {
        "storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/JohnKemTest/providers/Microsoft.Storage/storageAccounts/johnkemtest8162",
        "serviceBusRuleId": "",
        "locations": [
          "global"
        ],
        "categories": [
          "Delete",
          "Write",
          "Action"
        ],
        "retentionPolicy": {
          "enabled": true,
          "days": 3
        }
      }
    },
    {
      "id": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/providers/microsoft.insights/logprofiles/default2",
      "type": "",
      "name": "default2",
      "location": "",
      "tags": null,
      "properties": {
        "storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/JohnKemTest/providers/Microsoft.Storage/storageAccounts/johnkemtest8165",
        "serviceBusRuleId": "",
        "locations": [
          "global"
        ],
        "categories": [
          "Delete",
          "Write",
          "Action"
        ],
        "retentionPolicy": {
          "enabled": true,
          "days": 15
        }
      }
    }
  ]
}

定義

名前	説明
LogProfileCollection	ログ プロファイルのコレクションを表します。
LogProfileResource	ログ プロファイル リソース。
RetentionPolicy	ログの保持ポリシーを指定します。

LogProfileCollection

ログ プロファイルのコレクションを表します。

名前	型	説明
value	LogProfileResource[]	ログ プロファイルの値。

LogProfileResource

ログ プロファイル リソース。

名前	型	説明
id	string	Azure リソース ID
location	string	リソースの場所
name	string	Azure リソース名
properties.categories	string[]	ログのカテゴリ。 これらのカテゴリは、ユーザーに便利なように作成されます。 一部の値は、'Write'、'Delete'、および /または 'Action' です。
properties.locations	string[]	アクティビティ ログ イベントを格納またはストリーミングするリージョンの一覧。 これは、"グローバル" の場所を含む有効な ARM の場所のコンマ区切りの一覧です。
properties.retentionPolicy	RetentionPolicy	ログ内のイベントの保持ポリシー。
properties.serviceBusRuleId	string	アクティビティ ログをストリーミングするために Event Hubs を作成する Service Bus 名前空間のサービス バス ルール ID。 ルール ID の形式は、'{service bus リソース ID}/authorizationrules/{key name}' です。
properties.storageAccountId	string	アクティビティ ログを送信するストレージ アカウントのリソース ID。
tags	object	リソース タグ
type	string	Azure リソースタイプ

RetentionPolicy

ログの保持ポリシーを指定します。

名前	型	説明
days	integer	リテンション期間の日数を日数で指定します。 値 0 を指定すると、イベントは無期限に保持されます。
enabled	boolean	アイテム保持ポリシーが有効かどうかを示す 値。