Role Class

Describes a role on the cluster.

Inheritance

msrest.serialization.Model

Role

Constructor

Role(*, name: str | None = None, min_instance_count: int | None = None, target_instance_count: int | None = None, vm_group_name: str | None = None, autoscale_configuration: Autoscale | None = None, hardware_profile: HardwareProfile | None = None, os_profile: OsProfile | None = None, virtual_network_profile: VirtualNetworkProfile | None = None, data_disks_groups: List[DataDisksGroups] | None = None, script_actions: List[ScriptAction] | None = None, encrypt_data_disks: bool | None = False, **kwargs)

Parameters

Name	Description
name Required	str The name of the role.
min_instance_count Required	int The minimum instance count of the cluster.
target_instance_count Required	int The instance count of the cluster.
vm_group_name Required	str The name of the virtual machine group.
autoscale_configuration Required	Autoscale The autoscale configurations.
hardware_profile Required	HardwareProfile The hardware profile.
os_profile Required	OsProfile The operating system profile.
virtual_network_profile Required	VirtualNetworkProfile The virtual network profile.
data_disks_groups Required	list[DataDisksGroups] The data disks groups for the role.
script_actions Required	list[ScriptAction] The list of script actions on the role.
encrypt_data_disks Required	bool Indicates whether encrypt the data disks.

Keyword-Only Parameters

Name	Description
name Required
min_instance_count Required
target_instance_count Required
vm_group_name Required
autoscale_configuration Required
hardware_profile Required
os_profile Required
virtual_network_profile Required
data_disks_groups Required
script_actions Required
encrypt_data_disks Required