azure_monitor_workspaces

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

Overview

Name	azure_monitor_workspaces
Type	Resource
Id	azure.monitor_workspaces.azure_monitor_workspaces

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.
accountId	string	The immutable Id of the Azure Monitor Workspace. This property is read-only.
defaultIngestionSettings	object	The Data Collection Rule and Endpoint used for ingestion by default.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
metrics	object	Properties related to the metrics container in the Azure Monitor Workspace.
privateEndpointConnections	array	List of private endpoint connections.
provisioningState	string	The provisioning state of the Azure Monitor Workspace. Set to Succeeded if everything is healthy. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
publicNetworkAccess	string	Gets or sets allow or disallow public network access to Azure Monitor Workspace. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

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.
accountId	string	The immutable Id of the Azure Monitor Workspace. This property is read-only.
defaultIngestionSettings	object	The Data Collection Rule and Endpoint used for ingestion by default.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
metrics	object	Properties related to the metrics container in the Azure Monitor Workspace.
privateEndpointConnections	array	List of private endpoint connections.
provisioningState	string	The provisioning state of the Azure Monitor Workspace. Set to Succeeded if everything is healthy. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
publicNetworkAccess	string	Gets or sets allow or disallow public network access to Azure Monitor Workspace. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

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.
accountId	string	The immutable Id of the Azure Monitor Workspace. This property is read-only.
defaultIngestionSettings	object	The Data Collection Rule and Endpoint used for ingestion by default.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
metrics	object	Properties related to the metrics container in the Azure Monitor Workspace.
privateEndpointConnections	array	List of private endpoint connections.
provisioningState	string	The provisioning state of the Azure Monitor Workspace. Set to Succeeded if everything is healthy. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
publicNetworkAccess	string	Gets or sets allow or disallow public network access to Azure Monitor Workspace. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, azure_monitor_workspace_name, subscription_id		Returns the specified Azure Monitor Workspace.
list_by_resource_group	select	resource_group_name, subscription_id		Lists all Azure Monitor Workspaces in the specified resource group.
list_by_subscription	select	subscription_id		Lists all Azure Monitor Workspaces in the specified subscription.
create_or_update	insert	resource_group_name, azure_monitor_workspace_name, subscription_id, location		Creates or updates an Azure Monitor Workspace.
update	update	resource_group_name, azure_monitor_workspace_name, subscription_id		Updates part of an Azure Monitor Workspace.
create_or_update	replace	resource_group_name, azure_monitor_workspace_name, subscription_id, location		Creates or updates an Azure Monitor Workspace.
delete	delete	resource_group_name, azure_monitor_workspace_name, subscription_id		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
azure_monitor_workspace_name	string	The name of the Azure Monitor Workspace. The name is case insensitive. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Returns the specified Azure Monitor Workspace.

SELECT
id,
name,
accountId,
defaultIngestionSettings,
etag,
identity,
location,
metrics,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
systemData,
tags,
type
FROM azure.monitor_workspaces.azure_monitor_workspaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND azure_monitor_workspace_name = '{{ azure_monitor_workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all Azure Monitor Workspaces in the specified resource group.

SELECT
id,
name,
accountId,
defaultIngestionSettings,
etag,
identity,
location,
metrics,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
systemData,
tags,
type
FROM azure.monitor_workspaces.azure_monitor_workspaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists all Azure Monitor Workspaces in the specified subscription.

SELECT
id,
name,
accountId,
defaultIngestionSettings,
etag,
identity,
location,
metrics,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
systemData,
tags,
type
FROM azure.monitor_workspaces.azure_monitor_workspaces
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates an Azure Monitor Workspace.

INSERT INTO azure.monitor_workspaces.azure_monitor_workspaces (
tags,
location,
properties,
identity,
resource_group_name,
azure_monitor_workspace_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ azure_monitor_workspace_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: azure_monitor_workspaces
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the azure_monitor_workspaces resource.
  - name: azure_monitor_workspace_name
    value: "{{ azure_monitor_workspace_name }}"
    description: Required parameter for the azure_monitor_workspaces resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the azure_monitor_workspaces resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Resource properties.
    value:
      accountId: "{{ accountId }}"
      metrics:
        prometheusQueryEndpoint: "{{ prometheusQueryEndpoint }}"
        internalId: "{{ internalId }}"
        enableAccessUsingResourcePermissions: {{ enableAccessUsingResourcePermissions }}
      provisioningState: "{{ provisioningState }}"
      defaultIngestionSettings:
        dataCollectionRuleResourceId: "{{ dataCollectionRuleResourceId }}"
        dataCollectionEndpointResourceId: "{{ dataCollectionEndpointResourceId }}"
        dataCollectionRuleImmutableId: "{{ dataCollectionRuleImmutableId }}"
        ingestionEndpoints:
          metrics: "{{ metrics }}"
      privateEndpointConnections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          systemData:
            createdBy: "{{ createdBy }}"
            createdByType: "{{ createdByType }}"
            createdAt: "{{ createdAt }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            lastModifiedByType: "{{ lastModifiedByType }}"
            lastModifiedAt: "{{ lastModifiedAt }}"
          properties:
            groupIds:
              - "{{ groupIds }}"
            privateEndpoint:
              id: "{{ id }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
            provisioningState: "{{ provisioningState }}"
      publicNetworkAccess: "{{ publicNetworkAccess }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Updates part of an Azure Monitor Workspace.

UPDATE azure.monitor_workspaces.azure_monitor_workspaces
SET 
tags = '{{ tags }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND azure_monitor_workspace_name = '{{ azure_monitor_workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates an Azure Monitor Workspace.

REPLACE azure.monitor_workspaces.azure_monitor_workspaces
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND azure_monitor_workspace_name = '{{ azure_monitor_workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes an Azure Monitor Workspace.

DELETE FROM azure.monitor_workspaces.azure_monitor_workspaces
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND azure_monitor_workspace_name = '{{ azure_monitor_workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;