Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. compute
  5. ScaleSetStandbyPool

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.compute.ScaleSetStandbyPool

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages a Standby Pool for Virtual Machine Scale Sets.

NOTE : please follow the prerequisites mentioned in this article before using this resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleOrchestratedVirtualMachineScaleSet = new azure.compute.OrchestratedVirtualMachineScaleSet("example", {
    name: "example-ovmss",
    location: example.location,
    resourceGroupName: example.name,
    platformFaultDomainCount: 1,
    zones: ["1"],
});
const exampleScaleSetStandbyPool = new azure.compute.ScaleSetStandbyPool("example", {
    name: "example-spsvmp",
    resourceGroupName: example.name,
    location: "West Europe",
    attachedVirtualMachineScaleSetId: exampleOrchestratedVirtualMachineScaleSet.id,
    virtualMachineState: "Running",
    elasticityProfile: {
        maxReadyCapacity: 10,
        minReadyCapacity: 5,
    },
    tags: {
        key: "value",
    },
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_orchestrated_virtual_machine_scale_set = azure.compute.OrchestratedVirtualMachineScaleSet("example",
    name="example-ovmss",
    location=example.location,
    resource_group_name=example.name,
    platform_fault_domain_count=1,
    zones=["1"])
example_scale_set_standby_pool = azure.compute.ScaleSetStandbyPool("example",
    name="example-spsvmp",
    resource_group_name=example.name,
    location="West Europe",
    attached_virtual_machine_scale_set_id=example_orchestrated_virtual_machine_scale_set.id,
    virtual_machine_state="Running",
    elasticity_profile={
        "max_ready_capacity": 10,
        "min_ready_capacity": 5,
    },
    tags={
        "key": "value",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/compute"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleOrchestratedVirtualMachineScaleSet, err := compute.NewOrchestratedVirtualMachineScaleSet(ctx, "example", &compute.OrchestratedVirtualMachineScaleSetArgs{
			Name:                     pulumi.String("example-ovmss"),
			Location:                 example.Location,
			ResourceGroupName:        example.Name,
			PlatformFaultDomainCount: pulumi.Int(1),
			Zones: pulumi.StringArray{
				pulumi.String("1"),
			},
		})
		if err != nil {
			return err
		}
		_, err = compute.NewScaleSetStandbyPool(ctx, "example", &compute.ScaleSetStandbyPoolArgs{
			Name:                             pulumi.String("example-spsvmp"),
			ResourceGroupName:                example.Name,
			Location:                         pulumi.String("West Europe"),
			AttachedVirtualMachineScaleSetId: exampleOrchestratedVirtualMachineScaleSet.ID(),
			VirtualMachineState:              pulumi.String("Running"),
			ElasticityProfile: &compute.ScaleSetStandbyPoolElasticityProfileArgs{
				MaxReadyCapacity: pulumi.Int(10),
				MinReadyCapacity: pulumi.Int(5),
			},
			Tags: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleOrchestratedVirtualMachineScaleSet = new Azure.Compute.OrchestratedVirtualMachineScaleSet("example", new()
    {
        Name = "example-ovmss",
        Location = example.Location,
        ResourceGroupName = example.Name,
        PlatformFaultDomainCount = 1,
        Zones = new[]
        {
            "1",
        },
    });

    var exampleScaleSetStandbyPool = new Azure.Compute.ScaleSetStandbyPool("example", new()
    {
        Name = "example-spsvmp",
        ResourceGroupName = example.Name,
        Location = "West Europe",
        AttachedVirtualMachineScaleSetId = exampleOrchestratedVirtualMachineScaleSet.Id,
        VirtualMachineState = "Running",
        ElasticityProfile = new Azure.Compute.Inputs.ScaleSetStandbyPoolElasticityProfileArgs
        {
            MaxReadyCapacity = 10,
            MinReadyCapacity = 5,
        },
        Tags = 
        {
            { "key", "value" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.compute.OrchestratedVirtualMachineScaleSet;
import com.pulumi.azure.compute.OrchestratedVirtualMachineScaleSetArgs;
import com.pulumi.azure.compute.ScaleSetStandbyPool;
import com.pulumi.azure.compute.ScaleSetStandbyPoolArgs;
import com.pulumi.azure.compute.inputs.ScaleSetStandbyPoolElasticityProfileArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleOrchestratedVirtualMachineScaleSet = new OrchestratedVirtualMachineScaleSet("exampleOrchestratedVirtualMachineScaleSet", OrchestratedVirtualMachineScaleSetArgs.builder()
            .name("example-ovmss")
            .location(example.location())
            .resourceGroupName(example.name())
            .platformFaultDomainCount(1)
            .zones("1")
            .build());

        var exampleScaleSetStandbyPool = new ScaleSetStandbyPool("exampleScaleSetStandbyPool", ScaleSetStandbyPoolArgs.builder()
            .name("example-spsvmp")
            .resourceGroupName(example.name())
            .location("West Europe")
            .attachedVirtualMachineScaleSetId(exampleOrchestratedVirtualMachineScaleSet.id())
            .virtualMachineState("Running")
            .elasticityProfile(ScaleSetStandbyPoolElasticityProfileArgs.builder()
                .maxReadyCapacity(10)
                .minReadyCapacity(5)
                .build())
            .tags(Map.of("key", "value"))
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleOrchestratedVirtualMachineScaleSet:
    type: azure:compute:OrchestratedVirtualMachineScaleSet
    name: example
    properties:
      name: example-ovmss
      location: ${example.location}
      resourceGroupName: ${example.name}
      platformFaultDomainCount: 1
      zones:
        - '1'
  exampleScaleSetStandbyPool:
    type: azure:compute:ScaleSetStandbyPool
    name: example
    properties:
      name: example-spsvmp
      resourceGroupName: ${example.name}
      location: West Europe
      attachedVirtualMachineScaleSetId: ${exampleOrchestratedVirtualMachineScaleSet.id}
      virtualMachineState: Running
      elasticityProfile:
        maxReadyCapacity: 10
        minReadyCapacity: 5
      tags:
        key: value
Copy

Create ScaleSetStandbyPool Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ScaleSetStandbyPool(name: string, args: ScaleSetStandbyPoolArgs, opts?: CustomResourceOptions);
@overload
def ScaleSetStandbyPool(resource_name: str,
                        args: ScaleSetStandbyPoolArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def ScaleSetStandbyPool(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        attached_virtual_machine_scale_set_id: Optional[str] = None,
                        elasticity_profile: Optional[ScaleSetStandbyPoolElasticityProfileArgs] = None,
                        resource_group_name: Optional[str] = None,
                        virtual_machine_state: Optional[str] = None,
                        location: Optional[str] = None,
                        name: Optional[str] = None,
                        tags: Optional[Mapping[str, str]] = None)
func NewScaleSetStandbyPool(ctx *Context, name string, args ScaleSetStandbyPoolArgs, opts ...ResourceOption) (*ScaleSetStandbyPool, error)
public ScaleSetStandbyPool(string name, ScaleSetStandbyPoolArgs args, CustomResourceOptions? opts = null)
public ScaleSetStandbyPool(String name, ScaleSetStandbyPoolArgs args)
public ScaleSetStandbyPool(String name, ScaleSetStandbyPoolArgs args, CustomResourceOptions options)

type: azure:compute:ScaleSetStandbyPool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ScaleSetStandbyPoolArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ScaleSetStandbyPoolArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ScaleSetStandbyPoolArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ScaleSetStandbyPoolArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ScaleSetStandbyPoolArgs
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 scaleSetStandbyPoolResource = new Azure.Compute.ScaleSetStandbyPool("scaleSetStandbyPoolResource", new()
{
    AttachedVirtualMachineScaleSetId = "string",
    ElasticityProfile = new Azure.Compute.Inputs.ScaleSetStandbyPoolElasticityProfileArgs
    {
        MaxReadyCapacity = 0,
        MinReadyCapacity = 0,
    },
    ResourceGroupName = "string",
    VirtualMachineState = "string",
    Location = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := compute.NewScaleSetStandbyPool(ctx, "scaleSetStandbyPoolResource", &compute.ScaleSetStandbyPoolArgs{
	AttachedVirtualMachineScaleSetId: pulumi.String("string"),
	ElasticityProfile: &compute.ScaleSetStandbyPoolElasticityProfileArgs{
		MaxReadyCapacity: pulumi.Int(0),
		MinReadyCapacity: pulumi.Int(0),
	},
	ResourceGroupName:   pulumi.String("string"),
	VirtualMachineState: pulumi.String("string"),
	Location:            pulumi.String("string"),
	Name:                pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var scaleSetStandbyPoolResource = new ScaleSetStandbyPool("scaleSetStandbyPoolResource", ScaleSetStandbyPoolArgs.builder()
    .attachedVirtualMachineScaleSetId("string")
    .elasticityProfile(ScaleSetStandbyPoolElasticityProfileArgs.builder()
        .maxReadyCapacity(0)
        .minReadyCapacity(0)
        .build())
    .resourceGroupName("string")
    .virtualMachineState("string")
    .location("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
scale_set_standby_pool_resource = azure.compute.ScaleSetStandbyPool("scaleSetStandbyPoolResource",
    attached_virtual_machine_scale_set_id="string",
    elasticity_profile={
        "max_ready_capacity": 0,
        "min_ready_capacity": 0,
    },
    resource_group_name="string",
    virtual_machine_state="string",
    location="string",
    name="string",
    tags={
        "string": "string",
    })
Copy
const scaleSetStandbyPoolResource = new azure.compute.ScaleSetStandbyPool("scaleSetStandbyPoolResource", {
    attachedVirtualMachineScaleSetId: "string",
    elasticityProfile: {
        maxReadyCapacity: 0,
        minReadyCapacity: 0,
    },
    resourceGroupName: "string",
    virtualMachineState: "string",
    location: "string",
    name: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure:compute:ScaleSetStandbyPool
properties:
    attachedVirtualMachineScaleSetId: string
    elasticityProfile:
        maxReadyCapacity: 0
        minReadyCapacity: 0
    location: string
    name: string
    resourceGroupName: string
    tags:
        string: string
    virtualMachineState: string
Copy

ScaleSetStandbyPool 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 ScaleSetStandbyPool resource accepts the following input properties:

AttachedVirtualMachineScaleSetId This property is required. string
Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
ElasticityProfile This property is required. ScaleSetStandbyPoolElasticityProfile
An elasticity_profile block as defined below.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the Resource Group where the Standby Pool should exist. Changing this forces a new Standby Pool to be created.
VirtualMachineState This property is required. string
Specifies the desired state of virtual machines in the pool. Possible values are Running and Deallocated.
Location Changes to this property will trigger replacement. string
Specifies the Azure Region where the Standby Pool should exist. Changing this forces a new Standby Pool to be created.
Name Changes to this property will trigger replacement. string
Specifies the name which should be used for this Standby Pool. Changing this forces a new Standby Pool to be created.
Tags Dictionary<string, string>
A mapping of tags which should be assigned to the Standby Pool.
AttachedVirtualMachineScaleSetId This property is required. string
Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
ElasticityProfile This property is required. ScaleSetStandbyPoolElasticityProfileArgs
An elasticity_profile block as defined below.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the Resource Group where the Standby Pool should exist. Changing this forces a new Standby Pool to be created.
VirtualMachineState This property is required. string
Specifies the desired state of virtual machines in the pool. Possible values are Running and Deallocated.
Location Changes to this property will trigger replacement. string
Specifies the Azure Region where the Standby Pool should exist. Changing this forces a new Standby Pool to be created.
Name Changes to this property will trigger replacement. string
Specifies the name which should be used for this Standby Pool. Changing this forces a new Standby Pool to be created.
Tags map[string]string
A mapping of tags which should be assigned to the Standby Pool.
attachedVirtualMachineScaleSetId This property is required. String
Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
elasticityProfile This property is required. ScaleSetStandbyPoolElasticityProfile
An elasticity_profile block as defined below.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the name of the Resource Group where the Standby Pool should exist. Changing this forces a new Standby Pool to be created.
virtualMachineState This property is required. String
Specifies the desired state of virtual machines in the pool. Possible values are Running and Deallocated.
location Changes to this property will trigger replacement. String
Specifies the Azure Region where the Standby Pool should exist. Changing this forces a new Standby Pool to be created.
name Changes to this property will trigger replacement. String
Specifies the name which should be used for this Standby Pool. Changing this forces a new Standby Pool to be created.
tags Map<String,String>
A mapping of tags which should be assigned to the Standby Pool.
attachedVirtualMachineScaleSetId This property is required. string
Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
elasticityProfile This property is required. ScaleSetStandbyPoolElasticityProfile
An elasticity_profile block as defined below.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the Resource Group where the Standby Pool should exist. Changing this forces a new Standby Pool to be created.
virtualMachineState This property is required. string
Specifies the desired state of virtual machines in the pool. Possible values are Running and Deallocated.
location Changes to this property will trigger replacement. string
Specifies the Azure Region where the Standby Pool should exist. Changing this forces a new Standby Pool to be created.
name Changes to this property will trigger replacement. string
Specifies the name which should be used for this Standby Pool. Changing this forces a new Standby Pool to be created.
tags {[key: string]: string}
A mapping of tags which should be assigned to the Standby Pool.
attached_virtual_machine_scale_set_id This property is required. str
Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
elasticity_profile This property is required. ScaleSetStandbyPoolElasticityProfileArgs
An elasticity_profile block as defined below.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Specifies the name of the Resource Group where the Standby Pool should exist. Changing this forces a new Standby Pool to be created.
virtual_machine_state This property is required. str
Specifies the desired state of virtual machines in the pool. Possible values are Running and Deallocated.
location Changes to this property will trigger replacement. str
Specifies the Azure Region where the Standby Pool should exist. Changing this forces a new Standby Pool to be created.
name Changes to this property will trigger replacement. str
Specifies the name which should be used for this Standby Pool. Changing this forces a new Standby Pool to be created.
tags Mapping[str, str]
A mapping of tags which should be assigned to the Standby Pool.
attachedVirtualMachineScaleSetId This property is required. String
Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
elasticityProfile This property is required. Property Map
An elasticity_profile block as defined below.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the name of the Resource Group where the Standby Pool should exist. Changing this forces a new Standby Pool to be created.
virtualMachineState This property is required. String
Specifies the desired state of virtual machines in the pool. Possible values are Running and Deallocated.
location Changes to this property will trigger replacement. String
Specifies the Azure Region where the Standby Pool should exist. Changing this forces a new Standby Pool to be created.
name Changes to this property will trigger replacement. String
Specifies the name which should be used for this Standby Pool. Changing this forces a new Standby Pool to be created.
tags Map<String>
A mapping of tags which should be assigned to the Standby Pool.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing ScaleSetStandbyPool Resource

Get an existing ScaleSetStandbyPool 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?: ScaleSetStandbyPoolState, opts?: CustomResourceOptions): ScaleSetStandbyPool
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        attached_virtual_machine_scale_set_id: Optional[str] = None,
        elasticity_profile: Optional[ScaleSetStandbyPoolElasticityProfileArgs] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        virtual_machine_state: Optional[str] = None) -> ScaleSetStandbyPool
func GetScaleSetStandbyPool(ctx *Context, name string, id IDInput, state *ScaleSetStandbyPoolState, opts ...ResourceOption) (*ScaleSetStandbyPool, error)
public static ScaleSetStandbyPool Get(string name, Input<string> id, ScaleSetStandbyPoolState? state, CustomResourceOptions? opts = null)
public static ScaleSetStandbyPool get(String name, Output<String> id, ScaleSetStandbyPoolState state, CustomResourceOptions options)
resources:  _:    type: azure:compute:ScaleSetStandbyPool    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AttachedVirtualMachineScaleSetId string
Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
ElasticityProfile ScaleSetStandbyPoolElasticityProfile
An elasticity_profile block as defined below.
Location Changes to this property will trigger replacement. string
Specifies the Azure Region where the Standby Pool should exist. Changing this forces a new Standby Pool to be created.
Name Changes to this property will trigger replacement. string
Specifies the name which should be used for this Standby Pool. Changing this forces a new Standby Pool to be created.
ResourceGroupName Changes to this property will trigger replacement. string
Specifies the name of the Resource Group where the Standby Pool should exist. Changing this forces a new Standby Pool to be created.
Tags Dictionary<string, string>
A mapping of tags which should be assigned to the Standby Pool.
VirtualMachineState string
Specifies the desired state of virtual machines in the pool. Possible values are Running and Deallocated.
AttachedVirtualMachineScaleSetId string
Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
ElasticityProfile ScaleSetStandbyPoolElasticityProfileArgs
An elasticity_profile block as defined below.
Location Changes to this property will trigger replacement. string
Specifies the Azure Region where the Standby Pool should exist. Changing this forces a new Standby Pool to be created.
Name Changes to this property will trigger replacement. string
Specifies the name which should be used for this Standby Pool. Changing this forces a new Standby Pool to be created.
ResourceGroupName Changes to this property will trigger replacement. string
Specifies the name of the Resource Group where the Standby Pool should exist. Changing this forces a new Standby Pool to be created.
Tags map[string]string
A mapping of tags which should be assigned to the Standby Pool.
VirtualMachineState string
Specifies the desired state of virtual machines in the pool. Possible values are Running and Deallocated.
attachedVirtualMachineScaleSetId String
Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
elasticityProfile ScaleSetStandbyPoolElasticityProfile
An elasticity_profile block as defined below.
location Changes to this property will trigger replacement. String
Specifies the Azure Region where the Standby Pool should exist. Changing this forces a new Standby Pool to be created.
name Changes to this property will trigger replacement. String
Specifies the name which should be used for this Standby Pool. Changing this forces a new Standby Pool to be created.
resourceGroupName Changes to this property will trigger replacement. String
Specifies the name of the Resource Group where the Standby Pool should exist. Changing this forces a new Standby Pool to be created.
tags Map<String,String>
A mapping of tags which should be assigned to the Standby Pool.
virtualMachineState String
Specifies the desired state of virtual machines in the pool. Possible values are Running and Deallocated.
attachedVirtualMachineScaleSetId string
Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
elasticityProfile ScaleSetStandbyPoolElasticityProfile
An elasticity_profile block as defined below.
location Changes to this property will trigger replacement. string
Specifies the Azure Region where the Standby Pool should exist. Changing this forces a new Standby Pool to be created.
name Changes to this property will trigger replacement. string
Specifies the name which should be used for this Standby Pool. Changing this forces a new Standby Pool to be created.
resourceGroupName Changes to this property will trigger replacement. string
Specifies the name of the Resource Group where the Standby Pool should exist. Changing this forces a new Standby Pool to be created.
tags {[key: string]: string}
A mapping of tags which should be assigned to the Standby Pool.
virtualMachineState string
Specifies the desired state of virtual machines in the pool. Possible values are Running and Deallocated.
attached_virtual_machine_scale_set_id str
Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
elasticity_profile ScaleSetStandbyPoolElasticityProfileArgs
An elasticity_profile block as defined below.
location Changes to this property will trigger replacement. str
Specifies the Azure Region where the Standby Pool should exist. Changing this forces a new Standby Pool to be created.
name Changes to this property will trigger replacement. str
Specifies the name which should be used for this Standby Pool. Changing this forces a new Standby Pool to be created.
resource_group_name Changes to this property will trigger replacement. str
Specifies the name of the Resource Group where the Standby Pool should exist. Changing this forces a new Standby Pool to be created.
tags Mapping[str, str]
A mapping of tags which should be assigned to the Standby Pool.
virtual_machine_state str
Specifies the desired state of virtual machines in the pool. Possible values are Running and Deallocated.
attachedVirtualMachineScaleSetId String
Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
elasticityProfile Property Map
An elasticity_profile block as defined below.
location Changes to this property will trigger replacement. String
Specifies the Azure Region where the Standby Pool should exist. Changing this forces a new Standby Pool to be created.
name Changes to this property will trigger replacement. String
Specifies the name which should be used for this Standby Pool. Changing this forces a new Standby Pool to be created.
resourceGroupName Changes to this property will trigger replacement. String
Specifies the name of the Resource Group where the Standby Pool should exist. Changing this forces a new Standby Pool to be created.
tags Map<String>
A mapping of tags which should be assigned to the Standby Pool.
virtualMachineState String
Specifies the desired state of virtual machines in the pool. Possible values are Running and Deallocated.

Supporting Types

ScaleSetStandbyPoolElasticityProfile
, ScaleSetStandbyPoolElasticityProfileArgs

MaxReadyCapacity This property is required. int
Specifies the maximum number of virtual machines in the standby pool.
MinReadyCapacity This property is required. int

Specifies the desired minimum number of virtual machines in the standby pool.

NOTE min_ready_capacity cannot exceed max_ready_capacity.

MaxReadyCapacity This property is required. int
Specifies the maximum number of virtual machines in the standby pool.
MinReadyCapacity This property is required. int

Specifies the desired minimum number of virtual machines in the standby pool.

NOTE min_ready_capacity cannot exceed max_ready_capacity.

maxReadyCapacity This property is required. Integer
Specifies the maximum number of virtual machines in the standby pool.
minReadyCapacity This property is required. Integer

Specifies the desired minimum number of virtual machines in the standby pool.

NOTE min_ready_capacity cannot exceed max_ready_capacity.

maxReadyCapacity This property is required. number
Specifies the maximum number of virtual machines in the standby pool.
minReadyCapacity This property is required. number

Specifies the desired minimum number of virtual machines in the standby pool.

NOTE min_ready_capacity cannot exceed max_ready_capacity.

max_ready_capacity This property is required. int
Specifies the maximum number of virtual machines in the standby pool.
min_ready_capacity This property is required. int

Specifies the desired minimum number of virtual machines in the standby pool.

NOTE min_ready_capacity cannot exceed max_ready_capacity.

maxReadyCapacity This property is required. Number
Specifies the maximum number of virtual machines in the standby pool.
minReadyCapacity This property is required. Number

Specifies the desired minimum number of virtual machines in the standby pool.

NOTE min_ready_capacity cannot exceed max_ready_capacity.

Import

Standby Pool can be imported using the resource id, e.g.

$ pulumi import azure:compute/scaleSetStandbyPool:ScaleSetStandbyPool example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.StandbyPool/standbyVirtualMachinePools/standbyVirtualMachinePool1
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure