Role Class
Describes a role on the cluster.
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: _models.Autoscale | None = None, hardware_profile: _models.HardwareProfile | None = None, os_profile: _models.OsProfile | None = None, virtual_network_profile: _models.VirtualNetworkProfile | None = None, data_disks_groups: list['_models.DataDisksGroups'] | None = None, script_actions: list['_models.ScriptAction'] | None = None, encrypt_data_disks: bool = False, **kwargs: Any)Keyword-Only Parameters
| Name | Description |
|---|---|
|
name
|
The name of the role. Default value: None
|
|
min_instance_count
|
The minimum instance count of the cluster. Default value: None
|
|
target_instance_count
|
The instance count of the cluster. Default value: None
|
|
vm_group_name
|
The name of the virtual machine group. Default value: None
|
|
autoscale_configuration
|
The autoscale configurations. Default value: None
|
|
hardware_profile
|
The hardware profile. Default value: None
|
|
os_profile
|
The operating system profile. Default value: None
|
|
virtual_network_profile
|
The virtual network profile. Default value: None
|
|
data_disks_groups
|
The data disks groups for the role. Default value: None
|
|
script_actions
|
The list of script actions on the role. Default value: None
|
|
encrypt_data_disks
|
Indicates whether encrypt the data disks. Default value: False
|
Variables
| Name | Description |
|---|---|
|
name
|
The name of the role. |
|
min_instance_count
|
The minimum instance count of the cluster. |
|
target_instance_count
|
The instance count of the cluster. |
|
vm_group_name
|
The name of the virtual machine group. |
|
autoscale_configuration
|
The autoscale configurations. |
|
hardware_profile
|
The hardware profile. |
|
os_profile
|
The operating system profile. |
|
virtual_network_profile
|
The virtual network profile. |
|
data_disks_groups
|
The data disks groups for the role. |
|
script_actions
|
The list of script actions on the role. |
|
encrypt_data_disks
|
Indicates whether encrypt the data disks. |
