Log Profiles - List

參考

服務:: Monitor

API 版本:: 2016-03-01

列出記錄配置檔。

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

URI 參數

名稱	位於	必要	類型	Description
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	用於此作業的 API 版本。

回應

名稱	類型	Description
200 OK	LogProfileCollection	成功要求列出記錄配置檔

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

List log profiles

範例要求

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


/**
 * 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

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

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

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

範例回覆

狀態碼:: 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
        }
      }
    }
  ]
}

定義

名稱	Description
LogProfileCollection	表示記錄配置檔的集合。
LogProfileResource	記錄配置檔資源。
RetentionPolicy	指定記錄的保留原則。

LogProfileCollection

表示記錄配置檔的集合。

名稱	類型	Description
value	LogProfileResource[]	記錄檔配置檔的值。

LogProfileResource

記錄配置檔資源。

名稱	類型	Description
id	string	Azure 資源標識碼
location	string	資源位置
name	string	Azure 資源名稱
properties.categories	string[]	記錄的類別。這些類別會建立為方便使用者。某些值包括：『Write』、『Delete』和/或 'Action'。
properties.locations	string[]	應儲存或串流活動記錄事件的區域清單。這是有效 ARM 位置的逗號分隔清單，包括「全域」位置。
properties.retentionPolicy	RetentionPolicy	記錄中事件的保留原則。
properties.serviceBusRuleId	string	您想要在其中建立事件中樞來串流活動記錄之服務總線命名空間的服務總線規則標識碼。規則標識碼的格式為：『{服務總線資源標識符}/authorizationrules/{key name}』。
properties.storageAccountId	string	您想要傳送活動記錄之記憶體帳戶的資源識別碼。
tags	object	資源標籤
type	string	Azure 資源類型

RetentionPolicy

指定記錄的保留原則。

名稱	類型	Description
days	integer	保留天數的天數。值為 0 會無限期地保留事件。
enabled	boolean	值，指出是否啟用保留原則。

共用方式為

Log Profiles - List

URI 參數

回應

安全性

azure_auth

範圍

範例

List log profiles

範例要求

範例回覆

定義

LogProfileCollection

LogProfileResource

RetentionPolicy

其他資源