We recommend using Azure Native.
azure.compute.AvailabilitySet
Explore with Pulumi AI
Manages an Availability Set for Virtual Machines.
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 exampleAvailabilitySet = new azure.compute.AvailabilitySet("example", {
name: "example-aset",
location: example.location,
resourceGroupName: example.name,
tags: {
environment: "Production",
},
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_availability_set = azure.compute.AvailabilitySet("example",
name="example-aset",
location=example.location,
resource_group_name=example.name,
tags={
"environment": "Production",
})
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/compute"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
_, err = compute.NewAvailabilitySet(ctx, "example", &compute.AvailabilitySetArgs{
Name: pulumi.String("example-aset"),
Location: example.Location,
ResourceGroupName: example.Name,
Tags: pulumi.StringMap{
"environment": pulumi.String("Production"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-resources",
Location = "West Europe",
});
var exampleAvailabilitySet = new Azure.Compute.AvailabilitySet("example", new()
{
Name = "example-aset",
Location = example.Location,
ResourceGroupName = example.Name,
Tags =
{
{ "environment", "Production" },
},
});
});
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-resources")
.location("West Europe")
.build());
var exampleAvailabilitySet = new AvailabilitySet("exampleAvailabilitySet", AvailabilitySetArgs.builder()
.name("example-aset")
.location(example.location())
.resourceGroupName(example.name())
.tags(Map.of("environment", "Production"))
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleAvailabilitySet:
type: azure:compute:AvailabilitySet
name: example
properties:
name: example-aset
location: ${example.location}
resourceGroupName: ${example.name}
tags:
environment: Production
Create AvailabilitySet Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AvailabilitySet(name: string, args: AvailabilitySetArgs, opts?: CustomResourceOptions);
@overload
def AvailabilitySet(resource_name: str,
args: AvailabilitySetArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AvailabilitySet(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = 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,
tags: Optional[Mapping[str, str]] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var availabilitySetResource = new Azure.Compute.AvailabilitySet("availabilitySetResource", new()
{
ResourceGroupName = "string",
Location = "string",
Managed = false,
Name = "string",
PlatformFaultDomainCount = 0,
PlatformUpdateDomainCount = 0,
ProximityPlacementGroupId = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := compute.NewAvailabilitySet(ctx, "availabilitySetResource", &compute.AvailabilitySetArgs{
ResourceGroupName: pulumi.String("string"),
Location: pulumi.String("string"),
Managed: pulumi.Bool(false),
Name: pulumi.String("string"),
PlatformFaultDomainCount: pulumi.Int(0),
PlatformUpdateDomainCount: pulumi.Int(0),
ProximityPlacementGroupId: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var availabilitySetResource = new AvailabilitySet("availabilitySetResource", AvailabilitySetArgs.builder()
.resourceGroupName("string")
.location("string")
.managed(false)
.name("string")
.platformFaultDomainCount(0)
.platformUpdateDomainCount(0)
.proximityPlacementGroupId("string")
.tags(Map.of("string", "string"))
.build());
availability_set_resource = azure.compute.AvailabilitySet("availabilitySetResource",
resource_group_name="string",
location="string",
managed=False,
name="string",
platform_fault_domain_count=0,
platform_update_domain_count=0,
proximity_placement_group_id="string",
tags={
"string": "string",
})
const availabilitySetResource = new azure.compute.AvailabilitySet("availabilitySetResource", {
resourceGroupName: "string",
location: "string",
managed: false,
name: "string",
platformFaultDomainCount: 0,
platformUpdateDomainCount: 0,
proximityPlacementGroupId: "string",
tags: {
string: "string",
},
});
type: azure:compute:AvailabilitySet
properties:
location: string
managed: false
name: string
platformFaultDomainCount: 0
platformUpdateDomainCount: 0
proximityPlacementGroupId: string
resourceGroupName: string
tags:
string: string
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:
- Resource
Group stringName - 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) orfalse
(to specify classic). Default istrue
. 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.
- Platform
Fault intDomain Count 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. More information about update and fault domains and how they work can be found here.
- Platform
Update intDomain Count 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. More information about update and fault domains and how they work can be found here.
- Proximity
Placement stringGroup Id - The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created.
- Dictionary<string, string>
- A mapping of tags to assign to the resource.
- Resource
Group stringName - 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) orfalse
(to specify classic). Default istrue
. 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.
- Platform
Fault intDomain Count 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. More information about update and fault domains and how they work can be found here.
- Platform
Update intDomain Count 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. More information about update and fault domains and how they work can be found here.
- Proximity
Placement stringGroup Id - The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created.
- map[string]string
- A mapping of tags to assign to the resource.
- resource
Group StringName - 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) orfalse
(to specify classic). Default istrue
. 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.
- platform
Fault IntegerDomain Count 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. More information about update and fault domains and how they work can be found here.
- platform
Update IntegerDomain Count 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. More information about update and fault domains and how they work can be found here.
- proximity
Placement StringGroup Id - The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created.
- Map<String,String>
- A mapping of tags to assign to the resource.
- resource
Group stringName - 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) orfalse
(to specify classic). Default istrue
. 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.
- platform
Fault numberDomain Count 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. More information about update and fault domains and how they work can be found here.
- platform
Update numberDomain Count 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. More information about update and fault domains and how they work can be found here.
- proximity
Placement stringGroup Id - The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created.
- {[key: string]: string}
- A mapping of tags to assign to the resource.
- resource_
group_ strname - 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) orfalse
(to specify classic). Default istrue
. 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_ intdomain_ count 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. More information about update and fault domains and how they work can be found here.
- platform_
update_ intdomain_ count 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. More information about update and fault domains and how they work can be found here.
- proximity_
placement_ strgroup_ id - The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created.
- Mapping[str, str]
- A mapping of tags to assign to the resource.
- resource
Group StringName - 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) orfalse
(to specify classic). Default istrue
. 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.
- platform
Fault NumberDomain Count 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. More information about update and fault domains and how they work can be found here.
- platform
Update NumberDomain Count 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. More information about update and fault domains and how they work can be found here.
- proximity
Placement StringGroup Id - The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created.
- 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.
- 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) orfalse
(to specify classic). Default istrue
. 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.
- Platform
Fault intDomain Count 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. More information about update and fault domains and how they work can be found here.
- Platform
Update intDomain Count 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. More information about update and fault domains and how they work can be found here.
- Proximity
Placement stringGroup Id - 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 stringName - The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.
- 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) orfalse
(to specify classic). Default istrue
. 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.
- Platform
Fault intDomain Count 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. More information about update and fault domains and how they work can be found here.
- Platform
Update intDomain Count 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. More information about update and fault domains and how they work can be found here.
- Proximity
Placement stringGroup Id - 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 stringName - The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.
- 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) orfalse
(to specify classic). Default istrue
. 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.
- platform
Fault IntegerDomain Count 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. More information about update and fault domains and how they work can be found here.
- platform
Update IntegerDomain Count 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. More information about update and fault domains and how they work can be found here.
- proximity
Placement StringGroup Id - 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 StringName - The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.
- 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) orfalse
(to specify classic). Default istrue
. 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.
- platform
Fault numberDomain Count 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. More information about update and fault domains and how they work can be found here.
- platform
Update numberDomain Count 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. More information about update and fault domains and how they work can be found here.
- proximity
Placement stringGroup Id - 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 stringName - The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.
- {[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) orfalse
(to specify classic). Default istrue
. 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_ intdomain_ count 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. More information about update and fault domains and how they work can be found here.
- platform_
update_ intdomain_ count 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. More information about update and fault domains and how they work can be found here.
- proximity_
placement_ strgroup_ id - 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_ strname - The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.
- 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) orfalse
(to specify classic). Default istrue
. 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.
- platform
Fault NumberDomain Count 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. More information about update and fault domains and how they work can be found here.
- platform
Update NumberDomain Count 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. More information about update and fault domains and how they work can be found here.
- proximity
Placement StringGroup Id - 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 StringName - The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.
- 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
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.