ManagedCluster Class

The manged cluster resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance

azure.mgmt.servicefabricmanagedclusters.models._models_py3.Resource

ManagedCluster

Constructor

ManagedCluster(*, location: str, tags: Optional[Dict[str, str]] = None, sku: Optional[azure.mgmt.servicefabricmanagedclusters.models._models_py3.Sku] = None, dns_name: Optional[str] = None, client_connection_port: Optional[int] = 19000, http_gateway_connection_port: Optional[int] = 19080, admin_user_name: Optional[str] = None, admin_password: Optional[str] = None, load_balancing_rules: Optional[List[azure.mgmt.servicefabricmanagedclusters.models._models_py3.LoadBalancingRule]] = None, allow_rdp_access: Optional[bool] = None, network_security_rules: Optional[List[azure.mgmt.servicefabricmanagedclusters.models._models_py3.NetworkSecurityRule]] = None, clients: Optional[List[azure.mgmt.servicefabricmanagedclusters.models._models_py3.ClientCertificate]] = None, azure_active_directory: Optional[azure.mgmt.servicefabricmanagedclusters.models._models_py3.AzureActiveDirectory] = None, fabric_settings: Optional[List[azure.mgmt.servicefabricmanagedclusters.models._models_py3.SettingsSectionDescription]] = None, cluster_code_version: Optional[str] = None, cluster_upgrade_mode: Optional[Union[str, azure.mgmt.servicefabricmanagedclusters.models._service_fabric_managed_clusters_management_client_enums.ClusterUpgradeMode]] = 'Automatic', cluster_upgrade_cadence: Optional[Union[str, azure.mgmt.servicefabricmanagedclusters.models._service_fabric_managed_clusters_management_client_enums.ClusterUpgradeCadence]] = None, addon_features: Optional[List[Union[str, azure.mgmt.servicefabricmanagedclusters.models._service_fabric_managed_clusters_management_client_enums.ManagedClusterAddOnFeature]]] = None, enable_auto_os_upgrade: Optional[bool] = None, zonal_resiliency: Optional[bool] = False, application_type_versions_cleanup_policy: Optional[azure.mgmt.servicefabricmanagedclusters.models._models_py3.ApplicationTypeVersionsCleanupPolicy] = None, **kwargs)

Parameters

location

str

Required

Required. Azure resource location.

tags

dict[str, str]

Required

A set of tags. Azure resource tags.

sku

<xref:service_fabric_managed_clusters_management_client.models.Sku>

Required

The sku of the managed cluster.

dns_name

str

Required

The cluster dns name.

client_connection_port

int

Required

The port used for client connections to the cluster.

http_gateway_connection_port

int

Required

The port used for HTTP connections to the cluster.

admin_user_name

str

Required

VM admin user name.

admin_password

str

Required

VM admin user password.

load_balancing_rules

list[<xref:service_fabric_managed_clusters_management_client.models.LoadBalancingRule>]

Required

Load balancing rules that are applied to the public load balancer of the cluster.

allow_rdp_access

bool

Required

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.

network_security_rules

list[<xref:service_fabric_managed_clusters_management_client.models.NetworkSecurityRule>]

Required

Custom Network Security Rules that are applied to the virtual network of the cluster.

clients

list[<xref:service_fabric_managed_clusters_management_client.models.ClientCertificate>]

Required

Client certificates that are allowed to manage the cluster.

azure_active_directory

<xref:service_fabric_managed_clusters_management_client.models.AzureActiveDirectory>

Required

The AAD authentication settings of the cluster.

fabric_settings

list[<xref:service_fabric_managed_clusters_management_client.models.SettingsSectionDescription>]

Required

The list of custom fabric settings to configure the cluster.

cluster_code_version

str

Required

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 <xref:./ClusterVersion.md>. To get the list of available version for existing clusters use availableClusterVersions.

cluster_upgrade_mode

str or <xref:service_fabric_managed_clusters_management_client.models.ClusterUpgradeMode>

Required

The upgrade mode of the cluster when new Service Fabric runtime version is available. Possible values include: "Automatic", "Manual". Default value: "Automatic".

cluster_upgrade_cadence

str or <xref:service_fabric_managed_clusters_management_client.models.ClusterUpgradeCadence>

Required

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'. Possible values include: "Wave0", "Wave1", "Wave2".

addon_features

list[str or <xref:service_fabric_managed_clusters_management_client.models.ManagedClusterAddOnFeature>]

Required

List of add-on features to enable on the cluster.

enable_auto_os_upgrade

bool

Required

Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false.

zonal_resiliency

bool

Required

Indicates if the cluster has zone resiliency.

application_type_versions_cleanup_policy

<xref:service_fabric_managed_clusters_management_client.models.ApplicationTypeVersionsCleanupPolicy>

Required

The policy used to clean up unused versions.

Variables

id

str

Azure resource identifier.

name

str

Azure resource name.

type

str

Azure resource type.

etag

str

Azure resource etag.

system_data

<xref:service_fabric_managed_clusters_management_client.models.SystemData>

Metadata pertaining to creation and last modification of the resource.

fqdn

str

The fully qualified domain name associated with the public load balancer of the cluster.

ipv4_address

str

The IPv4 address associated with the public load balancer of the cluster.

cluster_id

str

A service generated unique identifier for the cluster resource.

cluster_state

str or <xref:service_fabric_managed_clusters_management_client.models.ClusterState>

The current state of the cluster. Possible values include: "WaitingForNodes", "Deploying", "BaselineUpgrade", "Upgrading", "UpgradeFailed", "Ready".

cluster_certificate_thumbprints

list[str]

List of thumbprints of the cluster certificates.

provisioning_state

str or <xref:service_fabric_managed_clusters_management_client.models.ManagedResourceProvisioningState>

The provisioning state of the managed cluster resource. Possible values include: "None", "Creating", "Created", "Updating", "Succeeded", "Failed", "Canceled", "Deleting", "Deleted", "Other".