clusters

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

Overview

Name	clusters
Type	Resource
Id	azure.service_fabric.clusters

Fields

vw_clusters

Name	Datatype	Description
id	text	Azure resource identifier.
name	text	Azure resource name.
add_on_features	text	field from the properties object
application_type_versions_cleanup_policy	text	field from the properties object
available_cluster_versions	text	field from the properties object
azure_active_directory	text	field from the properties object
certificate	text	field from the properties object
certificate_common_names	text	field from the properties object
client_certificate_common_names	text	field from the properties object
client_certificate_thumbprints	text	field from the properties object
clusterName	text	field from the properties object
cluster_code_version	text	field from the properties object
cluster_endpoint	text	field from the properties object
cluster_id	text	field from the properties object
cluster_state	text	field from the properties object
diagnostics_storage_account_config	text	field from the properties object
etag	text	Azure resource etag.
event_store_service_enabled	text	field from the properties object
fabric_settings	text	field from the properties object
infrastructure_service_manager	text	field from the properties object
location	text	Azure resource location.
management_endpoint	text	field from the properties object
node_types	text	field from the properties object
notifications	text	field from the properties object
provisioning_state	text	field from the properties object
reliability_level	text	field from the properties object
resourceGroupName	text	field from the properties object
reverse_proxy_certificate	text	field from the properties object
reverse_proxy_certificate_common_names	text	field from the properties object
sf_zonal_upgrade_mode	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Azure resource tags.
type	text	Azure resource type.
upgrade_description	text	field from the properties object
upgrade_mode	text	field from the properties object
upgrade_pause_end_timestamp_utc	text	field from the properties object
upgrade_pause_start_timestamp_utc	text	field from the properties object
upgrade_wave	text	field from the properties object
vm_image	text	field from the properties object
vmss_zonal_upgrade_mode	text	field from the properties object
wave_upgrade_paused	text	field from the properties object

clusters

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	Describes 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

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

SELECT examples

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

vw_clusters

SELECT
id,
name,
add_on_features,
application_type_versions_cleanup_policy,
available_cluster_versions,
azure_active_directory,
certificate,
certificate_common_names,
client_certificate_common_names,
client_certificate_thumbprints,
clusterName,
cluster_code_version,
cluster_endpoint,
cluster_id,
cluster_state,
diagnostics_storage_account_config,
etag,
event_store_service_enabled,
fabric_settings,
infrastructure_service_manager,
location,
management_endpoint,
node_types,
notifications,
provisioning_state,
reliability_level,
resourceGroupName,
reverse_proxy_certificate,
reverse_proxy_certificate_common_names,
sf_zonal_upgrade_mode,
subscriptionId,
system_data,
tags,
type,
upgrade_description,
upgrade_mode,
upgrade_pause_end_timestamp_utc,
upgrade_pause_start_timestamp_utc,
upgrade_wave,
vm_image,
vmss_zonal_upgrade_mode,
wave_upgrade_paused
FROM azure.service_fabric.vw_clusters
WHERE subscriptionId = '{{ subscriptionId }}';

clusters

SELECT
id,
name,
etag,
location,
properties,
systemData,
tags,
type
FROM azure.service_fabric.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.service_fabric.clusters (
clusterName,
resourceGroupName,
subscriptionId,
location,
tags,
systemData,
properties
)
SELECT 
'{{ clusterName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ location }}',
'{{ tags }}',
'{{ systemData }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: tags
      value: object
    - name: etag
      value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string
    - name: properties
      value:
        - name: addOnFeatures
          value:
            - []
        - name: availableClusterVersions
          value:
            - - name: codeVersion
                value: string
              - name: supportExpiryUtc
                value: string
              - name: environment
                value: []
        - name: azureActiveDirectory
          value:
            - name: tenantId
              value: string
            - name: clusterApplication
              value: string
            - name: clientApplication
              value: string
        - name: certificate
          value:
            - name: thumbprint
              value: string
            - name: thumbprintSecondary
              value: string
            - name: x509StoreName
              value: []
        - name: certificateCommonNames
          value:
            - name: commonNames
              value:
                - - name: certificateCommonName
                    value: string
                  - name: certificateIssuerThumbprint
                    value: string
        - name: clientCertificateCommonNames
          value:
            - - name: isAdmin
                value: boolean
              - name: certificateCommonName
                value: string
              - name: certificateIssuerThumbprint
                value: string
        - name: clientCertificateThumbprints
          value:
            - - name: isAdmin
                value: boolean
              - name: certificateThumbprint
                value: string
        - name: clusterCodeVersion
          value: string
        - name: clusterEndpoint
          value: string
        - name: clusterId
          value: string
        - name: clusterState
          value: []
        - name: diagnosticsStorageAccountConfig
          value:
            - name: storageAccountName
              value: string
            - name: protectedAccountKeyName
              value: string
            - name: protectedAccountKeyName2
              value: string
            - name: blobEndpoint
              value: string
            - name: queueEndpoint
              value: string
            - name: tableEndpoint
              value: string
        - name: eventStoreServiceEnabled
          value: boolean
        - name: fabricSettings
          value:
            - - name: name
                value: string
              - name: parameters
                value:
                  - - name: name
                      value: string
                    - name: value
                      value: string
        - name: managementEndpoint
          value: string
        - name: nodeTypes
          value:
            - - name: name
                value: string
              - name: placementProperties
                value: object
              - name: capacities
                value: object
              - name: clientConnectionEndpointPort
                value: integer
              - name: httpGatewayEndpointPort
                value: integer
              - name: durabilityLevel
                value: []
              - name: applicationPorts
                value:
                  - name: startPort
                    value: integer
                  - name: endPort
                    value: integer
              - name: isPrimary
                value: boolean
              - name: vmInstanceCount
                value: integer
              - name: reverseProxyEndpointPort
                value: integer
              - name: isStateless
                value: boolean
              - name: multipleAvailabilityZones
                value: boolean
        - name: provisioningState
          value: string
        - name: reliabilityLevel
          value: []
        - name: upgradeDescription
          value:
            - name: forceRestart
              value: boolean
            - name: upgradeReplicaSetCheckTimeout
              value: string
            - name: healthCheckWaitDuration
              value: string
            - name: healthCheckStableDuration
              value: string
            - name: healthCheckRetryTimeout
              value: string
            - name: upgradeTimeout
              value: string
            - name: upgradeDomainTimeout
              value: string
            - name: healthPolicy
              value:
                - name: maxPercentUnhealthyNodes
                  value: integer
                - name: maxPercentUnhealthyApplications
                  value: integer
                - name: applicationHealthPolicies
                  value: []
            - name: deltaHealthPolicy
              value:
                - name: maxPercentDeltaUnhealthyNodes
                  value: integer
                - name: maxPercentUpgradeDomainDeltaUnhealthyNodes
                  value: integer
                - name: maxPercentDeltaUnhealthyApplications
                  value: integer
                - name: applicationDeltaHealthPolicies
                  value: []
        - name: upgradeMode
          value: []
        - name: applicationTypeVersionsCleanupPolicy
          value:
            - name: maxUnusedVersionsToKeep
              value: integer
        - name: vmImage
          value: string
        - name: sfZonalUpgradeMode
          value: []
        - name: vmssZonalUpgradeMode
          value: []
        - name: infrastructureServiceManager
          value: boolean
        - name: upgradeWave
          value: []
        - name: upgradePauseStartTimestampUtc
          value: string
        - name: upgradePauseEndTimestampUtc
          value: string
        - name: waveUpgradePaused
          value: boolean
        - name: notifications
          value:
            - - name: isEnabled
                value: boolean
              - name: notificationCategory
                value: string
              - name: notificationLevel
                value: string
              - name: notificationTargets
                value:
                  - - name: notificationChannel
                      value: string
                    - name: receivers
                      value:
                        - string

UPDATE example

Updates a clusters resource.

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

DELETE example

Deletes the specified clusters resource.

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