azure_monitor_workspaces

Creates, updates, deletes, gets or lists an azure_monitor_workspaces resource.

Overview

Name	azure_monitor_workspaces
Type	Resource
Id	azure.monitor.azure_monitor_workspaces

Fields

The following fields are returned by SELECT queries:

get

Request completed successfully

Name	Datatype	Description
etag	string	Resource entity tag (ETag)
location	string	The geo-location where the resource lives
properties	object	Properties of an Azure Monitor Workspace
tags	object	Resource tags.

list_by_resource_group

Request completed successfully

Name	Datatype	Description
etag	string	Resource entity tag (ETag)
location	string	The geo-location where the resource lives
properties	object	Properties of an Azure Monitor Workspace
tags	object	Resource tags.

list_by_subscription

Request completed successfully

Name	Datatype	Description
etag	string	Resource entity tag (ETag)
location	string	The geo-location where the resource lives
properties	object	Properties of an Azure Monitor Workspace
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, azureMonitorWorkspaceName		Returns the specified Azure Monitor Workspace
list_by_resource_group	select	subscriptionId, resourceGroupName		Lists all Azure Monitor Workspaces in the specified resource group
list_by_subscription	select	subscriptionId		Lists all Azure Monitor Workspaces in the specified subscription
create	insert	subscriptionId, resourceGroupName, azureMonitorWorkspaceName, data__location		Creates or updates an Azure Monitor Workspace
update	update	subscriptionId, resourceGroupName, azureMonitorWorkspaceName		Updates part of an Azure Monitor Workspace
delete	delete	subscriptionId, resourceGroupName, azureMonitorWorkspaceName		Deletes an Azure Monitor Workspace

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
azureMonitorWorkspaceName	string	The name of the Azure Monitor Workspace. The name is case insensitive
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Returns the specified Azure Monitor Workspace

SELECT
etag,
location,
properties,
tags
FROM azure.monitor.azure_monitor_workspaces
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND azureMonitorWorkspaceName = '{{ azureMonitorWorkspaceName }}' -- required
;

list_by_resource_group

Lists all Azure Monitor Workspaces in the specified resource group

SELECT
etag,
location,
properties,
tags
FROM azure.monitor.azure_monitor_workspaces
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Lists all Azure Monitor Workspaces in the specified subscription

SELECT
etag,
location,
properties,
tags
FROM azure.monitor.azure_monitor_workspaces
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Creates or updates an Azure Monitor Workspace

INSERT INTO azure.monitor.azure_monitor_workspaces (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
azureMonitorWorkspaceName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ azureMonitorWorkspaceName }}'
RETURNING
etag,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: azure_monitor_workspaces
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the azure_monitor_workspaces resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the azure_monitor_workspaces resource.
    - name: azureMonitorWorkspaceName
      value: string
      description: Required parameter for the azure_monitor_workspaces resource.
    - name: properties
      value: object
      description: |
        Properties of an Azure Monitor Workspace
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Updates part of an Azure Monitor Workspace

UPDATE azure.monitor.azure_monitor_workspaces
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND azureMonitorWorkspaceName = '{{ azureMonitorWorkspaceName }}' --required
RETURNING
etag,
location,
properties,
tags;

DELETE examples

delete

Deletes an Azure Monitor Workspace

DELETE FROM azure.monitor.azure_monitor_workspaces
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND azureMonitorWorkspaceName = '{{ azureMonitorWorkspaceName }}' --required
;