ScaleSet

Manages a virtual machine scale set.

## Disclaimers

Create a ScaleSet Resource

new ScaleSet(name: string, args: ScaleSetArgs, opts?: CustomResourceOptions);

def ScaleSet(resource_name, opts=None, automatic_os_upgrade=None, boot_diagnostics=None, eviction_policy=None, extensions=None, health_probe_id=None, identity=None, license_type=None, location=None, name=None, network_profiles=None, os_profile=None, os_profile_linux_config=None, os_profile_secrets=None, os_profile_windows_config=None, overprovision=None, plan=None, priority=None, proximity_placement_group_id=None, resource_group_name=None, rolling_upgrade_policy=None, single_placement_group=None, sku=None, storage_profile_data_disks=None, storage_profile_image_reference=None, storage_profile_os_disk=None, tags=None, upgrade_policy_mode=None, zones=None, __props__=None);

func NewScaleSet(ctx *Context, name string, args ScaleSetArgs, opts ...ResourceOption) (*ScaleSet, error)

public ScaleSet(string name, ScaleSetArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ScaleSetArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ScaleSetArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ScaleSetArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

ScaleSet Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The ScaleSet resource accepts the following input properties:

NetworkProfiles List<ScaleSetNetworkProfileArgs>: A collection of network profile block as documented below.
OsProfile ScaleSetOsProfileArgs: A Virtual Machine OS Profile block as documented below.
ResourceGroupName string: The name of the resource group in which to create the virtual machine scale set. Changing this forces a new resource to be created.
Sku ScaleSetSkuArgs: A sku block as documented below.
StorageProfileOsDisk ScaleSetStorageProfileOsDiskArgs: A storage profile os disk block as documented below
UpgradePolicyMode string: Specifies the mode of an upgrade to virtual machines in the scale set. Possible values, Rolling, Manual, or Automatic. When choosing Rolling, you will need to set a health probe.
AutomaticOsUpgrade bool: Automatic OS patches can be applied by Azure to your scaleset. This is particularly useful when upgrade_policy_mode is set to Rolling. Defaults to false.
BootDiagnostics ScaleSetBootDiagnosticsArgs: A boot diagnostics profile block as referenced below.
EvictionPolicy string: Specifies the eviction policy for Virtual Machines in this Scale Set. Possible values are Deallocate and Delete.
Extensions List<ScaleSetExtensionArgs>: Can be specified multiple times to add extension profiles to the scale set. Each extension block supports the fields documented below.
HealthProbeId string: Specifies the identifier for the load balancer health probe. Required when using Rolling as your upgrade_policy_mode.
Identity ScaleSetIdentityArgs
LicenseType string: Specifies the Windows OS license type. If supplied, the only allowed values are Windows_Client and Windows_Server.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the virtual machine scale set resource. Changing this forces a new resource to be created.
OsProfileLinuxConfig ScaleSetOsProfileLinuxConfigArgs: A Linux config block as documented below.
OsProfileSecrets List<ScaleSetOsProfileSecretArgs>: A collection of Secret blocks as documented below.
OsProfileWindowsConfig ScaleSetOsProfileWindowsConfigArgs: A Windows config block as documented below.
Overprovision bool: Specifies whether the virtual machine scale set should be overprovisioned.
Plan ScaleSetPlanArgs: A plan block as documented below.
Priority string: Specifies the priority for the Virtual Machines in the Scale Set. Defaults to Regular. Possible values are Low and Regular.
ProximityPlacementGroupId string: The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created
RollingUpgradePolicy ScaleSetRollingUpgradePolicyArgs: A rolling_upgrade_policy block as defined below. This is only applicable when the upgrade_policy_mode is Rolling.
SinglePlacementGroup bool: Specifies whether the scale set is limited to a single placement group with a maximum size of 100 virtual machines. If set to false, managed disks must be used. Default is true. Changing this forces a new resource to be created. See documentation for more information.
StorageProfileDataDisks List<ScaleSetStorageProfileDataDiskArgs>: A storage profile data disk block as documented below
StorageProfileImageReference ScaleSetStorageProfileImageReferenceArgs: A storage profile image reference block as documented below.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
Zones List<string>: A collection of availability zones to spread the Virtual Machines over.

NetworkProfiles []ScaleSetNetworkProfile: A collection of network profile block as documented below.
OsProfile ScaleSetOsProfile: A Virtual Machine OS Profile block as documented below.
ResourceGroupName string: The name of the resource group in which to create the virtual machine scale set. Changing this forces a new resource to be created.
Sku ScaleSetSku: A sku block as documented below.
StorageProfileOsDisk ScaleSetStorageProfileOsDisk: A storage profile os disk block as documented below
UpgradePolicyMode string: Specifies the mode of an upgrade to virtual machines in the scale set. Possible values, Rolling, Manual, or Automatic. When choosing Rolling, you will need to set a health probe.
AutomaticOsUpgrade bool: Automatic OS patches can be applied by Azure to your scaleset. This is particularly useful when upgrade_policy_mode is set to Rolling. Defaults to false.
BootDiagnostics ScaleSetBootDiagnostics: A boot diagnostics profile block as referenced below.
EvictionPolicy string: Specifies the eviction policy for Virtual Machines in this Scale Set. Possible values are Deallocate and Delete.
Extensions []ScaleSetExtension: Can be specified multiple times to add extension profiles to the scale set. Each extension block supports the fields documented below.
HealthProbeId string: Specifies the identifier for the load balancer health probe. Required when using Rolling as your upgrade_policy_mode.
Identity ScaleSetIdentity
LicenseType string: Specifies the Windows OS license type. If supplied, the only allowed values are Windows_Client and Windows_Server.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the virtual machine scale set resource. Changing this forces a new resource to be created.
OsProfileLinuxConfig ScaleSetOsProfileLinuxConfig: A Linux config block as documented below.
OsProfileSecrets []ScaleSetOsProfileSecret: A collection of Secret blocks as documented below.
OsProfileWindowsConfig ScaleSetOsProfileWindowsConfig: A Windows config block as documented below.
Overprovision bool: Specifies whether the virtual machine scale set should be overprovisioned.
Plan ScaleSetPlan: A plan block as documented below.
Priority string: Specifies the priority for the Virtual Machines in the Scale Set. Defaults to Regular. Possible values are Low and Regular.
ProximityPlacementGroupId string: The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created
RollingUpgradePolicy ScaleSetRollingUpgradePolicy: A rolling_upgrade_policy block as defined below. This is only applicable when the upgrade_policy_mode is Rolling.
SinglePlacementGroup bool: Specifies whether the scale set is limited to a single placement group with a maximum size of 100 virtual machines. If set to false, managed disks must be used. Default is true. Changing this forces a new resource to be created. See documentation for more information.
StorageProfileDataDisks []ScaleSetStorageProfileDataDisk: A storage profile data disk block as documented below
StorageProfileImageReference ScaleSetStorageProfileImageReference: A storage profile image reference block as documented below.
Tags map[string]string: A mapping of tags to assign to the resource.
Zones []string: A collection of availability zones to spread the Virtual Machines over.

networkProfiles ScaleSetNetworkProfile[]: A collection of network profile block as documented below.
osProfile ScaleSetOsProfile: A Virtual Machine OS Profile block as documented below.
resourceGroupName string: The name of the resource group in which to create the virtual machine scale set. Changing this forces a new resource to be created.
sku ScaleSetSku: A sku block as documented below.
storageProfileOsDisk ScaleSetStorageProfileOsDisk: A storage profile os disk block as documented below
upgradePolicyMode string: Specifies the mode of an upgrade to virtual machines in the scale set. Possible values, Rolling, Manual, or Automatic. When choosing Rolling, you will need to set a health probe.
automaticOsUpgrade boolean: Automatic OS patches can be applied by Azure to your scaleset. This is particularly useful when upgrade_policy_mode is set to Rolling. Defaults to false.
bootDiagnostics ScaleSetBootDiagnostics: A boot diagnostics profile block as referenced below.
evictionPolicy string: Specifies the eviction policy for Virtual Machines in this Scale Set. Possible values are Deallocate and Delete.
extensions ScaleSetExtension[]: Can be specified multiple times to add extension profiles to the scale set. Each extension block supports the fields documented below.
healthProbeId string: Specifies the identifier for the load balancer health probe. Required when using Rolling as your upgrade_policy_mode.
identity ScaleSetIdentity
licenseType string: Specifies the Windows OS license type. If supplied, the only allowed values are Windows_Client and Windows_Server.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: Specifies the name of the virtual machine scale set resource. Changing this forces a new resource to be created.
osProfileLinuxConfig ScaleSetOsProfileLinuxConfig: A Linux config block as documented below.
osProfileSecrets ScaleSetOsProfileSecret[]: A collection of Secret blocks as documented below.
osProfileWindowsConfig ScaleSetOsProfileWindowsConfig: A Windows config block as documented below.
overprovision boolean: Specifies whether the virtual machine scale set should be overprovisioned.
plan ScaleSetPlan: A plan block as documented below.
priority string: Specifies the priority for the Virtual Machines in the Scale Set. Defaults to Regular. Possible values are Low and Regular.
proximityPlacementGroupId string: The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created
rollingUpgradePolicy ScaleSetRollingUpgradePolicy: A rolling_upgrade_policy block as defined below. This is only applicable when the upgrade_policy_mode is Rolling.
singlePlacementGroup boolean: Specifies whether the scale set is limited to a single placement group with a maximum size of 100 virtual machines. If set to false, managed disks must be used. Default is true. Changing this forces a new resource to be created. See documentation for more information.
storageProfileDataDisks ScaleSetStorageProfileDataDisk[]: A storage profile data disk block as documented below
storageProfileImageReference ScaleSetStorageProfileImageReference: A storage profile image reference block as documented below.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
zones string[]: A collection of availability zones to spread the Virtual Machines over.

network_profiles List[ScaleSetNetworkProfile]: A collection of network profile block as documented below.
os_profile Dict[ScaleSetOsProfile]: A Virtual Machine OS Profile block as documented below.
resource_group_name str: The name of the resource group in which to create the virtual machine scale set. Changing this forces a new resource to be created.
sku Dict[ScaleSetSku]: A sku block as documented below.
storage_profile_os_disk Dict[ScaleSetStorageProfileOsDisk]: A storage profile os disk block as documented below
upgrade_policy_mode str: Specifies the mode of an upgrade to virtual machines in the scale set. Possible values, Rolling, Manual, or Automatic. When choosing Rolling, you will need to set a health probe.
automatic_os_upgrade bool: Automatic OS patches can be applied by Azure to your scaleset. This is particularly useful when upgrade_policy_mode is set to Rolling. Defaults to false.
boot_diagnostics Dict[ScaleSetBootDiagnostics]: A boot diagnostics profile block as referenced below.
eviction_policy str: Specifies the eviction policy for Virtual Machines in this Scale Set. Possible values are Deallocate and Delete.
extensions List[ScaleSetExtension]: Can be specified multiple times to add extension profiles to the scale set. Each extension block supports the fields documented below.
health_probe_id str: Specifies the identifier for the load balancer health probe. Required when using Rolling as your upgrade_policy_mode.
identity Dict[ScaleSetIdentity]
license_type str: Specifies the Windows OS license type. If supplied, the only allowed values are Windows_Client and Windows_Server.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: Specifies the name of the virtual machine scale set resource. Changing this forces a new resource to be created.
os_profile_linux_config Dict[ScaleSetOsProfileLinuxConfig]: A Linux config block as documented below.
os_profile_secrets List[ScaleSetOsProfileSecret]: A collection of Secret blocks as documented below.
os_profile_windows_config Dict[ScaleSetOsProfileWindowsConfig]: A Windows config block as documented below.
overprovision bool: Specifies whether the virtual machine scale set should be overprovisioned.
plan Dict[ScaleSetPlan]: A plan block as documented below.
priority str: Specifies the priority for the Virtual Machines in the Scale Set. Defaults to Regular. Possible values are Low and Regular.
proximity_placement_group_id str: The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created
rolling_upgrade_policy Dict[ScaleSetRollingUpgradePolicy]: A rolling_upgrade_policy block as defined below. This is only applicable when the upgrade_policy_mode is Rolling.
single_placement_group bool: Specifies whether the scale set is limited to a single placement group with a maximum size of 100 virtual machines. If set to false, managed disks must be used. Default is true. Changing this forces a new resource to be created. See documentation for more information.
storage_profile_data_disks List[ScaleSetStorageProfileDataDisk]: A storage profile data disk block as documented below
storage_profile_image_reference Dict[ScaleSetStorageProfileImageReference]: A storage profile image reference block as documented below.
tags Dict[str, str]: A mapping of tags to assign to the resource.
zones List[str]: A collection of availability zones to spread the Virtual Machines over.

Outputs

All input properties are implicitly available as output properties. Additionally, the ScaleSet resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing ScaleSet Resource

Get an existing ScaleSet resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ScaleSetState, opts?: CustomResourceOptions): ScaleSet

static get(resource_name, id, opts=None, automatic_os_upgrade=None, boot_diagnostics=None, eviction_policy=None, extensions=None, health_probe_id=None, identity=None, license_type=None, location=None, name=None, network_profiles=None, os_profile=None, os_profile_linux_config=None, os_profile_secrets=None, os_profile_windows_config=None, overprovision=None, plan=None, priority=None, proximity_placement_group_id=None, resource_group_name=None, rolling_upgrade_policy=None, single_placement_group=None, sku=None, storage_profile_data_disks=None, storage_profile_image_reference=None, storage_profile_os_disk=None, tags=None, upgrade_policy_mode=None, zones=None, __props__=None);

func GetScaleSet(ctx *Context, name string, id IDInput, state *ScaleSetState, opts ...ResourceOption) (*ScaleSet, error)

public static ScaleSet Get(string name, Input<string> id, ScaleSetState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AutomaticOsUpgrade bool: Automatic OS patches can be applied by Azure to your scaleset. This is particularly useful when upgrade_policy_mode is set to Rolling. Defaults to false.
BootDiagnostics ScaleSetBootDiagnosticsArgs: A boot diagnostics profile block as referenced below.
EvictionPolicy string: Specifies the eviction policy for Virtual Machines in this Scale Set. Possible values are Deallocate and Delete.
Extensions List<ScaleSetExtensionArgs>: Can be specified multiple times to add extension profiles to the scale set. Each extension block supports the fields documented below.
HealthProbeId string: Specifies the identifier for the load balancer health probe. Required when using Rolling as your upgrade_policy_mode.
Identity ScaleSetIdentityArgs
LicenseType string: Specifies the Windows OS license type. If supplied, the only allowed values are Windows_Client and Windows_Server.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the virtual machine scale set resource. Changing this forces a new resource to be created.
NetworkProfiles List<ScaleSetNetworkProfileArgs>: A collection of network profile block as documented below.
OsProfile ScaleSetOsProfileArgs: A Virtual Machine OS Profile block as documented below.
OsProfileLinuxConfig ScaleSetOsProfileLinuxConfigArgs: A Linux config block as documented below.
OsProfileSecrets List<ScaleSetOsProfileSecretArgs>: A collection of Secret blocks as documented below.
OsProfileWindowsConfig ScaleSetOsProfileWindowsConfigArgs: A Windows config block as documented below.
Overprovision bool: Specifies whether the virtual machine scale set should be overprovisioned.
Plan ScaleSetPlanArgs: A plan block as documented below.
Priority string: Specifies the priority for the Virtual Machines in the Scale Set. Defaults to Regular. Possible values are Low and Regular.
ProximityPlacementGroupId string: The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created
ResourceGroupName string: The name of the resource group in which to create the virtual machine scale set. Changing this forces a new resource to be created.
RollingUpgradePolicy ScaleSetRollingUpgradePolicyArgs: A rolling_upgrade_policy block as defined below. This is only applicable when the upgrade_policy_mode is Rolling.
SinglePlacementGroup bool: Specifies whether the scale set is limited to a single placement group with a maximum size of 100 virtual machines. If set to false, managed disks must be used. Default is true. Changing this forces a new resource to be created. See documentation for more information.
Sku ScaleSetSkuArgs: A sku block as documented below.
StorageProfileDataDisks List<ScaleSetStorageProfileDataDiskArgs>: A storage profile data disk block as documented below
StorageProfileImageReference ScaleSetStorageProfileImageReferenceArgs: A storage profile image reference block as documented below.
StorageProfileOsDisk ScaleSetStorageProfileOsDiskArgs: A storage profile os disk block as documented below
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
UpgradePolicyMode string: Specifies the mode of an upgrade to virtual machines in the scale set. Possible values, Rolling, Manual, or Automatic. When choosing Rolling, you will need to set a health probe.
Zones List<string>: A collection of availability zones to spread the Virtual Machines over.

AutomaticOsUpgrade bool: Automatic OS patches can be applied by Azure to your scaleset. This is particularly useful when upgrade_policy_mode is set to Rolling. Defaults to false.
BootDiagnostics ScaleSetBootDiagnostics: A boot diagnostics profile block as referenced below.
EvictionPolicy string: Specifies the eviction policy for Virtual Machines in this Scale Set. Possible values are Deallocate and Delete.
Extensions []ScaleSetExtension: Can be specified multiple times to add extension profiles to the scale set. Each extension block supports the fields documented below.
HealthProbeId string: Specifies the identifier for the load balancer health probe. Required when using Rolling as your upgrade_policy_mode.
Identity ScaleSetIdentity
LicenseType string: Specifies the Windows OS license type. If supplied, the only allowed values are Windows_Client and Windows_Server.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the virtual machine scale set resource. Changing this forces a new resource to be created.
NetworkProfiles []ScaleSetNetworkProfile: A collection of network profile block as documented below.
OsProfile ScaleSetOsProfile: A Virtual Machine OS Profile block as documented below.
OsProfileLinuxConfig ScaleSetOsProfileLinuxConfig: A Linux config block as documented below.
OsProfileSecrets []ScaleSetOsProfileSecret: A collection of Secret blocks as documented below.
OsProfileWindowsConfig ScaleSetOsProfileWindowsConfig: A Windows config block as documented below.
Overprovision bool: Specifies whether the virtual machine scale set should be overprovisioned.
Plan ScaleSetPlan: A plan block as documented below.
Priority string: Specifies the priority for the Virtual Machines in the Scale Set. Defaults to Regular. Possible values are Low and Regular.
ProximityPlacementGroupId string: The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created
ResourceGroupName string: The name of the resource group in which to create the virtual machine scale set. Changing this forces a new resource to be created.
RollingUpgradePolicy ScaleSetRollingUpgradePolicy: A rolling_upgrade_policy block as defined below. This is only applicable when the upgrade_policy_mode is Rolling.
SinglePlacementGroup bool: Specifies whether the scale set is limited to a single placement group with a maximum size of 100 virtual machines. If set to false, managed disks must be used. Default is true. Changing this forces a new resource to be created. See documentation for more information.
Sku ScaleSetSku: A sku block as documented below.
StorageProfileDataDisks []ScaleSetStorageProfileDataDisk: A storage profile data disk block as documented below
StorageProfileImageReference ScaleSetStorageProfileImageReference: A storage profile image reference block as documented below.
StorageProfileOsDisk ScaleSetStorageProfileOsDisk: A storage profile os disk block as documented below
Tags map[string]string: A mapping of tags to assign to the resource.
UpgradePolicyMode string: Specifies the mode of an upgrade to virtual machines in the scale set. Possible values, Rolling, Manual, or Automatic. When choosing Rolling, you will need to set a health probe.
Zones []string: A collection of availability zones to spread the Virtual Machines over.

automaticOsUpgrade boolean: Automatic OS patches can be applied by Azure to your scaleset. This is particularly useful when upgrade_policy_mode is set to Rolling. Defaults to false.
bootDiagnostics ScaleSetBootDiagnostics: A boot diagnostics profile block as referenced below.
evictionPolicy string: Specifies the eviction policy for Virtual Machines in this Scale Set. Possible values are Deallocate and Delete.
extensions ScaleSetExtension[]: Can be specified multiple times to add extension profiles to the scale set. Each extension block supports the fields documented below.
healthProbeId string: Specifies the identifier for the load balancer health probe. Required when using Rolling as your upgrade_policy_mode.
identity ScaleSetIdentity
licenseType string: Specifies the Windows OS license type. If supplied, the only allowed values are Windows_Client and Windows_Server.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: Specifies the name of the virtual machine scale set resource. Changing this forces a new resource to be created.
networkProfiles ScaleSetNetworkProfile[]: A collection of network profile block as documented below.
osProfile ScaleSetOsProfile: A Virtual Machine OS Profile block as documented below.
osProfileLinuxConfig ScaleSetOsProfileLinuxConfig: A Linux config block as documented below.
osProfileSecrets ScaleSetOsProfileSecret[]: A collection of Secret blocks as documented below.
osProfileWindowsConfig ScaleSetOsProfileWindowsConfig: A Windows config block as documented below.
overprovision boolean: Specifies whether the virtual machine scale set should be overprovisioned.
plan ScaleSetPlan: A plan block as documented below.
priority string: Specifies the priority for the Virtual Machines in the Scale Set. Defaults to Regular. Possible values are Low and Regular.
proximityPlacementGroupId string: The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created
resourceGroupName string: The name of the resource group in which to create the virtual machine scale set. Changing this forces a new resource to be created.
rollingUpgradePolicy ScaleSetRollingUpgradePolicy: A rolling_upgrade_policy block as defined below. This is only applicable when the upgrade_policy_mode is Rolling.
singlePlacementGroup boolean: Specifies whether the scale set is limited to a single placement group with a maximum size of 100 virtual machines. If set to false, managed disks must be used. Default is true. Changing this forces a new resource to be created. See documentation for more information.
sku ScaleSetSku: A sku block as documented below.
storageProfileDataDisks ScaleSetStorageProfileDataDisk[]: A storage profile data disk block as documented below
storageProfileImageReference ScaleSetStorageProfileImageReference: A storage profile image reference block as documented below.
storageProfileOsDisk ScaleSetStorageProfileOsDisk: A storage profile os disk block as documented below
tags {[key: string]: string}: A mapping of tags to assign to the resource.
upgradePolicyMode string: Specifies the mode of an upgrade to virtual machines in the scale set. Possible values, Rolling, Manual, or Automatic. When choosing Rolling, you will need to set a health probe.
zones string[]: A collection of availability zones to spread the Virtual Machines over.

automatic_os_upgrade bool: Automatic OS patches can be applied by Azure to your scaleset. This is particularly useful when upgrade_policy_mode is set to Rolling. Defaults to false.
boot_diagnostics Dict[ScaleSetBootDiagnostics]: A boot diagnostics profile block as referenced below.
eviction_policy str: Specifies the eviction policy for Virtual Machines in this Scale Set. Possible values are Deallocate and Delete.
extensions List[ScaleSetExtension]: Can be specified multiple times to add extension profiles to the scale set. Each extension block supports the fields documented below.
health_probe_id str: Specifies the identifier for the load balancer health probe. Required when using Rolling as your upgrade_policy_mode.
identity Dict[ScaleSetIdentity]
license_type str: Specifies the Windows OS license type. If supplied, the only allowed values are Windows_Client and Windows_Server.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: Specifies the name of the virtual machine scale set resource. Changing this forces a new resource to be created.
network_profiles List[ScaleSetNetworkProfile]: A collection of network profile block as documented below.
os_profile Dict[ScaleSetOsProfile]: A Virtual Machine OS Profile block as documented below.
os_profile_linux_config Dict[ScaleSetOsProfileLinuxConfig]: A Linux config block as documented below.
os_profile_secrets List[ScaleSetOsProfileSecret]: A collection of Secret blocks as documented below.
os_profile_windows_config Dict[ScaleSetOsProfileWindowsConfig]: A Windows config block as documented below.
overprovision bool: Specifies whether the virtual machine scale set should be overprovisioned.
plan Dict[ScaleSetPlan]: A plan block as documented below.
priority str: Specifies the priority for the Virtual Machines in the Scale Set. Defaults to Regular. Possible values are Low and Regular.
proximity_placement_group_id str: The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created
resource_group_name str: The name of the resource group in which to create the virtual machine scale set. Changing this forces a new resource to be created.
rolling_upgrade_policy Dict[ScaleSetRollingUpgradePolicy]: A rolling_upgrade_policy block as defined below. This is only applicable when the upgrade_policy_mode is Rolling.
single_placement_group bool: Specifies whether the scale set is limited to a single placement group with a maximum size of 100 virtual machines. If set to false, managed disks must be used. Default is true. Changing this forces a new resource to be created. See documentation for more information.
sku Dict[ScaleSetSku]: A sku block as documented below.
storage_profile_data_disks List[ScaleSetStorageProfileDataDisk]: A storage profile data disk block as documented below
storage_profile_image_reference Dict[ScaleSetStorageProfileImageReference]: A storage profile image reference block as documented below.
storage_profile_os_disk Dict[ScaleSetStorageProfileOsDisk]: A storage profile os disk block as documented below
tags Dict[str, str]: A mapping of tags to assign to the resource.
upgrade_policy_mode str: Specifies the mode of an upgrade to virtual machines in the scale set. Possible values, Rolling, Manual, or Automatic. When choosing Rolling, you will need to set a health probe.
zones List[str]: A collection of availability zones to spread the Virtual Machines over.

Supporting Types

ScaleSetBootDiagnostics

StorageUri string
Enabled bool

StorageUri string
Enabled bool

storageUri string
enabled boolean

storageUri str
enabled bool

ScaleSetExtension

Name string: Specifies the name of the extension.
Publisher string: The publisher of the extension, available publishers can be found by using the Azure CLI.
Type string: The type of extension, available types for a publisher can be found using the Azure CLI.
TypeHandlerVersion string: Specifies the version of the extension to use, available versions can be found using the Azure CLI.
AutoUpgradeMinorVersion bool: Specifies whether or not to use the latest minor version available.
ProtectedSettings string: The protected_settings passed to the extension, like settings, these are specified as a JSON object in a string.
ProvisionAfterExtensions List<string>: Specifies a dependency array of extensions required to be executed before, the array stores the name of each extension.
Settings string: The settings passed to the extension, these are specified as a JSON object in a string.

Name string: Specifies the name of the extension.
Publisher string: The publisher of the extension, available publishers can be found by using the Azure CLI.
Type string: The type of extension, available types for a publisher can be found using the Azure CLI.
TypeHandlerVersion string: Specifies the version of the extension to use, available versions can be found using the Azure CLI.
AutoUpgradeMinorVersion bool: Specifies whether or not to use the latest minor version available.
ProtectedSettings string: The protected_settings passed to the extension, like settings, these are specified as a JSON object in a string.
ProvisionAfterExtensions []string: Specifies a dependency array of extensions required to be executed before, the array stores the name of each extension.
Settings string: The settings passed to the extension, these are specified as a JSON object in a string.

name string: Specifies the name of the extension.
publisher string: The publisher of the extension, available publishers can be found by using the Azure CLI.
type string: The type of extension, available types for a publisher can be found using the Azure CLI.
typeHandlerVersion string: Specifies the version of the extension to use, available versions can be found using the Azure CLI.
autoUpgradeMinorVersion boolean: Specifies whether or not to use the latest minor version available.
protectedSettings string: The protected_settings passed to the extension, like settings, these are specified as a JSON object in a string.
provisionAfterExtensions string[]: Specifies a dependency array of extensions required to be executed before, the array stores the name of each extension.
settings string: The settings passed to the extension, these are specified as a JSON object in a string.

name str: Specifies the name of the extension.
publisher str: The publisher of the extension, available publishers can be found by using the Azure CLI.
type str: The type of extension, available types for a publisher can be found using the Azure CLI.
type_handler_version str: Specifies the version of the extension to use, available versions can be found using the Azure CLI.
auto_upgrade_minor_version bool: Specifies whether or not to use the latest minor version available.
protected_settings str: The protected_settings passed to the extension, like settings, these are specified as a JSON object in a string.
provision_after_extensions List[str]: Specifies a dependency array of extensions required to be executed before, the array stores the name of each extension.
settings str: The settings passed to the extension, these are specified as a JSON object in a string.

ScaleSetIdentity

Type string: Specifies the identity type to be assigned to the scale set. Allowable values are SystemAssigned and UserAssigned. For the SystemAssigned identity the scale set’s Service Principal ID (SPN) can be retrieved after the scale set has been created. See documentation for more information.
IdentityIds List<string>: Specifies a list of user managed identity ids to be assigned to the VMSS. Required if type is UserAssigned.
PrincipalId string

Type string: Specifies the identity type to be assigned to the scale set. Allowable values are SystemAssigned and UserAssigned. For the SystemAssigned identity the scale set’s Service Principal ID (SPN) can be retrieved after the scale set has been created. See documentation for more information.
IdentityIds []string: Specifies a list of user managed identity ids to be assigned to the VMSS. Required if type is UserAssigned.
PrincipalId string

type string: Specifies the identity type to be assigned to the scale set. Allowable values are SystemAssigned and UserAssigned. For the SystemAssigned identity the scale set’s Service Principal ID (SPN) can be retrieved after the scale set has been created. See documentation for more information.
identityIds string[]: Specifies a list of user managed identity ids to be assigned to the VMSS. Required if type is UserAssigned.
principalId string

type str: Specifies the identity type to be assigned to the scale set. Allowable values are SystemAssigned and UserAssigned. For the SystemAssigned identity the scale set’s Service Principal ID (SPN) can be retrieved after the scale set has been created. See documentation for more information.
identityIds List[str]: Specifies a list of user managed identity ids to be assigned to the VMSS. Required if type is UserAssigned.
principal_id str

ScaleSetNetworkProfile

IpConfigurations List<ScaleSetNetworkProfileIpConfigurationArgs>: An ip_configuration block as documented below.
Name string: Specifies the name of the network interface configuration.
Primary bool: Indicates whether network interfaces created from the network interface configuration will be the primary NIC of the VM.
AcceleratedNetworking bool: Specifies whether to enable accelerated networking or not. Defaults to false.
DnsSettings ScaleSetNetworkProfileDnsSettingsArgs: A dns_settings block as documented below.
IpForwarding bool: Whether IP forwarding is enabled on this NIC. Defaults to false.
NetworkSecurityGroupId string: Specifies the identifier for the network security group.

IpConfigurations []ScaleSetNetworkProfileIpConfiguration: An ip_configuration block as documented below.
Name string: Specifies the name of the network interface configuration.
Primary bool: Indicates whether network interfaces created from the network interface configuration will be the primary NIC of the VM.
AcceleratedNetworking bool: Specifies whether to enable accelerated networking or not. Defaults to false.
DnsSettings ScaleSetNetworkProfileDnsSettings: A dns_settings block as documented below.
IpForwarding bool: Whether IP forwarding is enabled on this NIC. Defaults to false.
NetworkSecurityGroupId string: Specifies the identifier for the network security group.

ipConfigurations ScaleSetNetworkProfileIpConfiguration[]: An ip_configuration block as documented below.
name string: Specifies the name of the network interface configuration.
primary boolean: Indicates whether network interfaces created from the network interface configuration will be the primary NIC of the VM.
acceleratedNetworking boolean: Specifies whether to enable accelerated networking or not. Defaults to false.
dnsSettings ScaleSetNetworkProfileDnsSettings: A dns_settings block as documented below.
ipForwarding boolean: Whether IP forwarding is enabled on this NIC. Defaults to false.
networkSecurityGroupId string: Specifies the identifier for the network security group.

ip_configurations List[ScaleSetNetworkProfileIpConfiguration]: An ip_configuration block as documented below.
name str: Specifies the name of the network interface configuration.
primary bool: Indicates whether network interfaces created from the network interface configuration will be the primary NIC of the VM.
acceleratedNetworking bool: Specifies whether to enable accelerated networking or not. Defaults to false.
dnsSettings Dict[ScaleSetNetworkProfileDnsSettings]: A dns_settings block as documented below.
ipForwarding bool: Whether IP forwarding is enabled on this NIC. Defaults to false.
network_security_group_id str: Specifies the identifier for the network security group.

ScaleSetNetworkProfileDnsSettings

DnsServers List<string>: Specifies an array of dns servers.

DnsServers []string: Specifies an array of dns servers.

dnsServers string[]: Specifies an array of dns servers.

dns_servers List[str]: Specifies an array of dns servers.

ScaleSetNetworkProfileIpConfiguration

Name string: Specifies name of the IP configuration.
Primary bool: Specifies if this ip_configuration is the primary one.
SubnetId string: Specifies the identifier of the subnet.
ApplicationGatewayBackendAddressPoolIds List<string>: Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets can use the same application gateway.
ApplicationSecurityGroupIds List<string>: Specifies up to 20 application security group IDs.
LoadBalancerBackendAddressPoolIds List<string>: Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer.
LoadBalancerInboundNatRulesIds List<string>: Specifies an array of references to inbound NAT pools for load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer.
PublicIpAddressConfiguration ScaleSetNetworkProfileIpConfigurationPublicIpAddressConfigurationArgs: Describes a virtual machines scale set IP Configuration’s PublicIPAddress configuration. The public_ip_address_configuration is documented below.

Name string: Specifies name of the IP configuration.
Primary bool: Specifies if this ip_configuration is the primary one.
SubnetId string: Specifies the identifier of the subnet.
ApplicationGatewayBackendAddressPoolIds []string: Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets can use the same application gateway.
ApplicationSecurityGroupIds []string: Specifies up to 20 application security group IDs.
LoadBalancerBackendAddressPoolIds []string: Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer.
LoadBalancerInboundNatRulesIds []string: Specifies an array of references to inbound NAT pools for load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer.
PublicIpAddressConfiguration ScaleSetNetworkProfileIpConfigurationPublicIpAddressConfiguration: Describes a virtual machines scale set IP Configuration’s PublicIPAddress configuration. The public_ip_address_configuration is documented below.

name string: Specifies name of the IP configuration.
primary boolean: Specifies if this ip_configuration is the primary one.
subnetId string: Specifies the identifier of the subnet.
applicationGatewayBackendAddressPoolIds string[]: Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets can use the same application gateway.
applicationSecurityGroupIds string[]: Specifies up to 20 application security group IDs.
loadBalancerBackendAddressPoolIds string[]: Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer.
loadBalancerInboundNatRulesIds string[]: Specifies an array of references to inbound NAT pools for load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer.
publicIpAddressConfiguration ScaleSetNetworkProfileIpConfigurationPublicIpAddressConfiguration: Describes a virtual machines scale set IP Configuration’s PublicIPAddress configuration. The public_ip_address_configuration is documented below.

name str: Specifies name of the IP configuration.
primary bool: Specifies if this ip_configuration is the primary one.
subnet_id str: Specifies the identifier of the subnet.
applicationGatewayBackendAddressPoolIds List[str]: Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets can use the same application gateway.
applicationSecurityGroupIds List[str]: Specifies up to 20 application security group IDs.
loadBalancerBackendAddressPoolIds List[str]: Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer.
loadBalancerInboundNatRulesIds List[str]: Specifies an array of references to inbound NAT pools for load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer.
publicIpAddressConfiguration Dict[ScaleSetNetworkProfileIpConfigurationPublicIpAddressConfiguration]: Describes a virtual machines scale set IP Configuration’s PublicIPAddress configuration. The public_ip_address_configuration is documented below.

ScaleSetNetworkProfileIpConfigurationPublicIpAddressConfiguration

DomainNameLabel string: The domain name label for the dns settings.
IdleTimeout int: The idle timeout in minutes. This value must be between 4 and 30.
Name string: The name of the public ip address configuration

DomainNameLabel string: The domain name label for the dns settings.
IdleTimeout int: The idle timeout in minutes. This value must be between 4 and 30.
Name string: The name of the public ip address configuration

domainNameLabel string: The domain name label for the dns settings.
idleTimeout number: The idle timeout in minutes. This value must be between 4 and 30.
name string: The name of the public ip address configuration

domain_name_label str: The domain name label for the dns settings.
idleTimeout float: The idle timeout in minutes. This value must be between 4 and 30.
name str: The name of the public ip address configuration

ScaleSetOsProfile

AdminUsername string: Specifies the administrator account name to use for all the instances of virtual machines in the scale set.
ComputerNamePrefix string: Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 9 characters long for windows images and 1 - 58 for linux. Changing this forces a new resource to be created.
AdminPassword string: Specifies the administrator password to use for all the instances of virtual machines in a scale set.
CustomData string: Specifies custom data to supply to the machine. On linux-based systems, this can be used as a cloud-init script. On other systems, this will be copied as a file on disk. Internally, this provider will base64 encode this value before sending it to the API. The maximum length of the binary array is 65535 bytes.

AdminUsername string: Specifies the administrator account name to use for all the instances of virtual machines in the scale set.
ComputerNamePrefix string: Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 9 characters long for windows images and 1 - 58 for linux. Changing this forces a new resource to be created.
AdminPassword string: Specifies the administrator password to use for all the instances of virtual machines in a scale set.
CustomData string: Specifies custom data to supply to the machine. On linux-based systems, this can be used as a cloud-init script. On other systems, this will be copied as a file on disk. Internally, this provider will base64 encode this value before sending it to the API. The maximum length of the binary array is 65535 bytes.

adminUsername string: Specifies the administrator account name to use for all the instances of virtual machines in the scale set.
computerNamePrefix string: Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 9 characters long for windows images and 1 - 58 for linux. Changing this forces a new resource to be created.
adminPassword string: Specifies the administrator password to use for all the instances of virtual machines in a scale set.
customData string: Specifies custom data to supply to the machine. On linux-based systems, this can be used as a cloud-init script. On other systems, this will be copied as a file on disk. Internally, this provider will base64 encode this value before sending it to the API. The maximum length of the binary array is 65535 bytes.

admin_username str: Specifies the administrator account name to use for all the instances of virtual machines in the scale set.
computer_name_prefix str: Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 9 characters long for windows images and 1 - 58 for linux. Changing this forces a new resource to be created.
admin_password str: Specifies the administrator password to use for all the instances of virtual machines in a scale set.
custom_data str: Specifies custom data to supply to the machine. On linux-based systems, this can be used as a cloud-init script. On other systems, this will be copied as a file on disk. Internally, this provider will base64 encode this value before sending it to the API. The maximum length of the binary array is 65535 bytes.

ScaleSetOsProfileLinuxConfig

DisablePasswordAuthentication bool: Specifies whether password authentication should be disabled. Defaults to false. Changing this forces a new resource to be created.
SshKeys List<ScaleSetOsProfileLinuxConfigSshKeyArgs>: Specifies a collection of path and key_data to be placed on the virtual machine.

DisablePasswordAuthentication bool: Specifies whether password authentication should be disabled. Defaults to false. Changing this forces a new resource to be created.
SshKeys []ScaleSetOsProfileLinuxConfigSshKey: Specifies a collection of path and key_data to be placed on the virtual machine.

disablePasswordAuthentication boolean: Specifies whether password authentication should be disabled. Defaults to false. Changing this forces a new resource to be created.
sshKeys ScaleSetOsProfileLinuxConfigSshKey[]: Specifies a collection of path and key_data to be placed on the virtual machine.

disable_password_authentication bool: Specifies whether password authentication should be disabled. Defaults to false. Changing this forces a new resource to be created.
sshKeys List[ScaleSetOsProfileLinuxConfigSshKey]: Specifies a collection of path and key_data to be placed on the virtual machine.

ScaleSetOsProfileLinuxConfigSshKey

Path string
KeyData string

Path string
KeyData string

path string
keyData string

path str
keyData str

ScaleSetOsProfileSecret

SourceVaultId string: Specifies the key vault to use.
VaultCertificates List<ScaleSetOsProfileSecretVaultCertificateArgs>: A collection of Vault Certificates as documented below

SourceVaultId string: Specifies the key vault to use.
VaultCertificates []ScaleSetOsProfileSecretVaultCertificate: A collection of Vault Certificates as documented below

sourceVaultId string: Specifies the key vault to use.
vaultCertificates ScaleSetOsProfileSecretVaultCertificate[]: A collection of Vault Certificates as documented below

sourceVaultId str: Specifies the key vault to use.
vaultCertificates List[ScaleSetOsProfileSecretVaultCertificate]: A collection of Vault Certificates as documented below

ScaleSetOsProfileSecretVaultCertificate

CertificateUrl string: It is the Base64 encoding of a JSON Object that which is encoded in UTF-8 of which the contents need to be data, dataType and password.
CertificateStore string: Specifies the certificate store on the Virtual Machine where the certificate should be added to.

CertificateUrl string: It is the Base64 encoding of a JSON Object that which is encoded in UTF-8 of which the contents need to be data, dataType and password.
CertificateStore string: Specifies the certificate store on the Virtual Machine where the certificate should be added to.

certificateUrl string: It is the Base64 encoding of a JSON Object that which is encoded in UTF-8 of which the contents need to be data, dataType and password.
certificateStore string: Specifies the certificate store on the Virtual Machine where the certificate should be added to.

certificateUrl str: It is the Base64 encoding of a JSON Object that which is encoded in UTF-8 of which the contents need to be data, dataType and password.
certificateStore str: Specifies the certificate store on the Virtual Machine where the certificate should be added to.

ScaleSetOsProfileWindowsConfig

AdditionalUnattendConfigs List<ScaleSetOsProfileWindowsConfigAdditionalUnattendConfigArgs>: An Additional Unattended Config block as documented below.
EnableAutomaticUpgrades bool: Indicates whether virtual machines in the scale set are enabled for automatic updates.
ProvisionVmAgent bool: Indicates whether virtual machine agent should be provisioned on the virtual machines in the scale set.
Winrms List<ScaleSetOsProfileWindowsConfigWinrmArgs>: A collection of WinRM configuration blocks as documented below.

AdditionalUnattendConfigs []ScaleSetOsProfileWindowsConfigAdditionalUnattendConfig: An Additional Unattended Config block as documented below.
EnableAutomaticUpgrades bool: Indicates whether virtual machines in the scale set are enabled for automatic updates.
ProvisionVmAgent bool: Indicates whether virtual machine agent should be provisioned on the virtual machines in the scale set.
Winrms []ScaleSetOsProfileWindowsConfigWinrm: A collection of WinRM configuration blocks as documented below.

additionalUnattendConfigs ScaleSetOsProfileWindowsConfigAdditionalUnattendConfig[]: An Additional Unattended Config block as documented below.
enableAutomaticUpgrades boolean: Indicates whether virtual machines in the scale set are enabled for automatic updates.
provisionVmAgent boolean: Indicates whether virtual machine agent should be provisioned on the virtual machines in the scale set.
winrms ScaleSetOsProfileWindowsConfigWinrm[]: A collection of WinRM configuration blocks as documented below.

additionalUnattendConfigs List[ScaleSetOsProfileWindowsConfigAdditionalUnattendConfig]: An Additional Unattended Config block as documented below.
enableAutomaticUpgrades bool: Indicates whether virtual machines in the scale set are enabled for automatic updates.
provision_vm_agent bool: Indicates whether virtual machine agent should be provisioned on the virtual machines in the scale set.
winrms List[ScaleSetOsProfileWindowsConfigWinrm]: A collection of WinRM configuration blocks as documented below.

ScaleSetOsProfileWindowsConfigAdditionalUnattendConfig

Component string: Specifies the name of the component to configure with the added content. The only allowable value is Microsoft-Windows-Shell-Setup.
Content string: Specifies the base-64 encoded XML formatted content that is added to the unattend.xml file for the specified path and component.
Pass string: Specifies the name of the pass that the content applies to. The only allowable value is oobeSystem.
SettingName string: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

Component string: Specifies the name of the component to configure with the added content. The only allowable value is Microsoft-Windows-Shell-Setup.
Content string: Specifies the base-64 encoded XML formatted content that is added to the unattend.xml file for the specified path and component.
Pass string: Specifies the name of the pass that the content applies to. The only allowable value is oobeSystem.
SettingName string: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

component string: Specifies the name of the component to configure with the added content. The only allowable value is Microsoft-Windows-Shell-Setup.
content string: Specifies the base-64 encoded XML formatted content that is added to the unattend.xml file for the specified path and component.
pass string: Specifies the name of the pass that the content applies to. The only allowable value is oobeSystem.
settingName string: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

component str: Specifies the name of the component to configure with the added content. The only allowable value is Microsoft-Windows-Shell-Setup.
content str: Specifies the base-64 encoded XML formatted content that is added to the unattend.xml file for the specified path and component.
pass str: Specifies the name of the pass that the content applies to. The only allowable value is oobeSystem.
settingName str: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

ScaleSetOsProfileWindowsConfigWinrm

Protocol string: Specifies the protocol of listener
CertificateUrl string: Specifies URL of the certificate with which new Virtual Machines is provisioned.

Protocol string: Specifies the protocol of listener
CertificateUrl string: Specifies URL of the certificate with which new Virtual Machines is provisioned.

protocol string: Specifies the protocol of listener
certificateUrl string: Specifies URL of the certificate with which new Virtual Machines is provisioned.

protocol str: Specifies the protocol of listener
certificateUrl str: Specifies URL of the certificate with which new Virtual Machines is provisioned.

ScaleSetPlan

Name string: Specifies the name of the image from the marketplace.
Product string: Specifies the product of the image from the marketplace.
Publisher string: Specifies the publisher of the image.

Name string: Specifies the name of the image from the marketplace.
Product string: Specifies the product of the image from the marketplace.
Publisher string: Specifies the publisher of the image.

name string: Specifies the name of the image from the marketplace.
product string: Specifies the product of the image from the marketplace.
publisher string: Specifies the publisher of the image.

name str: Specifies the name of the image from the marketplace.
product str: Specifies the product of the image from the marketplace.
publisher str: Specifies the publisher of the image.

ScaleSetRollingUpgradePolicy

MaxBatchInstancePercent int: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. Defaults to 20.
MaxUnhealthyInstancePercent int: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. Defaults to 20.
MaxUnhealthyUpgradedInstancePercent int: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. Defaults to 20.
PauseTimeBetweenBatches string: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format for duration (https://en.wikipedia.org/wiki/ISO_8601#Durations). Defaults to 0 seconds represented as PT0S.

MaxBatchInstancePercent int: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. Defaults to 20.
MaxUnhealthyInstancePercent int: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. Defaults to 20.
MaxUnhealthyUpgradedInstancePercent int: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. Defaults to 20.
PauseTimeBetweenBatches string: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format for duration (https://en.wikipedia.org/wiki/ISO_8601#Durations). Defaults to 0 seconds represented as PT0S.

maxBatchInstancePercent number: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. Defaults to 20.
maxUnhealthyInstancePercent number: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. Defaults to 20.
maxUnhealthyUpgradedInstancePercent number: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. Defaults to 20.
pauseTimeBetweenBatches string: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format for duration (https://en.wikipedia.org/wiki/ISO_8601#Durations). Defaults to 0 seconds represented as PT0S.

maxBatchInstancePercent float: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. Defaults to 20.
maxUnhealthyInstancePercent float: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. Defaults to 20.
maxUnhealthyUpgradedInstancePercent float: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. Defaults to 20.
pauseTimeBetweenBatches str: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format for duration (https://en.wikipedia.org/wiki/ISO_8601#Durations). Defaults to 0 seconds represented as PT0S.

ScaleSetSku

Capacity int: Specifies the number of virtual machines in the scale set.
Name string: Specifies the size of virtual machines in a scale set.
Tier string: Specifies the tier of virtual machines in a scale set. Possible values, standard or basic.

Capacity int: Specifies the number of virtual machines in the scale set.
Name string: Specifies the size of virtual machines in a scale set.
Tier string: Specifies the tier of virtual machines in a scale set. Possible values, standard or basic.

capacity number: Specifies the number of virtual machines in the scale set.
name string: Specifies the size of virtual machines in a scale set.
tier string: Specifies the tier of virtual machines in a scale set. Possible values, standard or basic.

capacity float: Specifies the number of virtual machines in the scale set.
name str: Specifies the size of virtual machines in a scale set.
tier str: Specifies the tier of virtual machines in a scale set. Possible values, standard or basic.

ScaleSetStorageProfileDataDisk

CreateOption string: Specifies how the data disk should be created. The only possible options are FromImage and Empty.
Lun int: Specifies the Logical Unit Number of the disk in each virtual machine in the scale set.
Caching string: Specifies the caching requirements. Possible values include: None (default), ReadOnly, ReadWrite.
DiskSizeGb int: Specifies the size of the disk in GB. This element is required when creating an empty disk.
ManagedDiskType string: Specifies the type of managed disk to create. Value must be either Standard_LRS, StandardSSD_LRS or Premium_LRS.

CreateOption string: Specifies how the data disk should be created. The only possible options are FromImage and Empty.
Lun int: Specifies the Logical Unit Number of the disk in each virtual machine in the scale set.
Caching string: Specifies the caching requirements. Possible values include: None (default), ReadOnly, ReadWrite.
DiskSizeGb int: Specifies the size of the disk in GB. This element is required when creating an empty disk.
ManagedDiskType string: Specifies the type of managed disk to create. Value must be either Standard_LRS, StandardSSD_LRS or Premium_LRS.

createOption string: Specifies how the data disk should be created. The only possible options are FromImage and Empty.
lun number: Specifies the Logical Unit Number of the disk in each virtual machine in the scale set.
caching string: Specifies the caching requirements. Possible values include: None (default), ReadOnly, ReadWrite.
diskSizeGb number: Specifies the size of the disk in GB. This element is required when creating an empty disk.
managedDiskType string: Specifies the type of managed disk to create. Value must be either Standard_LRS, StandardSSD_LRS or Premium_LRS.

create_option str: Specifies how the data disk should be created. The only possible options are FromImage and Empty.
lun float: Specifies the Logical Unit Number of the disk in each virtual machine in the scale set.
caching str: Specifies the caching requirements. Possible values include: None (default), ReadOnly, ReadWrite.
disk_size_gb float: Specifies the size of the disk in GB. This element is required when creating an empty disk.
managedDiskType str: Specifies the type of managed disk to create. Value must be either Standard_LRS, StandardSSD_LRS or Premium_LRS.

ScaleSetStorageProfileImageReference

Id string: Specifies the ID of the (custom) image to use to create the virtual machine scale set, as in the example below.
Offer string: Specifies the offer of the image used to create the virtual machines.
Publisher string: Specifies the publisher of the image used to create the virtual machines.
Sku string: Specifies the SKU of the image used to create the virtual machines.
Version string: Specifies the version of the image used to create the virtual machines.

Id string: Specifies the ID of the (custom) image to use to create the virtual machine scale set, as in the example below.
Offer string: Specifies the offer of the image used to create the virtual machines.
Publisher string: Specifies the publisher of the image used to create the virtual machines.
Sku string: Specifies the SKU of the image used to create the virtual machines.
Version string: Specifies the version of the image used to create the virtual machines.

id string: Specifies the ID of the (custom) image to use to create the virtual machine scale set, as in the example below.
offer string: Specifies the offer of the image used to create the virtual machines.
publisher string: Specifies the publisher of the image used to create the virtual machines.
sku string: Specifies the SKU of the image used to create the virtual machines.
version string: Specifies the version of the image used to create the virtual machines.

id str: Specifies the ID of the (custom) image to use to create the virtual machine scale set, as in the example below.
offer str: Specifies the offer of the image used to create the virtual machines.
publisher str: Specifies the publisher of the image used to create the virtual machines.
sku str: Specifies the SKU of the image used to create the virtual machines.
version str: Specifies the version of the image used to create the virtual machines.

ScaleSetStorageProfileOsDisk

CreateOption string: Specifies how the virtual machine should be created. The only possible option is FromImage.
Caching string: Specifies the caching requirements. Possible values include: None (default), ReadOnly, ReadWrite.
Image string: Specifies the blob uri for user image. A virtual machine scale set creates an os disk in the same container as the user image. Updating the osDisk image causes the existing disk to be deleted and a new one created with the new image. If the VM scale set is in Manual upgrade mode then the virtual machines are not updated until they have manualUpgrade applied to them. When setting this field os_type needs to be specified. Cannot be used when vhd_containers, managed_disk_type or storage_profile_image_reference are specified.
ManagedDiskType string: Specifies the type of managed disk to create. Value you must be either Standard_LRS, StandardSSD_LRS or Premium_LRS. Cannot be used when vhd_containers or image is specified.
Name string: Specifies the disk name. Must be specified when using unmanaged disk (‘managed_disk_type’ property not set).
OsType string: Specifies the operating system Type, valid values are windows, linux.
VhdContainers List<string>: Specifies the vhd uri. Cannot be used when image or managed_disk_type is specified.

CreateOption string: Specifies how the virtual machine should be created. The only possible option is FromImage.
Caching string: Specifies the caching requirements. Possible values include: None (default), ReadOnly, ReadWrite.
Image string: Specifies the blob uri for user image. A virtual machine scale set creates an os disk in the same container as the user image. Updating the osDisk image causes the existing disk to be deleted and a new one created with the new image. If the VM scale set is in Manual upgrade mode then the virtual machines are not updated until they have manualUpgrade applied to them. When setting this field os_type needs to be specified. Cannot be used when vhd_containers, managed_disk_type or storage_profile_image_reference are specified.
ManagedDiskType string: Specifies the type of managed disk to create. Value you must be either Standard_LRS, StandardSSD_LRS or Premium_LRS. Cannot be used when vhd_containers or image is specified.
Name string: Specifies the disk name. Must be specified when using unmanaged disk (‘managed_disk_type’ property not set).
OsType string: Specifies the operating system Type, valid values are windows, linux.
VhdContainers []string: Specifies the vhd uri. Cannot be used when image or managed_disk_type is specified.

createOption string: Specifies how the virtual machine should be created. The only possible option is FromImage.
caching string: Specifies the caching requirements. Possible values include: None (default), ReadOnly, ReadWrite.
image string: Specifies the blob uri for user image. A virtual machine scale set creates an os disk in the same container as the user image. Updating the osDisk image causes the existing disk to be deleted and a new one created with the new image. If the VM scale set is in Manual upgrade mode then the virtual machines are not updated until they have manualUpgrade applied to them. When setting this field os_type needs to be specified. Cannot be used when vhd_containers, managed_disk_type or storage_profile_image_reference are specified.
managedDiskType string: Specifies the type of managed disk to create. Value you must be either Standard_LRS, StandardSSD_LRS or Premium_LRS. Cannot be used when vhd_containers or image is specified.
name string: Specifies the disk name. Must be specified when using unmanaged disk (‘managed_disk_type’ property not set).
osType string: Specifies the operating system Type, valid values are windows, linux.
vhdContainers string[]: Specifies the vhd uri. Cannot be used when image or managed_disk_type is specified.

create_option str: Specifies how the virtual machine should be created. The only possible option is FromImage.
caching str: Specifies the caching requirements. Possible values include: None (default), ReadOnly, ReadWrite.
image str: Specifies the blob uri for user image. A virtual machine scale set creates an os disk in the same container as the user image. Updating the osDisk image causes the existing disk to be deleted and a new one created with the new image. If the VM scale set is in Manual upgrade mode then the virtual machines are not updated until they have manualUpgrade applied to them. When setting this field os_type needs to be specified. Cannot be used when vhd_containers, managed_disk_type or storage_profile_image_reference are specified.
managedDiskType str: Specifies the type of managed disk to create. Value you must be either Standard_LRS, StandardSSD_LRS or Premium_LRS. Cannot be used when vhd_containers or image is specified.
name str: Specifies the disk name. Must be specified when using unmanaged disk (‘managed_disk_type’ property not set).
os_type str: Specifies the operating system Type, valid values are windows, linux.
vhdContainers List[str]: Specifies the vhd uri. Cannot be used when image or managed_disk_type is specified.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud