azure_diagnostic_setting

event_hub_authorization_rule_id

Type: STRING
Provider name: properties.eventHubAuthorizationRuleId
Description: The resource Id for the event hub authorization rule.

event_hub_name

Type: STRING
Provider name: properties.eventHubName
Description: The name of the event hub. If none is specified, the default event hub will be selected.

id

Type: STRING
Provider name: id
Description: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

log_analytics_destination_type

Type: STRING
Provider name: properties.logAnalyticsDestinationType
Description: A string indicating whether the export to Log Analytics should use the default destination type, i.e. AzureDiagnostics, or use a destination type constructed as follows: _. Possible values are: Dedicated and null (null is default.)

logs

Type: UNORDERED_LIST_STRUCT
Provider name: properties.logs
Description: The list of logs settings.

  • category
    Type: STRING
    Provider name: category
    Description: Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation.
  • category_group
    Type: STRING
    Provider name: categoryGroup
    Description: Name of a Diagnostic Log category group for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation.
  • enabled
    Type: BOOLEAN
    Provider name: enabled
    Description: a value indicating whether this log is enabled.
  • retention_policy
    Type: STRUCT
    Provider name: retentionPolicy
    Description: the retention policy for this log.
    • days
      Type: INT32
      Provider name: days
      Description: the number of days for the retention in days. A value of 0 will retain the events indefinitely.
    • enabled
      Type: BOOLEAN
      Provider name: enabled
      Description: a value indicating whether the retention policy is enabled.

marketplace_partner_id

Type: STRING
Provider name: properties.marketplacePartnerId
Description: The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs.

metrics

Type: UNORDERED_LIST_STRUCT
Provider name: properties.metrics
Description: The list of metric settings.

  • category
    Type: STRING
    Provider name: category
    Description: Name of a Diagnostic Metric category for a resource type this setting is applied to. To obtain the list of Diagnostic metric categories for a resource, first perform a GET diagnostic settings operation.
  • enabled
    Type: BOOLEAN
    Provider name: enabled
    Description: a value indicating whether this category is enabled.
  • retention_policy
    Type: STRUCT
    Provider name: retentionPolicy
    Description: the retention policy for this category.
    • days
      Type: INT32
      Provider name: days
      Description: the number of days for the retention in days. A value of 0 will retain the events indefinitely.
    • enabled
      Type: BOOLEAN
      Provider name: enabled
      Description: a value indicating whether the retention policy is enabled.
  • time_grain
    Type: STRING
    Provider name: timeGrain
    Description: the timegrain of the metric in ISO8601 format.

name

Type: STRING
Provider name: name
Description: The name of the resource

resource_group

Type: STRING

service_bus_rule_id

Type: STRING
Provider name: properties.serviceBusRuleId
Description: The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility.

storage_account_id

Type: STRING
Provider name: properties.storageAccountId
Description: The resource ID of the storage account to which you would like to send Diagnostic Logs.

subscription_id

Type: STRING

subscription_name

Type: STRING

system_data

Type: STRUCT
Provider name: systemData
Description: The system metadata related to this resource.

  • created_at
    Type: STRING
    Provider name: createdAt
    Description: The timestamp of resource creation (UTC).
  • created_by
    Type: STRING
    Provider name: createdBy
    Description: The identity that created the resource.
  • created_by_type
    Type: STRING
    Provider name: createdByType
    Description: The type of identity that created the resource.
  • last_modified_at
    Type: STRING
    Provider name: lastModifiedAt
    Description: The timestamp of resource last modification (UTC)
  • last_modified_by
    Type: STRING
    Provider name: lastModifiedBy
    Description: The identity that last modified the resource.
  • last_modified_by_type
    Type: STRING
    Provider name: lastModifiedByType
    Description: The type of identity that last modified the resource.

tags

Type: UNORDERED_LIST_STRING

type

Type: STRING
Provider name: type
Description: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

workspace_id

Type: STRING
Provider name: properties.workspaceId
Description: The full ARM resource ID of the Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2