managed_clusters

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

Overview

Name	managed_clusters
Type	Resource
Id	azure.service_fabric_managed_clusters.managed_clusters

Fields

vw_managed_clusters

Name	Datatype	Description
id	text	Azure resource identifier.
name	text	Azure resource name.
addon_features	text	field from the properties object
admin_password	text	field from the properties object
admin_user_name	text	field from the properties object
allow_rdp_access	text	field from the properties object
application_type_versions_cleanup_policy	text	field from the properties object
auto_generated_domain_name_label_scope	text	field from the properties object
auxiliary_subnets	text	field from the properties object
azure_active_directory	text	field from the properties object
client_connection_port	text	field from the properties object
clients	text	field from the properties object
clusterName	text	field from the properties object
cluster_certificate_thumbprints	text	field from the properties object
cluster_code_version	text	field from the properties object
cluster_id	text	field from the properties object
cluster_state	text	field from the properties object
cluster_upgrade_cadence	text	field from the properties object
cluster_upgrade_mode	text	field from the properties object
custom_fqdn	text	field from the properties object
ddos_protection_plan_id	text	field from the properties object
dns_name	text	field from the properties object
enable_auto_os_upgrade	text	field from the properties object
enable_http_gateway_exclusive_auth_mode	text	field from the properties object
enable_ipv6	text	field from the properties object
enable_service_public_ip	text	field from the properties object
etag	text	Azure resource etag.
fabric_settings	text	field from the properties object
fqdn	text	field from the properties object
http_gateway_connection_port	text	field from the properties object
http_gateway_token_auth_connection_port	text	field from the properties object
ip_tags	text	field from the properties object
ipv4_address	text	field from the properties object
ipv6_address	text	field from the properties object
load_balancing_rules	text	field from the properties object
location	text	Azure resource location.
network_security_rules	text	field from the properties object
provisioning_state	text	field from the properties object
public_ip_prefix_id	text	field from the properties object
public_ipv6_prefix_id	text	field from the properties object
resourceGroupName	text	field from the properties object
service_endpoints	text	field from the properties object
sku	text	Service Fabric managed cluster Sku definition
subnet_id	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
use_custom_vnet	text	field from the properties object
zonal_resiliency	text	field from the properties object
zonal_update_mode	text	field from the properties object

managed_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 managed cluster resource properties.
sku	object	Service Fabric managed cluster Sku definition
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 managed cluster resource created or in the process of being created in the specified resource group.
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.
list_by_subscription	SELECT	subscriptionId	Gets all Service Fabric cluster resources created or in the process of being created in the subscription.
create_or_update	INSERT	clusterName, resourceGroupName, subscriptionId, data__sku	Create or update a Service Fabric managed cluster resource with the specified name.
delete	DELETE	clusterName, resourceGroupName, subscriptionId	Delete a Service Fabric managed cluster resource with the specified name.
update	UPDATE	clusterName, resourceGroupName, subscriptionId	Update the tags of of a Service Fabric managed cluster resource with the specified name.
apply_maintenance_window	EXEC	clusterName, resourceGroupName, subscriptionId	Action to Apply Maintenance window on the Service Fabric Managed Clusters, right now. Any pending update will be applied.

SELECT examples

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

vw_managed_clusters

SELECT
id,
name,
addon_features,
admin_password,
admin_user_name,
allow_rdp_access,
application_type_versions_cleanup_policy,
auto_generated_domain_name_label_scope,
auxiliary_subnets,
azure_active_directory,
client_connection_port,
clients,
clusterName,
cluster_certificate_thumbprints,
cluster_code_version,
cluster_id,
cluster_state,
cluster_upgrade_cadence,
cluster_upgrade_mode,
custom_fqdn,
ddos_protection_plan_id,
dns_name,
enable_auto_os_upgrade,
enable_http_gateway_exclusive_auth_mode,
enable_ipv6,
enable_service_public_ip,
etag,
fabric_settings,
fqdn,
http_gateway_connection_port,
http_gateway_token_auth_connection_port,
ip_tags,
ipv4_address,
ipv6_address,
load_balancing_rules,
location,
network_security_rules,
provisioning_state,
public_ip_prefix_id,
public_ipv6_prefix_id,
resourceGroupName,
service_endpoints,
sku,
subnet_id,
subscriptionId,
system_data,
tags,
type,
upgrade_description,
use_custom_vnet,
zonal_resiliency,
zonal_update_mode
FROM azure.service_fabric_managed_clusters.vw_managed_clusters
WHERE subscriptionId = '{{ subscriptionId }}';

managed_clusters

SELECT
id,
name,
etag,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.service_fabric_managed_clusters.managed_clusters
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.service_fabric_managed_clusters.managed_clusters (
clusterName,
resourceGroupName,
subscriptionId,
data__sku,
location,
tags,
systemData,
properties,
sku
)
SELECT 
'{{ clusterName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__sku }}',
'{{ location }}',
'{{ tags }}',
'{{ systemData }}',
'{{ properties }}',
'{{ sku }}'
;

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: dnsName
          value: string
        - name: fqdn
          value: string
        - name: ipv4Address
          value: string
        - name: clusterId
          value: string
        - name: clusterState
          value: []
        - name: clusterCertificateThumbprints
          value:
            - string
        - name: clientConnectionPort
          value: integer
        - name: httpGatewayConnectionPort
          value: integer
        - name: adminUserName
          value: string
        - name: adminPassword
          value: string
        - name: loadBalancingRules
          value:
            - - name: frontendPort
                value: integer
              - name: backendPort
                value: integer
              - name: protocol
                value: string
              - name: probePort
                value: integer
              - name: probeProtocol
                value: string
              - name: probeRequestPath
                value: string
              - name: loadDistribution
                value: string
        - name: allowRdpAccess
          value: boolean
        - name: networkSecurityRules
          value:
            - - name: name
                value: string
              - name: description
                value: string
              - name: protocol
                value: string
              - name: sourceAddressPrefixes
                value:
                  - string
              - name: destinationAddressPrefixes
                value:
                  - string
              - name: sourcePortRanges
                value:
                  - string
              - name: destinationPortRanges
                value:
                  - string
              - name: sourceAddressPrefix
                value: string
              - name: destinationAddressPrefix
                value: string
              - name: sourcePortRange
                value: string
              - name: destinationPortRange
                value: string
              - name: access
                value: string
              - name: priority
                value: integer
              - name: direction
                value: string
        - name: clients
          value:
            - - name: isAdmin
                value: boolean
              - name: thumbprint
                value: string
              - name: commonName
                value: string
              - name: issuerThumbprint
                value: string
        - name: azureActiveDirectory
          value:
            - name: tenantId
              value: string
            - name: clusterApplication
              value: string
            - name: clientApplication
              value: string
        - name: fabricSettings
          value:
            - - name: name
                value: string
              - name: parameters
                value:
                  - - name: name
                      value: string
                    - name: value
                      value: string
        - name: provisioningState
          value: []
        - name: clusterCodeVersion
          value: string
        - name: clusterUpgradeMode
          value: []
        - name: clusterUpgradeCadence
          value: []
        - name: addonFeatures
          value:
            - []
        - name: enableAutoOSUpgrade
          value: boolean
        - name: zonalResiliency
          value: boolean
        - name: applicationTypeVersionsCleanupPolicy
          value:
            - name: maxUnusedVersionsToKeep
              value: integer
        - name: enableIpv6
          value: boolean
        - name: subnetId
          value: string
        - name: ipTags
          value:
            - - name: ipTagType
                value: string
              - name: tag
                value: string
        - name: ipv6Address
          value: string
        - name: enableServicePublicIP
          value: boolean
        - name: auxiliarySubnets
          value:
            - - name: name
                value: string
              - name: enableIpv6
                value: boolean
              - name: privateEndpointNetworkPolicies
                value: string
              - name: privateLinkServiceNetworkPolicies
                value: string
              - name: networkSecurityGroupId
                value: string
        - name: serviceEndpoints
          value:
            - - name: service
                value: string
              - name: locations
                value:
                  - string
        - name: zonalUpdateMode
          value: []
        - name: useCustomVnet
          value: boolean
        - name: publicIPPrefixId
          value: string
        - name: publicIPv6PrefixId
          value: string
        - name: ddosProtectionPlanId
          value: string
        - name: upgradeDescription
          value:
            - name: forceRestart
              value: boolean
            - name: healthPolicy
              value:
                - name: maxPercentUnhealthyNodes
                  value: integer
                - name: maxPercentUnhealthyApplications
                  value: integer
            - name: deltaHealthPolicy
              value:
                - name: maxPercentDeltaUnhealthyNodes
                  value: integer
                - name: maxPercentUpgradeDomainDeltaUnhealthyNodes
                  value: integer
                - name: maxPercentDeltaUnhealthyApplications
                  value: integer
            - name: monitoringPolicy
              value:
                - name: healthCheckWaitDuration
                  value: string
                - name: healthCheckStableDuration
                  value: string
                - name: healthCheckRetryTimeout
                  value: string
                - name: upgradeTimeout
                  value: string
                - name: upgradeDomainTimeout
                  value: string
            - name: upgradeReplicaSetCheckTimeout
              value: string
        - name: httpGatewayTokenAuthConnectionPort
          value: integer
        - name: enableHttpGatewayExclusiveAuthMode
          value: boolean
        - name: autoGeneratedDomainNameLabelScope
          value: []
        - name: customFqdn
          value: string
    - name: sku
      value:
        - name: name
          value: []

UPDATE example

Updates a managed_clusters resource.

/*+ update */
UPDATE azure.service_fabric_managed_clusters.managed_clusters
SET 
tags = '{{ tags }}'
WHERE 
clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified managed_clusters resource.

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