ClusterUpdateParameters Class

Cluster update request.

Inheritance

azure.mgmt.servicefabric._serialization.Model

ClusterUpdateParameters

Constructor

ClusterUpdateParameters(*, tags: Dict[str, str] | None = None, add_on_features: List[str | _models.AddOnFeatures] | None = None, certificate: _models.CertificateDescription | None = None, certificate_common_names: _models.ServerCertificateCommonNames | None = None, client_certificate_common_names: List[_models.ClientCertificateCommonName] | None = None, client_certificate_thumbprints: List[_models.ClientCertificateThumbprint] | None = None, cluster_code_version: str | None = None, event_store_service_enabled: bool | None = None, fabric_settings: List[_models.SettingsSectionDescription] | None = None, node_types: List[_models.NodeTypeDescription] | None = None, reliability_level: str | _models.ReliabilityLevel | None = None, reverse_proxy_certificate: _models.CertificateDescription | None = None, upgrade_description: _models.ClusterUpgradePolicy | None = None, application_type_versions_cleanup_policy: _models.ApplicationTypeVersionsCleanupPolicy | None = None, upgrade_mode: str | _models.UpgradeMode = 'Automatic', sf_zonal_upgrade_mode: str | _models.SfZonalUpgradeMode | None = None, vmss_zonal_upgrade_mode: str | _models.VmssZonalUpgradeMode | None = None, infrastructure_service_manager: bool | None = None, upgrade_wave: str | _models.ClusterUpgradeCadence | None = None, upgrade_pause_start_timestamp_utc: datetime | None = None, upgrade_pause_end_timestamp_utc: datetime | None = None, wave_upgrade_paused: bool | None = None, notifications: List[_models.Notification] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
tags	dict[str, str] Cluster update parameters.
add_on_features	list[str or AddOnFeatures] The list of add-on features to enable in the cluster.
certificate	CertificateDescription The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client.
certificate_common_names	ServerCertificateCommonNames Describes a list of server certificates referenced by common name that are used to secure the cluster.
client_certificate_common_names	list[ClientCertificateCommonName] The list of client certificates referenced by common name that are allowed to manage the cluster. This will overwrite the existing list.
client_certificate_thumbprints	list[ClientCertificateThumbprint] The list of client certificates referenced by thumbprint that are allowed to manage the cluster. This will overwrite the existing list.
cluster_code_version	str The Service Fabric runtime version of the cluster. This property can only by set the user when upgradeMode is set to 'Manual'. To get list of available Service Fabric versions for new clusters use ClusterVersion API. To get the list of available version for existing clusters use availableClusterVersions.
event_store_service_enabled	bool Indicates if the event store service is enabled.
fabric_settings	list[SettingsSectionDescription] The list of custom fabric settings to configure the cluster. This will overwrite the existing list.
node_types	list[NodeTypeDescription] The list of node types in the cluster. This will overwrite the existing list.
reliability_level	str or ReliabilityLevel The reliability level sets the replica set size of system services. Learn about ReliabilityLevel. None - Run the System services with a target replica set count of 1. This should only be used for test clusters. Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters. Silver - Run the System services with a target replica set count of 5. Gold - Run the System services with a target replica set count of 7. Platinum - Run the System services with a target replica set count of 9. Known values are: "None", "Bronze", "Silver", "Gold", and "Platinum".
reverse_proxy_certificate	CertificateDescription The server certificate used by reverse proxy.
upgrade_description	ClusterUpgradePolicy The policy to use when upgrading the cluster.
application_type_versions_cleanup_policy	ApplicationTypeVersionsCleanupPolicy The policy used to clean up unused versions.
upgrade_mode	str or UpgradeMode The upgrade mode of the cluster when new Service Fabric runtime version is available. Known values are: "Automatic" and "Manual". Default value: Automatic
sf_zonal_upgrade_mode	str or SfZonalUpgradeMode This property controls the logical grouping of VMs in upgrade domains (UDs). This property can't be modified if a node type with multiple Availability Zones is already present in the cluster. Known values are: "Parallel" and "Hierarchical".
vmss_zonal_upgrade_mode	str or VmssZonalUpgradeMode This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added. Known values are: "Parallel" and "Hierarchical".
infrastructure_service_manager	bool Indicates if infrastructure service manager is enabled.
upgrade_wave	str or ClusterUpgradeCadence Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when upgradeMode is set to 'Automatic'. Known values are: "Wave0", "Wave1", and "Wave2".
upgrade_pause_start_timestamp_utc	datetime The start timestamp to pause runtime version upgrades on the cluster (UTC).
upgrade_pause_end_timestamp_utc	datetime The end timestamp of pause runtime version upgrades on the cluster (UTC).
wave_upgrade_paused	bool Boolean to pause automatic runtime version upgrades to the cluster.
notifications	list[Notification] Indicates a list of notification channels for cluster events.

Variables

Name	Description
tags	dict[str, str] Cluster update parameters.
add_on_features	list[str or AddOnFeatures] The list of add-on features to enable in the cluster.
certificate	CertificateDescription The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client.
certificate_common_names	ServerCertificateCommonNames Describes a list of server certificates referenced by common name that are used to secure the cluster.
client_certificate_common_names	list[ClientCertificateCommonName] The list of client certificates referenced by common name that are allowed to manage the cluster. This will overwrite the existing list.
client_certificate_thumbprints	list[ClientCertificateThumbprint] The list of client certificates referenced by thumbprint that are allowed to manage the cluster. This will overwrite the existing list.
cluster_code_version	str The Service Fabric runtime version of the cluster. This property can only by set the user when upgradeMode is set to 'Manual'. To get list of available Service Fabric versions for new clusters use ClusterVersion API. To get the list of available version for existing clusters use availableClusterVersions.
event_store_service_enabled	bool Indicates if the event store service is enabled.
fabric_settings	list[SettingsSectionDescription] The list of custom fabric settings to configure the cluster. This will overwrite the existing list.
node_types	list[NodeTypeDescription] The list of node types in the cluster. This will overwrite the existing list.
reliability_level	str or ReliabilityLevel The reliability level sets the replica set size of system services. Learn about ReliabilityLevel. None - Run the System services with a target replica set count of 1. This should only be used for test clusters. Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters. Silver - Run the System services with a target replica set count of 5. Gold - Run the System services with a target replica set count of 7. Platinum - Run the System services with a target replica set count of 9. Known values are: "None", "Bronze", "Silver", "Gold", and "Platinum".
reverse_proxy_certificate	CertificateDescription The server certificate used by reverse proxy.
upgrade_description	ClusterUpgradePolicy The policy to use when upgrading the cluster.
application_type_versions_cleanup_policy	ApplicationTypeVersionsCleanupPolicy The policy used to clean up unused versions.
upgrade_mode	str or UpgradeMode The upgrade mode of the cluster when new Service Fabric runtime version is available. Known values are: "Automatic" and "Manual".
sf_zonal_upgrade_mode	str or SfZonalUpgradeMode This property controls the logical grouping of VMs in upgrade domains (UDs). This property can't be modified if a node type with multiple Availability Zones is already present in the cluster. Known values are: "Parallel" and "Hierarchical".
vmss_zonal_upgrade_mode	str or VmssZonalUpgradeMode This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added. Known values are: "Parallel" and "Hierarchical".
infrastructure_service_manager	bool Indicates if infrastructure service manager is enabled.
upgrade_wave	str or ClusterUpgradeCadence Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when upgradeMode is set to 'Automatic'. Known values are: "Wave0", "Wave1", and "Wave2".
upgrade_pause_start_timestamp_utc	datetime The start timestamp to pause runtime version upgrades on the cluster (UTC).
upgrade_pause_end_timestamp_utc	datetime The end timestamp of pause runtime version upgrades on the cluster (UTC).
wave_upgrade_paused	bool Boolean to pause automatic runtime version upgrades to the cluster.
notifications	list[Notification] Indicates a list of notification channels for cluster events.