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
The following fields are returned by SELECT queries:
- get_fault_simulation
- get
- list_by_resource_group
- list_by_subscription
| Name | Datatype | Description |
|---|---|---|
details | object | Fault simulation details. |
endTime | string (date-time) | The end time of the fault simulation. |
simulationId | string | unique identifier for the fault simulation. |
startTime | string (date-time) | The start time of the fault simulation. |
status | string | Fault simulation status. Known values are: "Starting", "Active", "Stopping", "Done", "StartFailed", and "StopFailed". (Starting, Active, Stopping, Done, StartFailed, StopFailed) |
| Name | Datatype | Description |
|---|---|---|
id | string | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. |
name | string | The name of the resource. |
VMImage | string | The VM image the node types are configured with. This property controls the Service Fabric component packages to be used for the cluster. Allowed values are: 'Windows'. The default value is 'Windows'. |
addonFeatures | array | List of add-on features to enable on the cluster. |
adminPassword | string | VM admin user password. |
adminUserName | string | VM admin user name. Required. |
allocatedOutboundPorts | integer | The number of outbound ports allocated for SNAT for each node in the backend pool of the default load balancer. The default value is 0 which provides dynamic port allocation based on pool size. |
allowRdpAccess | boolean | Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false. |
applicationTypeVersionsCleanupPolicy | object | The policy used to clean up unused versions. |
autoGeneratedDomainNameLabelScope | string | This property is the entry point to using a public CA cert for your cluster cert. It specifies the level of reuse allowed for the custom FQDN created, matching the subject of the public CA cert. Known values are: "TenantReuse", "SubscriptionReuse", "ResourceGroupReuse", and "NoReuse". (TenantReuse, SubscriptionReuse, ResourceGroupReuse, NoReuse) |
auxiliarySubnets | array | Auxiliary subnets for the cluster. |
azureActiveDirectory | object | The AAD authentication settings of the cluster. |
clientConnectionPort | integer | The port used for client connections to the cluster. |
clients | array | Client certificates that are allowed to manage the cluster. |
clusterCertificateThumbprints | array | List of thumbprints of the cluster certificates. |
clusterCodeVersion | string | The Service Fabric runtime version of the cluster. This property is required when clusterUpgradeMode is set to 'Manual'. To get list of available Service Fabric versions for new clusters use ClusterVersion API <./ClusterVersion.md>_. To get the list of available version for existing clusters use availableClusterVersions. |
clusterId | string | A service generated unique identifier for the cluster resource. |
clusterState | string | The current state of the cluster. Known values are: "WaitingForNodes", "Deploying", "BaselineUpgrade", "Upgrading", "UpgradeFailed", and "Ready". (WaitingForNodes, Deploying, BaselineUpgrade, Upgrading, UpgradeFailed, Ready) |
clusterUpgradeCadence | string | Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when clusterUpgradeMode is set to 'Automatic'. Known values are: "Wave0", "Wave1", and "Wave2". (Wave0, Wave1, Wave2) |
clusterUpgradeMode | string | The upgrade mode of the cluster when new Service Fabric runtime version is available. Known values are: "Automatic" and "Manual". (Automatic, Manual) |
ddosProtectionPlanId | string | Specify the resource id of a DDoS network protection plan that will be associated with the virtual network of the cluster. |
dnsName | string | The cluster dns name. Required. |
enableAutoOSUpgrade | boolean | Enables automatic OS upgrade for node types created using OS images with version 'latest'. The default value for this setting is false. |
enableHttpGatewayExclusiveAuthMode | boolean | If true, token-based authentication is not allowed on the HttpGatewayEndpoint. This is required to support TLS versions 1.3 and above. If token-based authentication is used, HttpGatewayTokenAuthConnectionPort must be defined. |
enableIpv6 | boolean | Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false. |
enableOutboundOnlyNodeTypes | boolean | Enable the creation of node types with only outbound traffic enabled. If set, a separate load balancer backend pool will be created for node types with inbound traffic enabled. Can only be set at the time of cluster creation. |
enableServicePublicIP | boolean | Setting this to true will link the IPv4 address as the ServicePublicIP of the IPv6 address. It can only be set to True if IPv6 is enabled on the cluster. |
etag | string | If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",. |
fabricSettings | array | The list of custom fabric settings to configure the cluster. |
fqdn | string | The fully qualified domain name associated with the public load balancer of the cluster. |
httpGatewayConnectionPort | integer | The port used for HTTP connections to the cluster. |
httpGatewayTokenAuthConnectionPort | integer | The port used for token-auth based HTTPS connections to the cluster. Cannot be set to the same port as HttpGatewayEndpoint. |
ipTags | array | The list of IP tags associated with the default public IP address of the cluster. |
ipv4Address | string | The IPv4 address associated with the public load balancer of the cluster. |
ipv6Address | string | IPv6 address for the cluster if IPv6 is enabled. |
loadBalancingRules | array | Load balancing rules that are applied to the public load balancer of the cluster. |
location | string | The geo-location where the resource lives. Required. |
networkSecurityRules | array | Custom Network Security Rules that are applied to the Virtual Network of the cluster. |
provisioningState | string | The provisioning state of the managed cluster resource. Known values are: "None", "Creating", "Created", "Updating", "Succeeded", "Failed", "Canceled", "Deleting", "Deleted", and "Other". (None, Creating, Created, Updating, Succeeded, Failed, Canceled, Deleting, Deleted, Other) |
publicIPPrefixId | string | Specify the resource id of a public IPv4 prefix that the load balancer will allocate a public IPv4 address from. This setting cannot be changed once the cluster is created. |
publicIPv6PrefixId | string | Specify the resource id of a public IPv6 prefix that the load balancer will allocate a public IPv6 address from. This setting cannot be changed once the cluster is created. |
serviceEndpoints | array | Service endpoints for subnets in the cluster. |
skipManagedNsgAssignment | boolean | Determines whether to skip the assignment of the managed network security group (SF-NSG) to the cluster subnet when using a bring-your-own virtual network (BYOVNET) configuration. The default value is false. |
sku | object | The sku of the managed cluster. Required. |
subnetId | string | If specified, the node types for the cluster are created in this subnet instead of the default VNet. The networkSecurityRules specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created. |
systemData | object | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
tags | object | Resource tags. |
type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". |
upgradeDescription | object | The policy to use when upgrading the cluster. |
useCustomVnet | boolean | For new clusters, this parameter indicates that it uses Bring your own VNet, but the subnet is specified at node type level; and for such clusters, the subnetId property is required for node types. |
zonalResiliency | boolean | Indicates if the cluster has zone resiliency. |
zonalUpdateMode | string | Indicates the update mode for Cross Az clusters. Known values are: "Standard" and "Fast". (Standard, Fast) |
| Name | Datatype | Description |
|---|---|---|
id | string | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. |
name | string | The name of the resource. |
VMImage | string | The VM image the node types are configured with. This property controls the Service Fabric component packages to be used for the cluster. Allowed values are: 'Windows'. The default value is 'Windows'. |
addonFeatures | array | List of add-on features to enable on the cluster. |
adminPassword | string | VM admin user password. |
adminUserName | string | VM admin user name. Required. |
allocatedOutboundPorts | integer | The number of outbound ports allocated for SNAT for each node in the backend pool of the default load balancer. The default value is 0 which provides dynamic port allocation based on pool size. |
allowRdpAccess | boolean | Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false. |
applicationTypeVersionsCleanupPolicy | object | The policy used to clean up unused versions. |
autoGeneratedDomainNameLabelScope | string | This property is the entry point to using a public CA cert for your cluster cert. It specifies the level of reuse allowed for the custom FQDN created, matching the subject of the public CA cert. Known values are: "TenantReuse", "SubscriptionReuse", "ResourceGroupReuse", and "NoReuse". (TenantReuse, SubscriptionReuse, ResourceGroupReuse, NoReuse) |
auxiliarySubnets | array | Auxiliary subnets for the cluster. |
azureActiveDirectory | object | The AAD authentication settings of the cluster. |
clientConnectionPort | integer | The port used for client connections to the cluster. |
clients | array | Client certificates that are allowed to manage the cluster. |
clusterCertificateThumbprints | array | List of thumbprints of the cluster certificates. |
clusterCodeVersion | string | The Service Fabric runtime version of the cluster. This property is required when clusterUpgradeMode is set to 'Manual'. To get list of available Service Fabric versions for new clusters use ClusterVersion API <./ClusterVersion.md>_. To get the list of available version for existing clusters use availableClusterVersions. |
clusterId | string | A service generated unique identifier for the cluster resource. |
clusterState | string | The current state of the cluster. Known values are: "WaitingForNodes", "Deploying", "BaselineUpgrade", "Upgrading", "UpgradeFailed", and "Ready". (WaitingForNodes, Deploying, BaselineUpgrade, Upgrading, UpgradeFailed, Ready) |
clusterUpgradeCadence | string | Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when clusterUpgradeMode is set to 'Automatic'. Known values are: "Wave0", "Wave1", and "Wave2". (Wave0, Wave1, Wave2) |
clusterUpgradeMode | string | The upgrade mode of the cluster when new Service Fabric runtime version is available. Known values are: "Automatic" and "Manual". (Automatic, Manual) |
ddosProtectionPlanId | string | Specify the resource id of a DDoS network protection plan that will be associated with the virtual network of the cluster. |
dnsName | string | The cluster dns name. Required. |
enableAutoOSUpgrade | boolean | Enables automatic OS upgrade for node types created using OS images with version 'latest'. The default value for this setting is false. |
enableHttpGatewayExclusiveAuthMode | boolean | If true, token-based authentication is not allowed on the HttpGatewayEndpoint. This is required to support TLS versions 1.3 and above. If token-based authentication is used, HttpGatewayTokenAuthConnectionPort must be defined. |
enableIpv6 | boolean | Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false. |
enableOutboundOnlyNodeTypes | boolean | Enable the creation of node types with only outbound traffic enabled. If set, a separate load balancer backend pool will be created for node types with inbound traffic enabled. Can only be set at the time of cluster creation. |
enableServicePublicIP | boolean | Setting this to true will link the IPv4 address as the ServicePublicIP of the IPv6 address. It can only be set to True if IPv6 is enabled on the cluster. |
etag | string | If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",. |
fabricSettings | array | The list of custom fabric settings to configure the cluster. |
fqdn | string | The fully qualified domain name associated with the public load balancer of the cluster. |
httpGatewayConnectionPort | integer | The port used for HTTP connections to the cluster. |
httpGatewayTokenAuthConnectionPort | integer | The port used for token-auth based HTTPS connections to the cluster. Cannot be set to the same port as HttpGatewayEndpoint. |
ipTags | array | The list of IP tags associated with the default public IP address of the cluster. |
ipv4Address | string | The IPv4 address associated with the public load balancer of the cluster. |
ipv6Address | string | IPv6 address for the cluster if IPv6 is enabled. |
loadBalancingRules | array | Load balancing rules that are applied to the public load balancer of the cluster. |
location | string | The geo-location where the resource lives. Required. |
networkSecurityRules | array | Custom Network Security Rules that are applied to the Virtual Network of the cluster. |
provisioningState | string | The provisioning state of the managed cluster resource. Known values are: "None", "Creating", "Created", "Updating", "Succeeded", "Failed", "Canceled", "Deleting", "Deleted", and "Other". (None, Creating, Created, Updating, Succeeded, Failed, Canceled, Deleting, Deleted, Other) |
publicIPPrefixId | string | Specify the resource id of a public IPv4 prefix that the load balancer will allocate a public IPv4 address from. This setting cannot be changed once the cluster is created. |
publicIPv6PrefixId | string | Specify the resource id of a public IPv6 prefix that the load balancer will allocate a public IPv6 address from. This setting cannot be changed once the cluster is created. |
serviceEndpoints | array | Service endpoints for subnets in the cluster. |
skipManagedNsgAssignment | boolean | Determines whether to skip the assignment of the managed network security group (SF-NSG) to the cluster subnet when using a bring-your-own virtual network (BYOVNET) configuration. The default value is false. |
sku | object | The sku of the managed cluster. Required. |
subnetId | string | If specified, the node types for the cluster are created in this subnet instead of the default VNet. The networkSecurityRules specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created. |
systemData | object | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
tags | object | Resource tags. |
type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". |
upgradeDescription | object | The policy to use when upgrading the cluster. |
useCustomVnet | boolean | For new clusters, this parameter indicates that it uses Bring your own VNet, but the subnet is specified at node type level; and for such clusters, the subnetId property is required for node types. |
zonalResiliency | boolean | Indicates if the cluster has zone resiliency. |
zonalUpdateMode | string | Indicates the update mode for Cross Az clusters. Known values are: "Standard" and "Fast". (Standard, Fast) |
| Name | Datatype | Description |
|---|---|---|
id | string | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. |
name | string | The name of the resource. |
VMImage | string | The VM image the node types are configured with. This property controls the Service Fabric component packages to be used for the cluster. Allowed values are: 'Windows'. The default value is 'Windows'. |
addonFeatures | array | List of add-on features to enable on the cluster. |
adminPassword | string | VM admin user password. |
adminUserName | string | VM admin user name. Required. |
allocatedOutboundPorts | integer | The number of outbound ports allocated for SNAT for each node in the backend pool of the default load balancer. The default value is 0 which provides dynamic port allocation based on pool size. |
allowRdpAccess | boolean | Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false. |
applicationTypeVersionsCleanupPolicy | object | The policy used to clean up unused versions. |
autoGeneratedDomainNameLabelScope | string | This property is the entry point to using a public CA cert for your cluster cert. It specifies the level of reuse allowed for the custom FQDN created, matching the subject of the public CA cert. Known values are: "TenantReuse", "SubscriptionReuse", "ResourceGroupReuse", and "NoReuse". (TenantReuse, SubscriptionReuse, ResourceGroupReuse, NoReuse) |
auxiliarySubnets | array | Auxiliary subnets for the cluster. |
azureActiveDirectory | object | The AAD authentication settings of the cluster. |
clientConnectionPort | integer | The port used for client connections to the cluster. |
clients | array | Client certificates that are allowed to manage the cluster. |
clusterCertificateThumbprints | array | List of thumbprints of the cluster certificates. |
clusterCodeVersion | string | The Service Fabric runtime version of the cluster. This property is required when clusterUpgradeMode is set to 'Manual'. To get list of available Service Fabric versions for new clusters use ClusterVersion API <./ClusterVersion.md>_. To get the list of available version for existing clusters use availableClusterVersions. |
clusterId | string | A service generated unique identifier for the cluster resource. |
clusterState | string | The current state of the cluster. Known values are: "WaitingForNodes", "Deploying", "BaselineUpgrade", "Upgrading", "UpgradeFailed", and "Ready". (WaitingForNodes, Deploying, BaselineUpgrade, Upgrading, UpgradeFailed, Ready) |
clusterUpgradeCadence | string | Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when clusterUpgradeMode is set to 'Automatic'. Known values are: "Wave0", "Wave1", and "Wave2". (Wave0, Wave1, Wave2) |
clusterUpgradeMode | string | The upgrade mode of the cluster when new Service Fabric runtime version is available. Known values are: "Automatic" and "Manual". (Automatic, Manual) |
ddosProtectionPlanId | string | Specify the resource id of a DDoS network protection plan that will be associated with the virtual network of the cluster. |
dnsName | string | The cluster dns name. Required. |
enableAutoOSUpgrade | boolean | Enables automatic OS upgrade for node types created using OS images with version 'latest'. The default value for this setting is false. |
enableHttpGatewayExclusiveAuthMode | boolean | If true, token-based authentication is not allowed on the HttpGatewayEndpoint. This is required to support TLS versions 1.3 and above. If token-based authentication is used, HttpGatewayTokenAuthConnectionPort must be defined. |
enableIpv6 | boolean | Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false. |
enableOutboundOnlyNodeTypes | boolean | Enable the creation of node types with only outbound traffic enabled. If set, a separate load balancer backend pool will be created for node types with inbound traffic enabled. Can only be set at the time of cluster creation. |
enableServicePublicIP | boolean | Setting this to true will link the IPv4 address as the ServicePublicIP of the IPv6 address. It can only be set to True if IPv6 is enabled on the cluster. |
etag | string | If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",. |
fabricSettings | array | The list of custom fabric settings to configure the cluster. |
fqdn | string | The fully qualified domain name associated with the public load balancer of the cluster. |
httpGatewayConnectionPort | integer | The port used for HTTP connections to the cluster. |
httpGatewayTokenAuthConnectionPort | integer | The port used for token-auth based HTTPS connections to the cluster. Cannot be set to the same port as HttpGatewayEndpoint. |
ipTags | array | The list of IP tags associated with the default public IP address of the cluster. |
ipv4Address | string | The IPv4 address associated with the public load balancer of the cluster. |
ipv6Address | string | IPv6 address for the cluster if IPv6 is enabled. |
loadBalancingRules | array | Load balancing rules that are applied to the public load balancer of the cluster. |
location | string | The geo-location where the resource lives. Required. |
networkSecurityRules | array | Custom Network Security Rules that are applied to the Virtual Network of the cluster. |
provisioningState | string | The provisioning state of the managed cluster resource. Known values are: "None", "Creating", "Created", "Updating", "Succeeded", "Failed", "Canceled", "Deleting", "Deleted", and "Other". (None, Creating, Created, Updating, Succeeded, Failed, Canceled, Deleting, Deleted, Other) |
publicIPPrefixId | string | Specify the resource id of a public IPv4 prefix that the load balancer will allocate a public IPv4 address from. This setting cannot be changed once the cluster is created. |
publicIPv6PrefixId | string | Specify the resource id of a public IPv6 prefix that the load balancer will allocate a public IPv6 address from. This setting cannot be changed once the cluster is created. |
serviceEndpoints | array | Service endpoints for subnets in the cluster. |
skipManagedNsgAssignment | boolean | Determines whether to skip the assignment of the managed network security group (SF-NSG) to the cluster subnet when using a bring-your-own virtual network (BYOVNET) configuration. The default value is false. |
sku | object | The sku of the managed cluster. Required. |
subnetId | string | If specified, the node types for the cluster are created in this subnet instead of the default VNet. The networkSecurityRules specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created. |
systemData | object | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
tags | object | Resource tags. |
type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". |
upgradeDescription | object | The policy to use when upgrading the cluster. |
useCustomVnet | boolean | For new clusters, this parameter indicates that it uses Bring your own VNet, but the subnet is specified at node type level; and for such clusters, the subnetId property is required for node types. |
zonalResiliency | boolean | Indicates if the cluster has zone resiliency. |
zonalUpdateMode | string | Indicates the update mode for Cross Az clusters. Known values are: "Standard" and "Fast". (Standard, Fast) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_fault_simulation | select | resource_group_name, cluster_name, subscription_id | Gets a fault simulation by the simulationId. | |
get | select | resource_group_name, cluster_name, subscription_id | 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 | resource_group_name, subscription_id | Gets all Service Fabric cluster resources created or in the process of being created in the resource group. | |
list_by_subscription | select | subscription_id | Gets all Service Fabric cluster resources created or in the process of being created in the subscription. | |
create_or_update | insert | resource_group_name, cluster_name, subscription_id, location, sku | Create or update a Service Fabric managed cluster resource with the specified name. | |
update | update | resource_group_name, cluster_name, subscription_id | Update the tags of of a Service Fabric managed cluster resource with the specified name. | |
create_or_update | replace | resource_group_name, cluster_name, subscription_id, location, sku | Create or update a Service Fabric managed cluster resource with the specified name. | |
delete | delete | resource_group_name, cluster_name, subscription_id | Delete a Service Fabric managed cluster resource with the specified name. | |
list_fault_simulation | exec | resource_group_name, cluster_name, subscription_id | Gets the list of recent fault simulations for the cluster. | |
start_fault_simulation | exec | resource_group_name, cluster_name, subscription_id, parameters | Starts a fault simulation on the cluster. | |
stop_fault_simulation | exec | resource_group_name, cluster_name, subscription_id, simulationId | Stops a fault simulation on the cluster. |
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 |
|---|---|---|
cluster_name | string | The name of the cluster resource. Required. |
resource_group_name | string | The name of the resource group. The name is case insensitive. Required. |
subscription_id | string |
SELECT examples
- get_fault_simulation
- get
- list_by_resource_group
- list_by_subscription
Gets a fault simulation by the simulationId.
SELECT
details,
endTime,
simulationId,
startTime,
status
FROM azure.service_fabric_managed_clusters.managed_clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;
Get a Service Fabric managed cluster resource created or in the process of being created in the specified resource group.
SELECT
id,
name,
VMImage,
addonFeatures,
adminPassword,
adminUserName,
allocatedOutboundPorts,
allowRdpAccess,
applicationTypeVersionsCleanupPolicy,
autoGeneratedDomainNameLabelScope,
auxiliarySubnets,
azureActiveDirectory,
clientConnectionPort,
clients,
clusterCertificateThumbprints,
clusterCodeVersion,
clusterId,
clusterState,
clusterUpgradeCadence,
clusterUpgradeMode,
ddosProtectionPlanId,
dnsName,
enableAutoOSUpgrade,
enableHttpGatewayExclusiveAuthMode,
enableIpv6,
enableOutboundOnlyNodeTypes,
enableServicePublicIP,
etag,
fabricSettings,
fqdn,
httpGatewayConnectionPort,
httpGatewayTokenAuthConnectionPort,
ipTags,
ipv4Address,
ipv6Address,
loadBalancingRules,
location,
networkSecurityRules,
provisioningState,
publicIPPrefixId,
publicIPv6PrefixId,
serviceEndpoints,
skipManagedNsgAssignment,
sku,
subnetId,
systemData,
tags,
type,
upgradeDescription,
useCustomVnet,
zonalResiliency,
zonalUpdateMode
FROM azure.service_fabric_managed_clusters.managed_clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;
Gets all Service Fabric cluster resources created or in the process of being created in the resource group.
SELECT
id,
name,
VMImage,
addonFeatures,
adminPassword,
adminUserName,
allocatedOutboundPorts,
allowRdpAccess,
applicationTypeVersionsCleanupPolicy,
autoGeneratedDomainNameLabelScope,
auxiliarySubnets,
azureActiveDirectory,
clientConnectionPort,
clients,
clusterCertificateThumbprints,
clusterCodeVersion,
clusterId,
clusterState,
clusterUpgradeCadence,
clusterUpgradeMode,
ddosProtectionPlanId,
dnsName,
enableAutoOSUpgrade,
enableHttpGatewayExclusiveAuthMode,
enableIpv6,
enableOutboundOnlyNodeTypes,
enableServicePublicIP,
etag,
fabricSettings,
fqdn,
httpGatewayConnectionPort,
httpGatewayTokenAuthConnectionPort,
ipTags,
ipv4Address,
ipv6Address,
loadBalancingRules,
location,
networkSecurityRules,
provisioningState,
publicIPPrefixId,
publicIPv6PrefixId,
serviceEndpoints,
skipManagedNsgAssignment,
sku,
subnetId,
systemData,
tags,
type,
upgradeDescription,
useCustomVnet,
zonalResiliency,
zonalUpdateMode
FROM azure.service_fabric_managed_clusters.managed_clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;
Gets all Service Fabric cluster resources created or in the process of being created in the subscription.
SELECT
id,
name,
VMImage,
addonFeatures,
adminPassword,
adminUserName,
allocatedOutboundPorts,
allowRdpAccess,
applicationTypeVersionsCleanupPolicy,
autoGeneratedDomainNameLabelScope,
auxiliarySubnets,
azureActiveDirectory,
clientConnectionPort,
clients,
clusterCertificateThumbprints,
clusterCodeVersion,
clusterId,
clusterState,
clusterUpgradeCadence,
clusterUpgradeMode,
ddosProtectionPlanId,
dnsName,
enableAutoOSUpgrade,
enableHttpGatewayExclusiveAuthMode,
enableIpv6,
enableOutboundOnlyNodeTypes,
enableServicePublicIP,
etag,
fabricSettings,
fqdn,
httpGatewayConnectionPort,
httpGatewayTokenAuthConnectionPort,
ipTags,
ipv4Address,
ipv6Address,
loadBalancingRules,
location,
networkSecurityRules,
provisioningState,
publicIPPrefixId,
publicIPv6PrefixId,
serviceEndpoints,
skipManagedNsgAssignment,
sku,
subnetId,
systemData,
tags,
type,
upgradeDescription,
useCustomVnet,
zonalResiliency,
zonalUpdateMode
FROM azure.service_fabric_managed_clusters.managed_clusters
WHERE subscription_id = '{{ subscription_id }}' -- required
;
INSERT examples
- create_or_update
- Manifest
Create or update a Service Fabric managed cluster resource with the specified name.
INSERT INTO azure.service_fabric_managed_clusters.managed_clusters (
tags,
location,
properties,
sku,
resource_group_name,
cluster_name,
subscription_id
)
SELECT
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ sku }}' /* required */,
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
sku,
systemData,
tags,
type
;
# Description fields are for documentation purposes
- name: managed_clusters
props:
- name: resource_group_name
value: "{{ resource_group_name }}"
description: Required parameter for the managed_clusters resource.
- name: cluster_name
value: "{{ cluster_name }}"
description: Required parameter for the managed_clusters resource.
- name: subscription_id
value: "{{ subscription_id }}"
description: Required parameter for the managed_clusters resource.
- name: tags
value: "{{ tags }}"
description: |
Resource tags.
- name: location
value: "{{ location }}"
description: |
The geo-location where the resource lives. Required.
- name: properties
description: |
The managed cluster resource properties.
value:
dnsName: "{{ dnsName }}"
fqdn: "{{ fqdn }}"
ipv4Address: "{{ ipv4Address }}"
clusterId: "{{ clusterId }}"
clusterState: "{{ clusterState }}"
clusterCertificateThumbprints:
- "{{ clusterCertificateThumbprints }}"
clientConnectionPort: {{ clientConnectionPort }}
httpGatewayConnectionPort: {{ httpGatewayConnectionPort }}
adminUserName: "{{ adminUserName }}"
adminPassword: "{{ adminPassword }}"
loadBalancingRules:
- frontendPort: {{ frontendPort }}
backendPort: {{ backendPort }}
protocol: "{{ protocol }}"
probePort: {{ probePort }}
probeProtocol: "{{ probeProtocol }}"
probeRequestPath: "{{ probeRequestPath }}"
loadDistribution: "{{ loadDistribution }}"
allowRdpAccess: {{ allowRdpAccess }}
networkSecurityRules:
- name: "{{ name }}"
description: "{{ description }}"
protocol: "{{ protocol }}"
sourceAddressPrefixes: "{{ sourceAddressPrefixes }}"
destinationAddressPrefixes: "{{ destinationAddressPrefixes }}"
sourcePortRanges: "{{ sourcePortRanges }}"
destinationPortRanges: "{{ destinationPortRanges }}"
sourceAddressPrefix: "{{ sourceAddressPrefix }}"
destinationAddressPrefix: "{{ destinationAddressPrefix }}"
sourcePortRange: "{{ sourcePortRange }}"
destinationPortRange: "{{ destinationPortRange }}"
access: "{{ access }}"
priority: {{ priority }}
direction: "{{ direction }}"
clients:
- isAdmin: {{ isAdmin }}
thumbprint: "{{ thumbprint }}"
commonName: "{{ commonName }}"
issuerThumbprint: "{{ issuerThumbprint }}"
azureActiveDirectory:
tenantId: "{{ tenantId }}"
clusterApplication: "{{ clusterApplication }}"
clientApplication: "{{ clientApplication }}"
fabricSettings:
- name: "{{ name }}"
parameters: "{{ parameters }}"
provisioningState: "{{ provisioningState }}"
clusterCodeVersion: "{{ clusterCodeVersion }}"
clusterUpgradeMode: "{{ clusterUpgradeMode }}"
clusterUpgradeCadence: "{{ clusterUpgradeCadence }}"
addonFeatures:
- "{{ addonFeatures }}"
enableAutoOSUpgrade: {{ enableAutoOSUpgrade }}
zonalResiliency: {{ zonalResiliency }}
applicationTypeVersionsCleanupPolicy:
maxUnusedVersionsToKeep: {{ maxUnusedVersionsToKeep }}
enableIpv6: {{ enableIpv6 }}
subnetId: "{{ subnetId }}"
ipTags:
- ipTagType: "{{ ipTagType }}"
tag: "{{ tag }}"
ipv6Address: "{{ ipv6Address }}"
enableServicePublicIP: {{ enableServicePublicIP }}
auxiliarySubnets:
- name: "{{ name }}"
enableIpv6: {{ enableIpv6 }}
privateEndpointNetworkPolicies: "{{ privateEndpointNetworkPolicies }}"
privateLinkServiceNetworkPolicies: "{{ privateLinkServiceNetworkPolicies }}"
networkSecurityGroupId: "{{ networkSecurityGroupId }}"
serviceEndpoints:
- service: "{{ service }}"
locations: "{{ locations }}"
networkIdentifier: "{{ networkIdentifier }}"
zonalUpdateMode: "{{ zonalUpdateMode }}"
useCustomVnet: {{ useCustomVnet }}
publicIPPrefixId: "{{ publicIPPrefixId }}"
publicIPv6PrefixId: "{{ publicIPv6PrefixId }}"
ddosProtectionPlanId: "{{ ddosProtectionPlanId }}"
upgradeDescription:
forceRestart: {{ forceRestart }}
healthPolicy:
maxPercentUnhealthyNodes: {{ maxPercentUnhealthyNodes }}
maxPercentUnhealthyApplications: {{ maxPercentUnhealthyApplications }}
deltaHealthPolicy:
maxPercentDeltaUnhealthyNodes: {{ maxPercentDeltaUnhealthyNodes }}
maxPercentUpgradeDomainDeltaUnhealthyNodes: {{ maxPercentUpgradeDomainDeltaUnhealthyNodes }}
maxPercentDeltaUnhealthyApplications: {{ maxPercentDeltaUnhealthyApplications }}
monitoringPolicy:
healthCheckWaitDuration: "{{ healthCheckWaitDuration }}"
healthCheckStableDuration: "{{ healthCheckStableDuration }}"
healthCheckRetryTimeout: "{{ healthCheckRetryTimeout }}"
upgradeTimeout: "{{ upgradeTimeout }}"
upgradeDomainTimeout: "{{ upgradeDomainTimeout }}"
upgradeReplicaSetCheckTimeout: "{{ upgradeReplicaSetCheckTimeout }}"
httpGatewayTokenAuthConnectionPort: {{ httpGatewayTokenAuthConnectionPort }}
enableHttpGatewayExclusiveAuthMode: {{ enableHttpGatewayExclusiveAuthMode }}
autoGeneratedDomainNameLabelScope: "{{ autoGeneratedDomainNameLabelScope }}"
allocatedOutboundPorts: {{ allocatedOutboundPorts }}
VMImage: "{{ VMImage }}"
enableOutboundOnlyNodeTypes: {{ enableOutboundOnlyNodeTypes }}
skipManagedNsgAssignment: {{ skipManagedNsgAssignment }}
- name: sku
description: |
The sku of the managed cluster. Required.
value:
name: "{{ name }}"
UPDATE examples
- update
Update the tags of of a Service Fabric managed cluster resource with the specified name.
UPDATE azure.service_fabric_managed_clusters.managed_clusters
SET
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,
sku,
systemData,
tags,
type;
REPLACE examples
- create_or_update
Create or update a Service Fabric managed cluster resource with the specified name.
REPLACE azure.service_fabric_managed_clusters.managed_clusters
SET
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
sku = '{{ sku }}'
WHERE
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND sku = '{{ sku }}' --required
RETURNING
id,
name,
etag,
location,
properties,
sku,
systemData,
tags,
type;
DELETE examples
- delete
Delete a Service Fabric managed cluster resource with the specified name.
DELETE FROM azure.service_fabric_managed_clusters.managed_clusters
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;
Lifecycle Methods
- list_fault_simulation
- start_fault_simulation
- stop_fault_simulation
Gets the list of recent fault simulations for the cluster.
EXEC azure.service_fabric_managed_clusters.managed_clusters.list_fault_simulation
@resource_group_name='{{ resource_group_name }}' --required,
@cluster_name='{{ cluster_name }}' --required,
@subscription_id='{{ subscription_id }}' --required
;
Starts a fault simulation on the cluster.
EXEC azure.service_fabric_managed_clusters.managed_clusters.start_fault_simulation
@resource_group_name='{{ resource_group_name }}' --required,
@cluster_name='{{ cluster_name }}' --required,
@subscription_id='{{ subscription_id }}' --required
@@json=
'{
"parameters": "{{ parameters }}"
}'
;
Stops a fault simulation on the cluster.
EXEC azure.service_fabric_managed_clusters.managed_clusters.stop_fault_simulation
@resource_group_name='{{ resource_group_name }}' --required,
@cluster_name='{{ cluster_name }}' --required,
@subscription_id='{{ subscription_id }}' --required
@@json=
'{
"simulationId": "{{ simulationId }}"
}'
;