1. Packages
  2. Azure Native
  3. API Docs
  4. compute
  5. getAvailabilitySet
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.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native.compute.getAvailabilitySet

Explore with Pulumi AI

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.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Retrieves information about an availability set.

Uses Azure REST API version 2023-03-01.

Other available API versions: 2023-07-01, 2023-09-01, 2024-03-01, 2024-07-01, 2024-11-01.

Using getAvailabilitySet

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAvailabilitySet(args: GetAvailabilitySetArgs, opts?: InvokeOptions): Promise<GetAvailabilitySetResult>
function getAvailabilitySetOutput(args: GetAvailabilitySetOutputArgs, opts?: InvokeOptions): Output<GetAvailabilitySetResult>
Copy
def get_availability_set(availability_set_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetAvailabilitySetResult
def get_availability_set_output(availability_set_name: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetAvailabilitySetResult]
Copy
func LookupAvailabilitySet(ctx *Context, args *LookupAvailabilitySetArgs, opts ...InvokeOption) (*LookupAvailabilitySetResult, error)
func LookupAvailabilitySetOutput(ctx *Context, args *LookupAvailabilitySetOutputArgs, opts ...InvokeOption) LookupAvailabilitySetResultOutput
Copy

> Note: This function is named LookupAvailabilitySet in the Go SDK.

public static class GetAvailabilitySet 
{
    public static Task<GetAvailabilitySetResult> InvokeAsync(GetAvailabilitySetArgs args, InvokeOptions? opts = null)
    public static Output<GetAvailabilitySetResult> Invoke(GetAvailabilitySetInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAvailabilitySetResult> getAvailabilitySet(GetAvailabilitySetArgs args, InvokeOptions options)
public static Output<GetAvailabilitySetResult> getAvailabilitySet(GetAvailabilitySetArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:compute:getAvailabilitySet
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AvailabilitySetName
This property is required.
Changes to this property will trigger replacement.
string
The name of the availability set.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
AvailabilitySetName
This property is required.
Changes to this property will trigger replacement.
string
The name of the availability set.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
availabilitySetName
This property is required.
Changes to this property will trigger replacement.
String
The name of the availability set.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
availabilitySetName
This property is required.
Changes to this property will trigger replacement.
string
The name of the availability set.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
availability_set_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the availability set.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
availabilitySetName
This property is required.
Changes to this property will trigger replacement.
String
The name of the availability set.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.

getAvailabilitySet Result

The following output properties are available:

Id string
Resource Id
Location string
Resource location
Name string
Resource name
Statuses List<Pulumi.AzureNative.Compute.Outputs.InstanceViewStatusResponse>
The resource status information.
Type string
Resource type
PlatformFaultDomainCount int
Fault Domain count.
PlatformUpdateDomainCount int
Update Domain count.
ProximityPlacementGroup Pulumi.AzureNative.Compute.Outputs.SubResourceResponse
Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01.
Sku Pulumi.AzureNative.Compute.Outputs.SkuResponse
Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'.
Tags Dictionary<string, string>
Resource tags
VirtualMachines List<Pulumi.AzureNative.Compute.Outputs.SubResourceResponse>
A list of references to all virtual machines in the availability set.
Id string
Resource Id
Location string
Resource location
Name string
Resource name
Statuses []InstanceViewStatusResponse
The resource status information.
Type string
Resource type
PlatformFaultDomainCount int
Fault Domain count.
PlatformUpdateDomainCount int
Update Domain count.
ProximityPlacementGroup SubResourceResponse
Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01.
Sku SkuResponse
Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'.
Tags map[string]string
Resource tags
VirtualMachines []SubResourceResponse
A list of references to all virtual machines in the availability set.
id String
Resource Id
location String
Resource location
name String
Resource name
statuses List<InstanceViewStatusResponse>
The resource status information.
type String
Resource type
platformFaultDomainCount Integer
Fault Domain count.
platformUpdateDomainCount Integer
Update Domain count.
proximityPlacementGroup SubResourceResponse
Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01.
sku SkuResponse
Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'.
tags Map<String,String>
Resource tags
virtualMachines List<SubResourceResponse>
A list of references to all virtual machines in the availability set.
id string
Resource Id
location string
Resource location
name string
Resource name
statuses InstanceViewStatusResponse[]
The resource status information.
type string
Resource type
platformFaultDomainCount number
Fault Domain count.
platformUpdateDomainCount number
Update Domain count.
proximityPlacementGroup SubResourceResponse
Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01.
sku SkuResponse
Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'.
tags {[key: string]: string}
Resource tags
virtualMachines SubResourceResponse[]
A list of references to all virtual machines in the availability set.
id str
Resource Id
location str
Resource location
name str
Resource name
statuses Sequence[InstanceViewStatusResponse]
The resource status information.
type str
Resource type
platform_fault_domain_count int
Fault Domain count.
platform_update_domain_count int
Update Domain count.
proximity_placement_group SubResourceResponse
Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01.
sku SkuResponse
Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'.
tags Mapping[str, str]
Resource tags
virtual_machines Sequence[SubResourceResponse]
A list of references to all virtual machines in the availability set.
id String
Resource Id
location String
Resource location
name String
Resource name
statuses List<Property Map>
The resource status information.
type String
Resource type
platformFaultDomainCount Number
Fault Domain count.
platformUpdateDomainCount Number
Update Domain count.
proximityPlacementGroup Property Map
Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01.
sku Property Map
Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'.
tags Map<String>
Resource tags
virtualMachines List<Property Map>
A list of references to all virtual machines in the availability set.

Supporting Types

InstanceViewStatusResponse

Code string
The status code.
DisplayStatus string
The short localizable label for the status.
Level string
The level code.
Message string
The detailed status message, including for alerts and error messages.
Time string
The time of the status.
Code string
The status code.
DisplayStatus string
The short localizable label for the status.
Level string
The level code.
Message string
The detailed status message, including for alerts and error messages.
Time string
The time of the status.
code String
The status code.
displayStatus String
The short localizable label for the status.
level String
The level code.
message String
The detailed status message, including for alerts and error messages.
time String
The time of the status.
code string
The status code.
displayStatus string
The short localizable label for the status.
level string
The level code.
message string
The detailed status message, including for alerts and error messages.
time string
The time of the status.
code str
The status code.
display_status str
The short localizable label for the status.
level str
The level code.
message str
The detailed status message, including for alerts and error messages.
time str
The time of the status.
code String
The status code.
displayStatus String
The short localizable label for the status.
level String
The level code.
message String
The detailed status message, including for alerts and error messages.
time String
The time of the status.

SkuResponse

Capacity double
Specifies the number of virtual machines in the scale set.
Name string
The sku name.
Tier string
Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic
Capacity float64
Specifies the number of virtual machines in the scale set.
Name string
The sku name.
Tier string
Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic
capacity Double
Specifies the number of virtual machines in the scale set.
name String
The sku name.
tier String
Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic
capacity number
Specifies the number of virtual machines in the scale set.
name string
The sku name.
tier string
Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic
capacity float
Specifies the number of virtual machines in the scale set.
name str
The sku name.
tier str
Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic
capacity Number
Specifies the number of virtual machines in the scale set.
name String
The sku name.
tier String
Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic

SubResourceResponse

Id string
Resource Id
Id string
Resource Id
id String
Resource Id
id string
Resource Id
id str
Resource Id
id String
Resource Id

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
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.90.0 published on Thursday, Mar 27, 2025 by Pulumi