We recommend using Azure Native.
azure.compute.OrchestratedVirtualMachineScaleSet
Explore with Pulumi AI
Manages an Virtual Machine Scale Set in Flexible Orchestration Mode.
Disclaimers
Note: As of the v2.86.0 (November 19, 2021) release of the provider this resource will only create Virtual Machine Scale Sets with the Flexible Orchestration Mode.
Note: All arguments including the administrator login and password will be stored in the raw state as plain-text. Read more about sensitive data in state.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "example-resources",
location: "West Europe",
});
const exampleOrchestratedVirtualMachineScaleSet = new azure.compute.OrchestratedVirtualMachineScaleSet("example", {
name: "example-VMSS",
location: example.location,
resourceGroupName: example.name,
platformFaultDomainCount: 1,
zones: ["1"],
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_orchestrated_virtual_machine_scale_set = azure.compute.OrchestratedVirtualMachineScaleSet("example",
name="example-VMSS",
location=example.location,
resource_group_name=example.name,
platform_fault_domain_count=1,
zones=["1"])
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/compute"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
_, err = compute.NewOrchestratedVirtualMachineScaleSet(ctx, "example", &compute.OrchestratedVirtualMachineScaleSetArgs{
Name: pulumi.String("example-VMSS"),
Location: example.Location,
ResourceGroupName: example.Name,
PlatformFaultDomainCount: pulumi.Int(1),
Zones: pulumi.StringArray{
pulumi.String("1"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-resources",
Location = "West Europe",
});
var exampleOrchestratedVirtualMachineScaleSet = new Azure.Compute.OrchestratedVirtualMachineScaleSet("example", new()
{
Name = "example-VMSS",
Location = example.Location,
ResourceGroupName = example.Name,
PlatformFaultDomainCount = 1,
Zones = new[]
{
"1",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.compute.OrchestratedVirtualMachineScaleSet;
import com.pulumi.azure.compute.OrchestratedVirtualMachineScaleSetArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-resources")
.location("West Europe")
.build());
var exampleOrchestratedVirtualMachineScaleSet = new OrchestratedVirtualMachineScaleSet("exampleOrchestratedVirtualMachineScaleSet", OrchestratedVirtualMachineScaleSetArgs.builder()
.name("example-VMSS")
.location(example.location())
.resourceGroupName(example.name())
.platformFaultDomainCount(1)
.zones("1")
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleOrchestratedVirtualMachineScaleSet:
type: azure:compute:OrchestratedVirtualMachineScaleSet
name: example
properties:
name: example-VMSS
location: ${example.location}
resourceGroupName: ${example.name}
platformFaultDomainCount: 1
zones:
- '1'
Create OrchestratedVirtualMachineScaleSet Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new OrchestratedVirtualMachineScaleSet(name: string, args: OrchestratedVirtualMachineScaleSetArgs, opts?: CustomResourceOptions);
@overload
def OrchestratedVirtualMachineScaleSet(resource_name: str,
args: OrchestratedVirtualMachineScaleSetArgs,
opts: Optional[ResourceOptions] = None)
@overload
def OrchestratedVirtualMachineScaleSet(resource_name: str,
opts: Optional[ResourceOptions] = None,
platform_fault_domain_count: Optional[int] = None,
resource_group_name: Optional[str] = None,
extensions: Optional[Sequence[OrchestratedVirtualMachineScaleSetExtensionArgs]] = None,
extensions_time_budget: Optional[str] = None,
data_disks: Optional[Sequence[OrchestratedVirtualMachineScaleSetDataDiskArgs]] = None,
os_profile: Optional[OrchestratedVirtualMachineScaleSetOsProfileArgs] = None,
eviction_policy: Optional[str] = None,
extension_operations_enabled: Optional[bool] = None,
additional_capabilities: Optional[OrchestratedVirtualMachineScaleSetAdditionalCapabilitiesArgs] = None,
plan: Optional[OrchestratedVirtualMachineScaleSetPlanArgs] = None,
identity: Optional[OrchestratedVirtualMachineScaleSetIdentityArgs] = None,
instances: Optional[int] = None,
license_type: Optional[str] = None,
location: Optional[str] = None,
max_bid_price: Optional[float] = None,
boot_diagnostics: Optional[OrchestratedVirtualMachineScaleSetBootDiagnosticsArgs] = None,
network_interfaces: Optional[Sequence[OrchestratedVirtualMachineScaleSetNetworkInterfaceArgs]] = None,
os_disk: Optional[OrchestratedVirtualMachineScaleSetOsDiskArgs] = None,
encryption_at_host_enabled: Optional[bool] = None,
capacity_reservation_group_id: Optional[str] = None,
name: Optional[str] = None,
priority: Optional[str] = None,
priority_mix: Optional[OrchestratedVirtualMachineScaleSetPriorityMixArgs] = None,
proximity_placement_group_id: Optional[str] = None,
automatic_instance_repair: Optional[OrchestratedVirtualMachineScaleSetAutomaticInstanceRepairArgs] = None,
single_placement_group: Optional[bool] = None,
sku_name: Optional[str] = None,
sku_profile: Optional[OrchestratedVirtualMachineScaleSetSkuProfileArgs] = None,
source_image_id: Optional[str] = None,
source_image_reference: Optional[OrchestratedVirtualMachineScaleSetSourceImageReferenceArgs] = None,
tags: Optional[Mapping[str, str]] = None,
termination_notification: Optional[OrchestratedVirtualMachineScaleSetTerminationNotificationArgs] = None,
user_data_base64: Optional[str] = None,
zone_balance: Optional[bool] = None,
zones: Optional[Sequence[str]] = None)
func NewOrchestratedVirtualMachineScaleSet(ctx *Context, name string, args OrchestratedVirtualMachineScaleSetArgs, opts ...ResourceOption) (*OrchestratedVirtualMachineScaleSet, error)
public OrchestratedVirtualMachineScaleSet(string name, OrchestratedVirtualMachineScaleSetArgs args, CustomResourceOptions? opts = null)
public OrchestratedVirtualMachineScaleSet(String name, OrchestratedVirtualMachineScaleSetArgs args)
public OrchestratedVirtualMachineScaleSet(String name, OrchestratedVirtualMachineScaleSetArgs args, CustomResourceOptions options)
type: azure:compute:OrchestratedVirtualMachineScaleSet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args OrchestratedVirtualMachineScaleSetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args OrchestratedVirtualMachineScaleSetArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args OrchestratedVirtualMachineScaleSetArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OrchestratedVirtualMachineScaleSetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args OrchestratedVirtualMachineScaleSetArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var orchestratedVirtualMachineScaleSetResource = new Azure.Compute.OrchestratedVirtualMachineScaleSet("orchestratedVirtualMachineScaleSetResource", new()
{
PlatformFaultDomainCount = 0,
ResourceGroupName = "string",
Extensions = new[]
{
new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetExtensionArgs
{
Name = "string",
Publisher = "string",
Type = "string",
TypeHandlerVersion = "string",
AutoUpgradeMinorVersionEnabled = false,
ExtensionsToProvisionAfterVmCreations = new[]
{
"string",
},
FailureSuppressionEnabled = false,
ForceExtensionExecutionOnChange = "string",
ProtectedSettings = "string",
ProtectedSettingsFromKeyVault = new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetExtensionProtectedSettingsFromKeyVaultArgs
{
SecretUrl = "string",
SourceVaultId = "string",
},
Settings = "string",
},
},
ExtensionsTimeBudget = "string",
DataDisks = new[]
{
new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetDataDiskArgs
{
Caching = "string",
StorageAccountType = "string",
CreateOption = "string",
DiskEncryptionSetId = "string",
DiskSizeGb = 0,
Lun = 0,
UltraSsdDiskIopsReadWrite = 0,
UltraSsdDiskMbpsReadWrite = 0,
WriteAcceleratorEnabled = false,
},
},
OsProfile = new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetOsProfileArgs
{
CustomData = "string",
LinuxConfiguration = new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationArgs
{
AdminUsername = "string",
AdminPassword = "string",
AdminSshKeys = new[]
{
new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationAdminSshKeyArgs
{
PublicKey = "string",
Username = "string",
},
},
ComputerNamePrefix = "string",
DisablePasswordAuthentication = false,
PatchAssessmentMode = "string",
PatchMode = "string",
ProvisionVmAgent = false,
Secrets = new[]
{
new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationSecretArgs
{
Certificates = new[]
{
new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationSecretCertificateArgs
{
Url = "string",
},
},
KeyVaultId = "string",
},
},
},
WindowsConfiguration = new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationArgs
{
AdminPassword = "string",
AdminUsername = "string",
AdditionalUnattendContents = new[]
{
new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationAdditionalUnattendContentArgs
{
Content = "string",
Setting = "string",
},
},
ComputerNamePrefix = "string",
EnableAutomaticUpdates = false,
HotpatchingEnabled = false,
PatchAssessmentMode = "string",
PatchMode = "string",
ProvisionVmAgent = false,
Secrets = new[]
{
new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationSecretArgs
{
Certificates = new[]
{
new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationSecretCertificateArgs
{
Store = "string",
Url = "string",
},
},
KeyVaultId = "string",
},
},
Timezone = "string",
WinrmListeners = new[]
{
new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationWinrmListenerArgs
{
Protocol = "string",
CertificateUrl = "string",
},
},
},
},
EvictionPolicy = "string",
ExtensionOperationsEnabled = false,
AdditionalCapabilities = new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetAdditionalCapabilitiesArgs
{
UltraSsdEnabled = false,
},
Plan = new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetPlanArgs
{
Name = "string",
Product = "string",
Publisher = "string",
},
Identity = new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetIdentityArgs
{
IdentityIds = new[]
{
"string",
},
Type = "string",
},
Instances = 0,
LicenseType = "string",
Location = "string",
MaxBidPrice = 0,
BootDiagnostics = new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetBootDiagnosticsArgs
{
StorageAccountUri = "string",
},
NetworkInterfaces = new[]
{
new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetNetworkInterfaceArgs
{
IpConfigurations = new[]
{
new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationArgs
{
Name = "string",
ApplicationGatewayBackendAddressPoolIds = new[]
{
"string",
},
ApplicationSecurityGroupIds = new[]
{
"string",
},
LoadBalancerBackendAddressPoolIds = new[]
{
"string",
},
Primary = false,
PublicIpAddresses = new[]
{
new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressArgs
{
Name = "string",
DomainNameLabel = "string",
IdleTimeoutInMinutes = 0,
IpTags = new[]
{
new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTagArgs
{
Tag = "string",
Type = "string",
},
},
PublicIpPrefixId = "string",
SkuName = "string",
Version = "string",
},
},
SubnetId = "string",
Version = "string",
},
},
Name = "string",
DnsServers = new[]
{
"string",
},
EnableAcceleratedNetworking = false,
EnableIpForwarding = false,
NetworkSecurityGroupId = "string",
Primary = false,
},
},
OsDisk = new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetOsDiskArgs
{
Caching = "string",
StorageAccountType = "string",
DiffDiskSettings = new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetOsDiskDiffDiskSettingsArgs
{
Option = "string",
Placement = "string",
},
DiskEncryptionSetId = "string",
DiskSizeGb = 0,
WriteAcceleratorEnabled = false,
},
EncryptionAtHostEnabled = false,
CapacityReservationGroupId = "string",
Name = "string",
Priority = "string",
PriorityMix = new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetPriorityMixArgs
{
BaseRegularCount = 0,
RegularPercentageAboveBase = 0,
},
ProximityPlacementGroupId = "string",
AutomaticInstanceRepair = new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetAutomaticInstanceRepairArgs
{
Enabled = false,
Action = "string",
GracePeriod = "string",
},
SinglePlacementGroup = false,
SkuName = "string",
SkuProfile = new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetSkuProfileArgs
{
AllocationStrategy = "string",
VmSizes = new[]
{
"string",
},
},
SourceImageId = "string",
SourceImageReference = new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetSourceImageReferenceArgs
{
Offer = "string",
Publisher = "string",
Sku = "string",
Version = "string",
},
Tags =
{
{ "string", "string" },
},
TerminationNotification = new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetTerminationNotificationArgs
{
Enabled = false,
Timeout = "string",
},
UserDataBase64 = "string",
ZoneBalance = false,
Zones = new[]
{
"string",
},
});
example, err := compute.NewOrchestratedVirtualMachineScaleSet(ctx, "orchestratedVirtualMachineScaleSetResource", &compute.OrchestratedVirtualMachineScaleSetArgs{
PlatformFaultDomainCount: pulumi.Int(0),
ResourceGroupName: pulumi.String("string"),
Extensions: compute.OrchestratedVirtualMachineScaleSetExtensionArray{
&compute.OrchestratedVirtualMachineScaleSetExtensionArgs{
Name: pulumi.String("string"),
Publisher: pulumi.String("string"),
Type: pulumi.String("string"),
TypeHandlerVersion: pulumi.String("string"),
AutoUpgradeMinorVersionEnabled: pulumi.Bool(false),
ExtensionsToProvisionAfterVmCreations: pulumi.StringArray{
pulumi.String("string"),
},
FailureSuppressionEnabled: pulumi.Bool(false),
ForceExtensionExecutionOnChange: pulumi.String("string"),
ProtectedSettings: pulumi.String("string"),
ProtectedSettingsFromKeyVault: &compute.OrchestratedVirtualMachineScaleSetExtensionProtectedSettingsFromKeyVaultArgs{
SecretUrl: pulumi.String("string"),
SourceVaultId: pulumi.String("string"),
},
Settings: pulumi.String("string"),
},
},
ExtensionsTimeBudget: pulumi.String("string"),
DataDisks: compute.OrchestratedVirtualMachineScaleSetDataDiskArray{
&compute.OrchestratedVirtualMachineScaleSetDataDiskArgs{
Caching: pulumi.String("string"),
StorageAccountType: pulumi.String("string"),
CreateOption: pulumi.String("string"),
DiskEncryptionSetId: pulumi.String("string"),
DiskSizeGb: pulumi.Int(0),
Lun: pulumi.Int(0),
UltraSsdDiskIopsReadWrite: pulumi.Int(0),
UltraSsdDiskMbpsReadWrite: pulumi.Int(0),
WriteAcceleratorEnabled: pulumi.Bool(false),
},
},
OsProfile: &compute.OrchestratedVirtualMachineScaleSetOsProfileArgs{
CustomData: pulumi.String("string"),
LinuxConfiguration: &compute.OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationArgs{
AdminUsername: pulumi.String("string"),
AdminPassword: pulumi.String("string"),
AdminSshKeys: compute.OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationAdminSshKeyArray{
&compute.OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationAdminSshKeyArgs{
PublicKey: pulumi.String("string"),
Username: pulumi.String("string"),
},
},
ComputerNamePrefix: pulumi.String("string"),
DisablePasswordAuthentication: pulumi.Bool(false),
PatchAssessmentMode: pulumi.String("string"),
PatchMode: pulumi.String("string"),
ProvisionVmAgent: pulumi.Bool(false),
Secrets: compute.OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationSecretArray{
&compute.OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationSecretArgs{
Certificates: compute.OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationSecretCertificateArray{
&compute.OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationSecretCertificateArgs{
Url: pulumi.String("string"),
},
},
KeyVaultId: pulumi.String("string"),
},
},
},
WindowsConfiguration: &compute.OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationArgs{
AdminPassword: pulumi.String("string"),
AdminUsername: pulumi.String("string"),
AdditionalUnattendContents: compute.OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationAdditionalUnattendContentArray{
&compute.OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationAdditionalUnattendContentArgs{
Content: pulumi.String("string"),
Setting: pulumi.String("string"),
},
},
ComputerNamePrefix: pulumi.String("string"),
EnableAutomaticUpdates: pulumi.Bool(false),
HotpatchingEnabled: pulumi.Bool(false),
PatchAssessmentMode: pulumi.String("string"),
PatchMode: pulumi.String("string"),
ProvisionVmAgent: pulumi.Bool(false),
Secrets: compute.OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationSecretArray{
&compute.OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationSecretArgs{
Certificates: compute.OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationSecretCertificateArray{
&compute.OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationSecretCertificateArgs{
Store: pulumi.String("string"),
Url: pulumi.String("string"),
},
},
KeyVaultId: pulumi.String("string"),
},
},
Timezone: pulumi.String("string"),
WinrmListeners: compute.OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationWinrmListenerArray{
&compute.OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationWinrmListenerArgs{
Protocol: pulumi.String("string"),
CertificateUrl: pulumi.String("string"),
},
},
},
},
EvictionPolicy: pulumi.String("string"),
ExtensionOperationsEnabled: pulumi.Bool(false),
AdditionalCapabilities: &compute.OrchestratedVirtualMachineScaleSetAdditionalCapabilitiesArgs{
UltraSsdEnabled: pulumi.Bool(false),
},
Plan: &compute.OrchestratedVirtualMachineScaleSetPlanArgs{
Name: pulumi.String("string"),
Product: pulumi.String("string"),
Publisher: pulumi.String("string"),
},
Identity: &compute.OrchestratedVirtualMachineScaleSetIdentityArgs{
IdentityIds: pulumi.StringArray{
pulumi.String("string"),
},
Type: pulumi.String("string"),
},
Instances: pulumi.Int(0),
LicenseType: pulumi.String("string"),
Location: pulumi.String("string"),
MaxBidPrice: pulumi.Float64(0),
BootDiagnostics: &compute.OrchestratedVirtualMachineScaleSetBootDiagnosticsArgs{
StorageAccountUri: pulumi.String("string"),
},
NetworkInterfaces: compute.OrchestratedVirtualMachineScaleSetNetworkInterfaceArray{
&compute.OrchestratedVirtualMachineScaleSetNetworkInterfaceArgs{
IpConfigurations: compute.OrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationArray{
&compute.OrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationArgs{
Name: pulumi.String("string"),
ApplicationGatewayBackendAddressPoolIds: pulumi.StringArray{
pulumi.String("string"),
},
ApplicationSecurityGroupIds: pulumi.StringArray{
pulumi.String("string"),
},
LoadBalancerBackendAddressPoolIds: pulumi.StringArray{
pulumi.String("string"),
},
Primary: pulumi.Bool(false),
PublicIpAddresses: compute.OrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressArray{
&compute.OrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressArgs{
Name: pulumi.String("string"),
DomainNameLabel: pulumi.String("string"),
IdleTimeoutInMinutes: pulumi.Int(0),
IpTags: compute.OrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTagArray{
&compute.OrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTagArgs{
Tag: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
PublicIpPrefixId: pulumi.String("string"),
SkuName: pulumi.String("string"),
Version: pulumi.String("string"),
},
},
SubnetId: pulumi.String("string"),
Version: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
DnsServers: pulumi.StringArray{
pulumi.String("string"),
},
EnableAcceleratedNetworking: pulumi.Bool(false),
EnableIpForwarding: pulumi.Bool(false),
NetworkSecurityGroupId: pulumi.String("string"),
Primary: pulumi.Bool(false),
},
},
OsDisk: &compute.OrchestratedVirtualMachineScaleSetOsDiskArgs{
Caching: pulumi.String("string"),
StorageAccountType: pulumi.String("string"),
DiffDiskSettings: &compute.OrchestratedVirtualMachineScaleSetOsDiskDiffDiskSettingsArgs{
Option: pulumi.String("string"),
Placement: pulumi.String("string"),
},
DiskEncryptionSetId: pulumi.String("string"),
DiskSizeGb: pulumi.Int(0),
WriteAcceleratorEnabled: pulumi.Bool(false),
},
EncryptionAtHostEnabled: pulumi.Bool(false),
CapacityReservationGroupId: pulumi.String("string"),
Name: pulumi.String("string"),
Priority: pulumi.String("string"),
PriorityMix: &compute.OrchestratedVirtualMachineScaleSetPriorityMixArgs{
BaseRegularCount: pulumi.Int(0),
RegularPercentageAboveBase: pulumi.Int(0),
},
ProximityPlacementGroupId: pulumi.String("string"),
AutomaticInstanceRepair: &compute.OrchestratedVirtualMachineScaleSetAutomaticInstanceRepairArgs{
Enabled: pulumi.Bool(false),
Action: pulumi.String("string"),
GracePeriod: pulumi.String("string"),
},
SinglePlacementGroup: pulumi.Bool(false),
SkuName: pulumi.String("string"),
SkuProfile: &compute.OrchestratedVirtualMachineScaleSetSkuProfileArgs{
AllocationStrategy: pulumi.String("string"),
VmSizes: pulumi.StringArray{
pulumi.String("string"),
},
},
SourceImageId: pulumi.String("string"),
SourceImageReference: &compute.OrchestratedVirtualMachineScaleSetSourceImageReferenceArgs{
Offer: pulumi.String("string"),
Publisher: pulumi.String("string"),
Sku: pulumi.String("string"),
Version: pulumi.String("string"),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
TerminationNotification: &compute.OrchestratedVirtualMachineScaleSetTerminationNotificationArgs{
Enabled: pulumi.Bool(false),
Timeout: pulumi.String("string"),
},
UserDataBase64: pulumi.String("string"),
ZoneBalance: pulumi.Bool(false),
Zones: pulumi.StringArray{
pulumi.String("string"),
},
})
var orchestratedVirtualMachineScaleSetResource = new OrchestratedVirtualMachineScaleSet("orchestratedVirtualMachineScaleSetResource", OrchestratedVirtualMachineScaleSetArgs.builder()
.platformFaultDomainCount(0)
.resourceGroupName("string")
.extensions(OrchestratedVirtualMachineScaleSetExtensionArgs.builder()
.name("string")
.publisher("string")
.type("string")
.typeHandlerVersion("string")
.autoUpgradeMinorVersionEnabled(false)
.extensionsToProvisionAfterVmCreations("string")
.failureSuppressionEnabled(false)
.forceExtensionExecutionOnChange("string")
.protectedSettings("string")
.protectedSettingsFromKeyVault(OrchestratedVirtualMachineScaleSetExtensionProtectedSettingsFromKeyVaultArgs.builder()
.secretUrl("string")
.sourceVaultId("string")
.build())
.settings("string")
.build())
.extensionsTimeBudget("string")
.dataDisks(OrchestratedVirtualMachineScaleSetDataDiskArgs.builder()
.caching("string")
.storageAccountType("string")
.createOption("string")
.diskEncryptionSetId("string")
.diskSizeGb(0)
.lun(0)
.ultraSsdDiskIopsReadWrite(0)
.ultraSsdDiskMbpsReadWrite(0)
.writeAcceleratorEnabled(false)
.build())
.osProfile(OrchestratedVirtualMachineScaleSetOsProfileArgs.builder()
.customData("string")
.linuxConfiguration(OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationArgs.builder()
.adminUsername("string")
.adminPassword("string")
.adminSshKeys(OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationAdminSshKeyArgs.builder()
.publicKey("string")
.username("string")
.build())
.computerNamePrefix("string")
.disablePasswordAuthentication(false)
.patchAssessmentMode("string")
.patchMode("string")
.provisionVmAgent(false)
.secrets(OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationSecretArgs.builder()
.certificates(OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationSecretCertificateArgs.builder()
.url("string")
.build())
.keyVaultId("string")
.build())
.build())
.windowsConfiguration(OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationArgs.builder()
.adminPassword("string")
.adminUsername("string")
.additionalUnattendContents(OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationAdditionalUnattendContentArgs.builder()
.content("string")
.setting("string")
.build())
.computerNamePrefix("string")
.enableAutomaticUpdates(false)
.hotpatchingEnabled(false)
.patchAssessmentMode("string")
.patchMode("string")
.provisionVmAgent(false)
.secrets(OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationSecretArgs.builder()
.certificates(OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationSecretCertificateArgs.builder()
.store("string")
.url("string")
.build())
.keyVaultId("string")
.build())
.timezone("string")
.winrmListeners(OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationWinrmListenerArgs.builder()
.protocol("string")
.certificateUrl("string")
.build())
.build())
.build())
.evictionPolicy("string")
.extensionOperationsEnabled(false)
.additionalCapabilities(OrchestratedVirtualMachineScaleSetAdditionalCapabilitiesArgs.builder()
.ultraSsdEnabled(false)
.build())
.plan(OrchestratedVirtualMachineScaleSetPlanArgs.builder()
.name("string")
.product("string")
.publisher("string")
.build())
.identity(OrchestratedVirtualMachineScaleSetIdentityArgs.builder()
.identityIds("string")
.type("string")
.build())
.instances(0)
.licenseType("string")
.location("string")
.maxBidPrice(0)
.bootDiagnostics(OrchestratedVirtualMachineScaleSetBootDiagnosticsArgs.builder()
.storageAccountUri("string")
.build())
.networkInterfaces(OrchestratedVirtualMachineScaleSetNetworkInterfaceArgs.builder()
.ipConfigurations(OrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationArgs.builder()
.name("string")
.applicationGatewayBackendAddressPoolIds("string")
.applicationSecurityGroupIds("string")
.loadBalancerBackendAddressPoolIds("string")
.primary(false)
.publicIpAddresses(OrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressArgs.builder()
.name("string")
.domainNameLabel("string")
.idleTimeoutInMinutes(0)
.ipTags(OrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTagArgs.builder()
.tag("string")
.type("string")
.build())
.publicIpPrefixId("string")
.skuName("string")
.version("string")
.build())
.subnetId("string")
.version("string")
.build())
.name("string")
.dnsServers("string")
.enableAcceleratedNetworking(false)
.enableIpForwarding(false)
.networkSecurityGroupId("string")
.primary(false)
.build())
.osDisk(OrchestratedVirtualMachineScaleSetOsDiskArgs.builder()
.caching("string")
.storageAccountType("string")
.diffDiskSettings(OrchestratedVirtualMachineScaleSetOsDiskDiffDiskSettingsArgs.builder()
.option("string")
.placement("string")
.build())
.diskEncryptionSetId("string")
.diskSizeGb(0)
.writeAcceleratorEnabled(false)
.build())
.encryptionAtHostEnabled(false)
.capacityReservationGroupId("string")
.name("string")
.priority("string")
.priorityMix(OrchestratedVirtualMachineScaleSetPriorityMixArgs.builder()
.baseRegularCount(0)
.regularPercentageAboveBase(0)
.build())
.proximityPlacementGroupId("string")
.automaticInstanceRepair(OrchestratedVirtualMachineScaleSetAutomaticInstanceRepairArgs.builder()
.enabled(false)
.action("string")
.gracePeriod("string")
.build())
.singlePlacementGroup(false)
.skuName("string")
.skuProfile(OrchestratedVirtualMachineScaleSetSkuProfileArgs.builder()
.allocationStrategy("string")
.vmSizes("string")
.build())
.sourceImageId("string")
.sourceImageReference(OrchestratedVirtualMachineScaleSetSourceImageReferenceArgs.builder()
.offer("string")
.publisher("string")
.sku("string")
.version("string")
.build())
.tags(Map.of("string", "string"))
.terminationNotification(OrchestratedVirtualMachineScaleSetTerminationNotificationArgs.builder()
.enabled(false)
.timeout("string")
.build())
.userDataBase64("string")
.zoneBalance(false)
.zones("string")
.build());
orchestrated_virtual_machine_scale_set_resource = azure.compute.OrchestratedVirtualMachineScaleSet("orchestratedVirtualMachineScaleSetResource",
platform_fault_domain_count=0,
resource_group_name="string",
extensions=[{
"name": "string",
"publisher": "string",
"type": "string",
"type_handler_version": "string",
"auto_upgrade_minor_version_enabled": False,
"extensions_to_provision_after_vm_creations": ["string"],
"failure_suppression_enabled": False,
"force_extension_execution_on_change": "string",
"protected_settings": "string",
"protected_settings_from_key_vault": {
"secret_url": "string",
"source_vault_id": "string",
},
"settings": "string",
}],
extensions_time_budget="string",
data_disks=[{
"caching": "string",
"storage_account_type": "string",
"create_option": "string",
"disk_encryption_set_id": "string",
"disk_size_gb": 0,
"lun": 0,
"ultra_ssd_disk_iops_read_write": 0,
"ultra_ssd_disk_mbps_read_write": 0,
"write_accelerator_enabled": False,
}],
os_profile={
"custom_data": "string",
"linux_configuration": {
"admin_username": "string",
"admin_password": "string",
"admin_ssh_keys": [{
"public_key": "string",
"username": "string",
}],
"computer_name_prefix": "string",
"disable_password_authentication": False,
"patch_assessment_mode": "string",
"patch_mode": "string",
"provision_vm_agent": False,
"secrets": [{
"certificates": [{
"url": "string",
}],
"key_vault_id": "string",
}],
},
"windows_configuration": {
"admin_password": "string",
"admin_username": "string",
"additional_unattend_contents": [{
"content": "string",
"setting": "string",
}],
"computer_name_prefix": "string",
"enable_automatic_updates": False,
"hotpatching_enabled": False,
"patch_assessment_mode": "string",
"patch_mode": "string",
"provision_vm_agent": False,
"secrets": [{
"certificates": [{
"store": "string",
"url": "string",
}],
"key_vault_id": "string",
}],
"timezone": "string",
"winrm_listeners": [{
"protocol": "string",
"certificate_url": "string",
}],
},
},
eviction_policy="string",
extension_operations_enabled=False,
additional_capabilities={
"ultra_ssd_enabled": False,
},
plan={
"name": "string",
"product": "string",
"publisher": "string",
},
identity={
"identity_ids": ["string"],
"type": "string",
},
instances=0,
license_type="string",
location="string",
max_bid_price=0,
boot_diagnostics={
"storage_account_uri": "string",
},
network_interfaces=[{
"ip_configurations": [{
"name": "string",
"application_gateway_backend_address_pool_ids": ["string"],
"application_security_group_ids": ["string"],
"load_balancer_backend_address_pool_ids": ["string"],
"primary": False,
"public_ip_addresses": [{
"name": "string",
"domain_name_label": "string",
"idle_timeout_in_minutes": 0,
"ip_tags": [{
"tag": "string",
"type": "string",
}],
"public_ip_prefix_id": "string",
"sku_name": "string",
"version": "string",
}],
"subnet_id": "string",
"version": "string",
}],
"name": "string",
"dns_servers": ["string"],
"enable_accelerated_networking": False,
"enable_ip_forwarding": False,
"network_security_group_id": "string",
"primary": False,
}],
os_disk={
"caching": "string",
"storage_account_type": "string",
"diff_disk_settings": {
"option": "string",
"placement": "string",
},
"disk_encryption_set_id": "string",
"disk_size_gb": 0,
"write_accelerator_enabled": False,
},
encryption_at_host_enabled=False,
capacity_reservation_group_id="string",
name="string",
priority="string",
priority_mix={
"base_regular_count": 0,
"regular_percentage_above_base": 0,
},
proximity_placement_group_id="string",
automatic_instance_repair={
"enabled": False,
"action": "string",
"grace_period": "string",
},
single_placement_group=False,
sku_name="string",
sku_profile={
"allocation_strategy": "string",
"vm_sizes": ["string"],
},
source_image_id="string",
source_image_reference={
"offer": "string",
"publisher": "string",
"sku": "string",
"version": "string",
},
tags={
"string": "string",
},
termination_notification={
"enabled": False,
"timeout": "string",
},
user_data_base64="string",
zone_balance=False,
zones=["string"])
const orchestratedVirtualMachineScaleSetResource = new azure.compute.OrchestratedVirtualMachineScaleSet("orchestratedVirtualMachineScaleSetResource", {
platformFaultDomainCount: 0,
resourceGroupName: "string",
extensions: [{
name: "string",
publisher: "string",
type: "string",
typeHandlerVersion: "string",
autoUpgradeMinorVersionEnabled: false,
extensionsToProvisionAfterVmCreations: ["string"],
failureSuppressionEnabled: false,
forceExtensionExecutionOnChange: "string",
protectedSettings: "string",
protectedSettingsFromKeyVault: {
secretUrl: "string",
sourceVaultId: "string",
},
settings: "string",
}],
extensionsTimeBudget: "string",
dataDisks: [{
caching: "string",
storageAccountType: "string",
createOption: "string",
diskEncryptionSetId: "string",
diskSizeGb: 0,
lun: 0,
ultraSsdDiskIopsReadWrite: 0,
ultraSsdDiskMbpsReadWrite: 0,
writeAcceleratorEnabled: false,
}],
osProfile: {
customData: "string",
linuxConfiguration: {
adminUsername: "string",
adminPassword: "string",
adminSshKeys: [{
publicKey: "string",
username: "string",
}],
computerNamePrefix: "string",
disablePasswordAuthentication: false,
patchAssessmentMode: "string",
patchMode: "string",
provisionVmAgent: false,
secrets: [{
certificates: [{
url: "string",
}],
keyVaultId: "string",
}],
},
windowsConfiguration: {
adminPassword: "string",
adminUsername: "string",
additionalUnattendContents: [{
content: "string",
setting: "string",
}],
computerNamePrefix: "string",
enableAutomaticUpdates: false,
hotpatchingEnabled: false,
patchAssessmentMode: "string",
patchMode: "string",
provisionVmAgent: false,
secrets: [{
certificates: [{
store: "string",
url: "string",
}],
keyVaultId: "string",
}],
timezone: "string",
winrmListeners: [{
protocol: "string",
certificateUrl: "string",
}],
},
},
evictionPolicy: "string",
extensionOperationsEnabled: false,
additionalCapabilities: {
ultraSsdEnabled: false,
},
plan: {
name: "string",
product: "string",
publisher: "string",
},
identity: {
identityIds: ["string"],
type: "string",
},
instances: 0,
licenseType: "string",
location: "string",
maxBidPrice: 0,
bootDiagnostics: {
storageAccountUri: "string",
},
networkInterfaces: [{
ipConfigurations: [{
name: "string",
applicationGatewayBackendAddressPoolIds: ["string"],
applicationSecurityGroupIds: ["string"],
loadBalancerBackendAddressPoolIds: ["string"],
primary: false,
publicIpAddresses: [{
name: "string",
domainNameLabel: "string",
idleTimeoutInMinutes: 0,
ipTags: [{
tag: "string",
type: "string",
}],
publicIpPrefixId: "string",
skuName: "string",
version: "string",
}],
subnetId: "string",
version: "string",
}],
name: "string",
dnsServers: ["string"],
enableAcceleratedNetworking: false,
enableIpForwarding: false,
networkSecurityGroupId: "string",
primary: false,
}],
osDisk: {
caching: "string",
storageAccountType: "string",
diffDiskSettings: {
option: "string",
placement: "string",
},
diskEncryptionSetId: "string",
diskSizeGb: 0,
writeAcceleratorEnabled: false,
},
encryptionAtHostEnabled: false,
capacityReservationGroupId: "string",
name: "string",
priority: "string",
priorityMix: {
baseRegularCount: 0,
regularPercentageAboveBase: 0,
},
proximityPlacementGroupId: "string",
automaticInstanceRepair: {
enabled: false,
action: "string",
gracePeriod: "string",
},
singlePlacementGroup: false,
skuName: "string",
skuProfile: {
allocationStrategy: "string",
vmSizes: ["string"],
},
sourceImageId: "string",
sourceImageReference: {
offer: "string",
publisher: "string",
sku: "string",
version: "string",
},
tags: {
string: "string",
},
terminationNotification: {
enabled: false,
timeout: "string",
},
userDataBase64: "string",
zoneBalance: false,
zones: ["string"],
});
type: azure:compute:OrchestratedVirtualMachineScaleSet
properties:
additionalCapabilities:
ultraSsdEnabled: false
automaticInstanceRepair:
action: string
enabled: false
gracePeriod: string
bootDiagnostics:
storageAccountUri: string
capacityReservationGroupId: string
dataDisks:
- caching: string
createOption: string
diskEncryptionSetId: string
diskSizeGb: 0
lun: 0
storageAccountType: string
ultraSsdDiskIopsReadWrite: 0
ultraSsdDiskMbpsReadWrite: 0
writeAcceleratorEnabled: false
encryptionAtHostEnabled: false
evictionPolicy: string
extensionOperationsEnabled: false
extensions:
- autoUpgradeMinorVersionEnabled: false
extensionsToProvisionAfterVmCreations:
- string
failureSuppressionEnabled: false
forceExtensionExecutionOnChange: string
name: string
protectedSettings: string
protectedSettingsFromKeyVault:
secretUrl: string
sourceVaultId: string
publisher: string
settings: string
type: string
typeHandlerVersion: string
extensionsTimeBudget: string
identity:
identityIds:
- string
type: string
instances: 0
licenseType: string
location: string
maxBidPrice: 0
name: string
networkInterfaces:
- dnsServers:
- string
enableAcceleratedNetworking: false
enableIpForwarding: false
ipConfigurations:
- applicationGatewayBackendAddressPoolIds:
- string
applicationSecurityGroupIds:
- string
loadBalancerBackendAddressPoolIds:
- string
name: string
primary: false
publicIpAddresses:
- domainNameLabel: string
idleTimeoutInMinutes: 0
ipTags:
- tag: string
type: string
name: string
publicIpPrefixId: string
skuName: string
version: string
subnetId: string
version: string
name: string
networkSecurityGroupId: string
primary: false
osDisk:
caching: string
diffDiskSettings:
option: string
placement: string
diskEncryptionSetId: string
diskSizeGb: 0
storageAccountType: string
writeAcceleratorEnabled: false
osProfile:
customData: string
linuxConfiguration:
adminPassword: string
adminSshKeys:
- publicKey: string
username: string
adminUsername: string
computerNamePrefix: string
disablePasswordAuthentication: false
patchAssessmentMode: string
patchMode: string
provisionVmAgent: false
secrets:
- certificates:
- url: string
keyVaultId: string
windowsConfiguration:
additionalUnattendContents:
- content: string
setting: string
adminPassword: string
adminUsername: string
computerNamePrefix: string
enableAutomaticUpdates: false
hotpatchingEnabled: false
patchAssessmentMode: string
patchMode: string
provisionVmAgent: false
secrets:
- certificates:
- store: string
url: string
keyVaultId: string
timezone: string
winrmListeners:
- certificateUrl: string
protocol: string
plan:
name: string
product: string
publisher: string
platformFaultDomainCount: 0
priority: string
priorityMix:
baseRegularCount: 0
regularPercentageAboveBase: 0
proximityPlacementGroupId: string
resourceGroupName: string
singlePlacementGroup: false
skuName: string
skuProfile:
allocationStrategy: string
vmSizes:
- string
sourceImageId: string
sourceImageReference:
offer: string
publisher: string
sku: string
version: string
tags:
string: string
terminationNotification:
enabled: false
timeout: string
userDataBase64: string
zoneBalance: false
zones:
- string
OrchestratedVirtualMachineScaleSet Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The OrchestratedVirtualMachineScaleSet resource accepts the following input properties:
- Platform
Fault intDomain Count Specifies the number of fault domains that are used by this Virtual Machine Scale Set. Changing this forces a new resource to be created.
Note: The number of Fault Domains varies depending on which Azure Region you're using. More information about update and fault domains and how they work can be found here.
- Resource
Group stringName - The name of the Resource Group in which the Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- Additional
Capabilities OrchestratedVirtual Machine Scale Set Additional Capabilities - An
additional_capabilities
block as defined below. - Automatic
Instance OrchestratedRepair Virtual Machine Scale Set Automatic Instance Repair An
automatic_instance_repair
block as defined below.Note: To enable the
automatic_instance_repair
, the Orchestrated Virtual Machine Scale Set must have a valid Application Health Extension.- Boot
Diagnostics OrchestratedVirtual Machine Scale Set Boot Diagnostics - A
boot_diagnostics
block as defined below. - Capacity
Reservation stringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine Scale Set should be allocated to. Changing this forces a new resource to be created.
Note:
capacity_reservation_group_id
cannot be specified withproximity_placement_group_id
Note: If
capacity_reservation_group_id
is specified thesingle_placement_group
must be set tofalse
.- Data
Disks List<OrchestratedVirtual Machine Scale Set Data Disk> - One or more
data_disk
blocks as defined below. - Encryption
At boolHost Enabled - Should disks attached to this Virtual Machine Scale Set be encrypted by enabling Encryption at Host?
- Eviction
Policy string - The Policy which should be used by Spot Virtual Machines that are Evicted from the Scale Set. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created. - Extension
Operations boolEnabled Should extension operations be allowed on the Virtual Machine Scale Set? Possible values are
true
orfalse
. Defaults totrue
. Changing this forces a new Virtual Machine Scale Set to be created.Note:
extension_operations_enabled
may only be set tofalse
if there are no extensions defined in theextension
field.- Extensions
List<Orchestrated
Virtual Machine Scale Set Extension> - One or more
extension
blocks as defined below - Extensions
Time stringBudget - Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to
PT1H30M
. - Identity
Orchestrated
Virtual Machine Scale Set Identity - An
identity
block as defined below. - Instances int
- The number of Virtual Machines in the Virtual Machine Scale Set.
- License
Type string - Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine Scale Set. Possible values are
None
,Windows_Client
andWindows_Server
. - Location string
- The Azure location where the Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- Max
Bid doublePrice - The maximum price you're willing to pay for each Virtual Machine in this Scale Set, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machines in the Scale Set will be evicted using the eviction_policy. Defaults to
-1
, which means that each Virtual Machine in the Scale Set should not be evicted for price reasons. - Name string
- The name of the Virtual Machine Scale Set. Changing this forces a new resource to be created.
- Network
Interfaces List<OrchestratedVirtual Machine Scale Set Network Interface> - One or more
network_interface
blocks as defined below. - Os
Disk OrchestratedVirtual Machine Scale Set Os Disk - An
os_disk
block as defined below. - Os
Profile OrchestratedVirtual Machine Scale Set Os Profile - An
os_profile
block as defined below. - Plan
Orchestrated
Virtual Machine Scale Set Plan - A
plan
block as documented below. Changing this forces a new resource to be created. - Priority string
- The Priority of this Virtual Machine Scale Set. Possible values are
Regular
andSpot
. Defaults toRegular
. Changing this value forces a new resource. - Priority
Mix OrchestratedVirtual Machine Scale Set Priority Mix - a
priority_mix
block as defined below - Proximity
Placement stringGroup Id - The ID of the Proximity Placement Group which the Virtual Machine should be assigned to. Changing this forces a new resource to be created.
- Single
Placement boolGroup Should this Virtual Machine Scale Set be limited to a Single Placement Group, which means the number of instances will be capped at 100 Virtual Machines. Possible values are
true
orfalse
.Note:
single_placement_group
behaves differently for Flexible orchestration Virtual Machine Scale Sets than it does for Uniform orchestration Virtual Machine Scale Sets. It is recommended that you do not define thesingle_placement_group
field in your configuration file as the service will determine what this value should be based off of the value contained within thesku_name
field of your configuration file. You may set thesingle_placement_group
field totrue
, however once you set it tofalse
you will not be able to revert it back totrue
.- Sku
Name string - The
name
of the SKU to be used by this Virtual Machine Scale Set. Valid values include: any of the General purpose, Compute optimized, Memory optimized, Storage optimized, GPU optimized, FPGA optimized, High performance, or Previous generation virtual machine SKUs. - Sku
Profile OrchestratedVirtual Machine Scale Set Sku Profile An
sku_profile
block as defined below. Changing this forces a new resource to be created.Note: If
sku_profile
is specified thesku_name
must be set toMix
.- Source
Image stringId - The ID of an Image which each Virtual Machine in this Scale Set should be based on. Possible Image ID types include
Image ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s. - Source
Image OrchestratedReference Virtual Machine Scale Set Source Image Reference - A
source_image_reference
block as defined below. - Dictionary<string, string>
- A mapping of tags which should be assigned to this Virtual Machine Scale Set.
- Termination
Notification OrchestratedVirtual Machine Scale Set Termination Notification - A
termination_notification
block as defined below. - User
Data stringBase64 - The Base64-Encoded User Data which should be used for this Virtual Machine Scale Set.
- Zone
Balance bool Should the Virtual Machines in this Scale Set be strictly evenly distributed across Availability Zones? Defaults to
false
. Changing this forces a new resource to be created.Note: This can only be set to
true
when one or morezones
are configured.- Zones List<string>
Specifies a list of Availability Zones across which the Virtual Machine Scale Set will create instances.
Note: Updating
zones
to remove an existing zone forces a new Virtual Machine Scale Set to be created.Note: Availability Zones are only supported in several regions at this time.
- Platform
Fault intDomain Count Specifies the number of fault domains that are used by this Virtual Machine Scale Set. Changing this forces a new resource to be created.
Note: The number of Fault Domains varies depending on which Azure Region you're using. More information about update and fault domains and how they work can be found here.
- Resource
Group stringName - The name of the Resource Group in which the Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- Additional
Capabilities OrchestratedVirtual Machine Scale Set Additional Capabilities Args - An
additional_capabilities
block as defined below. - Automatic
Instance OrchestratedRepair Virtual Machine Scale Set Automatic Instance Repair Args An
automatic_instance_repair
block as defined below.Note: To enable the
automatic_instance_repair
, the Orchestrated Virtual Machine Scale Set must have a valid Application Health Extension.- Boot
Diagnostics OrchestratedVirtual Machine Scale Set Boot Diagnostics Args - A
boot_diagnostics
block as defined below. - Capacity
Reservation stringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine Scale Set should be allocated to. Changing this forces a new resource to be created.
Note:
capacity_reservation_group_id
cannot be specified withproximity_placement_group_id
Note: If
capacity_reservation_group_id
is specified thesingle_placement_group
must be set tofalse
.- Data
Disks []OrchestratedVirtual Machine Scale Set Data Disk Args - One or more
data_disk
blocks as defined below. - Encryption
At boolHost Enabled - Should disks attached to this Virtual Machine Scale Set be encrypted by enabling Encryption at Host?
- Eviction
Policy string - The Policy which should be used by Spot Virtual Machines that are Evicted from the Scale Set. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created. - Extension
Operations boolEnabled Should extension operations be allowed on the Virtual Machine Scale Set? Possible values are
true
orfalse
. Defaults totrue
. Changing this forces a new Virtual Machine Scale Set to be created.Note:
extension_operations_enabled
may only be set tofalse
if there are no extensions defined in theextension
field.- Extensions
[]Orchestrated
Virtual Machine Scale Set Extension Args - One or more
extension
blocks as defined below - Extensions
Time stringBudget - Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to
PT1H30M
. - Identity
Orchestrated
Virtual Machine Scale Set Identity Args - An
identity
block as defined below. - Instances int
- The number of Virtual Machines in the Virtual Machine Scale Set.
- License
Type string - Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine Scale Set. Possible values are
None
,Windows_Client
andWindows_Server
. - Location string
- The Azure location where the Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- Max
Bid float64Price - The maximum price you're willing to pay for each Virtual Machine in this Scale Set, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machines in the Scale Set will be evicted using the eviction_policy. Defaults to
-1
, which means that each Virtual Machine in the Scale Set should not be evicted for price reasons. - Name string
- The name of the Virtual Machine Scale Set. Changing this forces a new resource to be created.
- Network
Interfaces []OrchestratedVirtual Machine Scale Set Network Interface Args - One or more
network_interface
blocks as defined below. - Os
Disk OrchestratedVirtual Machine Scale Set Os Disk Args - An
os_disk
block as defined below. - Os
Profile OrchestratedVirtual Machine Scale Set Os Profile Args - An
os_profile
block as defined below. - Plan
Orchestrated
Virtual Machine Scale Set Plan Args - A
plan
block as documented below. Changing this forces a new resource to be created. - Priority string
- The Priority of this Virtual Machine Scale Set. Possible values are
Regular
andSpot
. Defaults toRegular
. Changing this value forces a new resource. - Priority
Mix OrchestratedVirtual Machine Scale Set Priority Mix Args - a
priority_mix
block as defined below - Proximity
Placement stringGroup Id - The ID of the Proximity Placement Group which the Virtual Machine should be assigned to. Changing this forces a new resource to be created.
- Single
Placement boolGroup Should this Virtual Machine Scale Set be limited to a Single Placement Group, which means the number of instances will be capped at 100 Virtual Machines. Possible values are
true
orfalse
.Note:
single_placement_group
behaves differently for Flexible orchestration Virtual Machine Scale Sets than it does for Uniform orchestration Virtual Machine Scale Sets. It is recommended that you do not define thesingle_placement_group
field in your configuration file as the service will determine what this value should be based off of the value contained within thesku_name
field of your configuration file. You may set thesingle_placement_group
field totrue
, however once you set it tofalse
you will not be able to revert it back totrue
.- Sku
Name string - The
name
of the SKU to be used by this Virtual Machine Scale Set. Valid values include: any of the General purpose, Compute optimized, Memory optimized, Storage optimized, GPU optimized, FPGA optimized, High performance, or Previous generation virtual machine SKUs. - Sku
Profile OrchestratedVirtual Machine Scale Set Sku Profile Args An
sku_profile
block as defined below. Changing this forces a new resource to be created.Note: If
sku_profile
is specified thesku_name
must be set toMix
.- Source
Image stringId - The ID of an Image which each Virtual Machine in this Scale Set should be based on. Possible Image ID types include
Image ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s. - Source
Image OrchestratedReference Virtual Machine Scale Set Source Image Reference Args - A
source_image_reference
block as defined below. - map[string]string
- A mapping of tags which should be assigned to this Virtual Machine Scale Set.
- Termination
Notification OrchestratedVirtual Machine Scale Set Termination Notification Args - A
termination_notification
block as defined below. - User
Data stringBase64 - The Base64-Encoded User Data which should be used for this Virtual Machine Scale Set.
- Zone
Balance bool Should the Virtual Machines in this Scale Set be strictly evenly distributed across Availability Zones? Defaults to
false
. Changing this forces a new resource to be created.Note: This can only be set to
true
when one or morezones
are configured.- Zones []string
Specifies a list of Availability Zones across which the Virtual Machine Scale Set will create instances.
Note: Updating
zones
to remove an existing zone forces a new Virtual Machine Scale Set to be created.Note: Availability Zones are only supported in several regions at this time.
- platform
Fault IntegerDomain Count Specifies the number of fault domains that are used by this Virtual Machine Scale Set. Changing this forces a new resource to be created.
Note: The number of Fault Domains varies depending on which Azure Region you're using. More information about update and fault domains and how they work can be found here.
- resource
Group StringName - The name of the Resource Group in which the Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- additional
Capabilities OrchestratedVirtual Machine Scale Set Additional Capabilities - An
additional_capabilities
block as defined below. - automatic
Instance OrchestratedRepair Virtual Machine Scale Set Automatic Instance Repair An
automatic_instance_repair
block as defined below.Note: To enable the
automatic_instance_repair
, the Orchestrated Virtual Machine Scale Set must have a valid Application Health Extension.- boot
Diagnostics OrchestratedVirtual Machine Scale Set Boot Diagnostics - A
boot_diagnostics
block as defined below. - capacity
Reservation StringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine Scale Set should be allocated to. Changing this forces a new resource to be created.
Note:
capacity_reservation_group_id
cannot be specified withproximity_placement_group_id
Note: If
capacity_reservation_group_id
is specified thesingle_placement_group
must be set tofalse
.- data
Disks List<OrchestratedVirtual Machine Scale Set Data Disk> - One or more
data_disk
blocks as defined below. - encryption
At BooleanHost Enabled - Should disks attached to this Virtual Machine Scale Set be encrypted by enabling Encryption at Host?
- eviction
Policy String - The Policy which should be used by Spot Virtual Machines that are Evicted from the Scale Set. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created. - extension
Operations BooleanEnabled Should extension operations be allowed on the Virtual Machine Scale Set? Possible values are
true
orfalse
. Defaults totrue
. Changing this forces a new Virtual Machine Scale Set to be created.Note:
extension_operations_enabled
may only be set tofalse
if there are no extensions defined in theextension
field.- extensions
List<Orchestrated
Virtual Machine Scale Set Extension> - One or more
extension
blocks as defined below - extensions
Time StringBudget - Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to
PT1H30M
. - identity
Orchestrated
Virtual Machine Scale Set Identity - An
identity
block as defined below. - instances Integer
- The number of Virtual Machines in the Virtual Machine Scale Set.
- license
Type String - Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine Scale Set. Possible values are
None
,Windows_Client
andWindows_Server
. - location String
- The Azure location where the Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- max
Bid DoublePrice - The maximum price you're willing to pay for each Virtual Machine in this Scale Set, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machines in the Scale Set will be evicted using the eviction_policy. Defaults to
-1
, which means that each Virtual Machine in the Scale Set should not be evicted for price reasons. - name String
- The name of the Virtual Machine Scale Set. Changing this forces a new resource to be created.
- network
Interfaces List<OrchestratedVirtual Machine Scale Set Network Interface> - One or more
network_interface
blocks as defined below. - os
Disk OrchestratedVirtual Machine Scale Set Os Disk - An
os_disk
block as defined below. - os
Profile OrchestratedVirtual Machine Scale Set Os Profile - An
os_profile
block as defined below. - plan
Orchestrated
Virtual Machine Scale Set Plan - A
plan
block as documented below. Changing this forces a new resource to be created. - priority String
- The Priority of this Virtual Machine Scale Set. Possible values are
Regular
andSpot
. Defaults toRegular
. Changing this value forces a new resource. - priority
Mix OrchestratedVirtual Machine Scale Set Priority Mix - a
priority_mix
block as defined below - proximity
Placement StringGroup Id - The ID of the Proximity Placement Group which the Virtual Machine should be assigned to. Changing this forces a new resource to be created.
- single
Placement BooleanGroup Should this Virtual Machine Scale Set be limited to a Single Placement Group, which means the number of instances will be capped at 100 Virtual Machines. Possible values are
true
orfalse
.Note:
single_placement_group
behaves differently for Flexible orchestration Virtual Machine Scale Sets than it does for Uniform orchestration Virtual Machine Scale Sets. It is recommended that you do not define thesingle_placement_group
field in your configuration file as the service will determine what this value should be based off of the value contained within thesku_name
field of your configuration file. You may set thesingle_placement_group
field totrue
, however once you set it tofalse
you will not be able to revert it back totrue
.- sku
Name String - The
name
of the SKU to be used by this Virtual Machine Scale Set. Valid values include: any of the General purpose, Compute optimized, Memory optimized, Storage optimized, GPU optimized, FPGA optimized, High performance, or Previous generation virtual machine SKUs. - sku
Profile OrchestratedVirtual Machine Scale Set Sku Profile An
sku_profile
block as defined below. Changing this forces a new resource to be created.Note: If
sku_profile
is specified thesku_name
must be set toMix
.- source
Image StringId - The ID of an Image which each Virtual Machine in this Scale Set should be based on. Possible Image ID types include
Image ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s. - source
Image OrchestratedReference Virtual Machine Scale Set Source Image Reference - A
source_image_reference
block as defined below. - Map<String,String>
- A mapping of tags which should be assigned to this Virtual Machine Scale Set.
- termination
Notification OrchestratedVirtual Machine Scale Set Termination Notification - A
termination_notification
block as defined below. - user
Data StringBase64 - The Base64-Encoded User Data which should be used for this Virtual Machine Scale Set.
- zone
Balance Boolean Should the Virtual Machines in this Scale Set be strictly evenly distributed across Availability Zones? Defaults to
false
. Changing this forces a new resource to be created.Note: This can only be set to
true
when one or morezones
are configured.- zones List<String>
Specifies a list of Availability Zones across which the Virtual Machine Scale Set will create instances.
Note: Updating
zones
to remove an existing zone forces a new Virtual Machine Scale Set to be created.Note: Availability Zones are only supported in several regions at this time.
- platform
Fault numberDomain Count Specifies the number of fault domains that are used by this Virtual Machine Scale Set. Changing this forces a new resource to be created.
Note: The number of Fault Domains varies depending on which Azure Region you're using. More information about update and fault domains and how they work can be found here.
- resource
Group stringName - The name of the Resource Group in which the Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- additional
Capabilities OrchestratedVirtual Machine Scale Set Additional Capabilities - An
additional_capabilities
block as defined below. - automatic
Instance OrchestratedRepair Virtual Machine Scale Set Automatic Instance Repair An
automatic_instance_repair
block as defined below.Note: To enable the
automatic_instance_repair
, the Orchestrated Virtual Machine Scale Set must have a valid Application Health Extension.- boot
Diagnostics OrchestratedVirtual Machine Scale Set Boot Diagnostics - A
boot_diagnostics
block as defined below. - capacity
Reservation stringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine Scale Set should be allocated to. Changing this forces a new resource to be created.
Note:
capacity_reservation_group_id
cannot be specified withproximity_placement_group_id
Note: If
capacity_reservation_group_id
is specified thesingle_placement_group
must be set tofalse
.- data
Disks OrchestratedVirtual Machine Scale Set Data Disk[] - One or more
data_disk
blocks as defined below. - encryption
At booleanHost Enabled - Should disks attached to this Virtual Machine Scale Set be encrypted by enabling Encryption at Host?
- eviction
Policy string - The Policy which should be used by Spot Virtual Machines that are Evicted from the Scale Set. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created. - extension
Operations booleanEnabled Should extension operations be allowed on the Virtual Machine Scale Set? Possible values are
true
orfalse
. Defaults totrue
. Changing this forces a new Virtual Machine Scale Set to be created.Note:
extension_operations_enabled
may only be set tofalse
if there are no extensions defined in theextension
field.- extensions
Orchestrated
Virtual Machine Scale Set Extension[] - One or more
extension
blocks as defined below - extensions
Time stringBudget - Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to
PT1H30M
. - identity
Orchestrated
Virtual Machine Scale Set Identity - An
identity
block as defined below. - instances number
- The number of Virtual Machines in the Virtual Machine Scale Set.
- license
Type string - Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine Scale Set. Possible values are
None
,Windows_Client
andWindows_Server
. - location string
- The Azure location where the Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- max
Bid numberPrice - The maximum price you're willing to pay for each Virtual Machine in this Scale Set, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machines in the Scale Set will be evicted using the eviction_policy. Defaults to
-1
, which means that each Virtual Machine in the Scale Set should not be evicted for price reasons. - name string
- The name of the Virtual Machine Scale Set. Changing this forces a new resource to be created.
- network
Interfaces OrchestratedVirtual Machine Scale Set Network Interface[] - One or more
network_interface
blocks as defined below. - os
Disk OrchestratedVirtual Machine Scale Set Os Disk - An
os_disk
block as defined below. - os
Profile OrchestratedVirtual Machine Scale Set Os Profile - An
os_profile
block as defined below. - plan
Orchestrated
Virtual Machine Scale Set Plan - A
plan
block as documented below. Changing this forces a new resource to be created. - priority string
- The Priority of this Virtual Machine Scale Set. Possible values are
Regular
andSpot
. Defaults toRegular
. Changing this value forces a new resource. - priority
Mix OrchestratedVirtual Machine Scale Set Priority Mix - a
priority_mix
block as defined below - proximity
Placement stringGroup Id - The ID of the Proximity Placement Group which the Virtual Machine should be assigned to. Changing this forces a new resource to be created.
- single
Placement booleanGroup Should this Virtual Machine Scale Set be limited to a Single Placement Group, which means the number of instances will be capped at 100 Virtual Machines. Possible values are
true
orfalse
.Note:
single_placement_group
behaves differently for Flexible orchestration Virtual Machine Scale Sets than it does for Uniform orchestration Virtual Machine Scale Sets. It is recommended that you do not define thesingle_placement_group
field in your configuration file as the service will determine what this value should be based off of the value contained within thesku_name
field of your configuration file. You may set thesingle_placement_group
field totrue
, however once you set it tofalse
you will not be able to revert it back totrue
.- sku
Name string - The
name
of the SKU to be used by this Virtual Machine Scale Set. Valid values include: any of the General purpose, Compute optimized, Memory optimized, Storage optimized, GPU optimized, FPGA optimized, High performance, or Previous generation virtual machine SKUs. - sku
Profile OrchestratedVirtual Machine Scale Set Sku Profile An
sku_profile
block as defined below. Changing this forces a new resource to be created.Note: If
sku_profile
is specified thesku_name
must be set toMix
.- source
Image stringId - The ID of an Image which each Virtual Machine in this Scale Set should be based on. Possible Image ID types include
Image ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s. - source
Image OrchestratedReference Virtual Machine Scale Set Source Image Reference - A
source_image_reference
block as defined below. - {[key: string]: string}
- A mapping of tags which should be assigned to this Virtual Machine Scale Set.
- termination
Notification OrchestratedVirtual Machine Scale Set Termination Notification - A
termination_notification
block as defined below. - user
Data stringBase64 - The Base64-Encoded User Data which should be used for this Virtual Machine Scale Set.
- zone
Balance boolean Should the Virtual Machines in this Scale Set be strictly evenly distributed across Availability Zones? Defaults to
false
. Changing this forces a new resource to be created.Note: This can only be set to
true
when one or morezones
are configured.- zones string[]
Specifies a list of Availability Zones across which the Virtual Machine Scale Set will create instances.
Note: Updating
zones
to remove an existing zone forces a new Virtual Machine Scale Set to be created.Note: Availability Zones are only supported in several regions at this time.
- platform_
fault_ intdomain_ count Specifies the number of fault domains that are used by this Virtual Machine Scale Set. Changing this forces a new resource to be created.
Note: The number of Fault Domains varies depending on which Azure Region you're using. More information about update and fault domains and how they work can be found here.
- resource_
group_ strname - The name of the Resource Group in which the Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- additional_
capabilities OrchestratedVirtual Machine Scale Set Additional Capabilities Args - An
additional_capabilities
block as defined below. - automatic_
instance_ Orchestratedrepair Virtual Machine Scale Set Automatic Instance Repair Args An
automatic_instance_repair
block as defined below.Note: To enable the
automatic_instance_repair
, the Orchestrated Virtual Machine Scale Set must have a valid Application Health Extension.- boot_
diagnostics OrchestratedVirtual Machine Scale Set Boot Diagnostics Args - A
boot_diagnostics
block as defined below. - capacity_
reservation_ strgroup_ id Specifies the ID of the Capacity Reservation Group which the Virtual Machine Scale Set should be allocated to. Changing this forces a new resource to be created.
Note:
capacity_reservation_group_id
cannot be specified withproximity_placement_group_id
Note: If
capacity_reservation_group_id
is specified thesingle_placement_group
must be set tofalse
.- data_
disks Sequence[OrchestratedVirtual Machine Scale Set Data Disk Args] - One or more
data_disk
blocks as defined below. - encryption_
at_ boolhost_ enabled - Should disks attached to this Virtual Machine Scale Set be encrypted by enabling Encryption at Host?
- eviction_
policy str - The Policy which should be used by Spot Virtual Machines that are Evicted from the Scale Set. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created. - extension_
operations_ boolenabled Should extension operations be allowed on the Virtual Machine Scale Set? Possible values are
true
orfalse
. Defaults totrue
. Changing this forces a new Virtual Machine Scale Set to be created.Note:
extension_operations_enabled
may only be set tofalse
if there are no extensions defined in theextension
field.- extensions
Sequence[Orchestrated
Virtual Machine Scale Set Extension Args] - One or more
extension
blocks as defined below - extensions_
time_ strbudget - Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to
PT1H30M
. - identity
Orchestrated
Virtual Machine Scale Set Identity Args - An
identity
block as defined below. - instances int
- The number of Virtual Machines in the Virtual Machine Scale Set.
- license_
type str - Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine Scale Set. Possible values are
None
,Windows_Client
andWindows_Server
. - location str
- The Azure location where the Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- max_
bid_ floatprice - The maximum price you're willing to pay for each Virtual Machine in this Scale Set, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machines in the Scale Set will be evicted using the eviction_policy. Defaults to
-1
, which means that each Virtual Machine in the Scale Set should not be evicted for price reasons. - name str
- The name of the Virtual Machine Scale Set. Changing this forces a new resource to be created.
- network_
interfaces Sequence[OrchestratedVirtual Machine Scale Set Network Interface Args] - One or more
network_interface
blocks as defined below. - os_
disk OrchestratedVirtual Machine Scale Set Os Disk Args - An
os_disk
block as defined below. - os_
profile OrchestratedVirtual Machine Scale Set Os Profile Args - An
os_profile
block as defined below. - plan
Orchestrated
Virtual Machine Scale Set Plan Args - A
plan
block as documented below. Changing this forces a new resource to be created. - priority str
- The Priority of this Virtual Machine Scale Set. Possible values are
Regular
andSpot
. Defaults toRegular
. Changing this value forces a new resource. - priority_
mix OrchestratedVirtual Machine Scale Set Priority Mix Args - a
priority_mix
block as defined below - proximity_
placement_ strgroup_ id - The ID of the Proximity Placement Group which the Virtual Machine should be assigned to. Changing this forces a new resource to be created.
- single_
placement_ boolgroup Should this Virtual Machine Scale Set be limited to a Single Placement Group, which means the number of instances will be capped at 100 Virtual Machines. Possible values are
true
orfalse
.Note:
single_placement_group
behaves differently for Flexible orchestration Virtual Machine Scale Sets than it does for Uniform orchestration Virtual Machine Scale Sets. It is recommended that you do not define thesingle_placement_group
field in your configuration file as the service will determine what this value should be based off of the value contained within thesku_name
field of your configuration file. You may set thesingle_placement_group
field totrue
, however once you set it tofalse
you will not be able to revert it back totrue
.- sku_
name str - The
name
of the SKU to be used by this Virtual Machine Scale Set. Valid values include: any of the General purpose, Compute optimized, Memory optimized, Storage optimized, GPU optimized, FPGA optimized, High performance, or Previous generation virtual machine SKUs. - sku_
profile OrchestratedVirtual Machine Scale Set Sku Profile Args An
sku_profile
block as defined below. Changing this forces a new resource to be created.Note: If
sku_profile
is specified thesku_name
must be set toMix
.- source_
image_ strid - The ID of an Image which each Virtual Machine in this Scale Set should be based on. Possible Image ID types include
Image ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s. - source_
image_ Orchestratedreference Virtual Machine Scale Set Source Image Reference Args - A
source_image_reference
block as defined below. - Mapping[str, str]
- A mapping of tags which should be assigned to this Virtual Machine Scale Set.
- termination_
notification OrchestratedVirtual Machine Scale Set Termination Notification Args - A
termination_notification
block as defined below. - user_
data_ strbase64 - The Base64-Encoded User Data which should be used for this Virtual Machine Scale Set.
- zone_
balance bool Should the Virtual Machines in this Scale Set be strictly evenly distributed across Availability Zones? Defaults to
false
. Changing this forces a new resource to be created.Note: This can only be set to
true
when one or morezones
are configured.- zones Sequence[str]
Specifies a list of Availability Zones across which the Virtual Machine Scale Set will create instances.
Note: Updating
zones
to remove an existing zone forces a new Virtual Machine Scale Set to be created.Note: Availability Zones are only supported in several regions at this time.
- platform
Fault NumberDomain Count Specifies the number of fault domains that are used by this Virtual Machine Scale Set. Changing this forces a new resource to be created.
Note: The number of Fault Domains varies depending on which Azure Region you're using. More information about update and fault domains and how they work can be found here.
- resource
Group StringName - The name of the Resource Group in which the Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- additional
Capabilities Property Map - An
additional_capabilities
block as defined below. - automatic
Instance Property MapRepair An
automatic_instance_repair
block as defined below.Note: To enable the
automatic_instance_repair
, the Orchestrated Virtual Machine Scale Set must have a valid Application Health Extension.- boot
Diagnostics Property Map - A
boot_diagnostics
block as defined below. - capacity
Reservation StringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine Scale Set should be allocated to. Changing this forces a new resource to be created.
Note:
capacity_reservation_group_id
cannot be specified withproximity_placement_group_id
Note: If
capacity_reservation_group_id
is specified thesingle_placement_group
must be set tofalse
.- data
Disks List<Property Map> - One or more
data_disk
blocks as defined below. - encryption
At BooleanHost Enabled - Should disks attached to this Virtual Machine Scale Set be encrypted by enabling Encryption at Host?
- eviction
Policy String - The Policy which should be used by Spot Virtual Machines that are Evicted from the Scale Set. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created. - extension
Operations BooleanEnabled Should extension operations be allowed on the Virtual Machine Scale Set? Possible values are
true
orfalse
. Defaults totrue
. Changing this forces a new Virtual Machine Scale Set to be created.Note:
extension_operations_enabled
may only be set tofalse
if there are no extensions defined in theextension
field.- extensions List<Property Map>
- One or more
extension
blocks as defined below - extensions
Time StringBudget - Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to
PT1H30M
. - identity Property Map
- An
identity
block as defined below. - instances Number
- The number of Virtual Machines in the Virtual Machine Scale Set.
- license
Type String - Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine Scale Set. Possible values are
None
,Windows_Client
andWindows_Server
. - location String
- The Azure location where the Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- max
Bid NumberPrice - The maximum price you're willing to pay for each Virtual Machine in this Scale Set, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machines in the Scale Set will be evicted using the eviction_policy. Defaults to
-1
, which means that each Virtual Machine in the Scale Set should not be evicted for price reasons. - name String
- The name of the Virtual Machine Scale Set. Changing this forces a new resource to be created.
- network
Interfaces List<Property Map> - One or more
network_interface
blocks as defined below. - os
Disk Property Map - An
os_disk
block as defined below. - os
Profile Property Map - An
os_profile
block as defined below. - plan Property Map
- A
plan
block as documented below. Changing this forces a new resource to be created. - priority String
- The Priority of this Virtual Machine Scale Set. Possible values are
Regular
andSpot
. Defaults toRegular
. Changing this value forces a new resource. - priority
Mix Property Map - a
priority_mix
block as defined below - proximity
Placement StringGroup Id - The ID of the Proximity Placement Group which the Virtual Machine should be assigned to. Changing this forces a new resource to be created.
- single
Placement BooleanGroup Should this Virtual Machine Scale Set be limited to a Single Placement Group, which means the number of instances will be capped at 100 Virtual Machines. Possible values are
true
orfalse
.Note:
single_placement_group
behaves differently for Flexible orchestration Virtual Machine Scale Sets than it does for Uniform orchestration Virtual Machine Scale Sets. It is recommended that you do not define thesingle_placement_group
field in your configuration file as the service will determine what this value should be based off of the value contained within thesku_name
field of your configuration file. You may set thesingle_placement_group
field totrue
, however once you set it tofalse
you will not be able to revert it back totrue
.- sku
Name String - The
name
of the SKU to be used by this Virtual Machine Scale Set. Valid values include: any of the General purpose, Compute optimized, Memory optimized, Storage optimized, GPU optimized, FPGA optimized, High performance, or Previous generation virtual machine SKUs. - sku
Profile Property Map An
sku_profile
block as defined below. Changing this forces a new resource to be created.Note: If
sku_profile
is specified thesku_name
must be set toMix
.- source
Image StringId - The ID of an Image which each Virtual Machine in this Scale Set should be based on. Possible Image ID types include
Image ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s. - source
Image Property MapReference - A
source_image_reference
block as defined below. - Map<String>
- A mapping of tags which should be assigned to this Virtual Machine Scale Set.
- termination
Notification Property Map - A
termination_notification
block as defined below. - user
Data StringBase64 - The Base64-Encoded User Data which should be used for this Virtual Machine Scale Set.
- zone
Balance Boolean Should the Virtual Machines in this Scale Set be strictly evenly distributed across Availability Zones? Defaults to
false
. Changing this forces a new resource to be created.Note: This can only be set to
true
when one or morezones
are configured.- zones List<String>
Specifies a list of Availability Zones across which the Virtual Machine Scale Set will create instances.
Note: Updating
zones
to remove an existing zone forces a new Virtual Machine Scale Set to be created.Note: Availability Zones are only supported in several regions at this time.
Outputs
All input properties are implicitly available as output properties. Additionally, the OrchestratedVirtualMachineScaleSet resource produces the following output properties:
Look up Existing OrchestratedVirtualMachineScaleSet Resource
Get an existing OrchestratedVirtualMachineScaleSet 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?: OrchestratedVirtualMachineScaleSetState, opts?: CustomResourceOptions): OrchestratedVirtualMachineScaleSet
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
additional_capabilities: Optional[OrchestratedVirtualMachineScaleSetAdditionalCapabilitiesArgs] = None,
automatic_instance_repair: Optional[OrchestratedVirtualMachineScaleSetAutomaticInstanceRepairArgs] = None,
boot_diagnostics: Optional[OrchestratedVirtualMachineScaleSetBootDiagnosticsArgs] = None,
capacity_reservation_group_id: Optional[str] = None,
data_disks: Optional[Sequence[OrchestratedVirtualMachineScaleSetDataDiskArgs]] = None,
encryption_at_host_enabled: Optional[bool] = None,
eviction_policy: Optional[str] = None,
extension_operations_enabled: Optional[bool] = None,
extensions: Optional[Sequence[OrchestratedVirtualMachineScaleSetExtensionArgs]] = None,
extensions_time_budget: Optional[str] = None,
identity: Optional[OrchestratedVirtualMachineScaleSetIdentityArgs] = None,
instances: Optional[int] = None,
license_type: Optional[str] = None,
location: Optional[str] = None,
max_bid_price: Optional[float] = None,
name: Optional[str] = None,
network_interfaces: Optional[Sequence[OrchestratedVirtualMachineScaleSetNetworkInterfaceArgs]] = None,
os_disk: Optional[OrchestratedVirtualMachineScaleSetOsDiskArgs] = None,
os_profile: Optional[OrchestratedVirtualMachineScaleSetOsProfileArgs] = None,
plan: Optional[OrchestratedVirtualMachineScaleSetPlanArgs] = None,
platform_fault_domain_count: Optional[int] = None,
priority: Optional[str] = None,
priority_mix: Optional[OrchestratedVirtualMachineScaleSetPriorityMixArgs] = None,
proximity_placement_group_id: Optional[str] = None,
resource_group_name: Optional[str] = None,
single_placement_group: Optional[bool] = None,
sku_name: Optional[str] = None,
sku_profile: Optional[OrchestratedVirtualMachineScaleSetSkuProfileArgs] = None,
source_image_id: Optional[str] = None,
source_image_reference: Optional[OrchestratedVirtualMachineScaleSetSourceImageReferenceArgs] = None,
tags: Optional[Mapping[str, str]] = None,
termination_notification: Optional[OrchestratedVirtualMachineScaleSetTerminationNotificationArgs] = None,
unique_id: Optional[str] = None,
user_data_base64: Optional[str] = None,
zone_balance: Optional[bool] = None,
zones: Optional[Sequence[str]] = None) -> OrchestratedVirtualMachineScaleSet
func GetOrchestratedVirtualMachineScaleSet(ctx *Context, name string, id IDInput, state *OrchestratedVirtualMachineScaleSetState, opts ...ResourceOption) (*OrchestratedVirtualMachineScaleSet, error)
public static OrchestratedVirtualMachineScaleSet Get(string name, Input<string> id, OrchestratedVirtualMachineScaleSetState? state, CustomResourceOptions? opts = null)
public static OrchestratedVirtualMachineScaleSet get(String name, Output<String> id, OrchestratedVirtualMachineScaleSetState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- 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.
- Additional
Capabilities OrchestratedVirtual Machine Scale Set Additional Capabilities - An
additional_capabilities
block as defined below. - Automatic
Instance OrchestratedRepair Virtual Machine Scale Set Automatic Instance Repair An
automatic_instance_repair
block as defined below.Note: To enable the
automatic_instance_repair
, the Orchestrated Virtual Machine Scale Set must have a valid Application Health Extension.- Boot
Diagnostics OrchestratedVirtual Machine Scale Set Boot Diagnostics - A
boot_diagnostics
block as defined below. - Capacity
Reservation stringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine Scale Set should be allocated to. Changing this forces a new resource to be created.
Note:
capacity_reservation_group_id
cannot be specified withproximity_placement_group_id
Note: If
capacity_reservation_group_id
is specified thesingle_placement_group
must be set tofalse
.- Data
Disks List<OrchestratedVirtual Machine Scale Set Data Disk> - One or more
data_disk
blocks as defined below. - Encryption
At boolHost Enabled - Should disks attached to this Virtual Machine Scale Set be encrypted by enabling Encryption at Host?
- Eviction
Policy string - The Policy which should be used by Spot Virtual Machines that are Evicted from the Scale Set. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created. - Extension
Operations boolEnabled Should extension operations be allowed on the Virtual Machine Scale Set? Possible values are
true
orfalse
. Defaults totrue
. Changing this forces a new Virtual Machine Scale Set to be created.Note:
extension_operations_enabled
may only be set tofalse
if there are no extensions defined in theextension
field.- Extensions
List<Orchestrated
Virtual Machine Scale Set Extension> - One or more
extension
blocks as defined below - Extensions
Time stringBudget - Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to
PT1H30M
. - Identity
Orchestrated
Virtual Machine Scale Set Identity - An
identity
block as defined below. - Instances int
- The number of Virtual Machines in the Virtual Machine Scale Set.
- License
Type string - Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine Scale Set. Possible values are
None
,Windows_Client
andWindows_Server
. - Location string
- The Azure location where the Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- Max
Bid doublePrice - The maximum price you're willing to pay for each Virtual Machine in this Scale Set, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machines in the Scale Set will be evicted using the eviction_policy. Defaults to
-1
, which means that each Virtual Machine in the Scale Set should not be evicted for price reasons. - Name string
- The name of the Virtual Machine Scale Set. Changing this forces a new resource to be created.
- Network
Interfaces List<OrchestratedVirtual Machine Scale Set Network Interface> - One or more
network_interface
blocks as defined below. - Os
Disk OrchestratedVirtual Machine Scale Set Os Disk - An
os_disk
block as defined below. - Os
Profile OrchestratedVirtual Machine Scale Set Os Profile - An
os_profile
block as defined below. - Plan
Orchestrated
Virtual Machine Scale Set Plan - A
plan
block as documented below. Changing this forces a new resource to be created. - Platform
Fault intDomain Count Specifies the number of fault domains that are used by this Virtual Machine Scale Set. Changing this forces a new resource to be created.
Note: The number of Fault Domains varies depending on which Azure Region you're using. More information about update and fault domains and how they work can be found here.
- Priority string
- The Priority of this Virtual Machine Scale Set. Possible values are
Regular
andSpot
. Defaults toRegular
. Changing this value forces a new resource. - Priority
Mix OrchestratedVirtual Machine Scale Set Priority Mix - a
priority_mix
block as defined below - Proximity
Placement stringGroup Id - The ID of the Proximity Placement Group which the Virtual Machine should be assigned to. Changing this forces a new resource to be created.
- Resource
Group stringName - The name of the Resource Group in which the Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- Single
Placement boolGroup Should this Virtual Machine Scale Set be limited to a Single Placement Group, which means the number of instances will be capped at 100 Virtual Machines. Possible values are
true
orfalse
.Note:
single_placement_group
behaves differently for Flexible orchestration Virtual Machine Scale Sets than it does for Uniform orchestration Virtual Machine Scale Sets. It is recommended that you do not define thesingle_placement_group
field in your configuration file as the service will determine what this value should be based off of the value contained within thesku_name
field of your configuration file. You may set thesingle_placement_group
field totrue
, however once you set it tofalse
you will not be able to revert it back totrue
.- Sku
Name string - The
name
of the SKU to be used by this Virtual Machine Scale Set. Valid values include: any of the General purpose, Compute optimized, Memory optimized, Storage optimized, GPU optimized, FPGA optimized, High performance, or Previous generation virtual machine SKUs. - Sku
Profile OrchestratedVirtual Machine Scale Set Sku Profile An
sku_profile
block as defined below. Changing this forces a new resource to be created.Note: If
sku_profile
is specified thesku_name
must be set toMix
.- Source
Image stringId - The ID of an Image which each Virtual Machine in this Scale Set should be based on. Possible Image ID types include
Image ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s. - Source
Image OrchestratedReference Virtual Machine Scale Set Source Image Reference - A
source_image_reference
block as defined below. - Dictionary<string, string>
- A mapping of tags which should be assigned to this Virtual Machine Scale Set.
- Termination
Notification OrchestratedVirtual Machine Scale Set Termination Notification - A
termination_notification
block as defined below. - Unique
Id string - The Unique ID for the Virtual Machine Scale Set.
- User
Data stringBase64 - The Base64-Encoded User Data which should be used for this Virtual Machine Scale Set.
- Zone
Balance bool Should the Virtual Machines in this Scale Set be strictly evenly distributed across Availability Zones? Defaults to
false
. Changing this forces a new resource to be created.Note: This can only be set to
true
when one or morezones
are configured.- Zones List<string>
Specifies a list of Availability Zones across which the Virtual Machine Scale Set will create instances.
Note: Updating
zones
to remove an existing zone forces a new Virtual Machine Scale Set to be created.Note: Availability Zones are only supported in several regions at this time.
- Additional
Capabilities OrchestratedVirtual Machine Scale Set Additional Capabilities Args - An
additional_capabilities
block as defined below. - Automatic
Instance OrchestratedRepair Virtual Machine Scale Set Automatic Instance Repair Args An
automatic_instance_repair
block as defined below.Note: To enable the
automatic_instance_repair
, the Orchestrated Virtual Machine Scale Set must have a valid Application Health Extension.- Boot
Diagnostics OrchestratedVirtual Machine Scale Set Boot Diagnostics Args - A
boot_diagnostics
block as defined below. - Capacity
Reservation stringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine Scale Set should be allocated to. Changing this forces a new resource to be created.
Note:
capacity_reservation_group_id
cannot be specified withproximity_placement_group_id
Note: If
capacity_reservation_group_id
is specified thesingle_placement_group
must be set tofalse
.- Data
Disks []OrchestratedVirtual Machine Scale Set Data Disk Args - One or more
data_disk
blocks as defined below. - Encryption
At boolHost Enabled - Should disks attached to this Virtual Machine Scale Set be encrypted by enabling Encryption at Host?
- Eviction
Policy string - The Policy which should be used by Spot Virtual Machines that are Evicted from the Scale Set. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created. - Extension
Operations boolEnabled Should extension operations be allowed on the Virtual Machine Scale Set? Possible values are
true
orfalse
. Defaults totrue
. Changing this forces a new Virtual Machine Scale Set to be created.Note:
extension_operations_enabled
may only be set tofalse
if there are no extensions defined in theextension
field.- Extensions
[]Orchestrated
Virtual Machine Scale Set Extension Args - One or more
extension
blocks as defined below - Extensions
Time stringBudget - Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to
PT1H30M
. - Identity
Orchestrated
Virtual Machine Scale Set Identity Args - An
identity
block as defined below. - Instances int
- The number of Virtual Machines in the Virtual Machine Scale Set.
- License
Type string - Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine Scale Set. Possible values are
None
,Windows_Client
andWindows_Server
. - Location string
- The Azure location where the Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- Max
Bid float64Price - The maximum price you're willing to pay for each Virtual Machine in this Scale Set, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machines in the Scale Set will be evicted using the eviction_policy. Defaults to
-1
, which means that each Virtual Machine in the Scale Set should not be evicted for price reasons. - Name string
- The name of the Virtual Machine Scale Set. Changing this forces a new resource to be created.
- Network
Interfaces []OrchestratedVirtual Machine Scale Set Network Interface Args - One or more
network_interface
blocks as defined below. - Os
Disk OrchestratedVirtual Machine Scale Set Os Disk Args - An
os_disk
block as defined below. - Os
Profile OrchestratedVirtual Machine Scale Set Os Profile Args - An
os_profile
block as defined below. - Plan
Orchestrated
Virtual Machine Scale Set Plan Args - A
plan
block as documented below. Changing this forces a new resource to be created. - Platform
Fault intDomain Count Specifies the number of fault domains that are used by this Virtual Machine Scale Set. Changing this forces a new resource to be created.
Note: The number of Fault Domains varies depending on which Azure Region you're using. More information about update and fault domains and how they work can be found here.
- Priority string
- The Priority of this Virtual Machine Scale Set. Possible values are
Regular
andSpot
. Defaults toRegular
. Changing this value forces a new resource. - Priority
Mix OrchestratedVirtual Machine Scale Set Priority Mix Args - a
priority_mix
block as defined below - Proximity
Placement stringGroup Id - The ID of the Proximity Placement Group which the Virtual Machine should be assigned to. Changing this forces a new resource to be created.
- Resource
Group stringName - The name of the Resource Group in which the Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- Single
Placement boolGroup Should this Virtual Machine Scale Set be limited to a Single Placement Group, which means the number of instances will be capped at 100 Virtual Machines. Possible values are
true
orfalse
.Note:
single_placement_group
behaves differently for Flexible orchestration Virtual Machine Scale Sets than it does for Uniform orchestration Virtual Machine Scale Sets. It is recommended that you do not define thesingle_placement_group
field in your configuration file as the service will determine what this value should be based off of the value contained within thesku_name
field of your configuration file. You may set thesingle_placement_group
field totrue
, however once you set it tofalse
you will not be able to revert it back totrue
.- Sku
Name string - The
name
of the SKU to be used by this Virtual Machine Scale Set. Valid values include: any of the General purpose, Compute optimized, Memory optimized, Storage optimized, GPU optimized, FPGA optimized, High performance, or Previous generation virtual machine SKUs. - Sku
Profile OrchestratedVirtual Machine Scale Set Sku Profile Args An
sku_profile
block as defined below. Changing this forces a new resource to be created.Note: If
sku_profile
is specified thesku_name
must be set toMix
.- Source
Image stringId - The ID of an Image which each Virtual Machine in this Scale Set should be based on. Possible Image ID types include
Image ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s. - Source
Image OrchestratedReference Virtual Machine Scale Set Source Image Reference Args - A
source_image_reference
block as defined below. - map[string]string
- A mapping of tags which should be assigned to this Virtual Machine Scale Set.
- Termination
Notification OrchestratedVirtual Machine Scale Set Termination Notification Args - A
termination_notification
block as defined below. - Unique
Id string - The Unique ID for the Virtual Machine Scale Set.
- User
Data stringBase64 - The Base64-Encoded User Data which should be used for this Virtual Machine Scale Set.
- Zone
Balance bool Should the Virtual Machines in this Scale Set be strictly evenly distributed across Availability Zones? Defaults to
false
. Changing this forces a new resource to be created.Note: This can only be set to
true
when one or morezones
are configured.- Zones []string
Specifies a list of Availability Zones across which the Virtual Machine Scale Set will create instances.
Note: Updating
zones
to remove an existing zone forces a new Virtual Machine Scale Set to be created.Note: Availability Zones are only supported in several regions at this time.
- additional
Capabilities OrchestratedVirtual Machine Scale Set Additional Capabilities - An
additional_capabilities
block as defined below. - automatic
Instance OrchestratedRepair Virtual Machine Scale Set Automatic Instance Repair An
automatic_instance_repair
block as defined below.Note: To enable the
automatic_instance_repair
, the Orchestrated Virtual Machine Scale Set must have a valid Application Health Extension.- boot
Diagnostics OrchestratedVirtual Machine Scale Set Boot Diagnostics - A
boot_diagnostics
block as defined below. - capacity
Reservation StringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine Scale Set should be allocated to. Changing this forces a new resource to be created.
Note:
capacity_reservation_group_id
cannot be specified withproximity_placement_group_id
Note: If
capacity_reservation_group_id
is specified thesingle_placement_group
must be set tofalse
.- data
Disks List<OrchestratedVirtual Machine Scale Set Data Disk> - One or more
data_disk
blocks as defined below. - encryption
At BooleanHost Enabled - Should disks attached to this Virtual Machine Scale Set be encrypted by enabling Encryption at Host?
- eviction
Policy String - The Policy which should be used by Spot Virtual Machines that are Evicted from the Scale Set. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created. - extension
Operations BooleanEnabled Should extension operations be allowed on the Virtual Machine Scale Set? Possible values are
true
orfalse
. Defaults totrue
. Changing this forces a new Virtual Machine Scale Set to be created.Note:
extension_operations_enabled
may only be set tofalse
if there are no extensions defined in theextension
field.- extensions
List<Orchestrated
Virtual Machine Scale Set Extension> - One or more
extension
blocks as defined below - extensions
Time StringBudget - Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to
PT1H30M
. - identity
Orchestrated
Virtual Machine Scale Set Identity - An
identity
block as defined below. - instances Integer
- The number of Virtual Machines in the Virtual Machine Scale Set.
- license
Type String - Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine Scale Set. Possible values are
None
,Windows_Client
andWindows_Server
. - location String
- The Azure location where the Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- max
Bid DoublePrice - The maximum price you're willing to pay for each Virtual Machine in this Scale Set, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machines in the Scale Set will be evicted using the eviction_policy. Defaults to
-1
, which means that each Virtual Machine in the Scale Set should not be evicted for price reasons. - name String
- The name of the Virtual Machine Scale Set. Changing this forces a new resource to be created.
- network
Interfaces List<OrchestratedVirtual Machine Scale Set Network Interface> - One or more
network_interface
blocks as defined below. - os
Disk OrchestratedVirtual Machine Scale Set Os Disk - An
os_disk
block as defined below. - os
Profile OrchestratedVirtual Machine Scale Set Os Profile - An
os_profile
block as defined below. - plan
Orchestrated
Virtual Machine Scale Set Plan - A
plan
block as documented below. Changing this forces a new resource to be created. - platform
Fault IntegerDomain Count Specifies the number of fault domains that are used by this Virtual Machine Scale Set. Changing this forces a new resource to be created.
Note: The number of Fault Domains varies depending on which Azure Region you're using. More information about update and fault domains and how they work can be found here.
- priority String
- The Priority of this Virtual Machine Scale Set. Possible values are
Regular
andSpot
. Defaults toRegular
. Changing this value forces a new resource. - priority
Mix OrchestratedVirtual Machine Scale Set Priority Mix - a
priority_mix
block as defined below - proximity
Placement StringGroup Id - The ID of the Proximity Placement Group which the Virtual Machine should be assigned to. Changing this forces a new resource to be created.
- resource
Group StringName - The name of the Resource Group in which the Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- single
Placement BooleanGroup Should this Virtual Machine Scale Set be limited to a Single Placement Group, which means the number of instances will be capped at 100 Virtual Machines. Possible values are
true
orfalse
.Note:
single_placement_group
behaves differently for Flexible orchestration Virtual Machine Scale Sets than it does for Uniform orchestration Virtual Machine Scale Sets. It is recommended that you do not define thesingle_placement_group
field in your configuration file as the service will determine what this value should be based off of the value contained within thesku_name
field of your configuration file. You may set thesingle_placement_group
field totrue
, however once you set it tofalse
you will not be able to revert it back totrue
.- sku
Name String - The
name
of the SKU to be used by this Virtual Machine Scale Set. Valid values include: any of the General purpose, Compute optimized, Memory optimized, Storage optimized, GPU optimized, FPGA optimized, High performance, or Previous generation virtual machine SKUs. - sku
Profile OrchestratedVirtual Machine Scale Set Sku Profile An
sku_profile
block as defined below. Changing this forces a new resource to be created.Note: If
sku_profile
is specified thesku_name
must be set toMix
.- source
Image StringId - The ID of an Image which each Virtual Machine in this Scale Set should be based on. Possible Image ID types include
Image ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s. - source
Image OrchestratedReference Virtual Machine Scale Set Source Image Reference - A
source_image_reference
block as defined below. - Map<String,String>
- A mapping of tags which should be assigned to this Virtual Machine Scale Set.
- termination
Notification OrchestratedVirtual Machine Scale Set Termination Notification - A
termination_notification
block as defined below. - unique
Id String - The Unique ID for the Virtual Machine Scale Set.
- user
Data StringBase64 - The Base64-Encoded User Data which should be used for this Virtual Machine Scale Set.
- zone
Balance Boolean Should the Virtual Machines in this Scale Set be strictly evenly distributed across Availability Zones? Defaults to
false
. Changing this forces a new resource to be created.Note: This can only be set to
true
when one or morezones
are configured.- zones List<String>
Specifies a list of Availability Zones across which the Virtual Machine Scale Set will create instances.
Note: Updating
zones
to remove an existing zone forces a new Virtual Machine Scale Set to be created.Note: Availability Zones are only supported in several regions at this time.
- additional
Capabilities OrchestratedVirtual Machine Scale Set Additional Capabilities - An
additional_capabilities
block as defined below. - automatic
Instance OrchestratedRepair Virtual Machine Scale Set Automatic Instance Repair An
automatic_instance_repair
block as defined below.Note: To enable the
automatic_instance_repair
, the Orchestrated Virtual Machine Scale Set must have a valid Application Health Extension.- boot
Diagnostics OrchestratedVirtual Machine Scale Set Boot Diagnostics - A
boot_diagnostics
block as defined below. - capacity
Reservation stringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine Scale Set should be allocated to. Changing this forces a new resource to be created.
Note:
capacity_reservation_group_id
cannot be specified withproximity_placement_group_id
Note: If
capacity_reservation_group_id
is specified thesingle_placement_group
must be set tofalse
.- data
Disks OrchestratedVirtual Machine Scale Set Data Disk[] - One or more
data_disk
blocks as defined below. - encryption
At booleanHost Enabled - Should disks attached to this Virtual Machine Scale Set be encrypted by enabling Encryption at Host?
- eviction
Policy string - The Policy which should be used by Spot Virtual Machines that are Evicted from the Scale Set. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created. - extension
Operations booleanEnabled Should extension operations be allowed on the Virtual Machine Scale Set? Possible values are
true
orfalse
. Defaults totrue
. Changing this forces a new Virtual Machine Scale Set to be created.Note:
extension_operations_enabled
may only be set tofalse
if there are no extensions defined in theextension
field.- extensions
Orchestrated
Virtual Machine Scale Set Extension[] - One or more
extension
blocks as defined below - extensions
Time stringBudget - Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to
PT1H30M
. - identity
Orchestrated
Virtual Machine Scale Set Identity - An
identity
block as defined below. - instances number
- The number of Virtual Machines in the Virtual Machine Scale Set.
- license
Type string - Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine Scale Set. Possible values are
None
,Windows_Client
andWindows_Server
. - location string
- The Azure location where the Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- max
Bid numberPrice - The maximum price you're willing to pay for each Virtual Machine in this Scale Set, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machines in the Scale Set will be evicted using the eviction_policy. Defaults to
-1
, which means that each Virtual Machine in the Scale Set should not be evicted for price reasons. - name string
- The name of the Virtual Machine Scale Set. Changing this forces a new resource to be created.
- network
Interfaces OrchestratedVirtual Machine Scale Set Network Interface[] - One or more
network_interface
blocks as defined below. - os
Disk OrchestratedVirtual Machine Scale Set Os Disk - An
os_disk
block as defined below. - os
Profile OrchestratedVirtual Machine Scale Set Os Profile - An
os_profile
block as defined below. - plan
Orchestrated
Virtual Machine Scale Set Plan - A
plan
block as documented below. Changing this forces a new resource to be created. - platform
Fault numberDomain Count Specifies the number of fault domains that are used by this Virtual Machine Scale Set. Changing this forces a new resource to be created.
Note: The number of Fault Domains varies depending on which Azure Region you're using. More information about update and fault domains and how they work can be found here.
- priority string
- The Priority of this Virtual Machine Scale Set. Possible values are
Regular
andSpot
. Defaults toRegular
. Changing this value forces a new resource. - priority
Mix OrchestratedVirtual Machine Scale Set Priority Mix - a
priority_mix
block as defined below - proximity
Placement stringGroup Id - The ID of the Proximity Placement Group which the Virtual Machine should be assigned to. Changing this forces a new resource to be created.
- resource
Group stringName - The name of the Resource Group in which the Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- single
Placement booleanGroup Should this Virtual Machine Scale Set be limited to a Single Placement Group, which means the number of instances will be capped at 100 Virtual Machines. Possible values are
true
orfalse
.Note:
single_placement_group
behaves differently for Flexible orchestration Virtual Machine Scale Sets than it does for Uniform orchestration Virtual Machine Scale Sets. It is recommended that you do not define thesingle_placement_group
field in your configuration file as the service will determine what this value should be based off of the value contained within thesku_name
field of your configuration file. You may set thesingle_placement_group
field totrue
, however once you set it tofalse
you will not be able to revert it back totrue
.- sku
Name string - The
name
of the SKU to be used by this Virtual Machine Scale Set. Valid values include: any of the General purpose, Compute optimized, Memory optimized, Storage optimized, GPU optimized, FPGA optimized, High performance, or Previous generation virtual machine SKUs. - sku
Profile OrchestratedVirtual Machine Scale Set Sku Profile An
sku_profile
block as defined below. Changing this forces a new resource to be created.Note: If
sku_profile
is specified thesku_name
must be set toMix
.- source
Image stringId - The ID of an Image which each Virtual Machine in this Scale Set should be based on. Possible Image ID types include
Image ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s. - source
Image OrchestratedReference Virtual Machine Scale Set Source Image Reference - A
source_image_reference
block as defined below. - {[key: string]: string}
- A mapping of tags which should be assigned to this Virtual Machine Scale Set.
- termination
Notification OrchestratedVirtual Machine Scale Set Termination Notification - A
termination_notification
block as defined below. - unique
Id string - The Unique ID for the Virtual Machine Scale Set.
- user
Data stringBase64 - The Base64-Encoded User Data which should be used for this Virtual Machine Scale Set.
- zone
Balance boolean Should the Virtual Machines in this Scale Set be strictly evenly distributed across Availability Zones? Defaults to
false
. Changing this forces a new resource to be created.Note: This can only be set to
true
when one or morezones
are configured.- zones string[]
Specifies a list of Availability Zones across which the Virtual Machine Scale Set will create instances.
Note: Updating
zones
to remove an existing zone forces a new Virtual Machine Scale Set to be created.Note: Availability Zones are only supported in several regions at this time.
- additional_
capabilities OrchestratedVirtual Machine Scale Set Additional Capabilities Args - An
additional_capabilities
block as defined below. - automatic_
instance_ Orchestratedrepair Virtual Machine Scale Set Automatic Instance Repair Args An
automatic_instance_repair
block as defined below.Note: To enable the
automatic_instance_repair
, the Orchestrated Virtual Machine Scale Set must have a valid Application Health Extension.- boot_
diagnostics OrchestratedVirtual Machine Scale Set Boot Diagnostics Args - A
boot_diagnostics
block as defined below. - capacity_
reservation_ strgroup_ id Specifies the ID of the Capacity Reservation Group which the Virtual Machine Scale Set should be allocated to. Changing this forces a new resource to be created.
Note:
capacity_reservation_group_id
cannot be specified withproximity_placement_group_id
Note: If
capacity_reservation_group_id
is specified thesingle_placement_group
must be set tofalse
.- data_
disks Sequence[OrchestratedVirtual Machine Scale Set Data Disk Args] - One or more
data_disk
blocks as defined below. - encryption_
at_ boolhost_ enabled - Should disks attached to this Virtual Machine Scale Set be encrypted by enabling Encryption at Host?
- eviction_
policy str - The Policy which should be used by Spot Virtual Machines that are Evicted from the Scale Set. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created. - extension_
operations_ boolenabled Should extension operations be allowed on the Virtual Machine Scale Set? Possible values are
true
orfalse
. Defaults totrue
. Changing this forces a new Virtual Machine Scale Set to be created.Note:
extension_operations_enabled
may only be set tofalse
if there are no extensions defined in theextension
field.- extensions
Sequence[Orchestrated
Virtual Machine Scale Set Extension Args] - One or more
extension
blocks as defined below - extensions_
time_ strbudget - Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to
PT1H30M
. - identity
Orchestrated
Virtual Machine Scale Set Identity Args - An
identity
block as defined below. - instances int
- The number of Virtual Machines in the Virtual Machine Scale Set.
- license_
type str - Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine Scale Set. Possible values are
None
,Windows_Client
andWindows_Server
. - location str
- The Azure location where the Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- max_
bid_ floatprice - The maximum price you're willing to pay for each Virtual Machine in this Scale Set, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machines in the Scale Set will be evicted using the eviction_policy. Defaults to
-1
, which means that each Virtual Machine in the Scale Set should not be evicted for price reasons. - name str
- The name of the Virtual Machine Scale Set. Changing this forces a new resource to be created.
- network_
interfaces Sequence[OrchestratedVirtual Machine Scale Set Network Interface Args] - One or more
network_interface
blocks as defined below. - os_
disk OrchestratedVirtual Machine Scale Set Os Disk Args - An
os_disk
block as defined below. - os_
profile OrchestratedVirtual Machine Scale Set Os Profile Args - An
os_profile
block as defined below. - plan
Orchestrated
Virtual Machine Scale Set Plan Args - A
plan
block as documented below. Changing this forces a new resource to be created. - platform_
fault_ intdomain_ count Specifies the number of fault domains that are used by this Virtual Machine Scale Set. Changing this forces a new resource to be created.
Note: The number of Fault Domains varies depending on which Azure Region you're using. More information about update and fault domains and how they work can be found here.
- priority str
- The Priority of this Virtual Machine Scale Set. Possible values are
Regular
andSpot
. Defaults toRegular
. Changing this value forces a new resource. - priority_
mix OrchestratedVirtual Machine Scale Set Priority Mix Args - a
priority_mix
block as defined below - proximity_
placement_ strgroup_ id - The ID of the Proximity Placement Group which the Virtual Machine should be assigned to. Changing this forces a new resource to be created.
- resource_
group_ strname - The name of the Resource Group in which the Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- single_
placement_ boolgroup Should this Virtual Machine Scale Set be limited to a Single Placement Group, which means the number of instances will be capped at 100 Virtual Machines. Possible values are
true
orfalse
.Note:
single_placement_group
behaves differently for Flexible orchestration Virtual Machine Scale Sets than it does for Uniform orchestration Virtual Machine Scale Sets. It is recommended that you do not define thesingle_placement_group
field in your configuration file as the service will determine what this value should be based off of the value contained within thesku_name
field of your configuration file. You may set thesingle_placement_group
field totrue
, however once you set it tofalse
you will not be able to revert it back totrue
.- sku_
name str - The
name
of the SKU to be used by this Virtual Machine Scale Set. Valid values include: any of the General purpose, Compute optimized, Memory optimized, Storage optimized, GPU optimized, FPGA optimized, High performance, or Previous generation virtual machine SKUs. - sku_
profile OrchestratedVirtual Machine Scale Set Sku Profile Args An
sku_profile
block as defined below. Changing this forces a new resource to be created.Note: If
sku_profile
is specified thesku_name
must be set toMix
.- source_
image_ strid - The ID of an Image which each Virtual Machine in this Scale Set should be based on. Possible Image ID types include
Image ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s. - source_
image_ Orchestratedreference Virtual Machine Scale Set Source Image Reference Args - A
source_image_reference
block as defined below. - Mapping[str, str]
- A mapping of tags which should be assigned to this Virtual Machine Scale Set.
- termination_
notification OrchestratedVirtual Machine Scale Set Termination Notification Args - A
termination_notification
block as defined below. - unique_
id str - The Unique ID for the Virtual Machine Scale Set.
- user_
data_ strbase64 - The Base64-Encoded User Data which should be used for this Virtual Machine Scale Set.
- zone_
balance bool Should the Virtual Machines in this Scale Set be strictly evenly distributed across Availability Zones? Defaults to
false
. Changing this forces a new resource to be created.Note: This can only be set to
true
when one or morezones
are configured.- zones Sequence[str]
Specifies a list of Availability Zones across which the Virtual Machine Scale Set will create instances.
Note: Updating
zones
to remove an existing zone forces a new Virtual Machine Scale Set to be created.Note: Availability Zones are only supported in several regions at this time.
- additional
Capabilities Property Map - An
additional_capabilities
block as defined below. - automatic
Instance Property MapRepair An
automatic_instance_repair
block as defined below.Note: To enable the
automatic_instance_repair
, the Orchestrated Virtual Machine Scale Set must have a valid Application Health Extension.- boot
Diagnostics Property Map - A
boot_diagnostics
block as defined below. - capacity
Reservation StringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine Scale Set should be allocated to. Changing this forces a new resource to be created.
Note:
capacity_reservation_group_id
cannot be specified withproximity_placement_group_id
Note: If
capacity_reservation_group_id
is specified thesingle_placement_group
must be set tofalse
.- data
Disks List<Property Map> - One or more
data_disk
blocks as defined below. - encryption
At BooleanHost Enabled - Should disks attached to this Virtual Machine Scale Set be encrypted by enabling Encryption at Host?
- eviction
Policy String - The Policy which should be used by Spot Virtual Machines that are Evicted from the Scale Set. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created. - extension
Operations BooleanEnabled Should extension operations be allowed on the Virtual Machine Scale Set? Possible values are
true
orfalse
. Defaults totrue
. Changing this forces a new Virtual Machine Scale Set to be created.Note:
extension_operations_enabled
may only be set tofalse
if there are no extensions defined in theextension
field.- extensions List<Property Map>
- One or more
extension
blocks as defined below - extensions
Time StringBudget - Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to
PT1H30M
. - identity Property Map
- An
identity
block as defined below. - instances Number
- The number of Virtual Machines in the Virtual Machine Scale Set.
- license
Type String - Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine Scale Set. Possible values are
None
,Windows_Client
andWindows_Server
. - location String
- The Azure location where the Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- max
Bid NumberPrice - The maximum price you're willing to pay for each Virtual Machine in this Scale Set, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machines in the Scale Set will be evicted using the eviction_policy. Defaults to
-1
, which means that each Virtual Machine in the Scale Set should not be evicted for price reasons. - name String
- The name of the Virtual Machine Scale Set. Changing this forces a new resource to be created.
- network
Interfaces List<Property Map> - One or more
network_interface
blocks as defined below. - os
Disk Property Map - An
os_disk
block as defined below. - os
Profile Property Map - An
os_profile
block as defined below. - plan Property Map
- A
plan
block as documented below. Changing this forces a new resource to be created. - platform
Fault NumberDomain Count Specifies the number of fault domains that are used by this Virtual Machine Scale Set. Changing this forces a new resource to be created.
Note: The number of Fault Domains varies depending on which Azure Region you're using. More information about update and fault domains and how they work can be found here.
- priority String
- The Priority of this Virtual Machine Scale Set. Possible values are
Regular
andSpot
. Defaults toRegular
. Changing this value forces a new resource. - priority
Mix Property Map - a
priority_mix
block as defined below - proximity
Placement StringGroup Id - The ID of the Proximity Placement Group which the Virtual Machine should be assigned to. Changing this forces a new resource to be created.
- resource
Group StringName - The name of the Resource Group in which the Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- single
Placement BooleanGroup Should this Virtual Machine Scale Set be limited to a Single Placement Group, which means the number of instances will be capped at 100 Virtual Machines. Possible values are
true
orfalse
.Note:
single_placement_group
behaves differently for Flexible orchestration Virtual Machine Scale Sets than it does for Uniform orchestration Virtual Machine Scale Sets. It is recommended that you do not define thesingle_placement_group
field in your configuration file as the service will determine what this value should be based off of the value contained within thesku_name
field of your configuration file. You may set thesingle_placement_group
field totrue
, however once you set it tofalse
you will not be able to revert it back totrue
.- sku
Name String - The
name
of the SKU to be used by this Virtual Machine Scale Set. Valid values include: any of the General purpose, Compute optimized, Memory optimized, Storage optimized, GPU optimized, FPGA optimized, High performance, or Previous generation virtual machine SKUs. - sku
Profile Property Map An
sku_profile
block as defined below. Changing this forces a new resource to be created.Note: If
sku_profile
is specified thesku_name
must be set toMix
.- source
Image StringId - The ID of an Image which each Virtual Machine in this Scale Set should be based on. Possible Image ID types include
Image ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s. - source
Image Property MapReference - A
source_image_reference
block as defined below. - Map<String>
- A mapping of tags which should be assigned to this Virtual Machine Scale Set.
- termination
Notification Property Map - A
termination_notification
block as defined below. - unique
Id String - The Unique ID for the Virtual Machine Scale Set.
- user
Data StringBase64 - The Base64-Encoded User Data which should be used for this Virtual Machine Scale Set.
- zone
Balance Boolean Should the Virtual Machines in this Scale Set be strictly evenly distributed across Availability Zones? Defaults to
false
. Changing this forces a new resource to be created.Note: This can only be set to
true
when one or morezones
are configured.- zones List<String>
Specifies a list of Availability Zones across which the Virtual Machine Scale Set will create instances.
Note: Updating
zones
to remove an existing zone forces a new Virtual Machine Scale Set to be created.Note: Availability Zones are only supported in several regions at this time.
Supporting Types
OrchestratedVirtualMachineScaleSetAdditionalCapabilities, OrchestratedVirtualMachineScaleSetAdditionalCapabilitiesArgs
- Ultra
Ssd boolEnabled - Should the capacity to enable Data Disks of the
UltraSSD_LRS
storage account type be supported on this Virtual Machine Scale Set? Defaults tofalse
. Changing this forces a new resource to be created.
- Ultra
Ssd boolEnabled - Should the capacity to enable Data Disks of the
UltraSSD_LRS
storage account type be supported on this Virtual Machine Scale Set? Defaults tofalse
. Changing this forces a new resource to be created.
- ultra
Ssd BooleanEnabled - Should the capacity to enable Data Disks of the
UltraSSD_LRS
storage account type be supported on this Virtual Machine Scale Set? Defaults tofalse
. Changing this forces a new resource to be created.
- ultra
Ssd booleanEnabled - Should the capacity to enable Data Disks of the
UltraSSD_LRS
storage account type be supported on this Virtual Machine Scale Set? Defaults tofalse
. Changing this forces a new resource to be created.
- ultra_
ssd_ boolenabled - Should the capacity to enable Data Disks of the
UltraSSD_LRS
storage account type be supported on this Virtual Machine Scale Set? Defaults tofalse
. Changing this forces a new resource to be created.
- ultra
Ssd BooleanEnabled - Should the capacity to enable Data Disks of the
UltraSSD_LRS
storage account type be supported on this Virtual Machine Scale Set? Defaults tofalse
. Changing this forces a new resource to be created.
OrchestratedVirtualMachineScaleSetAutomaticInstanceRepair, OrchestratedVirtualMachineScaleSetAutomaticInstanceRepairArgs
- Enabled bool
- Should the automatic instance repair be enabled on this Virtual Machine Scale Set? Possible values are
true
andfalse
. - Action string
The repair action that will be used for repairing unhealthy virtual machines in the scale set. Possible values include
Replace
,Restart
,Reimage
.Note: Once the
action
field has been set it will always return the last value it was assigned if it is removed from the configuration file.Note: If you wish to update the repair
action
of an existingautomatic_instance_repair
policy, you must firstdisable
theautomatic_instance_repair
policy before you can re-enable theautomatic_instance_repair
policy with the new repairaction
defined.- Grace
Period string Amount of time for which automatic repairs will be delayed. The grace period starts right after the VM is found unhealthy. Possible values are between
10
and90
minutes. The time duration should be specified inISO 8601
format (e.g.PT10M
toPT90M
).Note: Once the
grace_period
field has been set it will always return the last value it was assigned if it is removed from the configuration file.
- Enabled bool
- Should the automatic instance repair be enabled on this Virtual Machine Scale Set? Possible values are
true
andfalse
. - Action string
The repair action that will be used for repairing unhealthy virtual machines in the scale set. Possible values include
Replace
,Restart
,Reimage
.Note: Once the
action
field has been set it will always return the last value it was assigned if it is removed from the configuration file.Note: If you wish to update the repair
action
of an existingautomatic_instance_repair
policy, you must firstdisable
theautomatic_instance_repair
policy before you can re-enable theautomatic_instance_repair
policy with the new repairaction
defined.- Grace
Period string Amount of time for which automatic repairs will be delayed. The grace period starts right after the VM is found unhealthy. Possible values are between
10
and90
minutes. The time duration should be specified inISO 8601
format (e.g.PT10M
toPT90M
).Note: Once the
grace_period
field has been set it will always return the last value it was assigned if it is removed from the configuration file.
- enabled Boolean
- Should the automatic instance repair be enabled on this Virtual Machine Scale Set? Possible values are
true
andfalse
. - action String
The repair action that will be used for repairing unhealthy virtual machines in the scale set. Possible values include
Replace
,Restart
,Reimage
.Note: Once the
action
field has been set it will always return the last value it was assigned if it is removed from the configuration file.Note: If you wish to update the repair
action
of an existingautomatic_instance_repair
policy, you must firstdisable
theautomatic_instance_repair
policy before you can re-enable theautomatic_instance_repair
policy with the new repairaction
defined.- grace
Period String Amount of time for which automatic repairs will be delayed. The grace period starts right after the VM is found unhealthy. Possible values are between
10
and90
minutes. The time duration should be specified inISO 8601
format (e.g.PT10M
toPT90M
).Note: Once the
grace_period
field has been set it will always return the last value it was assigned if it is removed from the configuration file.
- enabled boolean
- Should the automatic instance repair be enabled on this Virtual Machine Scale Set? Possible values are
true
andfalse
. - action string
The repair action that will be used for repairing unhealthy virtual machines in the scale set. Possible values include
Replace
,Restart
,Reimage
.Note: Once the
action
field has been set it will always return the last value it was assigned if it is removed from the configuration file.Note: If you wish to update the repair
action
of an existingautomatic_instance_repair
policy, you must firstdisable
theautomatic_instance_repair
policy before you can re-enable theautomatic_instance_repair
policy with the new repairaction
defined.- grace
Period string Amount of time for which automatic repairs will be delayed. The grace period starts right after the VM is found unhealthy. Possible values are between
10
and90
minutes. The time duration should be specified inISO 8601
format (e.g.PT10M
toPT90M
).Note: Once the
grace_period
field has been set it will always return the last value it was assigned if it is removed from the configuration file.
- enabled bool
- Should the automatic instance repair be enabled on this Virtual Machine Scale Set? Possible values are
true
andfalse
. - action str
The repair action that will be used for repairing unhealthy virtual machines in the scale set. Possible values include
Replace
,Restart
,Reimage
.Note: Once the
action
field has been set it will always return the last value it was assigned if it is removed from the configuration file.Note: If you wish to update the repair
action
of an existingautomatic_instance_repair
policy, you must firstdisable
theautomatic_instance_repair
policy before you can re-enable theautomatic_instance_repair
policy with the new repairaction
defined.- grace_
period str Amount of time for which automatic repairs will be delayed. The grace period starts right after the VM is found unhealthy. Possible values are between
10
and90
minutes. The time duration should be specified inISO 8601
format (e.g.PT10M
toPT90M
).Note: Once the
grace_period
field has been set it will always return the last value it was assigned if it is removed from the configuration file.
- enabled Boolean
- Should the automatic instance repair be enabled on this Virtual Machine Scale Set? Possible values are
true
andfalse
. - action String
The repair action that will be used for repairing unhealthy virtual machines in the scale set. Possible values include
Replace
,Restart
,Reimage
.Note: Once the
action
field has been set it will always return the last value it was assigned if it is removed from the configuration file.Note: If you wish to update the repair
action
of an existingautomatic_instance_repair
policy, you must firstdisable
theautomatic_instance_repair
policy before you can re-enable theautomatic_instance_repair
policy with the new repairaction
defined.- grace
Period String Amount of time for which automatic repairs will be delayed. The grace period starts right after the VM is found unhealthy. Possible values are between
10
and90
minutes. The time duration should be specified inISO 8601
format (e.g.PT10M
toPT90M
).Note: Once the
grace_period
field has been set it will always return the last value it was assigned if it is removed from the configuration file.
OrchestratedVirtualMachineScaleSetBootDiagnostics, OrchestratedVirtualMachineScaleSetBootDiagnosticsArgs
- Storage
Account stringUri - The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor. By including a
boot_diagnostics
block without passing thestorage_account_uri
field will cause the API to utilize a Managed Storage Account to store the Boot Diagnostics output.
- Storage
Account stringUri - The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor. By including a
boot_diagnostics
block without passing thestorage_account_uri
field will cause the API to utilize a Managed Storage Account to store the Boot Diagnostics output.
- storage
Account StringUri - The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor. By including a
boot_diagnostics
block without passing thestorage_account_uri
field will cause the API to utilize a Managed Storage Account to store the Boot Diagnostics output.
- storage
Account stringUri - The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor. By including a
boot_diagnostics
block without passing thestorage_account_uri
field will cause the API to utilize a Managed Storage Account to store the Boot Diagnostics output.
- storage_
account_ struri - The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor. By including a
boot_diagnostics
block without passing thestorage_account_uri
field will cause the API to utilize a Managed Storage Account to store the Boot Diagnostics output.
- storage
Account StringUri - The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor. By including a
boot_diagnostics
block without passing thestorage_account_uri
field will cause the API to utilize a Managed Storage Account to store the Boot Diagnostics output.
OrchestratedVirtualMachineScaleSetDataDisk, OrchestratedVirtualMachineScaleSetDataDiskArgs
- Caching string
- The type of Caching which should be used for this Data Disk. Possible values are None, ReadOnly and ReadWrite.
- Storage
Account stringType - The Type of Storage Account which should back this Data Disk. Possible values include
Standard_LRS
,StandardSSD_LRS
,StandardSSD_ZRS
,Premium_LRS
,PremiumV2_LRS
,Premium_ZRS
andUltraSSD_LRS
. - Create
Option string - The create option which should be used for this Data Disk. Possible values are Empty and FromImage. Defaults to
Empty
. (FromImage should only be used if the source image includes data disks). - Disk
Encryption stringSet Id - The ID of the Disk Encryption Set which should be used to encrypt the Data Disk. Changing this forces a new resource to be created.
- Disk
Size intGb - The size of the Data Disk which should be created. Required if
create_option
is specified asEmpty
. - Lun int
- The Logical Unit Number of the Data Disk, which must be unique within the Virtual Machine. Required if
create_option
is specified asEmpty
. - Ultra
Ssd intDisk Iops Read Write - Specifies the Read-Write IOPS for this Data Disk. Only settable when
storage_account_type
isPremiumV2_LRS
orUltraSSD_LRS
. - Ultra
Ssd intDisk Mbps Read Write - Specifies the bandwidth in MB per second for this Data Disk. Only settable when
storage_account_type
isPremiumV2_LRS
orUltraSSD_LRS
. - Write
Accelerator boolEnabled - Specifies if Write Accelerator is enabled on the Data Disk. Defaults to
false
.
- Caching string
- The type of Caching which should be used for this Data Disk. Possible values are None, ReadOnly and ReadWrite.
- Storage
Account stringType - The Type of Storage Account which should back this Data Disk. Possible values include
Standard_LRS
,StandardSSD_LRS
,StandardSSD_ZRS
,Premium_LRS
,PremiumV2_LRS
,Premium_ZRS
andUltraSSD_LRS
. - Create
Option string - The create option which should be used for this Data Disk. Possible values are Empty and FromImage. Defaults to
Empty
. (FromImage should only be used if the source image includes data disks). - Disk
Encryption stringSet Id - The ID of the Disk Encryption Set which should be used to encrypt the Data Disk. Changing this forces a new resource to be created.
- Disk
Size intGb - The size of the Data Disk which should be created. Required if
create_option
is specified asEmpty
. - Lun int
- The Logical Unit Number of the Data Disk, which must be unique within the Virtual Machine. Required if
create_option
is specified asEmpty
. - Ultra
Ssd intDisk Iops Read Write - Specifies the Read-Write IOPS for this Data Disk. Only settable when
storage_account_type
isPremiumV2_LRS
orUltraSSD_LRS
. - Ultra
Ssd intDisk Mbps Read Write - Specifies the bandwidth in MB per second for this Data Disk. Only settable when
storage_account_type
isPremiumV2_LRS
orUltraSSD_LRS
. - Write
Accelerator boolEnabled - Specifies if Write Accelerator is enabled on the Data Disk. Defaults to
false
.
- caching String
- The type of Caching which should be used for this Data Disk. Possible values are None, ReadOnly and ReadWrite.
- storage
Account StringType - The Type of Storage Account which should back this Data Disk. Possible values include
Standard_LRS
,StandardSSD_LRS
,StandardSSD_ZRS
,Premium_LRS
,PremiumV2_LRS
,Premium_ZRS
andUltraSSD_LRS
. - create
Option String - The create option which should be used for this Data Disk. Possible values are Empty and FromImage. Defaults to
Empty
. (FromImage should only be used if the source image includes data disks). - disk
Encryption StringSet Id - The ID of the Disk Encryption Set which should be used to encrypt the Data Disk. Changing this forces a new resource to be created.
- disk
Size IntegerGb - The size of the Data Disk which should be created. Required if
create_option
is specified asEmpty
. - lun Integer
- The Logical Unit Number of the Data Disk, which must be unique within the Virtual Machine. Required if
create_option
is specified asEmpty
. - ultra
Ssd IntegerDisk Iops Read Write - Specifies the Read-Write IOPS for this Data Disk. Only settable when
storage_account_type
isPremiumV2_LRS
orUltraSSD_LRS
. - ultra
Ssd IntegerDisk Mbps Read Write - Specifies the bandwidth in MB per second for this Data Disk. Only settable when
storage_account_type
isPremiumV2_LRS
orUltraSSD_LRS
. - write
Accelerator BooleanEnabled - Specifies if Write Accelerator is enabled on the Data Disk. Defaults to
false
.
- caching string
- The type of Caching which should be used for this Data Disk. Possible values are None, ReadOnly and ReadWrite.
- storage
Account stringType - The Type of Storage Account which should back this Data Disk. Possible values include
Standard_LRS
,StandardSSD_LRS
,StandardSSD_ZRS
,Premium_LRS
,PremiumV2_LRS
,Premium_ZRS
andUltraSSD_LRS
. - create
Option string - The create option which should be used for this Data Disk. Possible values are Empty and FromImage. Defaults to
Empty
. (FromImage should only be used if the source image includes data disks). - disk
Encryption stringSet Id - The ID of the Disk Encryption Set which should be used to encrypt the Data Disk. Changing this forces a new resource to be created.
- disk
Size numberGb - The size of the Data Disk which should be created. Required if
create_option
is specified asEmpty
. - lun number
- The Logical Unit Number of the Data Disk, which must be unique within the Virtual Machine. Required if
create_option
is specified asEmpty
. - ultra
Ssd numberDisk Iops Read Write - Specifies the Read-Write IOPS for this Data Disk. Only settable when
storage_account_type
isPremiumV2_LRS
orUltraSSD_LRS
. - ultra
Ssd numberDisk Mbps Read Write - Specifies the bandwidth in MB per second for this Data Disk. Only settable when
storage_account_type
isPremiumV2_LRS
orUltraSSD_LRS
. - write
Accelerator booleanEnabled - Specifies if Write Accelerator is enabled on the Data Disk. Defaults to
false
.
- caching str
- The type of Caching which should be used for this Data Disk. Possible values are None, ReadOnly and ReadWrite.
- storage_
account_ strtype - The Type of Storage Account which should back this Data Disk. Possible values include
Standard_LRS
,StandardSSD_LRS
,StandardSSD_ZRS
,Premium_LRS
,PremiumV2_LRS
,Premium_ZRS
andUltraSSD_LRS
. - create_
option str - The create option which should be used for this Data Disk. Possible values are Empty and FromImage. Defaults to
Empty
. (FromImage should only be used if the source image includes data disks). - disk_
encryption_ strset_ id - The ID of the Disk Encryption Set which should be used to encrypt the Data Disk. Changing this forces a new resource to be created.
- disk_
size_ intgb - The size of the Data Disk which should be created. Required if
create_option
is specified asEmpty
. - lun int
- The Logical Unit Number of the Data Disk, which must be unique within the Virtual Machine. Required if
create_option
is specified asEmpty
. - ultra_
ssd_ intdisk_ iops_ read_ write - Specifies the Read-Write IOPS for this Data Disk. Only settable when
storage_account_type
isPremiumV2_LRS
orUltraSSD_LRS
. - ultra_
ssd_ intdisk_ mbps_ read_ write - Specifies the bandwidth in MB per second for this Data Disk. Only settable when
storage_account_type
isPremiumV2_LRS
orUltraSSD_LRS
. - write_
accelerator_ boolenabled - Specifies if Write Accelerator is enabled on the Data Disk. Defaults to
false
.
- caching String
- The type of Caching which should be used for this Data Disk. Possible values are None, ReadOnly and ReadWrite.
- storage
Account StringType - The Type of Storage Account which should back this Data Disk. Possible values include
Standard_LRS
,StandardSSD_LRS
,StandardSSD_ZRS
,Premium_LRS
,PremiumV2_LRS
,Premium_ZRS
andUltraSSD_LRS
. - create
Option String - The create option which should be used for this Data Disk. Possible values are Empty and FromImage. Defaults to
Empty
. (FromImage should only be used if the source image includes data disks). - disk
Encryption StringSet Id - The ID of the Disk Encryption Set which should be used to encrypt the Data Disk. Changing this forces a new resource to be created.
- disk
Size NumberGb - The size of the Data Disk which should be created. Required if
create_option
is specified asEmpty
. - lun Number
- The Logical Unit Number of the Data Disk, which must be unique within the Virtual Machine. Required if
create_option
is specified asEmpty
. - ultra
Ssd NumberDisk Iops Read Write - Specifies the Read-Write IOPS for this Data Disk. Only settable when
storage_account_type
isPremiumV2_LRS
orUltraSSD_LRS
. - ultra
Ssd NumberDisk Mbps Read Write - Specifies the bandwidth in MB per second for this Data Disk. Only settable when
storage_account_type
isPremiumV2_LRS
orUltraSSD_LRS
. - write
Accelerator BooleanEnabled - Specifies if Write Accelerator is enabled on the Data Disk. Defaults to
false
.
OrchestratedVirtualMachineScaleSetExtension, OrchestratedVirtualMachineScaleSetExtensionArgs
- Name string
- The name for the Virtual Machine Scale Set Extension.
- Publisher string
- Specifies the Publisher of the Extension.
- Type string
- Specifies the Type of the Extension.
- Type
Handler stringVersion - Specifies the version of the extension to use, available versions can be found using the Azure CLI.
- Auto
Upgrade boolMinor Version Enabled - Should the latest version of the Extension be used at Deployment Time, if one is available? This won't auto-update the extension on existing installation. Defaults to
true
. - Extensions
To List<string>Provision After Vm Creations - An ordered list of Extension names which Virtual Machine Scale Set should provision after VM creation.
- Failure
Suppression boolEnabled Should failures from the extension be suppressed? Possible values are
true
orfalse
.Note: Operational failures such as not connecting to the VM will not be suppressed regardless of the
failure_suppression_enabled
value.- Force
Extension stringExecution On Change - A value which, when different to the previous value can be used to force-run the Extension even if the Extension Configuration hasn't changed.
- Protected
Settings string A JSON String which specifies Sensitive Settings (such as Passwords) for the Extension.
Note: Keys within the
protected_settings
block are notoriously case-sensitive, where the casing required (e.g.TitleCase
vssnakeCase
) depends on the Extension being used. Please refer to the documentation for the specific Virtual Machine Extension you're looking to use for more information.- Protected
Settings OrchestratedFrom Key Vault Virtual Machine Scale Set Extension Protected Settings From Key Vault A
protected_settings_from_key_vault
block as defined below.Note:
protected_settings_from_key_vault
cannot be used withprotected_settings
- Settings string
- A JSON String which specifies Settings for the Extension.
- Name string
- The name for the Virtual Machine Scale Set Extension.
- Publisher string
- Specifies the Publisher of the Extension.
- Type string
- Specifies the Type of the Extension.
- Type
Handler stringVersion - Specifies the version of the extension to use, available versions can be found using the Azure CLI.
- Auto
Upgrade boolMinor Version Enabled - Should the latest version of the Extension be used at Deployment Time, if one is available? This won't auto-update the extension on existing installation. Defaults to
true
. - Extensions
To []stringProvision After Vm Creations - An ordered list of Extension names which Virtual Machine Scale Set should provision after VM creation.
- Failure
Suppression boolEnabled Should failures from the extension be suppressed? Possible values are
true
orfalse
.Note: Operational failures such as not connecting to the VM will not be suppressed regardless of the
failure_suppression_enabled
value.- Force
Extension stringExecution On Change - A value which, when different to the previous value can be used to force-run the Extension even if the Extension Configuration hasn't changed.
- Protected
Settings string A JSON String which specifies Sensitive Settings (such as Passwords) for the Extension.
Note: Keys within the
protected_settings
block are notoriously case-sensitive, where the casing required (e.g.TitleCase
vssnakeCase
) depends on the Extension being used. Please refer to the documentation for the specific Virtual Machine Extension you're looking to use for more information.- Protected
Settings OrchestratedFrom Key Vault Virtual Machine Scale Set Extension Protected Settings From Key Vault A
protected_settings_from_key_vault
block as defined below.Note:
protected_settings_from_key_vault
cannot be used withprotected_settings
- Settings string
- A JSON String which specifies Settings for the Extension.
- name String
- The name for the Virtual Machine Scale Set Extension.
- publisher String
- Specifies the Publisher of the Extension.
- type String
- Specifies the Type of the Extension.
- type
Handler StringVersion - Specifies the version of the extension to use, available versions can be found using the Azure CLI.
- auto
Upgrade BooleanMinor Version Enabled - Should the latest version of the Extension be used at Deployment Time, if one is available? This won't auto-update the extension on existing installation. Defaults to
true
. - extensions
To List<String>Provision After Vm Creations - An ordered list of Extension names which Virtual Machine Scale Set should provision after VM creation.
- failure
Suppression BooleanEnabled Should failures from the extension be suppressed? Possible values are
true
orfalse
.Note: Operational failures such as not connecting to the VM will not be suppressed regardless of the
failure_suppression_enabled
value.- force
Extension StringExecution On Change - A value which, when different to the previous value can be used to force-run the Extension even if the Extension Configuration hasn't changed.
- protected
Settings String A JSON String which specifies Sensitive Settings (such as Passwords) for the Extension.
Note: Keys within the
protected_settings
block are notoriously case-sensitive, where the casing required (e.g.TitleCase
vssnakeCase
) depends on the Extension being used. Please refer to the documentation for the specific Virtual Machine Extension you're looking to use for more information.- protected
Settings OrchestratedFrom Key Vault Virtual Machine Scale Set Extension Protected Settings From Key Vault A
protected_settings_from_key_vault
block as defined below.Note:
protected_settings_from_key_vault
cannot be used withprotected_settings
- settings String
- A JSON String which specifies Settings for the Extension.
- name string
- The name for the Virtual Machine Scale Set Extension.
- publisher string
- Specifies the Publisher of the Extension.
- type string
- Specifies the Type of the Extension.
- type
Handler stringVersion - Specifies the version of the extension to use, available versions can be found using the Azure CLI.
- auto
Upgrade booleanMinor Version Enabled - Should the latest version of the Extension be used at Deployment Time, if one is available? This won't auto-update the extension on existing installation. Defaults to
true
. - extensions
To string[]Provision After Vm Creations - An ordered list of Extension names which Virtual Machine Scale Set should provision after VM creation.
- failure
Suppression booleanEnabled Should failures from the extension be suppressed? Possible values are
true
orfalse
.Note: Operational failures such as not connecting to the VM will not be suppressed regardless of the
failure_suppression_enabled
value.- force
Extension stringExecution On Change - A value which, when different to the previous value can be used to force-run the Extension even if the Extension Configuration hasn't changed.
- protected
Settings string A JSON String which specifies Sensitive Settings (such as Passwords) for the Extension.
Note: Keys within the
protected_settings
block are notoriously case-sensitive, where the casing required (e.g.TitleCase
vssnakeCase
) depends on the Extension being used. Please refer to the documentation for the specific Virtual Machine Extension you're looking to use for more information.- protected
Settings OrchestratedFrom Key Vault Virtual Machine Scale Set Extension Protected Settings From Key Vault A
protected_settings_from_key_vault
block as defined below.Note:
protected_settings_from_key_vault
cannot be used withprotected_settings
- settings string
- A JSON String which specifies Settings for the Extension.
- name str
- The name for the Virtual Machine Scale Set Extension.
- publisher str
- Specifies the Publisher of the Extension.
- type str
- Specifies the Type of the Extension.
- type_
handler_ strversion - Specifies the version of the extension to use, available versions can be found using the Azure CLI.
- auto_
upgrade_ boolminor_ version_ enabled - Should the latest version of the Extension be used at Deployment Time, if one is available? This won't auto-update the extension on existing installation. Defaults to
true
. - extensions_
to_ Sequence[str]provision_ after_ vm_ creations - An ordered list of Extension names which Virtual Machine Scale Set should provision after VM creation.
- failure_
suppression_ boolenabled Should failures from the extension be suppressed? Possible values are
true
orfalse
.Note: Operational failures such as not connecting to the VM will not be suppressed regardless of the
failure_suppression_enabled
value.- force_
extension_ strexecution_ on_ change - A value which, when different to the previous value can be used to force-run the Extension even if the Extension Configuration hasn't changed.
- protected_
settings str A JSON String which specifies Sensitive Settings (such as Passwords) for the Extension.
Note: Keys within the
protected_settings
block are notoriously case-sensitive, where the casing required (e.g.TitleCase
vssnakeCase
) depends on the Extension being used. Please refer to the documentation for the specific Virtual Machine Extension you're looking to use for more information.- protected_
settings_ Orchestratedfrom_ key_ vault Virtual Machine Scale Set Extension Protected Settings From Key Vault A
protected_settings_from_key_vault
block as defined below.Note:
protected_settings_from_key_vault
cannot be used withprotected_settings
- settings str
- A JSON String which specifies Settings for the Extension.
- name String
- The name for the Virtual Machine Scale Set Extension.
- publisher String
- Specifies the Publisher of the Extension.
- type String
- Specifies the Type of the Extension.
- type
Handler StringVersion - Specifies the version of the extension to use, available versions can be found using the Azure CLI.
- auto
Upgrade BooleanMinor Version Enabled - Should the latest version of the Extension be used at Deployment Time, if one is available? This won't auto-update the extension on existing installation. Defaults to
true
. - extensions
To List<String>Provision After Vm Creations - An ordered list of Extension names which Virtual Machine Scale Set should provision after VM creation.
- failure
Suppression BooleanEnabled Should failures from the extension be suppressed? Possible values are
true
orfalse
.Note: Operational failures such as not connecting to the VM will not be suppressed regardless of the
failure_suppression_enabled
value.- force
Extension StringExecution On Change - A value which, when different to the previous value can be used to force-run the Extension even if the Extension Configuration hasn't changed.
- protected
Settings String A JSON String which specifies Sensitive Settings (such as Passwords) for the Extension.
Note: Keys within the
protected_settings
block are notoriously case-sensitive, where the casing required (e.g.TitleCase
vssnakeCase
) depends on the Extension being used. Please refer to the documentation for the specific Virtual Machine Extension you're looking to use for more information.- protected
Settings Property MapFrom Key Vault A
protected_settings_from_key_vault
block as defined below.Note:
protected_settings_from_key_vault
cannot be used withprotected_settings
- settings String
- A JSON String which specifies Settings for the Extension.
OrchestratedVirtualMachineScaleSetExtensionProtectedSettingsFromKeyVault, OrchestratedVirtualMachineScaleSetExtensionProtectedSettingsFromKeyVaultArgs
- Secret
Url string - The URL to the Key Vault Secret which stores the protected settings.
- Source
Vault stringId - The ID of the source Key Vault.
- Secret
Url string - The URL to the Key Vault Secret which stores the protected settings.
- Source
Vault stringId - The ID of the source Key Vault.
- secret
Url String - The URL to the Key Vault Secret which stores the protected settings.
- source
Vault StringId - The ID of the source Key Vault.
- secret
Url string - The URL to the Key Vault Secret which stores the protected settings.
- source
Vault stringId - The ID of the source Key Vault.
- secret_
url str - The URL to the Key Vault Secret which stores the protected settings.
- source_
vault_ strid - The ID of the source Key Vault.
- secret
Url String - The URL to the Key Vault Secret which stores the protected settings.
- source
Vault StringId - The ID of the source Key Vault.
OrchestratedVirtualMachineScaleSetIdentity, OrchestratedVirtualMachineScaleSetIdentityArgs
- Identity
Ids List<string> - Specifies a list of User Managed Identity IDs to be assigned to this Windows Virtual Machine Scale Set.
- Type string
- The type of Managed Identity that should be configured on this Windows Virtual Machine Scale Set. Only possible value is
UserAssigned
.
- Identity
Ids []string - Specifies a list of User Managed Identity IDs to be assigned to this Windows Virtual Machine Scale Set.
- Type string
- The type of Managed Identity that should be configured on this Windows Virtual Machine Scale Set. Only possible value is
UserAssigned
.
- identity
Ids List<String> - Specifies a list of User Managed Identity IDs to be assigned to this Windows Virtual Machine Scale Set.
- type String
- The type of Managed Identity that should be configured on this Windows Virtual Machine Scale Set. Only possible value is
UserAssigned
.
- identity
Ids string[] - Specifies a list of User Managed Identity IDs to be assigned to this Windows Virtual Machine Scale Set.
- type string
- The type of Managed Identity that should be configured on this Windows Virtual Machine Scale Set. Only possible value is
UserAssigned
.
- identity_
ids Sequence[str] - Specifies a list of User Managed Identity IDs to be assigned to this Windows Virtual Machine Scale Set.
- type str
- The type of Managed Identity that should be configured on this Windows Virtual Machine Scale Set. Only possible value is
UserAssigned
.
- identity
Ids List<String> - Specifies a list of User Managed Identity IDs to be assigned to this Windows Virtual Machine Scale Set.
- type String
- The type of Managed Identity that should be configured on this Windows Virtual Machine Scale Set. Only possible value is
UserAssigned
.
OrchestratedVirtualMachineScaleSetNetworkInterface, OrchestratedVirtualMachineScaleSetNetworkInterfaceArgs
- Ip
Configurations List<OrchestratedVirtual Machine Scale Set Network Interface Ip Configuration> - One or more
ip_configuration
blocks as defined above. - Name string
- The Name which should be used for this Network Interface. Changing this forces a new resource to be created.
- Dns
Servers List<string> - A list of IP Addresses of DNS Servers which should be assigned to the Network Interface.
- Enable
Accelerated boolNetworking - Does this Network Interface support Accelerated Networking? Possible values are
true
andfalse
. Defaults tofalse
. - Enable
Ip boolForwarding - Does this Network Interface support IP Forwarding? Possible values are
true
andfalse
. Defaults tofalse
. - Network
Security stringGroup Id - The ID of a Network Security Group which should be assigned to this Network Interface.
- Primary bool
Is this the Primary IP Configuration? Possible values are
true
andfalse
. Defaults tofalse
.Note: If multiple
network_interface
blocks are specified, one must be set toprimary
.
- Ip
Configurations []OrchestratedVirtual Machine Scale Set Network Interface Ip Configuration - One or more
ip_configuration
blocks as defined above. - Name string
- The Name which should be used for this Network Interface. Changing this forces a new resource to be created.
- Dns
Servers []string - A list of IP Addresses of DNS Servers which should be assigned to the Network Interface.
- Enable
Accelerated boolNetworking - Does this Network Interface support Accelerated Networking? Possible values are
true
andfalse
. Defaults tofalse
. - Enable
Ip boolForwarding - Does this Network Interface support IP Forwarding? Possible values are
true
andfalse
. Defaults tofalse
. - Network
Security stringGroup Id - The ID of a Network Security Group which should be assigned to this Network Interface.
- Primary bool
Is this the Primary IP Configuration? Possible values are
true
andfalse
. Defaults tofalse
.Note: If multiple
network_interface
blocks are specified, one must be set toprimary
.
- ip
Configurations List<OrchestratedVirtual Machine Scale Set Network Interface Ip Configuration> - One or more
ip_configuration
blocks as defined above. - name String
- The Name which should be used for this Network Interface. Changing this forces a new resource to be created.
- dns
Servers List<String> - A list of IP Addresses of DNS Servers which should be assigned to the Network Interface.
- enable
Accelerated BooleanNetworking - Does this Network Interface support Accelerated Networking? Possible values are
true
andfalse
. Defaults tofalse
. - enable
Ip BooleanForwarding - Does this Network Interface support IP Forwarding? Possible values are
true
andfalse
. Defaults tofalse
. - network
Security StringGroup Id - The ID of a Network Security Group which should be assigned to this Network Interface.
- primary Boolean
Is this the Primary IP Configuration? Possible values are
true
andfalse
. Defaults tofalse
.Note: If multiple
network_interface
blocks are specified, one must be set toprimary
.
- ip
Configurations OrchestratedVirtual Machine Scale Set Network Interface Ip Configuration[] - One or more
ip_configuration
blocks as defined above. - name string
- The Name which should be used for this Network Interface. Changing this forces a new resource to be created.
- dns
Servers string[] - A list of IP Addresses of DNS Servers which should be assigned to the Network Interface.
- enable
Accelerated booleanNetworking - Does this Network Interface support Accelerated Networking? Possible values are
true
andfalse
. Defaults tofalse
. - enable
Ip booleanForwarding - Does this Network Interface support IP Forwarding? Possible values are
true
andfalse
. Defaults tofalse
. - network
Security stringGroup Id - The ID of a Network Security Group which should be assigned to this Network Interface.
- primary boolean
Is this the Primary IP Configuration? Possible values are
true
andfalse
. Defaults tofalse
.Note: If multiple
network_interface
blocks are specified, one must be set toprimary
.
- ip_
configurations Sequence[OrchestratedVirtual Machine Scale Set Network Interface Ip Configuration] - One or more
ip_configuration
blocks as defined above. - name str
- The Name which should be used for this Network Interface. Changing this forces a new resource to be created.
- dns_
servers Sequence[str] - A list of IP Addresses of DNS Servers which should be assigned to the Network Interface.
- enable_
accelerated_ boolnetworking - Does this Network Interface support Accelerated Networking? Possible values are
true
andfalse
. Defaults tofalse
. - enable_
ip_ boolforwarding - Does this Network Interface support IP Forwarding? Possible values are
true
andfalse
. Defaults tofalse
. - network_
security_ strgroup_ id - The ID of a Network Security Group which should be assigned to this Network Interface.
- primary bool
Is this the Primary IP Configuration? Possible values are
true
andfalse
. Defaults tofalse
.Note: If multiple
network_interface
blocks are specified, one must be set toprimary
.
- ip
Configurations List<Property Map> - One or more
ip_configuration
blocks as defined above. - name String
- The Name which should be used for this Network Interface. Changing this forces a new resource to be created.
- dns
Servers List<String> - A list of IP Addresses of DNS Servers which should be assigned to the Network Interface.
- enable
Accelerated BooleanNetworking - Does this Network Interface support Accelerated Networking? Possible values are
true
andfalse
. Defaults tofalse
. - enable
Ip BooleanForwarding - Does this Network Interface support IP Forwarding? Possible values are
true
andfalse
. Defaults tofalse
. - network
Security StringGroup Id - The ID of a Network Security Group which should be assigned to this Network Interface.
- primary Boolean
Is this the Primary IP Configuration? Possible values are
true
andfalse
. Defaults tofalse
.Note: If multiple
network_interface
blocks are specified, one must be set toprimary
.
OrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfiguration, OrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationArgs
- Name string
- The Name which should be used for this IP Configuration.
- Application
Gateway List<string>Backend Address Pool Ids - A list of Backend Address Pools IDs from a Application Gateway which this Virtual Machine Scale Set should be connected to.
- Application
Security List<string>Group Ids - A list of Application Security Group IDs which this Virtual Machine Scale Set should be connected to.
- Load
Balancer List<string>Backend Address Pool Ids A list of Backend Address Pools IDs from a Load Balancer which this Virtual Machine Scale Set should be connected to.
Note: When using this field you'll also need to configure a Rule for the Load Balancer, and use a depends_on between this resource and the Load Balancer Rule.
- Primary bool
Is this the Primary IP Configuration for this Network Interface? Possible values are
true
andfalse
. Defaults tofalse
.Note: One
ip_configuration
block must be marked as Primary for each Network Interface.- Public
Ip List<OrchestratedAddresses Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address> - A
public_ip_address
block as defined below. - Subnet
Id string The ID of the Subnet which this IP Configuration should be connected to.
Note:
subnet_id
is required if version is set toIPv4
.- Version string
- The Internet Protocol Version which should be used for this IP Configuration. Possible values are
IPv4
andIPv6
. Defaults toIPv4
.
- Name string
- The Name which should be used for this IP Configuration.
- Application
Gateway []stringBackend Address Pool Ids - A list of Backend Address Pools IDs from a Application Gateway which this Virtual Machine Scale Set should be connected to.
- Application
Security []stringGroup Ids - A list of Application Security Group IDs which this Virtual Machine Scale Set should be connected to.
- Load
Balancer []stringBackend Address Pool Ids A list of Backend Address Pools IDs from a Load Balancer which this Virtual Machine Scale Set should be connected to.
Note: When using this field you'll also need to configure a Rule for the Load Balancer, and use a depends_on between this resource and the Load Balancer Rule.
- Primary bool
Is this the Primary IP Configuration for this Network Interface? Possible values are
true
andfalse
. Defaults tofalse
.Note: One
ip_configuration
block must be marked as Primary for each Network Interface.- Public
Ip []OrchestratedAddresses Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address - A
public_ip_address
block as defined below. - Subnet
Id string The ID of the Subnet which this IP Configuration should be connected to.
Note:
subnet_id
is required if version is set toIPv4
.- Version string
- The Internet Protocol Version which should be used for this IP Configuration. Possible values are
IPv4
andIPv6
. Defaults toIPv4
.
- name String
- The Name which should be used for this IP Configuration.
- application
Gateway List<String>Backend Address Pool Ids - A list of Backend Address Pools IDs from a Application Gateway which this Virtual Machine Scale Set should be connected to.
- application
Security List<String>Group Ids - A list of Application Security Group IDs which this Virtual Machine Scale Set should be connected to.
- load
Balancer List<String>Backend Address Pool Ids A list of Backend Address Pools IDs from a Load Balancer which this Virtual Machine Scale Set should be connected to.
Note: When using this field you'll also need to configure a Rule for the Load Balancer, and use a depends_on between this resource and the Load Balancer Rule.
- primary Boolean
Is this the Primary IP Configuration for this Network Interface? Possible values are
true
andfalse
. Defaults tofalse
.Note: One
ip_configuration
block must be marked as Primary for each Network Interface.- public
Ip List<OrchestratedAddresses Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address> - A
public_ip_address
block as defined below. - subnet
Id String The ID of the Subnet which this IP Configuration should be connected to.
Note:
subnet_id
is required if version is set toIPv4
.- version String
- The Internet Protocol Version which should be used for this IP Configuration. Possible values are
IPv4
andIPv6
. Defaults toIPv4
.
- name string
- The Name which should be used for this IP Configuration.
- application
Gateway string[]Backend Address Pool Ids - A list of Backend Address Pools IDs from a Application Gateway which this Virtual Machine Scale Set should be connected to.
- application
Security string[]Group Ids - A list of Application Security Group IDs which this Virtual Machine Scale Set should be connected to.
- load
Balancer string[]Backend Address Pool Ids A list of Backend Address Pools IDs from a Load Balancer which this Virtual Machine Scale Set should be connected to.
Note: When using this field you'll also need to configure a Rule for the Load Balancer, and use a depends_on between this resource and the Load Balancer Rule.
- primary boolean
Is this the Primary IP Configuration for this Network Interface? Possible values are
true
andfalse
. Defaults tofalse
.Note: One
ip_configuration
block must be marked as Primary for each Network Interface.- public
Ip OrchestratedAddresses Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address[] - A
public_ip_address
block as defined below. - subnet
Id string The ID of the Subnet which this IP Configuration should be connected to.
Note:
subnet_id
is required if version is set toIPv4
.- version string
- The Internet Protocol Version which should be used for this IP Configuration. Possible values are
IPv4
andIPv6
. Defaults toIPv4
.
- name str
- The Name which should be used for this IP Configuration.
- application_
gateway_ Sequence[str]backend_ address_ pool_ ids - A list of Backend Address Pools IDs from a Application Gateway which this Virtual Machine Scale Set should be connected to.
- application_
security_ Sequence[str]group_ ids - A list of Application Security Group IDs which this Virtual Machine Scale Set should be connected to.
- load_
balancer_ Sequence[str]backend_ address_ pool_ ids A list of Backend Address Pools IDs from a Load Balancer which this Virtual Machine Scale Set should be connected to.
Note: When using this field you'll also need to configure a Rule for the Load Balancer, and use a depends_on between this resource and the Load Balancer Rule.
- primary bool
Is this the Primary IP Configuration for this Network Interface? Possible values are
true
andfalse
. Defaults tofalse
.Note: One
ip_configuration
block must be marked as Primary for each Network Interface.- public_
ip_ Sequence[Orchestratedaddresses Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address] - A
public_ip_address
block as defined below. - subnet_
id str The ID of the Subnet which this IP Configuration should be connected to.
Note:
subnet_id
is required if version is set toIPv4
.- version str
- The Internet Protocol Version which should be used for this IP Configuration. Possible values are
IPv4
andIPv6
. Defaults toIPv4
.
- name String
- The Name which should be used for this IP Configuration.
- application
Gateway List<String>Backend Address Pool Ids - A list of Backend Address Pools IDs from a Application Gateway which this Virtual Machine Scale Set should be connected to.
- application
Security List<String>Group Ids - A list of Application Security Group IDs which this Virtual Machine Scale Set should be connected to.
- load
Balancer List<String>Backend Address Pool Ids A list of Backend Address Pools IDs from a Load Balancer which this Virtual Machine Scale Set should be connected to.
Note: When using this field you'll also need to configure a Rule for the Load Balancer, and use a depends_on between this resource and the Load Balancer Rule.
- primary Boolean
Is this the Primary IP Configuration for this Network Interface? Possible values are
true
andfalse
. Defaults tofalse
.Note: One
ip_configuration
block must be marked as Primary for each Network Interface.- public
Ip List<Property Map>Addresses - A
public_ip_address
block as defined below. - subnet
Id String The ID of the Subnet which this IP Configuration should be connected to.
Note:
subnet_id
is required if version is set toIPv4
.- version String
- The Internet Protocol Version which should be used for this IP Configuration. Possible values are
IPv4
andIPv6
. Defaults toIPv4
.
OrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress, OrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressArgs
- Name string
- The Name of the Public IP Address Configuration.
- Domain
Name stringLabel - The Prefix which should be used for the Domain Name Label for each Virtual Machine Instance. Azure concatenates the Domain Name Label and Virtual Machine Index to create a unique Domain Name Label for each Virtual Machine. Valid values must be between
1
and26
characters long, start with a lower case letter, end with a lower case letter or number and contains onlya-z
,0-9
andhyphens
. - Idle
Timeout intIn Minutes - The Idle Timeout in Minutes for the Public IP Address. Possible values are in the range
4
to32
. - List<Orchestrated
Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address Ip Tag> - One or more
ip_tag
blocks as defined above. Changing this forces a new resource to be created. - Public
Ip stringPrefix Id - The ID of the Public IP Address Prefix from where Public IP Addresses should be allocated. Changing this forces a new resource to be created.
- Sku
Name string - Specifies what Public IP Address SKU the Public IP Address should be provisioned as. Possible vaules include
Basic_Regional
,Basic_Global
,Standard_Regional
orStandard_Global
. For more information about Public IP Address SKU's and their capabilities, please see the product documentation. Changing this forces a new resource to be created. - Version string
- The Internet Protocol Version which should be used for this public IP address. Possible values are
IPv4
andIPv6
. Defaults toIPv4
. Changing this forces a new resource to be created.
- Name string
- The Name of the Public IP Address Configuration.
- Domain
Name stringLabel - The Prefix which should be used for the Domain Name Label for each Virtual Machine Instance. Azure concatenates the Domain Name Label and Virtual Machine Index to create a unique Domain Name Label for each Virtual Machine. Valid values must be between
1
and26
characters long, start with a lower case letter, end with a lower case letter or number and contains onlya-z
,0-9
andhyphens
. - Idle
Timeout intIn Minutes - The Idle Timeout in Minutes for the Public IP Address. Possible values are in the range
4
to32
. - []Orchestrated
Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address Ip Tag - One or more
ip_tag
blocks as defined above. Changing this forces a new resource to be created. - Public
Ip stringPrefix Id - The ID of the Public IP Address Prefix from where Public IP Addresses should be allocated. Changing this forces a new resource to be created.
- Sku
Name string - Specifies what Public IP Address SKU the Public IP Address should be provisioned as. Possible vaules include
Basic_Regional
,Basic_Global
,Standard_Regional
orStandard_Global
. For more information about Public IP Address SKU's and their capabilities, please see the product documentation. Changing this forces a new resource to be created. - Version string
- The Internet Protocol Version which should be used for this public IP address. Possible values are
IPv4
andIPv6
. Defaults toIPv4
. Changing this forces a new resource to be created.
- name String
- The Name of the Public IP Address Configuration.
- domain
Name StringLabel - The Prefix which should be used for the Domain Name Label for each Virtual Machine Instance. Azure concatenates the Domain Name Label and Virtual Machine Index to create a unique Domain Name Label for each Virtual Machine. Valid values must be between
1
and26
characters long, start with a lower case letter, end with a lower case letter or number and contains onlya-z
,0-9
andhyphens
. - idle
Timeout IntegerIn Minutes - The Idle Timeout in Minutes for the Public IP Address. Possible values are in the range
4
to32
. - List<Orchestrated
Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address Ip Tag> - One or more
ip_tag
blocks as defined above. Changing this forces a new resource to be created. - public
Ip StringPrefix Id - The ID of the Public IP Address Prefix from where Public IP Addresses should be allocated. Changing this forces a new resource to be created.
- sku
Name String - Specifies what Public IP Address SKU the Public IP Address should be provisioned as. Possible vaules include
Basic_Regional
,Basic_Global
,Standard_Regional
orStandard_Global
. For more information about Public IP Address SKU's and their capabilities, please see the product documentation. Changing this forces a new resource to be created. - version String
- The Internet Protocol Version which should be used for this public IP address. Possible values are
IPv4
andIPv6
. Defaults toIPv4
. Changing this forces a new resource to be created.
- name string
- The Name of the Public IP Address Configuration.
- domain
Name stringLabel - The Prefix which should be used for the Domain Name Label for each Virtual Machine Instance. Azure concatenates the Domain Name Label and Virtual Machine Index to create a unique Domain Name Label for each Virtual Machine. Valid values must be between
1
and26
characters long, start with a lower case letter, end with a lower case letter or number and contains onlya-z
,0-9
andhyphens
. - idle
Timeout numberIn Minutes - The Idle Timeout in Minutes for the Public IP Address. Possible values are in the range
4
to32
. - Orchestrated
Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address Ip Tag[] - One or more
ip_tag
blocks as defined above. Changing this forces a new resource to be created. - public
Ip stringPrefix Id - The ID of the Public IP Address Prefix from where Public IP Addresses should be allocated. Changing this forces a new resource to be created.
- sku
Name string - Specifies what Public IP Address SKU the Public IP Address should be provisioned as. Possible vaules include
Basic_Regional
,Basic_Global
,Standard_Regional
orStandard_Global
. For more information about Public IP Address SKU's and their capabilities, please see the product documentation. Changing this forces a new resource to be created. - version string
- The Internet Protocol Version which should be used for this public IP address. Possible values are
IPv4
andIPv6
. Defaults toIPv4
. Changing this forces a new resource to be created.
- name str
- The Name of the Public IP Address Configuration.
- domain_
name_ strlabel - The Prefix which should be used for the Domain Name Label for each Virtual Machine Instance. Azure concatenates the Domain Name Label and Virtual Machine Index to create a unique Domain Name Label for each Virtual Machine. Valid values must be between
1
and26
characters long, start with a lower case letter, end with a lower case letter or number and contains onlya-z
,0-9
andhyphens
. - idle_
timeout_ intin_ minutes - The Idle Timeout in Minutes for the Public IP Address. Possible values are in the range
4
to32
. - Sequence[Orchestrated
Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address Ip Tag] - One or more
ip_tag
blocks as defined above. Changing this forces a new resource to be created. - public_
ip_ strprefix_ id - The ID of the Public IP Address Prefix from where Public IP Addresses should be allocated. Changing this forces a new resource to be created.
- sku_
name str - Specifies what Public IP Address SKU the Public IP Address should be provisioned as. Possible vaules include
Basic_Regional
,Basic_Global
,Standard_Regional
orStandard_Global
. For more information about Public IP Address SKU's and their capabilities, please see the product documentation. Changing this forces a new resource to be created. - version str
- The Internet Protocol Version which should be used for this public IP address. Possible values are
IPv4
andIPv6
. Defaults toIPv4
. Changing this forces a new resource to be created.
- name String
- The Name of the Public IP Address Configuration.
- domain
Name StringLabel - The Prefix which should be used for the Domain Name Label for each Virtual Machine Instance. Azure concatenates the Domain Name Label and Virtual Machine Index to create a unique Domain Name Label for each Virtual Machine. Valid values must be between
1
and26
characters long, start with a lower case letter, end with a lower case letter or number and contains onlya-z
,0-9
andhyphens
. - idle
Timeout NumberIn Minutes - The Idle Timeout in Minutes for the Public IP Address. Possible values are in the range
4
to32
. - List<Property Map>
- One or more
ip_tag
blocks as defined above. Changing this forces a new resource to be created. - public
Ip StringPrefix Id - The ID of the Public IP Address Prefix from where Public IP Addresses should be allocated. Changing this forces a new resource to be created.
- sku
Name String - Specifies what Public IP Address SKU the Public IP Address should be provisioned as. Possible vaules include
Basic_Regional
,Basic_Global
,Standard_Regional
orStandard_Global
. For more information about Public IP Address SKU's and their capabilities, please see the product documentation. Changing this forces a new resource to be created. - version String
- The Internet Protocol Version which should be used for this public IP address. Possible values are
IPv4
andIPv6
. Defaults toIPv4
. Changing this forces a new resource to be created.
OrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTag, OrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTagArgs
OrchestratedVirtualMachineScaleSetOsDisk, OrchestratedVirtualMachineScaleSetOsDiskArgs
- Caching string
- The Type of Caching which should be used for the Internal OS Disk. Possible values are
None
,ReadOnly
andReadWrite
. - Storage
Account stringType - The Type of Storage Account which should back this the Internal OS Disk. Possible values include
Standard_LRS
,StandardSSD_LRS
,StandardSSD_ZRS
,Premium_LRS
andPremium_ZRS
. Changing this forces a new resource to be created. - Diff
Disk OrchestratedSettings Virtual Machine Scale Set Os Disk Diff Disk Settings - A
diff_disk_settings
block as defined above. Changing this forces a new resource to be created. - Disk
Encryption stringSet Id The ID of the Disk Encryption Set which should be used to encrypt this OS Disk. Changing this forces a new resource to be created.
Note: Disk Encryption Sets are in Public Preview in a limited set of regions
- Disk
Size intGb - The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine Scale Set is sourced from.
- Write
Accelerator boolEnabled - Specifies if Write Accelerator is enabled on the OS Disk. Defaults to
false
.
- Caching string
- The Type of Caching which should be used for the Internal OS Disk. Possible values are
None
,ReadOnly
andReadWrite
. - Storage
Account stringType - The Type of Storage Account which should back this the Internal OS Disk. Possible values include
Standard_LRS
,StandardSSD_LRS
,StandardSSD_ZRS
,Premium_LRS
andPremium_ZRS
. Changing this forces a new resource to be created. - Diff
Disk OrchestratedSettings Virtual Machine Scale Set Os Disk Diff Disk Settings - A
diff_disk_settings
block as defined above. Changing this forces a new resource to be created. - Disk
Encryption stringSet Id The ID of the Disk Encryption Set which should be used to encrypt this OS Disk. Changing this forces a new resource to be created.
Note: Disk Encryption Sets are in Public Preview in a limited set of regions
- Disk
Size intGb - The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine Scale Set is sourced from.
- Write
Accelerator boolEnabled - Specifies if Write Accelerator is enabled on the OS Disk. Defaults to
false
.
- caching String
- The Type of Caching which should be used for the Internal OS Disk. Possible values are
None
,ReadOnly
andReadWrite
. - storage
Account StringType - The Type of Storage Account which should back this the Internal OS Disk. Possible values include
Standard_LRS
,StandardSSD_LRS
,StandardSSD_ZRS
,Premium_LRS
andPremium_ZRS
. Changing this forces a new resource to be created. - diff
Disk OrchestratedSettings Virtual Machine Scale Set Os Disk Diff Disk Settings - A
diff_disk_settings
block as defined above. Changing this forces a new resource to be created. - disk
Encryption StringSet Id The ID of the Disk Encryption Set which should be used to encrypt this OS Disk. Changing this forces a new resource to be created.
Note: Disk Encryption Sets are in Public Preview in a limited set of regions
- disk
Size IntegerGb - The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine Scale Set is sourced from.
- write
Accelerator BooleanEnabled - Specifies if Write Accelerator is enabled on the OS Disk. Defaults to
false
.
- caching string
- The Type of Caching which should be used for the Internal OS Disk. Possible values are
None
,ReadOnly
andReadWrite
. - storage
Account stringType - The Type of Storage Account which should back this the Internal OS Disk. Possible values include
Standard_LRS
,StandardSSD_LRS
,StandardSSD_ZRS
,Premium_LRS
andPremium_ZRS
. Changing this forces a new resource to be created. - diff
Disk OrchestratedSettings Virtual Machine Scale Set Os Disk Diff Disk Settings - A
diff_disk_settings
block as defined above. Changing this forces a new resource to be created. - disk
Encryption stringSet Id The ID of the Disk Encryption Set which should be used to encrypt this OS Disk. Changing this forces a new resource to be created.
Note: Disk Encryption Sets are in Public Preview in a limited set of regions
- disk
Size numberGb - The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine Scale Set is sourced from.
- write
Accelerator booleanEnabled - Specifies if Write Accelerator is enabled on the OS Disk. Defaults to
false
.
- caching str
- The Type of Caching which should be used for the Internal OS Disk. Possible values are
None
,ReadOnly
andReadWrite
. - storage_
account_ strtype - The Type of Storage Account which should back this the Internal OS Disk. Possible values include
Standard_LRS
,StandardSSD_LRS
,StandardSSD_ZRS
,Premium_LRS
andPremium_ZRS
. Changing this forces a new resource to be created. - diff_
disk_ Orchestratedsettings Virtual Machine Scale Set Os Disk Diff Disk Settings - A
diff_disk_settings
block as defined above. Changing this forces a new resource to be created. - disk_
encryption_ strset_ id The ID of the Disk Encryption Set which should be used to encrypt this OS Disk. Changing this forces a new resource to be created.
Note: Disk Encryption Sets are in Public Preview in a limited set of regions
- disk_
size_ intgb - The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine Scale Set is sourced from.
- write_
accelerator_ boolenabled - Specifies if Write Accelerator is enabled on the OS Disk. Defaults to
false
.
- caching String
- The Type of Caching which should be used for the Internal OS Disk. Possible values are
None
,ReadOnly
andReadWrite
. - storage
Account StringType - The Type of Storage Account which should back this the Internal OS Disk. Possible values include
Standard_LRS
,StandardSSD_LRS
,StandardSSD_ZRS
,Premium_LRS
andPremium_ZRS
. Changing this forces a new resource to be created. - diff
Disk Property MapSettings - A
diff_disk_settings
block as defined above. Changing this forces a new resource to be created. - disk
Encryption StringSet Id The ID of the Disk Encryption Set which should be used to encrypt this OS Disk. Changing this forces a new resource to be created.
Note: Disk Encryption Sets are in Public Preview in a limited set of regions
- disk
Size NumberGb - The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine Scale Set is sourced from.
- write
Accelerator BooleanEnabled - Specifies if Write Accelerator is enabled on the OS Disk. Defaults to
false
.
OrchestratedVirtualMachineScaleSetOsDiskDiffDiskSettings, OrchestratedVirtualMachineScaleSetOsDiskDiffDiskSettingsArgs
- Option string
- Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is
Local
. Changing this forces a new resource to be created. - Placement string
- Specifies where to store the Ephemeral Disk. Possible values are
CacheDisk
andResourceDisk
. Defaults toCacheDisk
. Changing this forces a new resource to be created.
- Option string
- Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is
Local
. Changing this forces a new resource to be created. - Placement string
- Specifies where to store the Ephemeral Disk. Possible values are
CacheDisk
andResourceDisk
. Defaults toCacheDisk
. Changing this forces a new resource to be created.
- option String
- Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is
Local
. Changing this forces a new resource to be created. - placement String
- Specifies where to store the Ephemeral Disk. Possible values are
CacheDisk
andResourceDisk
. Defaults toCacheDisk
. Changing this forces a new resource to be created.
- option string
- Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is
Local
. Changing this forces a new resource to be created. - placement string
- Specifies where to store the Ephemeral Disk. Possible values are
CacheDisk
andResourceDisk
. Defaults toCacheDisk
. Changing this forces a new resource to be created.
- option str
- Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is
Local
. Changing this forces a new resource to be created. - placement str
- Specifies where to store the Ephemeral Disk. Possible values are
CacheDisk
andResourceDisk
. Defaults toCacheDisk
. Changing this forces a new resource to be created.
- option String
- Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is
Local
. Changing this forces a new resource to be created. - placement String
- Specifies where to store the Ephemeral Disk. Possible values are
CacheDisk
andResourceDisk
. Defaults toCacheDisk
. Changing this forces a new resource to be created.
OrchestratedVirtualMachineScaleSetOsProfile, OrchestratedVirtualMachineScaleSetOsProfileArgs
- Custom
Data string The Base64-Encoded Custom Data which should be used for this Virtual Machine Scale Set.
Note: When Custom Data has been configured, it's not possible to remove it without tainting the Virtual Machine Scale Set, due to a limitation of the Azure API.
- Linux
Configuration OrchestratedVirtual Machine Scale Set Os Profile Linux Configuration - A
linux_configuration
block as documented below. - Windows
Configuration OrchestratedVirtual Machine Scale Set Os Profile Windows Configuration - A
windows_configuration
block as documented below.
- Custom
Data string The Base64-Encoded Custom Data which should be used for this Virtual Machine Scale Set.
Note: When Custom Data has been configured, it's not possible to remove it without tainting the Virtual Machine Scale Set, due to a limitation of the Azure API.
- Linux
Configuration OrchestratedVirtual Machine Scale Set Os Profile Linux Configuration - A
linux_configuration
block as documented below. - Windows
Configuration OrchestratedVirtual Machine Scale Set Os Profile Windows Configuration - A
windows_configuration
block as documented below.
- custom
Data String The Base64-Encoded Custom Data which should be used for this Virtual Machine Scale Set.
Note: When Custom Data has been configured, it's not possible to remove it without tainting the Virtual Machine Scale Set, due to a limitation of the Azure API.
- linux
Configuration OrchestratedVirtual Machine Scale Set Os Profile Linux Configuration - A
linux_configuration
block as documented below. - windows
Configuration OrchestratedVirtual Machine Scale Set Os Profile Windows Configuration - A
windows_configuration
block as documented below.
- custom
Data string The Base64-Encoded Custom Data which should be used for this Virtual Machine Scale Set.
Note: When Custom Data has been configured, it's not possible to remove it without tainting the Virtual Machine Scale Set, due to a limitation of the Azure API.
- linux
Configuration OrchestratedVirtual Machine Scale Set Os Profile Linux Configuration - A
linux_configuration
block as documented below. - windows
Configuration OrchestratedVirtual Machine Scale Set Os Profile Windows Configuration - A
windows_configuration
block as documented below.
- custom_
data str The Base64-Encoded Custom Data which should be used for this Virtual Machine Scale Set.
Note: When Custom Data has been configured, it's not possible to remove it without tainting the Virtual Machine Scale Set, due to a limitation of the Azure API.
- linux_
configuration OrchestratedVirtual Machine Scale Set Os Profile Linux Configuration - A
linux_configuration
block as documented below. - windows_
configuration OrchestratedVirtual Machine Scale Set Os Profile Windows Configuration - A
windows_configuration
block as documented below.
- custom
Data String The Base64-Encoded Custom Data which should be used for this Virtual Machine Scale Set.
Note: When Custom Data has been configured, it's not possible to remove it without tainting the Virtual Machine Scale Set, due to a limitation of the Azure API.
- linux
Configuration Property Map - A
linux_configuration
block as documented below. - windows
Configuration Property Map - A
windows_configuration
block as documented below.
OrchestratedVirtualMachineScaleSetOsProfileLinuxConfiguration, OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationArgs
- Admin
Username string - The username of the local administrator on each Virtual Machine Scale Set instance. Changing this forces a new resource to be created.
- Admin
Password string - The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
- Admin
Ssh List<OrchestratedKeys Virtual Machine Scale Set Os Profile Linux Configuration Admin Ssh Key> - A
admin_ssh_key
block as documented below. - Computer
Name stringPrefix - The prefix which should be used for the name of the Virtual Machines in this Scale Set. If unspecified this defaults to the value for the name field. If the value of the name field is not a valid
computer_name_prefix
, then you must specifycomputer_name_prefix
. Changing this forces a new resource to be created. - Disable
Password boolAuthentication When an
admin_password
is specifieddisable_password_authentication
must be set tofalse
. Defaults totrue
.Note: Either
admin_password
oradmin_ssh_key
must be specified.- Patch
Assessment stringMode Specifies the mode of VM Guest Patching for the virtual machines that are associated to the Virtual Machine Scale Set. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.Note: If the
patch_assessment_mode
is set toAutomaticByPlatform
then theprovision_vm_agent
field must be set totrue
.- Patch
Mode string Specifies the mode of in-guest patching of this Windows Virtual Machine. Possible values are
ImageDefault
orAutomaticByPlatform
. Defaults toImageDefault
. For more information on patch modes please see the product documentation.Note: If
patch_mode
is set toAutomaticByPlatform
theprovision_vm_agent
must be set totrue
and theextension
must contain at least one application health extension. An example of how to correctly configure a Virtual Machine Scale Set to provision a Linux Virtual Machine with Automatic VM Guest Patching enabled can be found in the./examples/orchestrated-vm-scale-set/automatic-vm-guest-patching
directory within the GitHub Repository.- Provision
Vm boolAgent - Should the Azure VM Agent be provisioned on each Virtual Machine in the Scale Set? Defaults to
true
. Changing this value forces a new resource to be created. - Secrets
List<Orchestrated
Virtual Machine Scale Set Os Profile Linux Configuration Secret> - One or more
secret
blocks as defined below.
- Admin
Username string - The username of the local administrator on each Virtual Machine Scale Set instance. Changing this forces a new resource to be created.
- Admin
Password string - The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
- Admin
Ssh []OrchestratedKeys Virtual Machine Scale Set Os Profile Linux Configuration Admin Ssh Key - A
admin_ssh_key
block as documented below. - Computer
Name stringPrefix - The prefix which should be used for the name of the Virtual Machines in this Scale Set. If unspecified this defaults to the value for the name field. If the value of the name field is not a valid
computer_name_prefix
, then you must specifycomputer_name_prefix
. Changing this forces a new resource to be created. - Disable
Password boolAuthentication When an
admin_password
is specifieddisable_password_authentication
must be set tofalse
. Defaults totrue
.Note: Either
admin_password
oradmin_ssh_key
must be specified.- Patch
Assessment stringMode Specifies the mode of VM Guest Patching for the virtual machines that are associated to the Virtual Machine Scale Set. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.Note: If the
patch_assessment_mode
is set toAutomaticByPlatform
then theprovision_vm_agent
field must be set totrue
.- Patch
Mode string Specifies the mode of in-guest patching of this Windows Virtual Machine. Possible values are
ImageDefault
orAutomaticByPlatform
. Defaults toImageDefault
. For more information on patch modes please see the product documentation.Note: If
patch_mode
is set toAutomaticByPlatform
theprovision_vm_agent
must be set totrue
and theextension
must contain at least one application health extension. An example of how to correctly configure a Virtual Machine Scale Set to provision a Linux Virtual Machine with Automatic VM Guest Patching enabled can be found in the./examples/orchestrated-vm-scale-set/automatic-vm-guest-patching
directory within the GitHub Repository.- Provision
Vm boolAgent - Should the Azure VM Agent be provisioned on each Virtual Machine in the Scale Set? Defaults to
true
. Changing this value forces a new resource to be created. - Secrets
[]Orchestrated
Virtual Machine Scale Set Os Profile Linux Configuration Secret - One or more
secret
blocks as defined below.
- admin
Username String - The username of the local administrator on each Virtual Machine Scale Set instance. Changing this forces a new resource to be created.
- admin
Password String - The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
- admin
Ssh List<OrchestratedKeys Virtual Machine Scale Set Os Profile Linux Configuration Admin Ssh Key> - A
admin_ssh_key
block as documented below. - computer
Name StringPrefix - The prefix which should be used for the name of the Virtual Machines in this Scale Set. If unspecified this defaults to the value for the name field. If the value of the name field is not a valid
computer_name_prefix
, then you must specifycomputer_name_prefix
. Changing this forces a new resource to be created. - disable
Password BooleanAuthentication When an
admin_password
is specifieddisable_password_authentication
must be set tofalse
. Defaults totrue
.Note: Either
admin_password
oradmin_ssh_key
must be specified.- patch
Assessment StringMode Specifies the mode of VM Guest Patching for the virtual machines that are associated to the Virtual Machine Scale Set. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.Note: If the
patch_assessment_mode
is set toAutomaticByPlatform
then theprovision_vm_agent
field must be set totrue
.- patch
Mode String Specifies the mode of in-guest patching of this Windows Virtual Machine. Possible values are
ImageDefault
orAutomaticByPlatform
. Defaults toImageDefault
. For more information on patch modes please see the product documentation.Note: If
patch_mode
is set toAutomaticByPlatform
theprovision_vm_agent
must be set totrue
and theextension
must contain at least one application health extension. An example of how to correctly configure a Virtual Machine Scale Set to provision a Linux Virtual Machine with Automatic VM Guest Patching enabled can be found in the./examples/orchestrated-vm-scale-set/automatic-vm-guest-patching
directory within the GitHub Repository.- provision
Vm BooleanAgent - Should the Azure VM Agent be provisioned on each Virtual Machine in the Scale Set? Defaults to
true
. Changing this value forces a new resource to be created. - secrets
List<Orchestrated
Virtual Machine Scale Set Os Profile Linux Configuration Secret> - One or more
secret
blocks as defined below.
- admin
Username string - The username of the local administrator on each Virtual Machine Scale Set instance. Changing this forces a new resource to be created.
- admin
Password string - The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
- admin
Ssh OrchestratedKeys Virtual Machine Scale Set Os Profile Linux Configuration Admin Ssh Key[] - A
admin_ssh_key
block as documented below. - computer
Name stringPrefix - The prefix which should be used for the name of the Virtual Machines in this Scale Set. If unspecified this defaults to the value for the name field. If the value of the name field is not a valid
computer_name_prefix
, then you must specifycomputer_name_prefix
. Changing this forces a new resource to be created. - disable
Password booleanAuthentication When an
admin_password
is specifieddisable_password_authentication
must be set tofalse
. Defaults totrue
.Note: Either
admin_password
oradmin_ssh_key
must be specified.- patch
Assessment stringMode Specifies the mode of VM Guest Patching for the virtual machines that are associated to the Virtual Machine Scale Set. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.Note: If the
patch_assessment_mode
is set toAutomaticByPlatform
then theprovision_vm_agent
field must be set totrue
.- patch
Mode string Specifies the mode of in-guest patching of this Windows Virtual Machine. Possible values are
ImageDefault
orAutomaticByPlatform
. Defaults toImageDefault
. For more information on patch modes please see the product documentation.Note: If
patch_mode
is set toAutomaticByPlatform
theprovision_vm_agent
must be set totrue
and theextension
must contain at least one application health extension. An example of how to correctly configure a Virtual Machine Scale Set to provision a Linux Virtual Machine with Automatic VM Guest Patching enabled can be found in the./examples/orchestrated-vm-scale-set/automatic-vm-guest-patching
directory within the GitHub Repository.- provision
Vm booleanAgent - Should the Azure VM Agent be provisioned on each Virtual Machine in the Scale Set? Defaults to
true
. Changing this value forces a new resource to be created. - secrets
Orchestrated
Virtual Machine Scale Set Os Profile Linux Configuration Secret[] - One or more
secret
blocks as defined below.
- admin_
username str - The username of the local administrator on each Virtual Machine Scale Set instance. Changing this forces a new resource to be created.
- admin_
password str - The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
- admin_
ssh_ Sequence[Orchestratedkeys Virtual Machine Scale Set Os Profile Linux Configuration Admin Ssh Key] - A
admin_ssh_key
block as documented below. - computer_
name_ strprefix - The prefix which should be used for the name of the Virtual Machines in this Scale Set. If unspecified this defaults to the value for the name field. If the value of the name field is not a valid
computer_name_prefix
, then you must specifycomputer_name_prefix
. Changing this forces a new resource to be created. - disable_
password_ boolauthentication When an
admin_password
is specifieddisable_password_authentication
must be set tofalse
. Defaults totrue
.Note: Either
admin_password
oradmin_ssh_key
must be specified.- patch_
assessment_ strmode Specifies the mode of VM Guest Patching for the virtual machines that are associated to the Virtual Machine Scale Set. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.Note: If the
patch_assessment_mode
is set toAutomaticByPlatform
then theprovision_vm_agent
field must be set totrue
.- patch_
mode str Specifies the mode of in-guest patching of this Windows Virtual Machine. Possible values are
ImageDefault
orAutomaticByPlatform
. Defaults toImageDefault
. For more information on patch modes please see the product documentation.Note: If
patch_mode
is set toAutomaticByPlatform
theprovision_vm_agent
must be set totrue
and theextension
must contain at least one application health extension. An example of how to correctly configure a Virtual Machine Scale Set to provision a Linux Virtual Machine with Automatic VM Guest Patching enabled can be found in the./examples/orchestrated-vm-scale-set/automatic-vm-guest-patching
directory within the GitHub Repository.- provision_
vm_ boolagent - Should the Azure VM Agent be provisioned on each Virtual Machine in the Scale Set? Defaults to
true
. Changing this value forces a new resource to be created. - secrets
Sequence[Orchestrated
Virtual Machine Scale Set Os Profile Linux Configuration Secret] - One or more
secret
blocks as defined below.
- admin
Username String - The username of the local administrator on each Virtual Machine Scale Set instance. Changing this forces a new resource to be created.
- admin
Password String - The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
- admin
Ssh List<Property Map>Keys - A
admin_ssh_key
block as documented below. - computer
Name StringPrefix - The prefix which should be used for the name of the Virtual Machines in this Scale Set. If unspecified this defaults to the value for the name field. If the value of the name field is not a valid
computer_name_prefix
, then you must specifycomputer_name_prefix
. Changing this forces a new resource to be created. - disable
Password BooleanAuthentication When an
admin_password
is specifieddisable_password_authentication
must be set tofalse
. Defaults totrue
.Note: Either
admin_password
oradmin_ssh_key
must be specified.- patch
Assessment StringMode Specifies the mode of VM Guest Patching for the virtual machines that are associated to the Virtual Machine Scale Set. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.Note: If the
patch_assessment_mode
is set toAutomaticByPlatform
then theprovision_vm_agent
field must be set totrue
.- patch
Mode String Specifies the mode of in-guest patching of this Windows Virtual Machine. Possible values are
ImageDefault
orAutomaticByPlatform
. Defaults toImageDefault
. For more information on patch modes please see the product documentation.Note: If
patch_mode
is set toAutomaticByPlatform
theprovision_vm_agent
must be set totrue
and theextension
must contain at least one application health extension. An example of how to correctly configure a Virtual Machine Scale Set to provision a Linux Virtual Machine with Automatic VM Guest Patching enabled can be found in the./examples/orchestrated-vm-scale-set/automatic-vm-guest-patching
directory within the GitHub Repository.- provision
Vm BooleanAgent - Should the Azure VM Agent be provisioned on each Virtual Machine in the Scale Set? Defaults to
true
. Changing this value forces a new resource to be created. - secrets List<Property Map>
- One or more
secret
blocks as defined below.
OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationAdminSshKey, OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationAdminSshKeyArgs
- Public
Key string - The Public Key which should be used for authentication, which needs to be in
ssh-rsa
format with at least 2048-bit or inssh-ed25519
format. - Username string
The Username for which this Public SSH Key should be configured.
Note: The Azure VM Agent only allows creating SSH Keys at the path
/home/{username}/.ssh/authorized_keys
- as such this public key will be written to the authorized keys file.
- Public
Key string - The Public Key which should be used for authentication, which needs to be in
ssh-rsa
format with at least 2048-bit or inssh-ed25519
format. - Username string
The Username for which this Public SSH Key should be configured.
Note: The Azure VM Agent only allows creating SSH Keys at the path
/home/{username}/.ssh/authorized_keys
- as such this public key will be written to the authorized keys file.
- public
Key String - The Public Key which should be used for authentication, which needs to be in
ssh-rsa
format with at least 2048-bit or inssh-ed25519
format. - username String
The Username for which this Public SSH Key should be configured.
Note: The Azure VM Agent only allows creating SSH Keys at the path
/home/{username}/.ssh/authorized_keys
- as such this public key will be written to the authorized keys file.
- public
Key string - The Public Key which should be used for authentication, which needs to be in
ssh-rsa
format with at least 2048-bit or inssh-ed25519
format. - username string
The Username for which this Public SSH Key should be configured.
Note: The Azure VM Agent only allows creating SSH Keys at the path
/home/{username}/.ssh/authorized_keys
- as such this public key will be written to the authorized keys file.
- public_
key str - The Public Key which should be used for authentication, which needs to be in
ssh-rsa
format with at least 2048-bit or inssh-ed25519
format. - username str
The Username for which this Public SSH Key should be configured.
Note: The Azure VM Agent only allows creating SSH Keys at the path
/home/{username}/.ssh/authorized_keys
- as such this public key will be written to the authorized keys file.
- public
Key String - The Public Key which should be used for authentication, which needs to be in
ssh-rsa
format with at least 2048-bit or inssh-ed25519
format. - username String
The Username for which this Public SSH Key should be configured.
Note: The Azure VM Agent only allows creating SSH Keys at the path
/home/{username}/.ssh/authorized_keys
- as such this public key will be written to the authorized keys file.
OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationSecret, OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationSecretArgs
- Certificates
List<Orchestrated
Virtual Machine Scale Set Os Profile Linux Configuration Secret Certificate> - One or more
certificate
blocks as defined below. - Key
Vault stringId - The ID of the Key Vault from which all Secrets should be sourced.
- Certificates
[]Orchestrated
Virtual Machine Scale Set Os Profile Linux Configuration Secret Certificate - One or more
certificate
blocks as defined below. - Key
Vault stringId - The ID of the Key Vault from which all Secrets should be sourced.
- certificates
List<Orchestrated
Virtual Machine Scale Set Os Profile Linux Configuration Secret Certificate> - One or more
certificate
blocks as defined below. - key
Vault StringId - The ID of the Key Vault from which all Secrets should be sourced.
- certificates
Orchestrated
Virtual Machine Scale Set Os Profile Linux Configuration Secret Certificate[] - One or more
certificate
blocks as defined below. - key
Vault stringId - The ID of the Key Vault from which all Secrets should be sourced.
- certificates
Sequence[Orchestrated
Virtual Machine Scale Set Os Profile Linux Configuration Secret Certificate] - One or more
certificate
blocks as defined below. - key_
vault_ strid - The ID of the Key Vault from which all Secrets should be sourced.
- certificates List<Property Map>
- One or more
certificate
blocks as defined below. - key
Vault StringId - The ID of the Key Vault from which all Secrets should be sourced.
OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationSecretCertificate, OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationSecretCertificateArgs
- Url string
The Secret URL of a Key Vault Certificate.
Note: This can be sourced from the
secret_id
field within theazure.keyvault.Certificate
Resource.
- Url string
The Secret URL of a Key Vault Certificate.
Note: This can be sourced from the
secret_id
field within theazure.keyvault.Certificate
Resource.
- url String
The Secret URL of a Key Vault Certificate.
Note: This can be sourced from the
secret_id
field within theazure.keyvault.Certificate
Resource.
- url string
The Secret URL of a Key Vault Certificate.
Note: This can be sourced from the
secret_id
field within theazure.keyvault.Certificate
Resource.
- url str
The Secret URL of a Key Vault Certificate.
Note: This can be sourced from the
secret_id
field within theazure.keyvault.Certificate
Resource.
- url String
The Secret URL of a Key Vault Certificate.
Note: This can be sourced from the
secret_id
field within theazure.keyvault.Certificate
Resource.
OrchestratedVirtualMachineScaleSetOsProfileWindowsConfiguration, OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationArgs
- Admin
Password string - The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
- Admin
Username string - The username of the local administrator on each Virtual Machine Scale Set instance. Changing this forces a new resource to be created.
- Additional
Unattend List<OrchestratedContents Virtual Machine Scale Set Os Profile Windows Configuration Additional Unattend Content> - One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created. - Computer
Name stringPrefix - The prefix which should be used for the name of the Virtual Machines in this Scale Set. If unspecified this defaults to the value for the
name
field. If the value of thename
field is not a validcomputer_name_prefix
, then you must specifycomputer_name_prefix
. Changing this forces a new resource to be created. - Enable
Automatic boolUpdates - Are automatic updates enabled for this Virtual Machine? Defaults to
true
. - Hotpatching
Enabled bool Should the VM be patched without requiring a reboot? Possible values are
true
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.Note: Hotpatching can only be enabled if the
patch_mode
is set toAutomaticByPlatform
, theprovision_vm_agent
is set totrue
, yoursource_image_reference
references a hotpatching enabled image, the VM'ssku_name
is set to a Azure generation 2 VM SKU and theextension
contains an application health extension. An example of how to correctly configure a Virtual Machine Scale Set to provision a Windows Virtual Machine with hotpatching enabled can be found in the./examples/orchestrated-vm-scale-set/hotpatching-enabled
directory within the GitHub Repository.- Patch
Assessment stringMode Specifies the mode of VM Guest Patching for the virtual machines that are associated to the Virtual Machine Scale Set. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.Note: If the
patch_assessment_mode
is set toAutomaticByPlatform
then theprovision_vm_agent
field must be set totrue
.- Patch
Mode string Specifies the mode of in-guest patching of this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.Note: If
patch_mode
is set toAutomaticByPlatform
theprovision_vm_agent
must be set totrue
and theextension
must contain at least one application health extension.- Provision
Vm boolAgent - Should the Azure VM Agent be provisioned on each Virtual Machine in the Scale Set? Defaults to
true
. Changing this value forces a new resource to be created. - Secrets
List<Orchestrated
Virtual Machine Scale Set Os Profile Windows Configuration Secret> - One or more
secret
blocks as defined below. - Timezone string
- Specifies the time zone of the virtual machine, the possible values are defined here.
- Winrm
Listeners List<OrchestratedVirtual Machine Scale Set Os Profile Windows Configuration Winrm Listener> - One or more
winrm_listener
blocks as defined below. Changing this forces a new resource to be created.
- Admin
Password string - The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
- Admin
Username string - The username of the local administrator on each Virtual Machine Scale Set instance. Changing this forces a new resource to be created.
- Additional
Unattend []OrchestratedContents Virtual Machine Scale Set Os Profile Windows Configuration Additional Unattend Content - One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created. - Computer
Name stringPrefix - The prefix which should be used for the name of the Virtual Machines in this Scale Set. If unspecified this defaults to the value for the
name
field. If the value of thename
field is not a validcomputer_name_prefix
, then you must specifycomputer_name_prefix
. Changing this forces a new resource to be created. - Enable
Automatic boolUpdates - Are automatic updates enabled for this Virtual Machine? Defaults to
true
. - Hotpatching
Enabled bool Should the VM be patched without requiring a reboot? Possible values are
true
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.Note: Hotpatching can only be enabled if the
patch_mode
is set toAutomaticByPlatform
, theprovision_vm_agent
is set totrue
, yoursource_image_reference
references a hotpatching enabled image, the VM'ssku_name
is set to a Azure generation 2 VM SKU and theextension
contains an application health extension. An example of how to correctly configure a Virtual Machine Scale Set to provision a Windows Virtual Machine with hotpatching enabled can be found in the./examples/orchestrated-vm-scale-set/hotpatching-enabled
directory within the GitHub Repository.- Patch
Assessment stringMode Specifies the mode of VM Guest Patching for the virtual machines that are associated to the Virtual Machine Scale Set. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.Note: If the
patch_assessment_mode
is set toAutomaticByPlatform
then theprovision_vm_agent
field must be set totrue
.- Patch
Mode string Specifies the mode of in-guest patching of this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.Note: If
patch_mode
is set toAutomaticByPlatform
theprovision_vm_agent
must be set totrue
and theextension
must contain at least one application health extension.- Provision
Vm boolAgent - Should the Azure VM Agent be provisioned on each Virtual Machine in the Scale Set? Defaults to
true
. Changing this value forces a new resource to be created. - Secrets
[]Orchestrated
Virtual Machine Scale Set Os Profile Windows Configuration Secret - One or more
secret
blocks as defined below. - Timezone string
- Specifies the time zone of the virtual machine, the possible values are defined here.
- Winrm
Listeners []OrchestratedVirtual Machine Scale Set Os Profile Windows Configuration Winrm Listener - One or more
winrm_listener
blocks as defined below. Changing this forces a new resource to be created.
- admin
Password String - The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
- admin
Username String - The username of the local administrator on each Virtual Machine Scale Set instance. Changing this forces a new resource to be created.
- additional
Unattend List<OrchestratedContents Virtual Machine Scale Set Os Profile Windows Configuration Additional Unattend Content> - One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created. - computer
Name StringPrefix - The prefix which should be used for the name of the Virtual Machines in this Scale Set. If unspecified this defaults to the value for the
name
field. If the value of thename
field is not a validcomputer_name_prefix
, then you must specifycomputer_name_prefix
. Changing this forces a new resource to be created. - enable
Automatic BooleanUpdates - Are automatic updates enabled for this Virtual Machine? Defaults to
true
. - hotpatching
Enabled Boolean Should the VM be patched without requiring a reboot? Possible values are
true
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.Note: Hotpatching can only be enabled if the
patch_mode
is set toAutomaticByPlatform
, theprovision_vm_agent
is set totrue
, yoursource_image_reference
references a hotpatching enabled image, the VM'ssku_name
is set to a Azure generation 2 VM SKU and theextension
contains an application health extension. An example of how to correctly configure a Virtual Machine Scale Set to provision a Windows Virtual Machine with hotpatching enabled can be found in the./examples/orchestrated-vm-scale-set/hotpatching-enabled
directory within the GitHub Repository.- patch
Assessment StringMode Specifies the mode of VM Guest Patching for the virtual machines that are associated to the Virtual Machine Scale Set. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.Note: If the
patch_assessment_mode
is set toAutomaticByPlatform
then theprovision_vm_agent
field must be set totrue
.- patch
Mode String Specifies the mode of in-guest patching of this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.Note: If
patch_mode
is set toAutomaticByPlatform
theprovision_vm_agent
must be set totrue
and theextension
must contain at least one application health extension.- provision
Vm BooleanAgent - Should the Azure VM Agent be provisioned on each Virtual Machine in the Scale Set? Defaults to
true
. Changing this value forces a new resource to be created. - secrets
List<Orchestrated
Virtual Machine Scale Set Os Profile Windows Configuration Secret> - One or more
secret
blocks as defined below. - timezone String
- Specifies the time zone of the virtual machine, the possible values are defined here.
- winrm
Listeners List<OrchestratedVirtual Machine Scale Set Os Profile Windows Configuration Winrm Listener> - One or more
winrm_listener
blocks as defined below. Changing this forces a new resource to be created.
- admin
Password string - The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
- admin
Username string - The username of the local administrator on each Virtual Machine Scale Set instance. Changing this forces a new resource to be created.
- additional
Unattend OrchestratedContents Virtual Machine Scale Set Os Profile Windows Configuration Additional Unattend Content[] - One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created. - computer
Name stringPrefix - The prefix which should be used for the name of the Virtual Machines in this Scale Set. If unspecified this defaults to the value for the
name
field. If the value of thename
field is not a validcomputer_name_prefix
, then you must specifycomputer_name_prefix
. Changing this forces a new resource to be created. - enable
Automatic booleanUpdates - Are automatic updates enabled for this Virtual Machine? Defaults to
true
. - hotpatching
Enabled boolean Should the VM be patched without requiring a reboot? Possible values are
true
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.Note: Hotpatching can only be enabled if the
patch_mode
is set toAutomaticByPlatform
, theprovision_vm_agent
is set totrue
, yoursource_image_reference
references a hotpatching enabled image, the VM'ssku_name
is set to a Azure generation 2 VM SKU and theextension
contains an application health extension. An example of how to correctly configure a Virtual Machine Scale Set to provision a Windows Virtual Machine with hotpatching enabled can be found in the./examples/orchestrated-vm-scale-set/hotpatching-enabled
directory within the GitHub Repository.- patch
Assessment stringMode Specifies the mode of VM Guest Patching for the virtual machines that are associated to the Virtual Machine Scale Set. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.Note: If the
patch_assessment_mode
is set toAutomaticByPlatform
then theprovision_vm_agent
field must be set totrue
.- patch
Mode string Specifies the mode of in-guest patching of this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.Note: If
patch_mode
is set toAutomaticByPlatform
theprovision_vm_agent
must be set totrue
and theextension
must contain at least one application health extension.- provision
Vm booleanAgent - Should the Azure VM Agent be provisioned on each Virtual Machine in the Scale Set? Defaults to
true
. Changing this value forces a new resource to be created. - secrets
Orchestrated
Virtual Machine Scale Set Os Profile Windows Configuration Secret[] - One or more
secret
blocks as defined below. - timezone string
- Specifies the time zone of the virtual machine, the possible values are defined here.
- winrm
Listeners OrchestratedVirtual Machine Scale Set Os Profile Windows Configuration Winrm Listener[] - One or more
winrm_listener
blocks as defined below. Changing this forces a new resource to be created.
- admin_
password str - The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
- admin_
username str - The username of the local administrator on each Virtual Machine Scale Set instance. Changing this forces a new resource to be created.
- additional_
unattend_ Sequence[Orchestratedcontents Virtual Machine Scale Set Os Profile Windows Configuration Additional Unattend Content] - One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created. - computer_
name_ strprefix - The prefix which should be used for the name of the Virtual Machines in this Scale Set. If unspecified this defaults to the value for the
name
field. If the value of thename
field is not a validcomputer_name_prefix
, then you must specifycomputer_name_prefix
. Changing this forces a new resource to be created. - enable_
automatic_ boolupdates - Are automatic updates enabled for this Virtual Machine? Defaults to
true
. - hotpatching_
enabled bool Should the VM be patched without requiring a reboot? Possible values are
true
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.Note: Hotpatching can only be enabled if the
patch_mode
is set toAutomaticByPlatform
, theprovision_vm_agent
is set totrue
, yoursource_image_reference
references a hotpatching enabled image, the VM'ssku_name
is set to a Azure generation 2 VM SKU and theextension
contains an application health extension. An example of how to correctly configure a Virtual Machine Scale Set to provision a Windows Virtual Machine with hotpatching enabled can be found in the./examples/orchestrated-vm-scale-set/hotpatching-enabled
directory within the GitHub Repository.- patch_
assessment_ strmode Specifies the mode of VM Guest Patching for the virtual machines that are associated to the Virtual Machine Scale Set. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.Note: If the
patch_assessment_mode
is set toAutomaticByPlatform
then theprovision_vm_agent
field must be set totrue
.- patch_
mode str Specifies the mode of in-guest patching of this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.Note: If
patch_mode
is set toAutomaticByPlatform
theprovision_vm_agent
must be set totrue
and theextension
must contain at least one application health extension.- provision_
vm_ boolagent - Should the Azure VM Agent be provisioned on each Virtual Machine in the Scale Set? Defaults to
true
. Changing this value forces a new resource to be created. - secrets
Sequence[Orchestrated
Virtual Machine Scale Set Os Profile Windows Configuration Secret] - One or more
secret
blocks as defined below. - timezone str
- Specifies the time zone of the virtual machine, the possible values are defined here.
- winrm_
listeners Sequence[OrchestratedVirtual Machine Scale Set Os Profile Windows Configuration Winrm Listener] - One or more
winrm_listener
blocks as defined below. Changing this forces a new resource to be created.
- admin
Password String - The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
- admin
Username String - The username of the local administrator on each Virtual Machine Scale Set instance. Changing this forces a new resource to be created.
- additional
Unattend List<Property Map>Contents - One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created. - computer
Name StringPrefix - The prefix which should be used for the name of the Virtual Machines in this Scale Set. If unspecified this defaults to the value for the
name
field. If the value of thename
field is not a validcomputer_name_prefix
, then you must specifycomputer_name_prefix
. Changing this forces a new resource to be created. - enable
Automatic BooleanUpdates - Are automatic updates enabled for this Virtual Machine? Defaults to
true
. - hotpatching
Enabled Boolean Should the VM be patched without requiring a reboot? Possible values are
true
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.Note: Hotpatching can only be enabled if the
patch_mode
is set toAutomaticByPlatform
, theprovision_vm_agent
is set totrue
, yoursource_image_reference
references a hotpatching enabled image, the VM'ssku_name
is set to a Azure generation 2 VM SKU and theextension
contains an application health extension. An example of how to correctly configure a Virtual Machine Scale Set to provision a Windows Virtual Machine with hotpatching enabled can be found in the./examples/orchestrated-vm-scale-set/hotpatching-enabled
directory within the GitHub Repository.- patch
Assessment StringMode Specifies the mode of VM Guest Patching for the virtual machines that are associated to the Virtual Machine Scale Set. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.Note: If the
patch_assessment_mode
is set toAutomaticByPlatform
then theprovision_vm_agent
field must be set totrue
.- patch
Mode String Specifies the mode of in-guest patching of this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.Note: If
patch_mode
is set toAutomaticByPlatform
theprovision_vm_agent
must be set totrue
and theextension
must contain at least one application health extension.- provision
Vm BooleanAgent - Should the Azure VM Agent be provisioned on each Virtual Machine in the Scale Set? Defaults to
true
. Changing this value forces a new resource to be created. - secrets List<Property Map>
- One or more
secret
blocks as defined below. - timezone String
- Specifies the time zone of the virtual machine, the possible values are defined here.
- winrm
Listeners List<Property Map> - One or more
winrm_listener
blocks as defined below. Changing this forces a new resource to be created.
OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationAdditionalUnattendContent, OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationAdditionalUnattendContentArgs
- Content string
- The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
- Setting string
- The name of the setting to which the content applies. Possible values are
AutoLogon
andFirstLogonCommands
. Changing this forces a new resource to be created.
- Content string
- The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
- Setting string
- The name of the setting to which the content applies. Possible values are
AutoLogon
andFirstLogonCommands
. Changing this forces a new resource to be created.
- content String
- The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
- setting String
- The name of the setting to which the content applies. Possible values are
AutoLogon
andFirstLogonCommands
. Changing this forces a new resource to be created.
- content string
- The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
- setting string
- The name of the setting to which the content applies. Possible values are
AutoLogon
andFirstLogonCommands
. Changing this forces a new resource to be created.
- content str
- The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
- setting str
- The name of the setting to which the content applies. Possible values are
AutoLogon
andFirstLogonCommands
. Changing this forces a new resource to be created.
- content String
- The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
- setting String
- The name of the setting to which the content applies. Possible values are
AutoLogon
andFirstLogonCommands
. Changing this forces a new resource to be created.
OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationSecret, OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationSecretArgs
- Certificates
List<Orchestrated
Virtual Machine Scale Set Os Profile Windows Configuration Secret Certificate> - One or more
certificate
blocks as defined below. - Key
Vault stringId - The ID of the Key Vault from which all Secrets should be sourced.
- Certificates
[]Orchestrated
Virtual Machine Scale Set Os Profile Windows Configuration Secret Certificate - One or more
certificate
blocks as defined below. - Key
Vault stringId - The ID of the Key Vault from which all Secrets should be sourced.
- certificates
List<Orchestrated
Virtual Machine Scale Set Os Profile Windows Configuration Secret Certificate> - One or more
certificate
blocks as defined below. - key
Vault StringId - The ID of the Key Vault from which all Secrets should be sourced.
- certificates
Orchestrated
Virtual Machine Scale Set Os Profile Windows Configuration Secret Certificate[] - One or more
certificate
blocks as defined below. - key
Vault stringId - The ID of the Key Vault from which all Secrets should be sourced.
- certificates
Sequence[Orchestrated
Virtual Machine Scale Set Os Profile Windows Configuration Secret Certificate] - One or more
certificate
blocks as defined below. - key_
vault_ strid - The ID of the Key Vault from which all Secrets should be sourced.
- certificates List<Property Map>
- One or more
certificate
blocks as defined below. - key
Vault StringId - The ID of the Key Vault from which all Secrets should be sourced.
OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationSecretCertificate, OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationSecretCertificateArgs
OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationWinrmListener, OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationWinrmListenerArgs
- Protocol string
- Specifies the protocol of listener. Possible values are
Http
orHttps
. Changing this forces a new resource to be created. - Certificate
Url string The Secret URL of a Key Vault Certificate, which must be specified when protocol is set to
Https
. Changing this forces a new resource to be created.Note: This can be sourced from the
secret_id
field within theazure.keyvault.Certificate
Resource.
- Protocol string
- Specifies the protocol of listener. Possible values are
Http
orHttps
. Changing this forces a new resource to be created. - Certificate
Url string The Secret URL of a Key Vault Certificate, which must be specified when protocol is set to
Https
. Changing this forces a new resource to be created.Note: This can be sourced from the
secret_id
field within theazure.keyvault.Certificate
Resource.
- protocol String
- Specifies the protocol of listener. Possible values are
Http
orHttps
. Changing this forces a new resource to be created. - certificate
Url String The Secret URL of a Key Vault Certificate, which must be specified when protocol is set to
Https
. Changing this forces a new resource to be created.Note: This can be sourced from the
secret_id
field within theazure.keyvault.Certificate
Resource.
- protocol string
- Specifies the protocol of listener. Possible values are
Http
orHttps
. Changing this forces a new resource to be created. - certificate
Url string The Secret URL of a Key Vault Certificate, which must be specified when protocol is set to
Https
. Changing this forces a new resource to be created.Note: This can be sourced from the
secret_id
field within theazure.keyvault.Certificate
Resource.
- protocol str
- Specifies the protocol of listener. Possible values are
Http
orHttps
. Changing this forces a new resource to be created. - certificate_
url str The Secret URL of a Key Vault Certificate, which must be specified when protocol is set to
Https
. Changing this forces a new resource to be created.Note: This can be sourced from the
secret_id
field within theazure.keyvault.Certificate
Resource.
- protocol String
- Specifies the protocol of listener. Possible values are
Http
orHttps
. Changing this forces a new resource to be created. - certificate
Url String The Secret URL of a Key Vault Certificate, which must be specified when protocol is set to
Https
. Changing this forces a new resource to be created.Note: This can be sourced from the
secret_id
field within theazure.keyvault.Certificate
Resource.
OrchestratedVirtualMachineScaleSetPlan, OrchestratedVirtualMachineScaleSetPlanArgs
- Name string
- Specifies the name of the image from the marketplace. Changing this forces a new resource to be created.
- Product string
- Specifies the product of the image from the marketplace. Changing this forces a new resource to be created.
- Publisher string
- Specifies the publisher of the image. Changing this forces a new resource to be created.
- Name string
- Specifies the name of the image from the marketplace. Changing this forces a new resource to be created.
- Product string
- Specifies the product of the image from the marketplace. Changing this forces a new resource to be created.
- Publisher string
- Specifies the publisher of the image. Changing this forces a new resource to be created.
- name String
- Specifies the name of the image from the marketplace. Changing this forces a new resource to be created.
- product String
- Specifies the product of the image from the marketplace. Changing this forces a new resource to be created.
- publisher String
- Specifies the publisher of the image. Changing this forces a new resource to be created.
- name string
- Specifies the name of the image from the marketplace. Changing this forces a new resource to be created.
- product string
- Specifies the product of the image from the marketplace. Changing this forces a new resource to be created.
- publisher string
- Specifies the publisher of the image. Changing this forces a new resource to be created.
- name str
- Specifies the name of the image from the marketplace. Changing this forces a new resource to be created.
- product str
- Specifies the product of the image from the marketplace. Changing this forces a new resource to be created.
- publisher str
- Specifies the publisher of the image. Changing this forces a new resource to be created.
- name String
- Specifies the name of the image from the marketplace. Changing this forces a new resource to be created.
- product String
- Specifies the product of the image from the marketplace. Changing this forces a new resource to be created.
- publisher String
- Specifies the publisher of the image. Changing this forces a new resource to be created.
OrchestratedVirtualMachineScaleSetPriorityMix, OrchestratedVirtualMachineScaleSetPriorityMixArgs
- Base
Regular intCount - Specifies the base number of VMs of
Regular
priority that will be created before any VMs of prioritySpot
are created. Possible values are integers between0
and1000
. Defaults to0
. - Regular
Percentage intAbove Base - Specifies the desired percentage of VM instances that are of
Regular
priority after the base count has been reached. Possible values are integers between0
and100
. Defaults to0
.
- Base
Regular intCount - Specifies the base number of VMs of
Regular
priority that will be created before any VMs of prioritySpot
are created. Possible values are integers between0
and1000
. Defaults to0
. - Regular
Percentage intAbove Base - Specifies the desired percentage of VM instances that are of
Regular
priority after the base count has been reached. Possible values are integers between0
and100
. Defaults to0
.
- base
Regular IntegerCount - Specifies the base number of VMs of
Regular
priority that will be created before any VMs of prioritySpot
are created. Possible values are integers between0
and1000
. Defaults to0
. - regular
Percentage IntegerAbove Base - Specifies the desired percentage of VM instances that are of
Regular
priority after the base count has been reached. Possible values are integers between0
and100
. Defaults to0
.
- base
Regular numberCount - Specifies the base number of VMs of
Regular
priority that will be created before any VMs of prioritySpot
are created. Possible values are integers between0
and1000
. Defaults to0
. - regular
Percentage numberAbove Base - Specifies the desired percentage of VM instances that are of
Regular
priority after the base count has been reached. Possible values are integers between0
and100
. Defaults to0
.
- base_
regular_ intcount - Specifies the base number of VMs of
Regular
priority that will be created before any VMs of prioritySpot
are created. Possible values are integers between0
and1000
. Defaults to0
. - regular_
percentage_ intabove_ base - Specifies the desired percentage of VM instances that are of
Regular
priority after the base count has been reached. Possible values are integers between0
and100
. Defaults to0
.
- base
Regular NumberCount - Specifies the base number of VMs of
Regular
priority that will be created before any VMs of prioritySpot
are created. Possible values are integers between0
and1000
. Defaults to0
. - regular
Percentage NumberAbove Base - Specifies the desired percentage of VM instances that are of
Regular
priority after the base count has been reached. Possible values are integers between0
and100
. Defaults to0
.
OrchestratedVirtualMachineScaleSetSkuProfile, OrchestratedVirtualMachineScaleSetSkuProfileArgs
- Allocation
Strategy string - Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated. Possible values are
LowestPrice
andCapacityOptimized
. - Vm
Sizes List<string> - Specifies the VM sizes for the virtual machine scale set.
- Allocation
Strategy string - Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated. Possible values are
LowestPrice
andCapacityOptimized
. - Vm
Sizes []string - Specifies the VM sizes for the virtual machine scale set.
- allocation
Strategy String - Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated. Possible values are
LowestPrice
andCapacityOptimized
. - vm
Sizes List<String> - Specifies the VM sizes for the virtual machine scale set.
- allocation
Strategy string - Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated. Possible values are
LowestPrice
andCapacityOptimized
. - vm
Sizes string[] - Specifies the VM sizes for the virtual machine scale set.
- allocation_
strategy str - Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated. Possible values are
LowestPrice
andCapacityOptimized
. - vm_
sizes Sequence[str] - Specifies the VM sizes for the virtual machine scale set.
- allocation
Strategy String - Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated. Possible values are
LowestPrice
andCapacityOptimized
. - vm
Sizes List<String> - Specifies the VM sizes for the virtual machine scale set.
OrchestratedVirtualMachineScaleSetSourceImageReference, OrchestratedVirtualMachineScaleSetSourceImageReferenceArgs
- Offer string
- Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
- Publisher string
- Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
- 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.
- Offer string
- Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
- Publisher string
- Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
- 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.
- offer String
- Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
- publisher String
- Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
- 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.
- offer string
- Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
- publisher string
- Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
- 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.
- offer str
- Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
- publisher str
- Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
- 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.
- offer String
- Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
- publisher String
- Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
- 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.
OrchestratedVirtualMachineScaleSetTerminationNotification, OrchestratedVirtualMachineScaleSetTerminationNotificationArgs
- Enabled bool
- Should the termination notification be enabled on this Virtual Machine Scale Set? Possible values
true
orfalse
. - Timeout string
- Length of time (in minutes, between
5
and15
) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified inISO 8601
format. Defaults toPT5M
.
- Enabled bool
- Should the termination notification be enabled on this Virtual Machine Scale Set? Possible values
true
orfalse
. - Timeout string
- Length of time (in minutes, between
5
and15
) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified inISO 8601
format. Defaults toPT5M
.
- enabled Boolean
- Should the termination notification be enabled on this Virtual Machine Scale Set? Possible values
true
orfalse
. - timeout String
- Length of time (in minutes, between
5
and15
) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified inISO 8601
format. Defaults toPT5M
.
- enabled boolean
- Should the termination notification be enabled on this Virtual Machine Scale Set? Possible values
true
orfalse
. - timeout string
- Length of time (in minutes, between
5
and15
) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified inISO 8601
format. Defaults toPT5M
.
- enabled bool
- Should the termination notification be enabled on this Virtual Machine Scale Set? Possible values
true
orfalse
. - timeout str
- Length of time (in minutes, between
5
and15
) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified inISO 8601
format. Defaults toPT5M
.
- enabled Boolean
- Should the termination notification be enabled on this Virtual Machine Scale Set? Possible values
true
orfalse
. - timeout String
- Length of time (in minutes, between
5
and15
) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified inISO 8601
format. Defaults toPT5M
.
Import
An Virtual Machine Scale Set can be imported using the resource id
, e.g.
$ pulumi import azure:compute/orchestratedVirtualMachineScaleSet:OrchestratedVirtualMachineScaleSet example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Compute/virtualMachineScaleSets/scaleset1
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.