1. Packages
  2. Azure Classic
  3. API Docs
  4. compute
  5. AvailabilitySet

We recommend using Azure Native.

Azure Classic v5.58.0 published on Saturday, Dec 2, 2023 by Pulumi

azure.compute.AvailabilitySet

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.58.0 published on Saturday, Dec 2, 2023 by Pulumi

    Manages an Availability Set for Virtual Machines.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
        {
            Location = "West Europe",
        });
    
        var exampleAvailabilitySet = new Azure.Compute.AvailabilitySet("exampleAvailabilitySet", new()
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            Tags = 
            {
                { "environment", "Production" },
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/compute"
    	"github.com/pulumi/pulumi-azure/sdk/v5/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.NewAvailabilitySet(ctx, "exampleAvailabilitySet", &compute.AvailabilitySetArgs{
    			Location:          exampleResourceGroup.Location,
    			ResourceGroupName: exampleResourceGroup.Name,
    			Tags: pulumi.StringMap{
    				"environment": pulumi.String("Production"),
    			},
    		})
    		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.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.compute.AvailabilitySet;
    import com.pulumi.azure.compute.AvailabilitySetArgs;
    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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
                .location("West Europe")
                .build());
    
            var exampleAvailabilitySet = new AvailabilitySet("exampleAvailabilitySet", AvailabilitySetArgs.builder()        
                .location(exampleResourceGroup.location())
                .resourceGroupName(exampleResourceGroup.name())
                .tags(Map.of("environment", "Production"))
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure as azure
    
    example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
    example_availability_set = azure.compute.AvailabilitySet("exampleAvailabilitySet",
        location=example_resource_group.location,
        resource_group_name=example_resource_group.name,
        tags={
            "environment": "Production",
        })
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
    const exampleAvailabilitySet = new azure.compute.AvailabilitySet("exampleAvailabilitySet", {
        location: exampleResourceGroup.location,
        resourceGroupName: exampleResourceGroup.name,
        tags: {
            environment: "Production",
        },
    });
    
    resources:
      exampleResourceGroup:
        type: azure:core:ResourceGroup
        properties:
          location: West Europe
      exampleAvailabilitySet:
        type: azure:compute:AvailabilitySet
        properties:
          location: ${exampleResourceGroup.location}
          resourceGroupName: ${exampleResourceGroup.name}
          tags:
            environment: Production
    

    Create AvailabilitySet Resource

    new AvailabilitySet(name: string, args: AvailabilitySetArgs, opts?: CustomResourceOptions);
    @overload
    def AvailabilitySet(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        location: Optional[str] = None,
                        managed: Optional[bool] = None,
                        name: Optional[str] = None,
                        platform_fault_domain_count: Optional[int] = None,
                        platform_update_domain_count: Optional[int] = None,
                        proximity_placement_group_id: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        tags: Optional[Mapping[str, str]] = None)
    @overload
    def AvailabilitySet(resource_name: str,
                        args: AvailabilitySetArgs,
                        opts: Optional[ResourceOptions] = None)
    func NewAvailabilitySet(ctx *Context, name string, args AvailabilitySetArgs, opts ...ResourceOption) (*AvailabilitySet, error)
    public AvailabilitySet(string name, AvailabilitySetArgs args, CustomResourceOptions? opts = null)
    public AvailabilitySet(String name, AvailabilitySetArgs args)
    public AvailabilitySet(String name, AvailabilitySetArgs args, CustomResourceOptions options)
    
    type: azure:compute:AvailabilitySet
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args AvailabilitySetArgs
    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 AvailabilitySetArgs
    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 AvailabilitySetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AvailabilitySetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AvailabilitySetArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    AvailabilitySet Resource Properties

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

    Inputs

    The AvailabilitySet resource accepts the following input properties:

    ResourceGroupName string

    The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.

    Location string

    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

    Managed bool

    Specifies whether the availability set is managed or not. Possible values are true (to specify aligned) or false (to specify classic). Default is true. Changing this forces a new resource to be created.

    Name string

    Specifies the name of the availability set. Changing this forces a new resource to be created.

    PlatformFaultDomainCount int

    Specifies the number of fault domains that are used. Defaults to 3. Changing this forces a new resource to be created.

    NOTE: The number of Fault Domains varies depending on which Azure Region you're using - a list can be found here.

    PlatformUpdateDomainCount int

    Specifies the number of update domains that are used. Defaults to 5. Changing this forces a new resource to be created.

    NOTE: The number of Update Domains varies depending on which Azure Region you're using - a list can be found here.

    ProximityPlacementGroupId string

    The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created.

    Tags Dictionary<string, string>

    A mapping of tags to assign to the resource.

    ResourceGroupName string

    The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.

    Location string

    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

    Managed bool

    Specifies whether the availability set is managed or not. Possible values are true (to specify aligned) or false (to specify classic). Default is true. Changing this forces a new resource to be created.

    Name string

    Specifies the name of the availability set. Changing this forces a new resource to be created.

    PlatformFaultDomainCount int

    Specifies the number of fault domains that are used. Defaults to 3. Changing this forces a new resource to be created.

    NOTE: The number of Fault Domains varies depending on which Azure Region you're using - a list can be found here.

    PlatformUpdateDomainCount int

    Specifies the number of update domains that are used. Defaults to 5. Changing this forces a new resource to be created.

    NOTE: The number of Update Domains varies depending on which Azure Region you're using - a list can be found here.

    ProximityPlacementGroupId string

    The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created.

    Tags map[string]string

    A mapping of tags to assign to the resource.

    resourceGroupName String

    The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.

    location String

    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

    managed Boolean

    Specifies whether the availability set is managed or not. Possible values are true (to specify aligned) or false (to specify classic). Default is true. Changing this forces a new resource to be created.

    name String

    Specifies the name of the availability set. Changing this forces a new resource to be created.

    platformFaultDomainCount Integer

    Specifies the number of fault domains that are used. Defaults to 3. Changing this forces a new resource to be created.

    NOTE: The number of Fault Domains varies depending on which Azure Region you're using - a list can be found here.

    platformUpdateDomainCount Integer

    Specifies the number of update domains that are used. Defaults to 5. Changing this forces a new resource to be created.

    NOTE: The number of Update Domains varies depending on which Azure Region you're using - a list can be found here.

    proximityPlacementGroupId String

    The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created.

    tags Map<String,String>

    A mapping of tags to assign to the resource.

    resourceGroupName string

    The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.

    location string

    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

    managed boolean

    Specifies whether the availability set is managed or not. Possible values are true (to specify aligned) or false (to specify classic). Default is true. Changing this forces a new resource to be created.

    name string

    Specifies the name of the availability set. Changing this forces a new resource to be created.

    platformFaultDomainCount number

    Specifies the number of fault domains that are used. Defaults to 3. Changing this forces a new resource to be created.

    NOTE: The number of Fault Domains varies depending on which Azure Region you're using - a list can be found here.

    platformUpdateDomainCount number

    Specifies the number of update domains that are used. Defaults to 5. Changing this forces a new resource to be created.

    NOTE: The number of Update Domains varies depending on which Azure Region you're using - a list can be found here.

    proximityPlacementGroupId string

    The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created.

    tags {[key: string]: string}

    A mapping of tags to assign to the resource.

    resource_group_name str

    The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.

    location str

    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

    managed bool

    Specifies whether the availability set is managed or not. Possible values are true (to specify aligned) or false (to specify classic). Default is true. Changing this forces a new resource to be created.

    name str

    Specifies the name of the availability set. Changing this forces a new resource to be created.

    platform_fault_domain_count int

    Specifies the number of fault domains that are used. Defaults to 3. Changing this forces a new resource to be created.

    NOTE: The number of Fault Domains varies depending on which Azure Region you're using - a list can be found here.

    platform_update_domain_count int

    Specifies the number of update domains that are used. Defaults to 5. Changing this forces a new resource to be created.

    NOTE: The number of Update Domains varies depending on which Azure Region you're using - a list can be found here.

    proximity_placement_group_id str

    The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created.

    tags Mapping[str, str]

    A mapping of tags to assign to the resource.

    resourceGroupName String

    The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.

    location String

    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

    managed Boolean

    Specifies whether the availability set is managed or not. Possible values are true (to specify aligned) or false (to specify classic). Default is true. Changing this forces a new resource to be created.

    name String

    Specifies the name of the availability set. Changing this forces a new resource to be created.

    platformFaultDomainCount Number

    Specifies the number of fault domains that are used. Defaults to 3. Changing this forces a new resource to be created.

    NOTE: The number of Fault Domains varies depending on which Azure Region you're using - a list can be found here.

    platformUpdateDomainCount Number

    Specifies the number of update domains that are used. Defaults to 5. Changing this forces a new resource to be created.

    NOTE: The number of Update Domains varies depending on which Azure Region you're using - a list can be found here.

    proximityPlacementGroupId String

    The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created.

    tags Map<String>

    A mapping of tags to assign to the resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AvailabilitySet 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 AvailabilitySet Resource

    Get an existing AvailabilitySet 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?: AvailabilitySetState, opts?: CustomResourceOptions): AvailabilitySet
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            location: Optional[str] = None,
            managed: Optional[bool] = None,
            name: Optional[str] = None,
            platform_fault_domain_count: Optional[int] = None,
            platform_update_domain_count: Optional[int] = None,
            proximity_placement_group_id: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None) -> AvailabilitySet
    func GetAvailabilitySet(ctx *Context, name string, id IDInput, state *AvailabilitySetState, opts ...ResourceOption) (*AvailabilitySet, error)
    public static AvailabilitySet Get(string name, Input<string> id, AvailabilitySetState? state, CustomResourceOptions? opts = null)
    public static AvailabilitySet get(String name, Output<String> id, AvailabilitySetState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Location string

    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

    Managed bool

    Specifies whether the availability set is managed or not. Possible values are true (to specify aligned) or false (to specify classic). Default is true. Changing this forces a new resource to be created.

    Name string

    Specifies the name of the availability set. Changing this forces a new resource to be created.

    PlatformFaultDomainCount int

    Specifies the number of fault domains that are used. Defaults to 3. Changing this forces a new resource to be created.

    NOTE: The number of Fault Domains varies depending on which Azure Region you're using - a list can be found here.

    PlatformUpdateDomainCount int

    Specifies the number of update domains that are used. Defaults to 5. Changing this forces a new resource to be created.

    NOTE: The number of Update Domains varies depending on which Azure Region you're using - a list can be found here.

    ProximityPlacementGroupId string

    The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created.

    ResourceGroupName string

    The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.

    Tags Dictionary<string, string>

    A mapping of tags to assign to the resource.

    Location string

    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

    Managed bool

    Specifies whether the availability set is managed or not. Possible values are true (to specify aligned) or false (to specify classic). Default is true. Changing this forces a new resource to be created.

    Name string

    Specifies the name of the availability set. Changing this forces a new resource to be created.

    PlatformFaultDomainCount int

    Specifies the number of fault domains that are used. Defaults to 3. Changing this forces a new resource to be created.

    NOTE: The number of Fault Domains varies depending on which Azure Region you're using - a list can be found here.

    PlatformUpdateDomainCount int

    Specifies the number of update domains that are used. Defaults to 5. Changing this forces a new resource to be created.

    NOTE: The number of Update Domains varies depending on which Azure Region you're using - a list can be found here.

    ProximityPlacementGroupId string

    The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created.

    ResourceGroupName string

    The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.

    Tags map[string]string

    A mapping of tags to assign to the resource.

    location String

    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

    managed Boolean

    Specifies whether the availability set is managed or not. Possible values are true (to specify aligned) or false (to specify classic). Default is true. Changing this forces a new resource to be created.

    name String

    Specifies the name of the availability set. Changing this forces a new resource to be created.

    platformFaultDomainCount Integer

    Specifies the number of fault domains that are used. Defaults to 3. Changing this forces a new resource to be created.

    NOTE: The number of Fault Domains varies depending on which Azure Region you're using - a list can be found here.

    platformUpdateDomainCount Integer

    Specifies the number of update domains that are used. Defaults to 5. Changing this forces a new resource to be created.

    NOTE: The number of Update Domains varies depending on which Azure Region you're using - a list can be found here.

    proximityPlacementGroupId String

    The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created.

    resourceGroupName String

    The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.

    tags Map<String,String>

    A mapping of tags to assign to the resource.

    location string

    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

    managed boolean

    Specifies whether the availability set is managed or not. Possible values are true (to specify aligned) or false (to specify classic). Default is true. Changing this forces a new resource to be created.

    name string

    Specifies the name of the availability set. Changing this forces a new resource to be created.

    platformFaultDomainCount number

    Specifies the number of fault domains that are used. Defaults to 3. Changing this forces a new resource to be created.

    NOTE: The number of Fault Domains varies depending on which Azure Region you're using - a list can be found here.

    platformUpdateDomainCount number

    Specifies the number of update domains that are used. Defaults to 5. Changing this forces a new resource to be created.

    NOTE: The number of Update Domains varies depending on which Azure Region you're using - a list can be found here.

    proximityPlacementGroupId string

    The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created.

    resourceGroupName string

    The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.

    tags {[key: string]: string}

    A mapping of tags to assign to the resource.

    location str

    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

    managed bool

    Specifies whether the availability set is managed or not. Possible values are true (to specify aligned) or false (to specify classic). Default is true. Changing this forces a new resource to be created.

    name str

    Specifies the name of the availability set. Changing this forces a new resource to be created.

    platform_fault_domain_count int

    Specifies the number of fault domains that are used. Defaults to 3. Changing this forces a new resource to be created.

    NOTE: The number of Fault Domains varies depending on which Azure Region you're using - a list can be found here.

    platform_update_domain_count int

    Specifies the number of update domains that are used. Defaults to 5. Changing this forces a new resource to be created.

    NOTE: The number of Update Domains varies depending on which Azure Region you're using - a list can be found here.

    proximity_placement_group_id str

    The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created.

    resource_group_name str

    The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.

    tags Mapping[str, str]

    A mapping of tags to assign to the resource.

    location String

    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

    managed Boolean

    Specifies whether the availability set is managed or not. Possible values are true (to specify aligned) or false (to specify classic). Default is true. Changing this forces a new resource to be created.

    name String

    Specifies the name of the availability set. Changing this forces a new resource to be created.

    platformFaultDomainCount Number

    Specifies the number of fault domains that are used. Defaults to 3. Changing this forces a new resource to be created.

    NOTE: The number of Fault Domains varies depending on which Azure Region you're using - a list can be found here.

    platformUpdateDomainCount Number

    Specifies the number of update domains that are used. Defaults to 5. Changing this forces a new resource to be created.

    NOTE: The number of Update Domains varies depending on which Azure Region you're using - a list can be found here.

    proximityPlacementGroupId String

    The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created.

    resourceGroupName String

    The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.

    tags Map<String>

    A mapping of tags to assign to the resource.

    Import

    Availability Sets can be imported using the resource id, e.g.

     $ pulumi import azure:compute/availabilitySet:AvailabilitySet group1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Compute/availabilitySets/webAvailSet
    

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the azurerm Terraform Provider.

    azure logo

    We recommend using Azure Native.

    Azure Classic v5.58.0 published on Saturday, Dec 2, 2023 by Pulumi