Diagnostic Settings Category - List

Lists the diagnostic settings categories for the specified resource.

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

URI Parameters

Name In Required Type Description
resourceUri
path True
  • string

The identifier of the resource.

api-version
query True
  • string

The API version to use for this operation.

Responses

Name Type Description
200 OK

Successful request to get more information about diagnostic setting category

Other Status Codes

Error response describing why the operation failed.

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

Gets the diagnostic setting

Sample Request

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

Sample Response

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

Definitions

categoryType

The type of the diagnostic settings category.

createdByType

The type of identity that created the resource.

DiagnosticSettingsCategoryResource

The diagnostic settings category resource.

DiagnosticSettingsCategoryResourceCollection

Represents a collection of diagnostic setting category resources.

ErrorResponse

Describes the format of Error response.

systemData

Metadata pertaining to creation and last modification of the resource.

categoryType

The type of the diagnostic settings category.

Name Type Description
Logs
  • string
Metrics
  • string

createdByType

The type of identity that created the resource.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

DiagnosticSettingsCategoryResource

The diagnostic settings category resource.

Name Type Description
id
  • string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

The name of the resource

properties.categoryGroups
  • string[]

the collection of what category groups are supported.

properties.categoryType

The type of the diagnostic settings category.

systemData

The system metadata related to this resource.

type
  • string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

DiagnosticSettingsCategoryResourceCollection

Represents a collection of diagnostic setting category resources.

Name Type Description
value

The collection of diagnostic settings category resources.

ErrorResponse

Describes the format of Error response.

Name Type Description
code
  • string

Error code

message
  • string

Error message indicating why the operation failed.

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt
  • string

The timestamp of resource creation (UTC).

createdBy
  • string

The identity that created the resource.

createdByType

The type of identity that created the resource.

lastModifiedAt
  • string

The timestamp of resource last modification (UTC)

lastModifiedBy
  • string

The identity that last modified the resource.

lastModifiedByType

The type of identity that last modified the resource.