diagnostic_settings

Creates, updates, deletes, gets or lists a diagnostic_settings resource.

Overview

Name	diagnostic_settings
Type	Resource
Id	azure.monitor.diagnostic_settings

Fields

The following fields are returned by SELECT queries:

get

Successful request to get more information about diagnostic setting

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
location	string	Resource location
properties	object	Properties of a Diagnostic Settings Resource.
systemData	object	The system metadata related to this resource.
tags		Resource tags
type	string	Azure resource type

list

Successful request to get more information about diagnostic setting

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
location	string	Resource location
properties	object	Properties of a Diagnostic Settings Resource.
systemData	object	The system metadata related to this resource.
tags		Resource tags
type	string	Azure resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceUri, name		Gets the active diagnostic settings for the specified resource.
list	select	resourceUri		Gets the active diagnostic settings list for the specified resource.
create_or_update	insert	resourceUri, name		Creates or updates diagnostic settings for the specified resource.
delete	delete	resourceUri, name		Deletes existing diagnostic settings for the specified resource.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
name	string	The name of the diagnostic setting.
resourceUri	string	The identifier of the resource.

SELECT examples

get

Gets the active diagnostic settings for the specified resource.

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure.monitor.diagnostic_settings
WHERE resourceUri = '{{ resourceUri }}' -- required
AND name = '{{ name }}' -- required
;

list

Gets the active diagnostic settings list for the specified resource.

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure.monitor.diagnostic_settings
WHERE resourceUri = '{{ resourceUri }}' -- required
;

INSERT examples

create_or_update

Creates or updates diagnostic settings for the specified resource.

INSERT INTO azure.monitor.diagnostic_settings (
data__location,
data__tags,
data__properties,
resourceUri,
name
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resourceUri }}',
'{{ name }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: diagnostic_settings
  props:
    - name: resourceUri
      value: string
      description: Required parameter for the diagnostic_settings resource.
    - name: name
      value: string
      description: Required parameter for the diagnostic_settings resource.
    - name: location
      value: string
      description: |
        Resource location
    - name: tags
      value: string
      description: |
        Resource tags
    - name: properties
      value: object
      description: |
        Properties of a Diagnostic Settings Resource.

DELETE examples

delete

Deletes existing diagnostic settings for the specified resource.

DELETE FROM azure.monitor.diagnostic_settings
WHERE resourceUri = '{{ resourceUri }}' --required
AND name = '{{ name }}' --required
;