We recommend using Azure Native.
published on Monday, Mar 9, 2026 by Pulumi
We recommend using Azure Native.
published on Monday, Mar 9, 2026 by Pulumi
Manages an Orchestrated Virtual Machine Scale Set.
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
using Pulumi;
using Azure = Pulumi.Azure;
class MyStack : Stack
{
public MyStack()
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
{
Location = "West Europe",
});
var exampleOrchestratedVirtualMachineScaleSet = new Azure.Compute.OrchestratedVirtualMachineScaleSet("exampleOrchestratedVirtualMachineScaleSet", new Azure.Compute.OrchestratedVirtualMachineScaleSetArgs
{
Location = exampleResourceGroup.Location,
ResourceGroupName = exampleResourceGroup.Name,
PlatformFaultDomainCount = 1,
Zones =
{
"1",
},
});
}
}
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/compute"
"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
_, err = compute.NewOrchestratedVirtualMachineScaleSet(ctx, "exampleOrchestratedVirtualMachineScaleSet", &compute.OrchestratedVirtualMachineScaleSetArgs{
Location: exampleResourceGroup.Location,
ResourceGroupName: exampleResourceGroup.Name,
PlatformFaultDomainCount: pulumi.Int(1),
Zones: pulumi.String{
"1",
},
})
if err != nil {
return err
}
return nil
})
}
Example coming soon!
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleOrchestratedVirtualMachineScaleSet = new azure.compute.OrchestratedVirtualMachineScaleSet("exampleOrchestratedVirtualMachineScaleSet", {
location: exampleResourceGroup.location,
resourceGroupName: exampleResourceGroup.name,
platformFaultDomainCount: 1,
zones: ["1"],
});
import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_orchestrated_virtual_machine_scale_set = azure.compute.OrchestratedVirtualMachineScaleSet("exampleOrchestratedVirtualMachineScaleSet",
location=example_resource_group.location,
resource_group_name=example_resource_group.name,
platform_fault_domain_count=1,
zones=["1"])
Example coming soon!
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,
os_disk: Optional[OrchestratedVirtualMachineScaleSetOsDiskArgs] = None,
tags: Optional[Mapping[str, str]] = None,
eviction_policy: Optional[str] = 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,
encryption_at_host_enabled: Optional[bool] = None,
automatic_instance_repair: Optional[OrchestratedVirtualMachineScaleSetAutomaticInstanceRepairArgs] = None,
boot_diagnostics: Optional[OrchestratedVirtualMachineScaleSetBootDiagnosticsArgs] = None,
data_disks: Optional[Sequence[OrchestratedVirtualMachineScaleSetDataDiskArgs]] = None,
priority: Optional[str] = None,
proximity_placement_group_id: Optional[str] = None,
plan: Optional[OrchestratedVirtualMachineScaleSetPlanArgs] = None,
sku_name: Optional[str] = None,
source_image_id: Optional[str] = None,
source_image_reference: Optional[OrchestratedVirtualMachineScaleSetSourceImageReferenceArgs] = None,
os_profile: Optional[OrchestratedVirtualMachineScaleSetOsProfileArgs] = None,
termination_notification: Optional[OrchestratedVirtualMachineScaleSetTerminationNotificationArgs] = None,
zone_balance: Optional[bool] = None,
zones: Optional[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",
OsDisk = new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetOsDiskArgs
{
Caching = "string",
StorageAccountType = "string",
DiffDiskSettings = new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetOsDiskDiffDiskSettingsArgs
{
Option = "string",
},
DiskEncryptionSetId = "string",
DiskSizeGb = 0,
WriteAcceleratorEnabled = false,
},
Tags =
{
{ "string", "string" },
},
EvictionPolicy = "string",
Extensions = new[]
{
new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetExtensionArgs
{
Name = "string",
Publisher = "string",
Type = "string",
TypeHandlerVersion = "string",
AutoUpgradeMinorVersionEnabled = false,
ExtensionsToProvisionAfterVmCreations = new[]
{
"string",
},
ForceExtensionExecutionOnChange = "string",
ProtectedSettings = "string",
Settings = "string",
},
},
ExtensionsTimeBudget = "string",
Identity = new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetIdentityArgs
{
IdentityIds = new[]
{
"string",
},
Type = "string",
},
Instances = 0,
LicenseType = "string",
Location = "string",
MaxBidPrice = 0,
Name = "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",
},
},
SubnetId = "string",
Version = "string",
},
},
Name = "string",
DnsServers = new[]
{
"string",
},
EnableAcceleratedNetworking = false,
EnableIpForwarding = false,
NetworkSecurityGroupId = "string",
Primary = false,
},
},
EncryptionAtHostEnabled = false,
AutomaticInstanceRepair = new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetAutomaticInstanceRepairArgs
{
Enabled = false,
GracePeriod = "string",
},
BootDiagnostics = new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetBootDiagnosticsArgs
{
StorageAccountUri = "string",
},
DataDisks = new[]
{
new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetDataDiskArgs
{
Caching = "string",
DiskSizeGb = 0,
Lun = 0,
StorageAccountType = "string",
CreateOption = "string",
DiskEncryptionSetId = "string",
UltraSsdDiskIopsReadWrite = 0,
UltraSsdDiskMbpsReadWrite = 0,
WriteAcceleratorEnabled = false,
},
},
Priority = "string",
ProximityPlacementGroupId = "string",
Plan = new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetPlanArgs
{
Name = "string",
Product = "string",
Publisher = "string",
},
SkuName = "string",
SourceImageId = "string",
SourceImageReference = new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetSourceImageReferenceArgs
{
Offer = "string",
Publisher = "string",
Sku = "string",
Version = "string",
},
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,
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",
ComputerNamePrefix = "string",
EnableAutomaticUpdates = false,
HotpatchingEnabled = false,
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",
},
},
},
},
TerminationNotification = new Azure.Compute.Inputs.OrchestratedVirtualMachineScaleSetTerminationNotificationArgs
{
Enabled = false,
Timeout = "string",
},
ZoneBalance = false,
Zones = "string",
});
example, err := compute.NewOrchestratedVirtualMachineScaleSet(ctx, "orchestratedVirtualMachineScaleSetResource", &compute.OrchestratedVirtualMachineScaleSetArgs{
PlatformFaultDomainCount: pulumi.Int(0),
ResourceGroupName: pulumi.String("string"),
OsDisk: &compute.OrchestratedVirtualMachineScaleSetOsDiskArgs{
Caching: pulumi.String("string"),
StorageAccountType: pulumi.String("string"),
DiffDiskSettings: &compute.OrchestratedVirtualMachineScaleSetOsDiskDiffDiskSettingsArgs{
Option: pulumi.String("string"),
},
DiskEncryptionSetId: pulumi.String("string"),
DiskSizeGb: pulumi.Int(0),
WriteAcceleratorEnabled: pulumi.Bool(false),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
EvictionPolicy: 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"),
},
ForceExtensionExecutionOnChange: pulumi.String("string"),
ProtectedSettings: pulumi.String("string"),
Settings: pulumi.String("string"),
},
},
ExtensionsTimeBudget: 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),
Name: 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"),
},
},
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),
},
},
EncryptionAtHostEnabled: pulumi.Bool(false),
AutomaticInstanceRepair: &compute.OrchestratedVirtualMachineScaleSetAutomaticInstanceRepairArgs{
Enabled: pulumi.Bool(false),
GracePeriod: pulumi.String("string"),
},
BootDiagnostics: &compute.OrchestratedVirtualMachineScaleSetBootDiagnosticsArgs{
StorageAccountUri: pulumi.String("string"),
},
DataDisks: compute.OrchestratedVirtualMachineScaleSetDataDiskArray{
&compute.OrchestratedVirtualMachineScaleSetDataDiskArgs{
Caching: pulumi.String("string"),
DiskSizeGb: pulumi.Int(0),
Lun: pulumi.Int(0),
StorageAccountType: pulumi.String("string"),
CreateOption: pulumi.String("string"),
DiskEncryptionSetId: pulumi.String("string"),
UltraSsdDiskIopsReadWrite: pulumi.Int(0),
UltraSsdDiskMbpsReadWrite: pulumi.Int(0),
WriteAcceleratorEnabled: pulumi.Bool(false),
},
},
Priority: pulumi.String("string"),
ProximityPlacementGroupId: pulumi.String("string"),
Plan: &compute.OrchestratedVirtualMachineScaleSetPlanArgs{
Name: pulumi.String("string"),
Product: pulumi.String("string"),
Publisher: pulumi.String("string"),
},
SkuName: 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"),
},
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),
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"),
ComputerNamePrefix: pulumi.String("string"),
EnableAutomaticUpdates: pulumi.Bool(false),
HotpatchingEnabled: pulumi.Bool(false),
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"),
},
},
},
},
TerminationNotification: &compute.OrchestratedVirtualMachineScaleSetTerminationNotificationArgs{
Enabled: pulumi.Bool(false),
Timeout: pulumi.String("string"),
},
ZoneBalance: pulumi.Bool(false),
Zones: pulumi.String("string"),
})
var orchestratedVirtualMachineScaleSetResource = new OrchestratedVirtualMachineScaleSet("orchestratedVirtualMachineScaleSetResource", OrchestratedVirtualMachineScaleSetArgs.builder()
.platformFaultDomainCount(0)
.resourceGroupName("string")
.osDisk(OrchestratedVirtualMachineScaleSetOsDiskArgs.builder()
.caching("string")
.storageAccountType("string")
.diffDiskSettings(OrchestratedVirtualMachineScaleSetOsDiskDiffDiskSettingsArgs.builder()
.option("string")
.build())
.diskEncryptionSetId("string")
.diskSizeGb(0)
.writeAcceleratorEnabled(false)
.build())
.tags(Map.of("string", "string"))
.evictionPolicy("string")
.extensions(OrchestratedVirtualMachineScaleSetExtensionArgs.builder()
.name("string")
.publisher("string")
.type("string")
.typeHandlerVersion("string")
.autoUpgradeMinorVersionEnabled(false)
.extensionsToProvisionAfterVmCreations("string")
.forceExtensionExecutionOnChange("string")
.protectedSettings("string")
.settings("string")
.build())
.extensionsTimeBudget("string")
.identity(OrchestratedVirtualMachineScaleSetIdentityArgs.builder()
.identityIds("string")
.type("string")
.build())
.instances(0)
.licenseType("string")
.location("string")
.maxBidPrice(0.0)
.name("string")
.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")
.build())
.subnetId("string")
.version("string")
.build())
.name("string")
.dnsServers("string")
.enableAcceleratedNetworking(false)
.enableIpForwarding(false)
.networkSecurityGroupId("string")
.primary(false)
.build())
.encryptionAtHostEnabled(false)
.automaticInstanceRepair(OrchestratedVirtualMachineScaleSetAutomaticInstanceRepairArgs.builder()
.enabled(false)
.gracePeriod("string")
.build())
.bootDiagnostics(OrchestratedVirtualMachineScaleSetBootDiagnosticsArgs.builder()
.storageAccountUri("string")
.build())
.dataDisks(OrchestratedVirtualMachineScaleSetDataDiskArgs.builder()
.caching("string")
.diskSizeGb(0)
.lun(0)
.storageAccountType("string")
.createOption("string")
.diskEncryptionSetId("string")
.ultraSsdDiskIopsReadWrite(0)
.ultraSsdDiskMbpsReadWrite(0)
.writeAcceleratorEnabled(false)
.build())
.priority("string")
.proximityPlacementGroupId("string")
.plan(OrchestratedVirtualMachineScaleSetPlanArgs.builder()
.name("string")
.product("string")
.publisher("string")
.build())
.skuName("string")
.sourceImageId("string")
.sourceImageReference(OrchestratedVirtualMachineScaleSetSourceImageReferenceArgs.builder()
.offer("string")
.publisher("string")
.sku("string")
.version("string")
.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)
.patchMode("string")
.provisionVmAgent(false)
.secrets(OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationSecretArgs.builder()
.certificates(OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationSecretCertificateArgs.builder()
.url("string")
.build())
.keyVaultId("string")
.build())
.build())
.windowsConfiguration(OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationArgs.builder()
.adminPassword("string")
.adminUsername("string")
.computerNamePrefix("string")
.enableAutomaticUpdates(false)
.hotpatchingEnabled(false)
.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())
.terminationNotification(OrchestratedVirtualMachineScaleSetTerminationNotificationArgs.builder()
.enabled(false)
.timeout("string")
.build())
.zoneBalance(false)
.zones("string")
.build());
orchestrated_virtual_machine_scale_set_resource = azure.compute.OrchestratedVirtualMachineScaleSet("orchestratedVirtualMachineScaleSetResource",
platform_fault_domain_count=0,
resource_group_name="string",
os_disk={
"caching": "string",
"storage_account_type": "string",
"diff_disk_settings": {
"option": "string",
},
"disk_encryption_set_id": "string",
"disk_size_gb": 0,
"write_accelerator_enabled": False,
},
tags={
"string": "string",
},
eviction_policy="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"],
"force_extension_execution_on_change": "string",
"protected_settings": "string",
"settings": "string",
}],
extensions_time_budget="string",
identity={
"identity_ids": ["string"],
"type": "string",
},
instances=0,
license_type="string",
location="string",
max_bid_price=0,
name="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",
}],
"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,
}],
encryption_at_host_enabled=False,
automatic_instance_repair={
"enabled": False,
"grace_period": "string",
},
boot_diagnostics={
"storage_account_uri": "string",
},
data_disks=[{
"caching": "string",
"disk_size_gb": 0,
"lun": 0,
"storage_account_type": "string",
"create_option": "string",
"disk_encryption_set_id": "string",
"ultra_ssd_disk_iops_read_write": 0,
"ultra_ssd_disk_mbps_read_write": 0,
"write_accelerator_enabled": False,
}],
priority="string",
proximity_placement_group_id="string",
plan={
"name": "string",
"product": "string",
"publisher": "string",
},
sku_name="string",
source_image_id="string",
source_image_reference={
"offer": "string",
"publisher": "string",
"sku": "string",
"version": "string",
},
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_mode": "string",
"provision_vm_agent": False,
"secrets": [{
"certificates": [{
"url": "string",
}],
"key_vault_id": "string",
}],
},
"windows_configuration": {
"admin_password": "string",
"admin_username": "string",
"computer_name_prefix": "string",
"enable_automatic_updates": False,
"hotpatching_enabled": False,
"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",
}],
},
},
termination_notification={
"enabled": False,
"timeout": "string",
},
zone_balance=False,
zones="string")
const orchestratedVirtualMachineScaleSetResource = new azure.compute.OrchestratedVirtualMachineScaleSet("orchestratedVirtualMachineScaleSetResource", {
platformFaultDomainCount: 0,
resourceGroupName: "string",
osDisk: {
caching: "string",
storageAccountType: "string",
diffDiskSettings: {
option: "string",
},
diskEncryptionSetId: "string",
diskSizeGb: 0,
writeAcceleratorEnabled: false,
},
tags: {
string: "string",
},
evictionPolicy: "string",
extensions: [{
name: "string",
publisher: "string",
type: "string",
typeHandlerVersion: "string",
autoUpgradeMinorVersionEnabled: false,
extensionsToProvisionAfterVmCreations: ["string"],
forceExtensionExecutionOnChange: "string",
protectedSettings: "string",
settings: "string",
}],
extensionsTimeBudget: "string",
identity: {
identityIds: ["string"],
type: "string",
},
instances: 0,
licenseType: "string",
location: "string",
maxBidPrice: 0,
name: "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",
}],
subnetId: "string",
version: "string",
}],
name: "string",
dnsServers: ["string"],
enableAcceleratedNetworking: false,
enableIpForwarding: false,
networkSecurityGroupId: "string",
primary: false,
}],
encryptionAtHostEnabled: false,
automaticInstanceRepair: {
enabled: false,
gracePeriod: "string",
},
bootDiagnostics: {
storageAccountUri: "string",
},
dataDisks: [{
caching: "string",
diskSizeGb: 0,
lun: 0,
storageAccountType: "string",
createOption: "string",
diskEncryptionSetId: "string",
ultraSsdDiskIopsReadWrite: 0,
ultraSsdDiskMbpsReadWrite: 0,
writeAcceleratorEnabled: false,
}],
priority: "string",
proximityPlacementGroupId: "string",
plan: {
name: "string",
product: "string",
publisher: "string",
},
skuName: "string",
sourceImageId: "string",
sourceImageReference: {
offer: "string",
publisher: "string",
sku: "string",
version: "string",
},
osProfile: {
customData: "string",
linuxConfiguration: {
adminUsername: "string",
adminPassword: "string",
adminSshKeys: [{
publicKey: "string",
username: "string",
}],
computerNamePrefix: "string",
disablePasswordAuthentication: false,
patchMode: "string",
provisionVmAgent: false,
secrets: [{
certificates: [{
url: "string",
}],
keyVaultId: "string",
}],
},
windowsConfiguration: {
adminPassword: "string",
adminUsername: "string",
computerNamePrefix: "string",
enableAutomaticUpdates: false,
hotpatchingEnabled: false,
patchMode: "string",
provisionVmAgent: false,
secrets: [{
certificates: [{
store: "string",
url: "string",
}],
keyVaultId: "string",
}],
timezone: "string",
winrmListeners: [{
protocol: "string",
certificateUrl: "string",
}],
},
},
terminationNotification: {
enabled: false,
timeout: "string",
},
zoneBalance: false,
zones: "string",
});
type: azure:compute:OrchestratedVirtualMachineScaleSet
properties:
automaticInstanceRepair:
enabled: false
gracePeriod: string
bootDiagnostics:
storageAccountUri: string
dataDisks:
- caching: string
createOption: string
diskEncryptionSetId: string
diskSizeGb: 0
lun: 0
storageAccountType: string
ultraSsdDiskIopsReadWrite: 0
ultraSsdDiskMbpsReadWrite: 0
writeAcceleratorEnabled: false
encryptionAtHostEnabled: false
evictionPolicy: string
extensions:
- autoUpgradeMinorVersionEnabled: false
extensionsToProvisionAfterVmCreations:
- string
forceExtensionExecutionOnChange: string
name: string
protectedSettings: 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
subnetId: string
version: string
name: string
networkSecurityGroupId: string
primary: false
osDisk:
caching: string
diffDiskSettings:
option: 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
patchMode: string
provisionVmAgent: false
secrets:
- certificates:
- url: string
keyVaultId: string
windowsConfiguration:
adminPassword: string
adminUsername: string
computerNamePrefix: string
enableAutomaticUpdates: false
hotpatchingEnabled: false
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
proximityPlacementGroupId: string
resourceGroupName: string
skuName: string
sourceImageId: string
sourceImageReference:
offer: string
publisher: string
sku: string
version: string
tags:
string: string
terminationNotification:
enabled: false
timeout: 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 Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- Resource
Group stringName - The name of the Resource Group in which the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- Automatic
Instance OrchestratedRepair Virtual Machine Scale Set Automatic Instance Repair - Boot
Diagnostics OrchestratedVirtual Machine Scale Set Boot Diagnostics - Data
Disks List<OrchestratedVirtual Machine Scale Set Data Disk> - Encryption
At boolHost Enabled - Eviction
Policy string - Extensions
List<Orchestrated
Virtual Machine Scale Set Extension> - 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. The default value is 90 minutes (PT1H30M).
- Identity
Orchestrated
Virtual Machine Scale Set Identity - Instances int
- The number of Virtual Machines in the Orcestrated Virtual Machine Scale Set.
- License
Type string - Location string
- The Azure location where the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- Max
Bid doublePrice - Name string
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- Network
Interfaces List<OrchestratedVirtual Machine Scale Set Network Interface> - Os
Disk OrchestratedVirtual Machine Scale Set Os Disk - Os
Profile OrchestratedVirtual Machine Scale Set Os Profile - Plan
Orchestrated
Virtual Machine Scale Set Plan - Priority string
- Proximity
Placement stringGroup Id - The ID of the Proximity Placement Group which the Orchestrated Virtual Machine should be assigned to. Changing this forces a new resource to be created.
- Sku
Name string - Source
Image stringId - Source
Image OrchestratedReference Virtual Machine Scale Set Source Image Reference - A
source_image_referenceblock as defined below. - Dictionary<string, string>
- A mapping of tags which should be assigned to this Orchestrated Virtual Machine Scale Set.
- Termination
Notification OrchestratedVirtual Machine Scale Set Termination Notification - Zone
Balance bool - Zones string
- A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.
- Platform
Fault intDomain Count - Specifies the number of fault domains that are used by this Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- Resource
Group stringName - The name of the Resource Group in which the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- Automatic
Instance OrchestratedRepair Virtual Machine Scale Set Automatic Instance Repair Args - Boot
Diagnostics OrchestratedVirtual Machine Scale Set Boot Diagnostics Args - Data
Disks []OrchestratedVirtual Machine Scale Set Data Disk Args - Encryption
At boolHost Enabled - Eviction
Policy string - Extensions
[]Orchestrated
Virtual Machine Scale Set Extension Args - 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. The default value is 90 minutes (PT1H30M).
- Identity
Orchestrated
Virtual Machine Scale Set Identity Args - Instances int
- The number of Virtual Machines in the Orcestrated Virtual Machine Scale Set.
- License
Type string - Location string
- The Azure location where the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- Max
Bid float64Price - Name string
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- Network
Interfaces []OrchestratedVirtual Machine Scale Set Network Interface Args - Os
Disk OrchestratedVirtual Machine Scale Set Os Disk Args - Os
Profile OrchestratedVirtual Machine Scale Set Os Profile Args - Plan
Orchestrated
Virtual Machine Scale Set Plan Args - Priority string
- Proximity
Placement stringGroup Id - The ID of the Proximity Placement Group which the Orchestrated Virtual Machine should be assigned to. Changing this forces a new resource to be created.
- Sku
Name string - Source
Image stringId - Source
Image OrchestratedReference Virtual Machine Scale Set Source Image Reference Args - A
source_image_referenceblock as defined below. - map[string]string
- A mapping of tags which should be assigned to this Orchestrated Virtual Machine Scale Set.
- Termination
Notification OrchestratedVirtual Machine Scale Set Termination Notification Args - Zone
Balance bool - Zones string
- A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.
- platform
Fault IntegerDomain Count - Specifies the number of fault domains that are used by this Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- resource
Group StringName - The name of the Resource Group in which the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- automatic
Instance OrchestratedRepair Virtual Machine Scale Set Automatic Instance Repair - boot
Diagnostics OrchestratedVirtual Machine Scale Set Boot Diagnostics - data
Disks List<OrchestratedVirtual Machine Scale Set Data Disk> - encryption
At BooleanHost Enabled - eviction
Policy String - extensions
List<Orchestrated
Virtual Machine Scale Set Extension> - 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. The default value is 90 minutes (PT1H30M).
- identity
Orchestrated
Virtual Machine Scale Set Identity - instances Integer
- The number of Virtual Machines in the Orcestrated Virtual Machine Scale Set.
- license
Type String - location String
- The Azure location where the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- max
Bid DoublePrice - name String
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- network
Interfaces List<OrchestratedVirtual Machine Scale Set Network Interface> - os
Disk OrchestratedVirtual Machine Scale Set Os Disk - os
Profile OrchestratedVirtual Machine Scale Set Os Profile - plan
Orchestrated
Virtual Machine Scale Set Plan - priority String
- proximity
Placement StringGroup Id - The ID of the Proximity Placement Group which the Orchestrated Virtual Machine should be assigned to. Changing this forces a new resource to be created.
- sku
Name String - source
Image StringId - source
Image OrchestratedReference Virtual Machine Scale Set Source Image Reference - A
source_image_referenceblock as defined below. - Map<String,String>
- A mapping of tags which should be assigned to this Orchestrated Virtual Machine Scale Set.
- termination
Notification OrchestratedVirtual Machine Scale Set Termination Notification - zone
Balance Boolean - zones String
- A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.
- platform
Fault numberDomain Count - Specifies the number of fault domains that are used by this Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- resource
Group stringName - The name of the Resource Group in which the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- automatic
Instance OrchestratedRepair Virtual Machine Scale Set Automatic Instance Repair - boot
Diagnostics OrchestratedVirtual Machine Scale Set Boot Diagnostics - data
Disks OrchestratedVirtual Machine Scale Set Data Disk[] - encryption
At booleanHost Enabled - eviction
Policy string - extensions
Orchestrated
Virtual Machine Scale Set Extension[] - 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. The default value is 90 minutes (PT1H30M).
- identity
Orchestrated
Virtual Machine Scale Set Identity - instances number
- The number of Virtual Machines in the Orcestrated Virtual Machine Scale Set.
- license
Type string - location string
- The Azure location where the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- max
Bid numberPrice - name string
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- network
Interfaces OrchestratedVirtual Machine Scale Set Network Interface[] - os
Disk OrchestratedVirtual Machine Scale Set Os Disk - os
Profile OrchestratedVirtual Machine Scale Set Os Profile - plan
Orchestrated
Virtual Machine Scale Set Plan - priority string
- proximity
Placement stringGroup Id - The ID of the Proximity Placement Group which the Orchestrated Virtual Machine should be assigned to. Changing this forces a new resource to be created.
- sku
Name string - source
Image stringId - source
Image OrchestratedReference Virtual Machine Scale Set Source Image Reference - A
source_image_referenceblock as defined below. - {[key: string]: string}
- A mapping of tags which should be assigned to this Orchestrated Virtual Machine Scale Set.
- termination
Notification OrchestratedVirtual Machine Scale Set Termination Notification - zone
Balance boolean - zones string
- A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.
- platform_
fault_ intdomain_ count - Specifies the number of fault domains that are used by this Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- resource_
group_ strname - The name of the Resource Group in which the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- automatic_
instance_ Orchestratedrepair Virtual Machine Scale Set Automatic Instance Repair Args - boot_
diagnostics OrchestratedVirtual Machine Scale Set Boot Diagnostics Args - data_
disks Sequence[OrchestratedVirtual Machine Scale Set Data Disk Args] - encryption_
at_ boolhost_ enabled - eviction_
policy str - extensions
Sequence[Orchestrated
Virtual Machine Scale Set Extension Args] - 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. The default value is 90 minutes (PT1H30M).
- identity
Orchestrated
Virtual Machine Scale Set Identity Args - instances int
- The number of Virtual Machines in the Orcestrated Virtual Machine Scale Set.
- license_
type str - location str
- The Azure location where the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- max_
bid_ floatprice - name str
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- network_
interfaces Sequence[OrchestratedVirtual Machine Scale Set Network Interface Args] - os_
disk OrchestratedVirtual Machine Scale Set Os Disk Args - os_
profile OrchestratedVirtual Machine Scale Set Os Profile Args - plan
Orchestrated
Virtual Machine Scale Set Plan Args - priority str
- proximity_
placement_ strgroup_ id - The ID of the Proximity Placement Group which the Orchestrated Virtual Machine should be assigned to. Changing this forces a new resource to be created.
- sku_
name str - source_
image_ strid - source_
image_ Orchestratedreference Virtual Machine Scale Set Source Image Reference Args - A
source_image_referenceblock as defined below. - Mapping[str, str]
- A mapping of tags which should be assigned to this Orchestrated Virtual Machine Scale Set.
- termination_
notification OrchestratedVirtual Machine Scale Set Termination Notification Args - zone_
balance bool - zones str
- A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.
- platform
Fault NumberDomain Count - Specifies the number of fault domains that are used by this Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- resource
Group StringName - The name of the Resource Group in which the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- automatic
Instance Property MapRepair - boot
Diagnostics Property Map - data
Disks List<Property Map> - encryption
At BooleanHost Enabled - eviction
Policy String - extensions List<Property Map>
- 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. The default value is 90 minutes (PT1H30M).
- identity Property Map
- instances Number
- The number of Virtual Machines in the Orcestrated Virtual Machine Scale Set.
- license
Type String - location String
- The Azure location where the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- max
Bid NumberPrice - name String
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- network
Interfaces List<Property Map> - os
Disk Property Map - os
Profile Property Map - plan Property Map
- priority String
- proximity
Placement StringGroup Id - The ID of the Proximity Placement Group which the Orchestrated Virtual Machine should be assigned to. Changing this forces a new resource to be created.
- sku
Name String - source
Image StringId - source
Image Property MapReference - A
source_image_referenceblock as defined below. - Map<String>
- A mapping of tags which should be assigned to this Orchestrated Virtual Machine Scale Set.
- termination
Notification Property Map - zone
Balance Boolean - zones String
- A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.
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,
automatic_instance_repair: Optional[OrchestratedVirtualMachineScaleSetAutomaticInstanceRepairArgs] = None,
boot_diagnostics: Optional[OrchestratedVirtualMachineScaleSetBootDiagnosticsArgs] = None,
data_disks: Optional[Sequence[OrchestratedVirtualMachineScaleSetDataDiskArgs]] = None,
encryption_at_host_enabled: Optional[bool] = None,
eviction_policy: Optional[str] = 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,
proximity_placement_group_id: Optional[str] = None,
resource_group_name: Optional[str] = None,
sku_name: Optional[str] = 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,
zone_balance: Optional[bool] = None,
zones: Optional[str] = None) -> OrchestratedVirtualMachineScaleSetfunc 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)resources: _: type: azure:compute:OrchestratedVirtualMachineScaleSet get: id: ${id}- 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.
- Automatic
Instance OrchestratedRepair Virtual Machine Scale Set Automatic Instance Repair - Boot
Diagnostics OrchestratedVirtual Machine Scale Set Boot Diagnostics - Data
Disks List<OrchestratedVirtual Machine Scale Set Data Disk> - Encryption
At boolHost Enabled - Eviction
Policy string - Extensions
List<Orchestrated
Virtual Machine Scale Set Extension> - 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. The default value is 90 minutes (PT1H30M).
- Identity
Orchestrated
Virtual Machine Scale Set Identity - Instances int
- The number of Virtual Machines in the Orcestrated Virtual Machine Scale Set.
- License
Type string - Location string
- The Azure location where the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- Max
Bid doublePrice - Name string
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- Network
Interfaces List<OrchestratedVirtual Machine Scale Set Network Interface> - Os
Disk OrchestratedVirtual Machine Scale Set Os Disk - Os
Profile OrchestratedVirtual Machine Scale Set Os Profile - Plan
Orchestrated
Virtual Machine Scale Set Plan - Platform
Fault intDomain Count - Specifies the number of fault domains that are used by this Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- Priority string
- Proximity
Placement stringGroup Id - The ID of the Proximity Placement Group which the Orchestrated 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 Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- Sku
Name string - Source
Image stringId - Source
Image OrchestratedReference Virtual Machine Scale Set Source Image Reference - A
source_image_referenceblock as defined below. - Dictionary<string, string>
- A mapping of tags which should be assigned to this Orchestrated Virtual Machine Scale Set.
- Termination
Notification OrchestratedVirtual Machine Scale Set Termination Notification - Unique
Id string - The Unique ID for the Orchestrated Virtual Machine Scale Set.
- Zone
Balance bool - Zones string
- A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.
- Automatic
Instance OrchestratedRepair Virtual Machine Scale Set Automatic Instance Repair Args - Boot
Diagnostics OrchestratedVirtual Machine Scale Set Boot Diagnostics Args - Data
Disks []OrchestratedVirtual Machine Scale Set Data Disk Args - Encryption
At boolHost Enabled - Eviction
Policy string - Extensions
[]Orchestrated
Virtual Machine Scale Set Extension Args - 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. The default value is 90 minutes (PT1H30M).
- Identity
Orchestrated
Virtual Machine Scale Set Identity Args - Instances int
- The number of Virtual Machines in the Orcestrated Virtual Machine Scale Set.
- License
Type string - Location string
- The Azure location where the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- Max
Bid float64Price - Name string
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- Network
Interfaces []OrchestratedVirtual Machine Scale Set Network Interface Args - Os
Disk OrchestratedVirtual Machine Scale Set Os Disk Args - Os
Profile OrchestratedVirtual Machine Scale Set Os Profile Args - Plan
Orchestrated
Virtual Machine Scale Set Plan Args - Platform
Fault intDomain Count - Specifies the number of fault domains that are used by this Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- Priority string
- Proximity
Placement stringGroup Id - The ID of the Proximity Placement Group which the Orchestrated 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 Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- Sku
Name string - Source
Image stringId - Source
Image OrchestratedReference Virtual Machine Scale Set Source Image Reference Args - A
source_image_referenceblock as defined below. - map[string]string
- A mapping of tags which should be assigned to this Orchestrated Virtual Machine Scale Set.
- Termination
Notification OrchestratedVirtual Machine Scale Set Termination Notification Args - Unique
Id string - The Unique ID for the Orchestrated Virtual Machine Scale Set.
- Zone
Balance bool - Zones string
- A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.
- automatic
Instance OrchestratedRepair Virtual Machine Scale Set Automatic Instance Repair - boot
Diagnostics OrchestratedVirtual Machine Scale Set Boot Diagnostics - data
Disks List<OrchestratedVirtual Machine Scale Set Data Disk> - encryption
At BooleanHost Enabled - eviction
Policy String - extensions
List<Orchestrated
Virtual Machine Scale Set Extension> - 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. The default value is 90 minutes (PT1H30M).
- identity
Orchestrated
Virtual Machine Scale Set Identity - instances Integer
- The number of Virtual Machines in the Orcestrated Virtual Machine Scale Set.
- license
Type String - location String
- The Azure location where the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- max
Bid DoublePrice - name String
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- network
Interfaces List<OrchestratedVirtual Machine Scale Set Network Interface> - os
Disk OrchestratedVirtual Machine Scale Set Os Disk - os
Profile OrchestratedVirtual Machine Scale Set Os Profile - plan
Orchestrated
Virtual Machine Scale Set Plan - platform
Fault IntegerDomain Count - Specifies the number of fault domains that are used by this Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- priority String
- proximity
Placement StringGroup Id - The ID of the Proximity Placement Group which the Orchestrated 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 Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- sku
Name String - source
Image StringId - source
Image OrchestratedReference Virtual Machine Scale Set Source Image Reference - A
source_image_referenceblock as defined below. - Map<String,String>
- A mapping of tags which should be assigned to this Orchestrated Virtual Machine Scale Set.
- termination
Notification OrchestratedVirtual Machine Scale Set Termination Notification - unique
Id String - The Unique ID for the Orchestrated Virtual Machine Scale Set.
- zone
Balance Boolean - zones String
- A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.
- automatic
Instance OrchestratedRepair Virtual Machine Scale Set Automatic Instance Repair - boot
Diagnostics OrchestratedVirtual Machine Scale Set Boot Diagnostics - data
Disks OrchestratedVirtual Machine Scale Set Data Disk[] - encryption
At booleanHost Enabled - eviction
Policy string - extensions
Orchestrated
Virtual Machine Scale Set Extension[] - 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. The default value is 90 minutes (PT1H30M).
- identity
Orchestrated
Virtual Machine Scale Set Identity - instances number
- The number of Virtual Machines in the Orcestrated Virtual Machine Scale Set.
- license
Type string - location string
- The Azure location where the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- max
Bid numberPrice - name string
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- network
Interfaces OrchestratedVirtual Machine Scale Set Network Interface[] - os
Disk OrchestratedVirtual Machine Scale Set Os Disk - os
Profile OrchestratedVirtual Machine Scale Set Os Profile - plan
Orchestrated
Virtual Machine Scale Set Plan - platform
Fault numberDomain Count - Specifies the number of fault domains that are used by this Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- priority string
- proximity
Placement stringGroup Id - The ID of the Proximity Placement Group which the Orchestrated 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 Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- sku
Name string - source
Image stringId - source
Image OrchestratedReference Virtual Machine Scale Set Source Image Reference - A
source_image_referenceblock as defined below. - {[key: string]: string}
- A mapping of tags which should be assigned to this Orchestrated Virtual Machine Scale Set.
- termination
Notification OrchestratedVirtual Machine Scale Set Termination Notification - unique
Id string - The Unique ID for the Orchestrated Virtual Machine Scale Set.
- zone
Balance boolean - zones string
- A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.
- automatic_
instance_ Orchestratedrepair Virtual Machine Scale Set Automatic Instance Repair Args - boot_
diagnostics OrchestratedVirtual Machine Scale Set Boot Diagnostics Args - data_
disks Sequence[OrchestratedVirtual Machine Scale Set Data Disk Args] - encryption_
at_ boolhost_ enabled - eviction_
policy str - extensions
Sequence[Orchestrated
Virtual Machine Scale Set Extension Args] - 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. The default value is 90 minutes (PT1H30M).
- identity
Orchestrated
Virtual Machine Scale Set Identity Args - instances int
- The number of Virtual Machines in the Orcestrated Virtual Machine Scale Set.
- license_
type str - location str
- The Azure location where the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- max_
bid_ floatprice - name str
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- network_
interfaces Sequence[OrchestratedVirtual Machine Scale Set Network Interface Args] - os_
disk OrchestratedVirtual Machine Scale Set Os Disk Args - os_
profile OrchestratedVirtual Machine Scale Set Os Profile Args - plan
Orchestrated
Virtual Machine Scale Set Plan Args - platform_
fault_ intdomain_ count - Specifies the number of fault domains that are used by this Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- priority str
- proximity_
placement_ strgroup_ id - The ID of the Proximity Placement Group which the Orchestrated 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 Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- sku_
name str - source_
image_ strid - source_
image_ Orchestratedreference Virtual Machine Scale Set Source Image Reference Args - A
source_image_referenceblock as defined below. - Mapping[str, str]
- A mapping of tags which should be assigned to this Orchestrated Virtual Machine Scale Set.
- termination_
notification OrchestratedVirtual Machine Scale Set Termination Notification Args - unique_
id str - The Unique ID for the Orchestrated Virtual Machine Scale Set.
- zone_
balance bool - zones str
- A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.
- automatic
Instance Property MapRepair - boot
Diagnostics Property Map - data
Disks List<Property Map> - encryption
At BooleanHost Enabled - eviction
Policy String - extensions List<Property Map>
- 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. The default value is 90 minutes (PT1H30M).
- identity Property Map
- instances Number
- The number of Virtual Machines in the Orcestrated Virtual Machine Scale Set.
- license
Type String - location String
- The Azure location where the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- max
Bid NumberPrice - name String
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- network
Interfaces List<Property Map> - os
Disk Property Map - os
Profile Property Map - plan Property Map
- platform
Fault NumberDomain Count - Specifies the number of fault domains that are used by this Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- priority String
- proximity
Placement StringGroup Id - The ID of the Proximity Placement Group which the Orchestrated 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 Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- sku
Name String - source
Image StringId - source
Image Property MapReference - A
source_image_referenceblock as defined below. - Map<String>
- A mapping of tags which should be assigned to this Orchestrated Virtual Machine Scale Set.
- termination
Notification Property Map - unique
Id String - The Unique ID for the Orchestrated Virtual Machine Scale Set.
- zone
Balance Boolean - zones String
- A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.
Supporting Types
OrchestratedVirtualMachineScaleSetAutomaticInstanceRepair, OrchestratedVirtualMachineScaleSetAutomaticInstanceRepairArgs
- Enabled bool
- Grace
Period string
- Enabled bool
- Grace
Period string
- enabled Boolean
- grace
Period String
- enabled boolean
- grace
Period string
- enabled bool
- grace_
period str
- enabled Boolean
- grace
Period String
OrchestratedVirtualMachineScaleSetBootDiagnostics, OrchestratedVirtualMachineScaleSetBootDiagnosticsArgs
- Storage
Account stringUri
- Storage
Account stringUri
- storage
Account StringUri
- storage
Account stringUri
- storage
Account StringUri
OrchestratedVirtualMachineScaleSetDataDisk, OrchestratedVirtualMachineScaleSetDataDiskArgs
- Caching string
- Disk
Size intGb - Lun int
- Storage
Account stringType - Create
Option string - Disk
Encryption stringSet Id - Disk
Iops intRead Write - Disk
Mbps intRead Write - Ultra
Ssd intDisk Iops Read Write - Ultra
Ssd intDisk Mbps Read Write - Write
Accelerator boolEnabled
- Caching string
- Disk
Size intGb - Lun int
- Storage
Account stringType - Create
Option string - Disk
Encryption stringSet Id - Disk
Iops intRead Write - Disk
Mbps intRead Write - Ultra
Ssd intDisk Iops Read Write - Ultra
Ssd intDisk Mbps Read Write - Write
Accelerator boolEnabled
- caching String
- disk
Size IntegerGb - lun Integer
- storage
Account StringType - create
Option String - disk
Encryption StringSet Id - disk
Iops IntegerRead Write - disk
Mbps IntegerRead Write - ultra
Ssd IntegerDisk Iops Read Write - ultra
Ssd IntegerDisk Mbps Read Write - write
Accelerator BooleanEnabled
- caching string
- disk
Size numberGb - lun number
- storage
Account stringType - create
Option string - disk
Encryption stringSet Id - disk
Iops numberRead Write - disk
Mbps numberRead Write - ultra
Ssd numberDisk Iops Read Write - ultra
Ssd numberDisk Mbps Read Write - write
Accelerator booleanEnabled
- caching String
- disk
Size NumberGb - lun Number
- storage
Account StringType - create
Option String - disk
Encryption StringSet Id - disk
Iops NumberRead Write - disk
Mbps NumberRead Write - ultra
Ssd NumberDisk Iops Read Write - ultra
Ssd NumberDisk Mbps Read Write - write
Accelerator BooleanEnabled
OrchestratedVirtualMachineScaleSetExtension, OrchestratedVirtualMachineScaleSetExtensionArgs
- Name string
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- Publisher string
- Type string
- Type
Handler stringVersion - Auto
Upgrade boolMinor Version Enabled - Extensions
To List<string>Provision After Vm Creations - An ordered list of Extension names which Orchestrated Virtual Machine Scale Set should provision after VM creation.
- Force
Extension stringExecution On Change - Protected
Settings string - Settings string
- Name string
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- Publisher string
- Type string
- Type
Handler stringVersion - Auto
Upgrade boolMinor Version Enabled - Extensions
To []stringProvision After Vm Creations - An ordered list of Extension names which Orchestrated Virtual Machine Scale Set should provision after VM creation.
- Force
Extension stringExecution On Change - Protected
Settings string - Settings string
- name String
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- publisher String
- type String
- type
Handler StringVersion - auto
Upgrade BooleanMinor Version Enabled - extensions
To List<String>Provision After Vm Creations - An ordered list of Extension names which Orchestrated Virtual Machine Scale Set should provision after VM creation.
- force
Extension StringExecution On Change - protected
Settings String - settings String
- name string
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- publisher string
- type string
- type
Handler stringVersion - auto
Upgrade booleanMinor Version Enabled - extensions
To string[]Provision After Vm Creations - An ordered list of Extension names which Orchestrated Virtual Machine Scale Set should provision after VM creation.
- force
Extension stringExecution On Change - protected
Settings string - settings string
- name str
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- publisher str
- type str
- type_
handler_ strversion - auto_
upgrade_ boolminor_ version_ enabled - extensions_
to_ Sequence[str]provision_ after_ vm_ creations - An ordered list of Extension names which Orchestrated Virtual Machine Scale Set should provision after VM creation.
- force_
extension_ strexecution_ on_ change - protected_
settings str - settings str
- name String
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- publisher String
- type String
- type
Handler StringVersion - auto
Upgrade BooleanMinor Version Enabled - extensions
To List<String>Provision After Vm Creations - An ordered list of Extension names which Orchestrated Virtual Machine Scale Set should provision after VM creation.
- force
Extension StringExecution On Change - protected
Settings String - settings String
OrchestratedVirtualMachineScaleSetIdentity, OrchestratedVirtualMachineScaleSetIdentityArgs
- Identity
Ids List<string> - Type string
- Identity
Ids []string - Type string
- identity
Ids List<String> - type String
- identity
Ids string[] - type string
- identity_
ids Sequence[str] - type str
- identity
Ids List<String> - type String
OrchestratedVirtualMachineScaleSetNetworkInterface, OrchestratedVirtualMachineScaleSetNetworkInterfaceArgs
- Ip
Configurations List<OrchestratedVirtual Machine Scale Set Network Interface Ip Configuration> - Name string
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- Dns
Servers List<string> - Enable
Accelerated boolNetworking - Enable
Ip boolForwarding - Network
Security stringGroup Id - Primary bool
- Ip
Configurations []OrchestratedVirtual Machine Scale Set Network Interface Ip Configuration - Name string
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- Dns
Servers []string - Enable
Accelerated boolNetworking - Enable
Ip boolForwarding - Network
Security stringGroup Id - Primary bool
- ip
Configurations List<OrchestratedVirtual Machine Scale Set Network Interface Ip Configuration> - name String
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- dns
Servers List<String> - enable
Accelerated BooleanNetworking - enable
Ip BooleanForwarding - network
Security StringGroup Id - primary Boolean
- ip
Configurations OrchestratedVirtual Machine Scale Set Network Interface Ip Configuration[] - name string
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- dns
Servers string[] - enable
Accelerated booleanNetworking - enable
Ip booleanForwarding - network
Security stringGroup Id - primary boolean
- ip_
configurations Sequence[OrchestratedVirtual Machine Scale Set Network Interface Ip Configuration] - name str
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- dns_
servers Sequence[str] - enable_
accelerated_ boolnetworking - enable_
ip_ boolforwarding - network_
security_ strgroup_ id - primary bool
- ip
Configurations List<Property Map> - name String
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- dns
Servers List<String> - enable
Accelerated BooleanNetworking - enable
Ip BooleanForwarding - network
Security StringGroup Id - primary Boolean
OrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfiguration, OrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationArgs
- Name string
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- Application
Gateway List<string>Backend Address Pool Ids - Application
Security List<string>Group Ids - Load
Balancer List<string>Backend Address Pool Ids - Primary bool
- Public
Ip List<OrchestratedAddresses Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address> - Subnet
Id string - Version string
- Name string
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- Application
Gateway []stringBackend Address Pool Ids - Application
Security []stringGroup Ids - Load
Balancer []stringBackend Address Pool Ids - Primary bool
- Public
Ip []OrchestratedAddresses Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address - Subnet
Id string - Version string
- name String
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- application
Gateway List<String>Backend Address Pool Ids - application
Security List<String>Group Ids - load
Balancer List<String>Backend Address Pool Ids - primary Boolean
- public
Ip List<OrchestratedAddresses Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address> - subnet
Id String - version String
- name string
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- application
Gateway string[]Backend Address Pool Ids - application
Security string[]Group Ids - load
Balancer string[]Backend Address Pool Ids - primary boolean
- public
Ip OrchestratedAddresses Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address[] - subnet
Id string - version string
- name str
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- application_
gateway_ Sequence[str]backend_ address_ pool_ ids - application_
security_ Sequence[str]group_ ids - load_
balancer_ Sequence[str]backend_ address_ pool_ ids - primary bool
- public_
ip_ Sequence[Orchestratedaddresses Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address] - subnet_
id str - version str
- name String
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- application
Gateway List<String>Backend Address Pool Ids - application
Security List<String>Group Ids - load
Balancer List<String>Backend Address Pool Ids - primary Boolean
- public
Ip List<Property Map>Addresses - subnet
Id String - version String
OrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress, OrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressArgs
- Name string
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- Domain
Name stringLabel - Idle
Timeout intIn Minutes -
List<Orchestrated
Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address Ip Tag> - Public
Ip stringPrefix Id
- Name string
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- Domain
Name stringLabel - Idle
Timeout intIn Minutes -
[]Orchestrated
Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address Ip Tag - Public
Ip stringPrefix Id
- name String
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- domain
Name StringLabel - idle
Timeout IntegerIn Minutes -
List<Orchestrated
Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address Ip Tag> - public
Ip StringPrefix Id
- name string
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- domain
Name stringLabel - idle
Timeout numberIn Minutes -
Orchestrated
Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address Ip Tag[] - public
Ip stringPrefix Id
- name str
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- domain_
name_ strlabel - idle_
timeout_ intin_ minutes -
Sequence[Orchestrated
Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address Ip Tag] - public_
ip_ strprefix_ id
- name String
- The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.
- domain
Name StringLabel - idle
Timeout NumberIn Minutes - List<Property Map>
- public
Ip StringPrefix Id
OrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTag, OrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTagArgs
OrchestratedVirtualMachineScaleSetOsDisk, OrchestratedVirtualMachineScaleSetOsDiskArgs
- caching String
- storage
Account StringType - diff
Disk OrchestratedSettings Virtual Machine Scale Set Os Disk Diff Disk Settings - disk
Encryption StringSet Id - disk
Size IntegerGb - write
Accelerator BooleanEnabled
- caching String
- storage
Account StringType - diff
Disk Property MapSettings - disk
Encryption StringSet Id - disk
Size NumberGb - write
Accelerator BooleanEnabled
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.
- 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.
- 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.
- 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.
- 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.
- 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.
OrchestratedVirtualMachineScaleSetOsProfile, OrchestratedVirtualMachineScaleSetOsProfileArgs
OrchestratedVirtualMachineScaleSetOsProfileLinuxConfiguration, OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationArgs
- Admin
Username string - Admin
Password string - Admin
Ssh List<OrchestratedKeys Virtual Machine Scale Set Os Profile Linux Configuration Admin Ssh Key> - Computer
Name stringPrefix - Disable
Password boolAuthentication - When an
admin_passwordis specifieddisable_password_authenticationmust be set tofalse. Defaults totrue. - Patch
Mode string - Specifies the mode of in-guest patching of this Windows Virtual Machine. Possible values are
ImageDefaultorAutomaticByPlatform. Defaults toImageDefault. For more informaton on patch modes please see the product documentation. - Provision
Vm boolAgent - Secrets
List<Orchestrated
Virtual Machine Scale Set Os Profile Linux Configuration Secret>
- Admin
Username string - Admin
Password string - Admin
Ssh []OrchestratedKeys Virtual Machine Scale Set Os Profile Linux Configuration Admin Ssh Key - Computer
Name stringPrefix - Disable
Password boolAuthentication - When an
admin_passwordis specifieddisable_password_authenticationmust be set tofalse. Defaults totrue. - Patch
Mode string - Specifies the mode of in-guest patching of this Windows Virtual Machine. Possible values are
ImageDefaultorAutomaticByPlatform. Defaults toImageDefault. For more informaton on patch modes please see the product documentation. - Provision
Vm boolAgent - Secrets
[]Orchestrated
Virtual Machine Scale Set Os Profile Linux Configuration Secret
- admin
Username String - admin
Password String - admin
Ssh List<OrchestratedKeys Virtual Machine Scale Set Os Profile Linux Configuration Admin Ssh Key> - computer
Name StringPrefix - disable
Password BooleanAuthentication - When an
admin_passwordis specifieddisable_password_authenticationmust be set tofalse. Defaults totrue. - patch
Mode String - Specifies the mode of in-guest patching of this Windows Virtual Machine. Possible values are
ImageDefaultorAutomaticByPlatform. Defaults toImageDefault. For more informaton on patch modes please see the product documentation. - provision
Vm BooleanAgent - secrets
List<Orchestrated
Virtual Machine Scale Set Os Profile Linux Configuration Secret>
- admin
Username string - admin
Password string - admin
Ssh OrchestratedKeys Virtual Machine Scale Set Os Profile Linux Configuration Admin Ssh Key[] - computer
Name stringPrefix - disable
Password booleanAuthentication - When an
admin_passwordis specifieddisable_password_authenticationmust be set tofalse. Defaults totrue. - patch
Mode string - Specifies the mode of in-guest patching of this Windows Virtual Machine. Possible values are
ImageDefaultorAutomaticByPlatform. Defaults toImageDefault. For more informaton on patch modes please see the product documentation. - provision
Vm booleanAgent - secrets
Orchestrated
Virtual Machine Scale Set Os Profile Linux Configuration Secret[]
- admin_
username str - admin_
password str - admin_
ssh_ Sequence[Orchestratedkeys Virtual Machine Scale Set Os Profile Linux Configuration Admin Ssh Key] - computer_
name_ strprefix - disable_
password_ boolauthentication - When an
admin_passwordis specifieddisable_password_authenticationmust be set tofalse. Defaults totrue. - patch_
mode str - Specifies the mode of in-guest patching of this Windows Virtual Machine. Possible values are
ImageDefaultorAutomaticByPlatform. Defaults toImageDefault. For more informaton on patch modes please see the product documentation. - provision_
vm_ boolagent - secrets
Sequence[Orchestrated
Virtual Machine Scale Set Os Profile Linux Configuration Secret]
- admin
Username String - admin
Password String - admin
Ssh List<Property Map>Keys - computer
Name StringPrefix - disable
Password BooleanAuthentication - When an
admin_passwordis specifieddisable_password_authenticationmust be set tofalse. Defaults totrue. - patch
Mode String - Specifies the mode of in-guest patching of this Windows Virtual Machine. Possible values are
ImageDefaultorAutomaticByPlatform. Defaults toImageDefault. For more informaton on patch modes please see the product documentation. - provision
Vm BooleanAgent - secrets List<Property Map>
OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationAdminSshKey, OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationAdminSshKeyArgs
- Public
Key string - The Public Key which should be used for authentication, which needs to be at least 2048-bit and in ssh-rsa format. Changing this forces a new resource to be created.
- Username string
- The Username for which this Public SSH Key should be configured. Changing this forces a new resource to be created.
- Public
Key string - The Public Key which should be used for authentication, which needs to be at least 2048-bit and in ssh-rsa format. Changing this forces a new resource to be created.
- Username string
- The Username for which this Public SSH Key should be configured. Changing this forces a new resource to be created.
- public
Key String - The Public Key which should be used for authentication, which needs to be at least 2048-bit and in ssh-rsa format. Changing this forces a new resource to be created.
- username String
- The Username for which this Public SSH Key should be configured. Changing this forces a new resource to be created.
- public
Key string - The Public Key which should be used for authentication, which needs to be at least 2048-bit and in ssh-rsa format. Changing this forces a new resource to be created.
- username string
- The Username for which this Public SSH Key should be configured. Changing this forces a new resource to be created.
- public_
key str - The Public Key which should be used for authentication, which needs to be at least 2048-bit and in ssh-rsa format. Changing this forces a new resource to be created.
- username str
- The Username for which this Public SSH Key should be configured. Changing this forces a new resource to be created.
- public
Key String - The Public Key which should be used for authentication, which needs to be at least 2048-bit and in ssh-rsa format. Changing this forces a new resource to be created.
- username String
- The Username for which this Public SSH Key should be configured. Changing this forces a new resource to be created.
OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationSecret, OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationSecretArgs
OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationSecretCertificate, OrchestratedVirtualMachineScaleSetOsProfileLinuxConfigurationSecretCertificateArgs
- Url string
- The Secret URL of a Key Vault Certificate.
- Url string
- The Secret URL of a Key Vault Certificate.
- url String
- The Secret URL of a Key Vault Certificate.
- url string
- The Secret URL of a Key Vault Certificate.
- url str
- The Secret URL of a Key Vault Certificate.
- url String
- The Secret URL of a Key Vault Certificate.
OrchestratedVirtualMachineScaleSetOsProfileWindowsConfiguration, OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationArgs
- Admin
Password string - Admin
Username string - Computer
Name stringPrefix - Enable
Automatic boolUpdates - Hotpatching
Enabled bool - Should the VM be patched without requiring a reboot? Possible values are
trueorfalse. Defaults tofalse. For more information about hot patching please see the product documentation. - Patch
Mode string - Specifies the mode of in-guest patching of this Windows Virtual Machine. Possible values are
Manual,AutomaticByOSandAutomaticByPlatform. Defaults toAutomaticByOS. For more informaton on patch modes please see the product documentation. - Provision
Vm boolAgent - Secrets
List<Orchestrated
Virtual Machine Scale Set Os Profile Windows Configuration Secret> - Timezone string
- Winrm
Listeners List<OrchestratedVirtual Machine Scale Set Os Profile Windows Configuration Winrm Listener>
- Admin
Password string - Admin
Username string - Computer
Name stringPrefix - Enable
Automatic boolUpdates - Hotpatching
Enabled bool - Should the VM be patched without requiring a reboot? Possible values are
trueorfalse. Defaults tofalse. For more information about hot patching please see the product documentation. - Patch
Mode string - Specifies the mode of in-guest patching of this Windows Virtual Machine. Possible values are
Manual,AutomaticByOSandAutomaticByPlatform. Defaults toAutomaticByOS. For more informaton on patch modes please see the product documentation. - Provision
Vm boolAgent - Secrets
[]Orchestrated
Virtual Machine Scale Set Os Profile Windows Configuration Secret - Timezone string
- Winrm
Listeners []OrchestratedVirtual Machine Scale Set Os Profile Windows Configuration Winrm Listener
- admin
Password String - admin
Username String - computer
Name StringPrefix - enable
Automatic BooleanUpdates - hotpatching
Enabled Boolean - Should the VM be patched without requiring a reboot? Possible values are
trueorfalse. Defaults tofalse. For more information about hot patching please see the product documentation. - patch
Mode String - Specifies the mode of in-guest patching of this Windows Virtual Machine. Possible values are
Manual,AutomaticByOSandAutomaticByPlatform. Defaults toAutomaticByOS. For more informaton on patch modes please see the product documentation. - provision
Vm BooleanAgent - secrets
List<Orchestrated
Virtual Machine Scale Set Os Profile Windows Configuration Secret> - timezone String
- winrm
Listeners List<OrchestratedVirtual Machine Scale Set Os Profile Windows Configuration Winrm Listener>
- admin
Password string - admin
Username string - computer
Name stringPrefix - enable
Automatic booleanUpdates - hotpatching
Enabled boolean - Should the VM be patched without requiring a reboot? Possible values are
trueorfalse. Defaults tofalse. For more information about hot patching please see the product documentation. - patch
Mode string - Specifies the mode of in-guest patching of this Windows Virtual Machine. Possible values are
Manual,AutomaticByOSandAutomaticByPlatform. Defaults toAutomaticByOS. For more informaton on patch modes please see the product documentation. - provision
Vm booleanAgent - secrets
Orchestrated
Virtual Machine Scale Set Os Profile Windows Configuration Secret[] - timezone string
- winrm
Listeners OrchestratedVirtual Machine Scale Set Os Profile Windows Configuration Winrm Listener[]
- admin_
password str - admin_
username str - computer_
name_ strprefix - enable_
automatic_ boolupdates - hotpatching_
enabled bool - Should the VM be patched without requiring a reboot? Possible values are
trueorfalse. Defaults tofalse. For more information about hot patching please see the product documentation. - patch_
mode str - Specifies the mode of in-guest patching of this Windows Virtual Machine. Possible values are
Manual,AutomaticByOSandAutomaticByPlatform. Defaults toAutomaticByOS. For more informaton on patch modes please see the product documentation. - provision_
vm_ boolagent - secrets
Sequence[Orchestrated
Virtual Machine Scale Set Os Profile Windows Configuration Secret] - timezone str
- winrm_
listeners Sequence[OrchestratedVirtual Machine Scale Set Os Profile Windows Configuration Winrm Listener]
- admin
Password String - admin
Username String - computer
Name StringPrefix - enable
Automatic BooleanUpdates - hotpatching
Enabled Boolean - Should the VM be patched without requiring a reboot? Possible values are
trueorfalse. Defaults tofalse. For more information about hot patching please see the product documentation. - patch
Mode String - Specifies the mode of in-guest patching of this Windows Virtual Machine. Possible values are
Manual,AutomaticByOSandAutomaticByPlatform. Defaults toAutomaticByOS. For more informaton on patch modes please see the product documentation. - provision
Vm BooleanAgent - secrets List<Property Map>
- timezone String
- winrm
Listeners List<Property Map>
OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationSecret, OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationSecretArgs
OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationSecretCertificate, OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationSecretCertificateArgs
OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationWinrmListener, OrchestratedVirtualMachineScaleSetOsProfileWindowsConfigurationWinrmListenerArgs
- Protocol string
- Certificate
Url string
- Protocol string
- Certificate
Url string
- protocol String
- certificate
Url String
- protocol string
- certificate
Url string
- protocol str
- certificate_
url str
- protocol String
- certificate
Url String
OrchestratedVirtualMachineScaleSetPlan, OrchestratedVirtualMachineScaleSetPlanArgs
OrchestratedVirtualMachineScaleSetSourceImageReference, OrchestratedVirtualMachineScaleSetSourceImageReferenceArgs
OrchestratedVirtualMachineScaleSetTerminationNotification, OrchestratedVirtualMachineScaleSetTerminationNotificationArgs
Import
An Orchestrated 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/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
azurermTerraform Provider.
We recommend using Azure Native.
published on Monday, Mar 9, 2026 by Pulumi
