clusters

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

Overview

Name	clusters
Type	Resource
Id	azure.service_fabric.clusters

Fields

The following fields are returned by SELECT queries:

get

The operation completed successfully.

Name	Datatype	Description
id	string	Azure resource identifier.
name	string	Azure resource name.
etag	string	Azure resource etag.
location	string	Azure resource location.
properties	object	The cluster resource properties
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Azure resource tags.
type	string	Azure resource type.

list_by_resource_group

The operation completed successfully.

Name	Datatype	Description
id	string	Azure resource identifier.
name	string	Azure resource name.
etag	string	Azure resource etag.
location	string	Azure resource location.
properties	object	The cluster resource properties
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Azure resource tags.
type	string	Azure resource type.

list

The operation completed successfully.

Name	Datatype	Description
id	string	Azure resource identifier.
name	string	Azure resource name.
etag	string	Azure resource etag.
location	string	Azure resource location.
properties	object	The cluster resource properties
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Azure resource tags.
type	string	Azure resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, clusterName, subscriptionId	api-version	Get a Service Fabric cluster resource created or in the process of being created in the specified resource group.
list_by_resource_group	select	resourceGroupName, subscriptionId	api-version	Gets all Service Fabric cluster resources created or in the process of being created in the resource group.
list	select	subscriptionId	api-version	Gets all Service Fabric cluster resources created or in the process of being created in the subscription.
create_or_update	insert	resourceGroupName, clusterName, subscriptionId	api-version	Create or update a Service Fabric cluster resource with the specified name.
update	update	resourceGroupName, clusterName, subscriptionId	api-version	Update the configuration of a Service Fabric cluster resource with the specified name.
delete	delete	resourceGroupName, clusterName, subscriptionId	api-version	Delete a Service Fabric cluster resource with the specified name.

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	The name of the cluster resource.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	The customer subscription identifier.
api-version	string	The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification.

SELECT examples

get

Get a Service Fabric cluster resource created or in the process of being created in the specified resource group.

SELECT
id,
name,
etag,
location,
properties,
systemData,
tags,
type
FROM azure.service_fabric.clusters
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_resource_group

Gets all Service Fabric cluster resources created or in the process of being created in the resource group.

SELECT
id,
name,
etag,
location,
properties,
systemData,
tags,
type
FROM azure.service_fabric.clusters
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
;

list

Gets all Service Fabric cluster resources created or in the process of being created in the subscription.

SELECT
id,
name,
etag,
location,
properties,
systemData,
tags,
type
FROM azure.service_fabric.clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create_or_update

Create or update a Service Fabric cluster resource with the specified name.

INSERT INTO azure.service_fabric.clusters (
data__location,
data__tags,
data__properties,
resourceGroupName,
clusterName,
subscriptionId,
api-version
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ clusterName }}',
'{{ subscriptionId }}',
'{{ api-version }}'
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: clusters
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the clusters resource.
    - name: clusterName
      value: string
      description: Required parameter for the clusters resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the clusters resource.
    - name: location
      value: string
      description: |
        Azure resource location.
    - name: tags
      value: object
      description: |
        Azure resource tags.
    - name: properties
      value: object
      description: |
        The cluster resource properties
    - name: api-version
      value: string
      description: The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2021-06-01" for this specification.

UPDATE examples

update

Update the configuration of a Service Fabric cluster resource with the specified name.

UPDATE azure.service_fabric.clusters
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a Service Fabric cluster resource with the specified name.

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