storage_insight_configs

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

Overview

Name	storage_insight_configs
Type	Resource
Id	azure.log_analytics.storage_insight_configs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	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.
containers	array	The names of the blob containers that the workspace should read.
eTag	string	The ETag of the storage insight.
status	object	The status of the storage insight.
storageAccount	object	The storage account connection details. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tables	array	The names of the Azure tables that the workspace should read.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_workspace

Name	Datatype	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.
containers	array	The names of the blob containers that the workspace should read.
eTag	string	The ETag of the storage insight.
status	object	The status of the storage insight.
storageAccount	object	The storage account connection details. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tables	array	The names of the Azure tables that the workspace should read.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, storage_insight_name, subscription_id		Gets a storage insight instance.
list_by_workspace	select	resource_group_name, workspace_name, subscription_id		Lists the storage insight instances within a workspace.
create_or_update	insert	resource_group_name, workspace_name, storage_insight_name, subscription_id		Create or update a storage insight.
create_or_update	replace	resource_group_name, workspace_name, storage_insight_name, subscription_id		Create or update a storage insight.
delete	delete	resource_group_name, workspace_name, storage_insight_name, subscription_id		Deletes a storageInsightsConfigs 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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
storage_insight_name	string	Name of the storageInsightsConfigs resource. Required.
subscription_id	string
workspace_name	string	The name of the workspace. Required.

SELECT examples

get

Gets a storage insight instance.

SELECT
id,
name,
containers,
eTag,
status,
storageAccount,
systemData,
tables,
tags,
type
FROM azure.log_analytics.storage_insight_configs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND storage_insight_name = '{{ storage_insight_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_workspace

Lists the storage insight instances within a workspace.

SELECT
id,
name,
containers,
eTag,
status,
storageAccount,
systemData,
tables,
tags,
type
FROM azure.log_analytics.storage_insight_configs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a storage insight.

INSERT INTO azure.log_analytics.storage_insight_configs (
properties,
eTag,
tags,
resource_group_name,
workspace_name,
storage_insight_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ eTag }}',
'{{ tags }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ storage_insight_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
eTag,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: storage_insight_configs
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the storage_insight_configs resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the storage_insight_configs resource.
  - name: storage_insight_name
    value: "{{ storage_insight_name }}"
    description: Required parameter for the storage_insight_configs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the storage_insight_configs resource.
  - name: properties
    description: |
      Storage insight properties.
    value:
      containers:
        - "{{ containers }}"
      tables:
        - "{{ tables }}"
      storageAccount:
        id: "{{ id }}"
        key: "{{ key }}"
      status:
        state: "{{ state }}"
        description: "{{ description }}"
  - name: eTag
    value: "{{ eTag }}"
    description: |
      The ETag of the storage insight.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.

REPLACE examples

create_or_update

Create or update a storage insight.

REPLACE azure.log_analytics.storage_insight_configs
SET 
properties = '{{ properties }}',
eTag = '{{ eTag }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND storage_insight_name = '{{ storage_insight_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
eTag,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a storageInsightsConfigs resource.

DELETE FROM azure.log_analytics.storage_insight_configs
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND storage_insight_name = '{{ storage_insight_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;