List the log profiles.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/logprofiles?api-version=2016-03-01
URI Parameters
| Name |
In |
Required |
Type |
Description |
|
subscriptionId
|
path |
True
|
string
|
The ID of the target subscription.
|
|
api-version
|
query |
True
|
string
|
The API version to use for this operation.
|
Responses
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name |
Description |
|
user_impersonation
|
impersonate your user account
|
Examples
List log profiles
Sample Request
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
Sample Response
{
"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
}
}
}
]
}
Definitions
LogProfileCollection
Represents a collection of log profiles.
LogProfileResource
The log profile resource.
| Name |
Type |
Description |
|
id
|
string
|
Azure resource Id
|
|
location
|
string
|
Resource location
|
|
name
|
string
|
Azure resource name
|
|
properties.categories
|
string[]
|
the categories of the logs. These categories are created as is convenient to the user. Some values are: 'Write', 'Delete', and/or 'Action.'
|
|
properties.locations
|
string[]
|
List of regions for which Activity Log events should be stored or streamed. It is a comma separated list of valid ARM locations including the 'global' location.
|
|
properties.retentionPolicy
|
RetentionPolicy
|
the retention policy for the events in the log.
|
|
properties.serviceBusRuleId
|
string
|
The service bus rule ID of the service bus namespace in which you would like to have Event Hubs created for streaming the Activity Log. The rule ID is of the format: '{service bus resource ID}/authorizationrules/{key name}'.
|
|
properties.storageAccountId
|
string
|
the resource id of the storage account to which you would like to send the Activity Log.
|
|
tags
|
object
|
Resource tags
|
|
type
|
string
|
Azure resource type
|
RetentionPolicy
Specifies the retention policy for the log.
| Name |
Type |
Description |
|
days
|
integer
|
the number of days for the retention in days. A value of 0 will retain the events indefinitely.
|
|
enabled
|
boolean
|
a value indicating whether the retention policy is enabled.
|