Skip to main content

clusters

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

Overview​

Nameclusters
TypeResource
Idazure.service_fabric.clusters

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
supportedPatharrayThe list of intermediate cluster code versions for an upgrade or downgrade.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_upgradable_versionsselectresource_group_name, cluster_name, subscription_idOperation to get the minimum and maximum upgradable version from the current cluster version, or the required path to get to the an specific target version. If a target is not provided, it will get the minimum and maximum versions available from the current cluster version. If a target is given, it will provide the required path to get from the current cluster version to the target version.
getselectresource_group_name, cluster_name, subscription_idGets a Service Fabric cluster resource. Get a Service Fabric cluster resource created or in the process of being created in the specified resource group.
list_by_resource_groupselectresource_group_name, subscription_idGets the list of Service Fabric cluster resources created in the specified resource group. Gets all Service Fabric cluster resources created or in the process of being created in the resource group.
listselectsubscription_idGets the list of Service Fabric cluster resources created in the specified subscription. Gets all Service Fabric cluster resources created or in the process of being created in the subscription.
create_or_updateinsertresource_group_name, cluster_name, subscription_id, locationCreates or updates a Service Fabric cluster resource. Create or update a Service Fabric cluster resource with the specified name.
updateupdateresource_group_name, cluster_name, subscription_idUpdates the configuration of a Service Fabric cluster resource. Update the configuration of a Service Fabric cluster resource with the specified name.
create_or_updatereplaceresource_group_name, cluster_name, subscription_id, locationCreates or updates a Service Fabric cluster resource. Create or update a Service Fabric cluster resource with the specified name.
deletedeleteresource_group_name, cluster_name, subscription_idDeletes a Service Fabric cluster resource. 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.

NameDatatypeDescription
cluster_namestringThe name of the cluster resource. Required.
resource_group_namestringThe name of the resource group. The name is case insensitive. Required.
subscription_idstring

SELECT examples​

Operation to get the minimum and maximum upgradable version from the current cluster version, or the required path to get to the an specific target version. If a target is not provided, it will get the minimum and maximum versions available from the current cluster version. If a target is given, it will provide the required path to get from the current cluster version to the target version.

SELECT
supportedPath
FROM azure.service_fabric.clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples​

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

INSERT INTO azure.service_fabric.clusters (
tags,
location,
properties,
resource_group_name,
cluster_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type
;

UPDATE examples​

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

UPDATE azure.service_fabric.clusters
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

REPLACE examples​

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

REPLACE azure.service_fabric.clusters
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

DELETE examples​

Deletes a Service Fabric cluster resource. Delete a Service Fabric cluster resource with the specified name.

DELETE FROM azure.service_fabric.clusters
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;