clusters

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

Overview

Name	clusters
Type	Resource
Id	azure.log_analytics.clusters

Fields

The following fields are returned by SELECT queries:

get

OK response definition.

Name	Datatype	Description
identity	object	Resource's identity.
location	string	The geo-location where the resource lives
properties	object	Log Analytics cluster properties.
sku	object	The sku properties.
tags	object	Resource tags.

list_by_resource_group

OK response definition.

Name	Datatype	Description
identity	object	Resource's identity.
location	string	The geo-location where the resource lives
properties	object	Log Analytics cluster properties.
sku	object	The sku properties.
tags	object	Resource tags.

list

OK response definition.

Name	Datatype	Description
identity	object	Resource's identity.
location	string	The geo-location where the resource lives
properties	object	Log Analytics cluster properties.
sku	object	The sku properties.
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, clusterName		Gets a Log Analytics cluster instance.
list_by_resource_group	select	resourceGroupName, subscriptionId		Gets Log Analytics clusters in a resource group.
list	select	subscriptionId		Gets the Log Analytics clusters in a subscription.
create_or_update	insert	resourceGroupName, subscriptionId, clusterName		Create or update a Log Analytics cluster.
update	update	resourceGroupName, clusterName, subscriptionId		Updates a Log Analytics cluster.
delete	delete	resourceGroupName, clusterName, subscriptionId		Deletes a cluster instance.

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
clusterName	string	Name of the Log Analytics Cluster.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets a Log Analytics cluster instance.

SELECT
identity,
location,
properties,
sku,
tags
FROM azure.log_analytics.clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
;

list_by_resource_group

Gets Log Analytics clusters in a resource group.

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

list

Gets the Log Analytics clusters in a subscription.

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

INSERT examples

create_or_update

Create or update a Log Analytics cluster.

INSERT INTO azure.log_analytics.clusters (
data__identity,
data__sku,
data__properties,
data__tags,
data__location,
resourceGroupName,
subscriptionId,
clusterName
)
SELECT 
'{{ identity }}',
'{{ sku }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ clusterName }}'
RETURNING
identity,
location,
properties,
sku,
tags
;

Manifest

# Description fields are for documentation purposes
- name: clusters
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the clusters resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the clusters resource.
    - name: clusterName
      value: string
      description: Required parameter for the clusters resource.
    - name: identity
      value: object
      description: |
        Resource's identity.
    - name: sku
      value: object
      description: |
        The sku properties.
    - name: properties
      value: object
      description: |
        Log Analytics cluster properties.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Updates a Log Analytics cluster.

UPDATE azure.log_analytics.clusters
SET 
data__properties = '{{ properties }}',
data__identity = '{{ identity }}',
data__sku = '{{ sku }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
identity,
location,
properties,
sku,
tags;

DELETE examples

delete

Deletes a cluster instance.

DELETE FROM azure.log_analytics.clusters
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;