clusters

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

Overview

Name	clusters
Type	Resource
Id	azure.log_analytics.clusters

Fields

vw_clusters

Name	Datatype	Description
associated_workspaces	text	field from the properties object
billing_type	text	field from the properties object
capacity_reservation_properties	text	field from the properties object
clusterName	text	field from the properties object
cluster_id	text	field from the properties object
created_date	text	field from the properties object
identity	text	Managed service identity (system assigned and/or user assigned identities)
is_availability_zones_enabled	text	field from the properties object
is_double_encryption_enabled	text	field from the properties object
key_vault_properties	text	field from the properties object
last_modified_date	text	field from the properties object
location	text	The geo-location where the resource lives
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
sku	text	The cluster sku definition.
subscriptionId	text	field from the properties object
tags	text	Resource tags.

clusters

Name	Datatype	Description
identity	object	Managed service identity (system assigned and/or user assigned identities)
location	string	The geo-location where the resource lives
properties	object	Cluster properties.
sku	object	The cluster sku definition.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	clusterName, resourceGroupName, subscriptionId	Gets a Log Analytics cluster instance.
list	SELECT	subscriptionId	Gets the Log Analytics clusters in a subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Gets Log Analytics clusters in a resource group.
create_or_update	INSERT	clusterName, resourceGroupName, subscriptionId	Create or update a Log Analytics cluster.
delete	DELETE	clusterName, resourceGroupName, subscriptionId	Deletes a cluster instance.
update	UPDATE	clusterName, resourceGroupName, subscriptionId	Updates a Log Analytics cluster.

SELECT examples

Gets the Log Analytics clusters in a subscription.

vw_clusters

SELECT
associated_workspaces,
billing_type,
capacity_reservation_properties,
clusterName,
cluster_id,
created_date,
identity,
is_availability_zones_enabled,
is_double_encryption_enabled,
key_vault_properties,
last_modified_date,
location,
provisioning_state,
resourceGroupName,
sku,
subscriptionId,
tags
FROM azure.log_analytics.vw_clusters
WHERE subscriptionId = '{{ subscriptionId }}';

clusters

SELECT
identity,
location,
properties,
sku,
tags
FROM azure.log_analytics.clusters
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new clusters resource.

All Properties

/*+ create */
INSERT INTO azure.log_analytics.clusters (
clusterName,
resourceGroupName,
subscriptionId,
identity,
sku,
properties,
tags,
location
)
SELECT 
'{{ clusterName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ identity }}',
'{{ sku }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: []
        - name: userAssignedIdentities
          value: []
    - name: sku
      value:
        - name: capacity
          value: integer
        - name: name
          value: string
    - name: properties
      value:
        - name: clusterId
          value: string
        - name: provisioningState
          value: string
        - name: isDoubleEncryptionEnabled
          value: boolean
        - name: isAvailabilityZonesEnabled
          value: boolean
        - name: billingType
          value: []
        - name: keyVaultProperties
          value:
            - name: keyVaultUri
              value: string
            - name: keyName
              value: string
            - name: keyVersion
              value: string
            - name: keyRsaSize
              value: integer
        - name: lastModifiedDate
          value: string
        - name: createdDate
          value: string
        - name: associatedWorkspaces
          value:
            - - name: workspaceId
                value: string
              - name: workspaceName
                value: string
              - name: resourceId
                value: string
              - name: associateDate
                value: string
        - name: capacityReservationProperties
          value:
            - name: lastSkuUpdate
              value: string
            - name: minCapacity
              value: integer
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a clusters resource.

/*+ update */
UPDATE azure.log_analytics.clusters
SET 
properties = '{{ properties }}',
identity = '{{ identity }}',
sku = '{{ sku }}',
tags = '{{ tags }}'
WHERE 
clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified clusters resource.

/*+ delete */
DELETE FROM azure.log_analytics.clusters
WHERE clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';