Log Profiles - List

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

Name Type Description
200 OK

Successful request to list log profiles

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

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.

RetentionPolicy

Specifies the retention policy for the log.

LogProfileCollection

Represents a collection of log profiles.

Name Type Description
value

the values of the 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

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.