Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. standbypool
  5. StandbyVirtualMachinePool
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.standbypool.StandbyVirtualMachinePool

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    A StandbyVirtualMachinePoolResource. Azure REST API version: 2023-12-01-preview.

    Other available API versions: 2024-03-01, 2024-03-01-preview.

    Example Usage

    StandbyVirtualMachinePools_CreateOrUpdate

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var standbyVirtualMachinePool = new AzureNative.StandbyPool.StandbyVirtualMachinePool("standbyVirtualMachinePool", new()
    {
        AttachedVirtualMachineScaleSetId = "/subscriptions/8CC31D61-82D7-4B2B-B9DC-6B924DE7D229/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss",
        ElasticityProfile = new AzureNative.StandbyPool.Inputs.StandbyVirtualMachinePoolElasticityProfileArgs
        {
            MaxReadyCapacity = 304,
        },
        Location = "West US",
        ResourceGroupName = "rgstandbypool",
        StandbyVirtualMachinePoolName = "pool",
        Tags = null,
        VirtualMachineState = AzureNative.StandbyPool.VirtualMachineState.Running,
    });

});

    package main

import (
	standbypool "github.com/pulumi/pulumi-azure-native-sdk/standbypool/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := standbypool.NewStandbyVirtualMachinePool(ctx, "standbyVirtualMachinePool", &standbypool.StandbyVirtualMachinePoolArgs{
			AttachedVirtualMachineScaleSetId: pulumi.String("/subscriptions/8CC31D61-82D7-4B2B-B9DC-6B924DE7D229/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss"),
			ElasticityProfile: &standbypool.StandbyVirtualMachinePoolElasticityProfileArgs{
				MaxReadyCapacity: pulumi.Float64(304),
			},
			Location:                      pulumi.String("West US"),
			ResourceGroupName:             pulumi.String("rgstandbypool"),
			StandbyVirtualMachinePoolName: pulumi.String("pool"),
			Tags:                          pulumi.StringMap{},
			VirtualMachineState:           pulumi.String(standbypool.VirtualMachineStateRunning),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.standbypool.StandbyVirtualMachinePool;
import com.pulumi.azurenative.standbypool.StandbyVirtualMachinePoolArgs;
import com.pulumi.azurenative.standbypool.inputs.StandbyVirtualMachinePoolElasticityProfileArgs;
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 standbyVirtualMachinePool = new StandbyVirtualMachinePool("standbyVirtualMachinePool", StandbyVirtualMachinePoolArgs.builder()
            .attachedVirtualMachineScaleSetId("/subscriptions/8CC31D61-82D7-4B2B-B9DC-6B924DE7D229/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss")
            .elasticityProfile(StandbyVirtualMachinePoolElasticityProfileArgs.builder()
                .maxReadyCapacity(304)
                .build())
            .location("West US")
            .resourceGroupName("rgstandbypool")
            .standbyVirtualMachinePoolName("pool")
            .tags()
            .virtualMachineState("Running")
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const standbyVirtualMachinePool = new azure_native.standbypool.StandbyVirtualMachinePool("standbyVirtualMachinePool", {
    attachedVirtualMachineScaleSetId: "/subscriptions/8CC31D61-82D7-4B2B-B9DC-6B924DE7D229/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss",
    elasticityProfile: {
        maxReadyCapacity: 304,
    },
    location: "West US",
    resourceGroupName: "rgstandbypool",
    standbyVirtualMachinePoolName: "pool",
    tags: {},
    virtualMachineState: azure_native.standbypool.VirtualMachineState.Running,
});

    import pulumi
import pulumi_azure_native as azure_native

standby_virtual_machine_pool = azure_native.standbypool.StandbyVirtualMachinePool("standbyVirtualMachinePool",
    attached_virtual_machine_scale_set_id="/subscriptions/8CC31D61-82D7-4B2B-B9DC-6B924DE7D229/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss",
    elasticity_profile={
        "max_ready_capacity": 304,
    },
    location="West US",
    resource_group_name="rgstandbypool",
    standby_virtual_machine_pool_name="pool",
    tags={},
    virtual_machine_state=azure_native.standbypool.VirtualMachineState.RUNNING)

    resources:
  standbyVirtualMachinePool:
    type: azure-native:standbypool:StandbyVirtualMachinePool
    properties:
      attachedVirtualMachineScaleSetId: /subscriptions/8CC31D61-82D7-4B2B-B9DC-6B924DE7D229/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss
      elasticityProfile:
        maxReadyCapacity: 304
      location: West US
      resourceGroupName: rgstandbypool
      standbyVirtualMachinePoolName: pool
      tags: {}
      virtualMachineState: Running

    Create StandbyVirtualMachinePool Resource

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

    Constructor syntax

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

@overload
def StandbyVirtualMachinePool(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              resource_group_name: Optional[str] = None,
                              virtual_machine_state: Optional[Union[str, VirtualMachineState]] = None,
                              attached_virtual_machine_scale_set_id: Optional[str] = None,
                              elasticity_profile: Optional[StandbyVirtualMachinePoolElasticityProfileArgs] = None,
                              location: Optional[str] = None,
                              standby_virtual_machine_pool_name: Optional[str] = None,
                              tags: Optional[Mapping[str, str]] = None)
    func NewStandbyVirtualMachinePool(ctx *Context, name string, args StandbyVirtualMachinePoolArgs, opts ...ResourceOption) (*StandbyVirtualMachinePool, error)
    public StandbyVirtualMachinePool(string name, StandbyVirtualMachinePoolArgs args, CustomResourceOptions? opts = null)
    public StandbyVirtualMachinePool(String name, StandbyVirtualMachinePoolArgs args)
public StandbyVirtualMachinePool(String name, StandbyVirtualMachinePoolArgs args, CustomResourceOptions options)

    type: azure-native:standbypool:StandbyVirtualMachinePool
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 StandbyVirtualMachinePoolArgs
    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 StandbyVirtualMachinePoolArgs
    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 StandbyVirtualMachinePoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StandbyVirtualMachinePoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StandbyVirtualMachinePoolArgs
    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 standbyVirtualMachinePoolResource = new AzureNative.StandbyPool.StandbyVirtualMachinePool("standbyVirtualMachinePoolResource", new()
{
    ResourceGroupName = "string",
    VirtualMachineState = "string",
    AttachedVirtualMachineScaleSetId = "string",
    ElasticityProfile = new AzureNative.StandbyPool.Inputs.StandbyVirtualMachinePoolElasticityProfileArgs
    {
        MaxReadyCapacity = 0,
    },
    Location = "string",
    StandbyVirtualMachinePoolName = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := standbypool.NewStandbyVirtualMachinePool(ctx, "standbyVirtualMachinePoolResource", &standbypool.StandbyVirtualMachinePoolArgs{
	ResourceGroupName:                pulumi.String("string"),
	VirtualMachineState:              pulumi.String("string"),
	AttachedVirtualMachineScaleSetId: pulumi.String("string"),
	ElasticityProfile: &standbypool.StandbyVirtualMachinePoolElasticityProfileArgs{
		MaxReadyCapacity: pulumi.Float64(0),
	},
	Location:                      pulumi.String("string"),
	StandbyVirtualMachinePoolName: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var standbyVirtualMachinePoolResource = new StandbyVirtualMachinePool("standbyVirtualMachinePoolResource", StandbyVirtualMachinePoolArgs.builder()
    .resourceGroupName("string")
    .virtualMachineState("string")
    .attachedVirtualMachineScaleSetId("string")
    .elasticityProfile(StandbyVirtualMachinePoolElasticityProfileArgs.builder()
        .maxReadyCapacity(0)
        .build())
    .location("string")
    .standbyVirtualMachinePoolName("string")
    .tags(Map.of("string", "string"))
    .build());

    standby_virtual_machine_pool_resource = azure_native.standbypool.StandbyVirtualMachinePool("standbyVirtualMachinePoolResource",
    resource_group_name="string",
    virtual_machine_state="string",
    attached_virtual_machine_scale_set_id="string",
    elasticity_profile={
        "max_ready_capacity": 0,
    },
    location="string",
    standby_virtual_machine_pool_name="string",
    tags={
        "string": "string",
    })

    const standbyVirtualMachinePoolResource = new azure_native.standbypool.StandbyVirtualMachinePool("standbyVirtualMachinePoolResource", {
    resourceGroupName: "string",
    virtualMachineState: "string",
    attachedVirtualMachineScaleSetId: "string",
    elasticityProfile: {
        maxReadyCapacity: 0,
    },
    location: "string",
    standbyVirtualMachinePoolName: "string",
    tags: {
        string: "string",
    },
});

    type: azure-native:standbypool:StandbyVirtualMachinePool
properties:
    attachedVirtualMachineScaleSetId: string
    elasticityProfile:
        maxReadyCapacity: 0
    location: string
    resourceGroupName: string
    standbyVirtualMachinePoolName: string
    tags:
        string: string
    virtualMachineState: string

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

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    VirtualMachineState string | Pulumi.AzureNative.StandbyPool.VirtualMachineState
    Specifies the desired state of virtual machines in the pool.
    AttachedVirtualMachineScaleSetId string
    Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
    ElasticityProfile Pulumi.AzureNative.StandbyPool.Inputs.StandbyVirtualMachinePoolElasticityProfile
    Specifies the elasticity profile of the standby virtual machine pools.
    Location string
    The geo-location where the resource lives
    StandbyVirtualMachinePoolName string
    Name of the standby virtual machine pool
    Tags Dictionary<string, string>
    Resource tags.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    VirtualMachineState string | VirtualMachineState
    Specifies the desired state of virtual machines in the pool.
    AttachedVirtualMachineScaleSetId string
    Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
    ElasticityProfile StandbyVirtualMachinePoolElasticityProfileArgs
    Specifies the elasticity profile of the standby virtual machine pools.
    Location string
    The geo-location where the resource lives
    StandbyVirtualMachinePoolName string
    Name of the standby virtual machine pool
    Tags map[string]string
    Resource tags.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    virtualMachineState String | VirtualMachineState
    Specifies the desired state of virtual machines in the pool.
    attachedVirtualMachineScaleSetId String
    Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
    elasticityProfile StandbyVirtualMachinePoolElasticityProfile
    Specifies the elasticity profile of the standby virtual machine pools.
    location String
    The geo-location where the resource lives
    standbyVirtualMachinePoolName String
    Name of the standby virtual machine pool
    tags Map<String,String>
    Resource tags.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    virtualMachineState string | VirtualMachineState
    Specifies the desired state of virtual machines in the pool.
    attachedVirtualMachineScaleSetId string
    Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
    elasticityProfile StandbyVirtualMachinePoolElasticityProfile
    Specifies the elasticity profile of the standby virtual machine pools.
    location string
    The geo-location where the resource lives
    standbyVirtualMachinePoolName string
    Name of the standby virtual machine pool
    tags {[key: string]: string}
    Resource tags.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    virtual_machine_state str | VirtualMachineState
    Specifies the desired state of virtual machines in the pool.
    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 StandbyVirtualMachinePoolElasticityProfileArgs
    Specifies the elasticity profile of the standby virtual machine pools.
    location str
    The geo-location where the resource lives
    standby_virtual_machine_pool_name str
    Name of the standby virtual machine pool
    tags Mapping[str, str]
    Resource tags.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    virtualMachineState String | "Running" | "Deallocated"
    Specifies the desired state of virtual machines in the pool.
    attachedVirtualMachineScaleSetId String
    Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
    elasticityProfile Property Map
    Specifies the elasticity profile of the standby virtual machine pools.
    location String
    The geo-location where the resource lives
    standbyVirtualMachinePoolName String
    Name of the standby virtual machine pool
    tags Map<String>
    Resource tags.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    The status of the last operation.
    SystemData Pulumi.AzureNative.StandbyPool.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    The status of the last operation.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    The status of the last operation.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    provisioningState string
    The status of the last operation.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    provisioning_state str
    The status of the last operation.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    The status of the last operation.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    StandbyVirtualMachinePoolElasticityProfile, StandbyVirtualMachinePoolElasticityProfileArgs

    MaxReadyCapacity double
    Specifies the maximum number of virtual machines in the standby virtual machine pool.
    MaxReadyCapacity float64
    Specifies the maximum number of virtual machines in the standby virtual machine pool.
    maxReadyCapacity Double
    Specifies the maximum number of virtual machines in the standby virtual machine pool.
    maxReadyCapacity number
    Specifies the maximum number of virtual machines in the standby virtual machine pool.
    max_ready_capacity float
    Specifies the maximum number of virtual machines in the standby virtual machine pool.
    maxReadyCapacity Number
    Specifies the maximum number of virtual machines in the standby virtual machine pool.

    StandbyVirtualMachinePoolElasticityProfileResponse, StandbyVirtualMachinePoolElasticityProfileResponseArgs

    MaxReadyCapacity double
    Specifies the maximum number of virtual machines in the standby virtual machine pool.
    MaxReadyCapacity float64
    Specifies the maximum number of virtual machines in the standby virtual machine pool.
    maxReadyCapacity Double
    Specifies the maximum number of virtual machines in the standby virtual machine pool.
    maxReadyCapacity number
    Specifies the maximum number of virtual machines in the standby virtual machine pool.
    max_ready_capacity float
    Specifies the maximum number of virtual machines in the standby virtual machine pool.
    maxReadyCapacity Number
    Specifies the maximum number of virtual machines in the standby virtual machine pool.

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    VirtualMachineState, VirtualMachineStateArgs

    Running
    RunningThe virtual machine is up and running.
    Deallocated
    DeallocatedThe virtual machine has released the lease on the underlying hardware and is powered off.
    VirtualMachineStateRunning
    RunningThe virtual machine is up and running.
    VirtualMachineStateDeallocated
    DeallocatedThe virtual machine has released the lease on the underlying hardware and is powered off.
    Running
    RunningThe virtual machine is up and running.
    Deallocated
    DeallocatedThe virtual machine has released the lease on the underlying hardware and is powered off.
    Running
    RunningThe virtual machine is up and running.
    Deallocated
    DeallocatedThe virtual machine has released the lease on the underlying hardware and is powered off.
    RUNNING
    RunningThe virtual machine is up and running.
    DEALLOCATED
    DeallocatedThe virtual machine has released the lease on the underlying hardware and is powered off.
    "Running"
    RunningThe virtual machine is up and running.
    "Deallocated"
    DeallocatedThe virtual machine has released the lease on the underlying hardware and is powered off.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:standbypool:StandbyVirtualMachinePool pool /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyVirtualMachinePools/{standbyVirtualMachinePoolName}

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native