1. Packages
  2. Azure Native
  3. API Docs
  4. compute
  5. getAvailabilitySet
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi

azure-native.compute.getAvailabilitySet

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi

    Retrieves information about an availability set.

    Uses Azure REST API version 2024-11-01.

    Other available API versions: 2022-08-01, 2022-11-01, 2023-03-01, 2023-07-01, 2023-09-01, 2024-03-01, 2024-07-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native compute [ApiVersion]. See the version guide for details.

    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>
    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]
    func LookupAvailabilitySet(ctx *Context, args *LookupAvailabilitySetArgs, opts ...InvokeOption) (*LookupAvailabilitySetResult, error)
    func LookupAvailabilitySetOutput(ctx *Context, args *LookupAvailabilitySetOutputArgs, opts ...InvokeOption) LookupAvailabilitySetResultOutput

    > 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)
    }
    public static CompletableFuture<GetAvailabilitySetResult> getAvailabilitySet(GetAvailabilitySetArgs args, InvokeOptions options)
    public static Output<GetAvailabilitySetResult> getAvailabilitySet(GetAvailabilitySetArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:compute:getAvailabilitySet
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AvailabilitySetName string
    The name of the availability set.
    ResourceGroupName string
    The name of the resource group.
    AvailabilitySetName string
    The name of the availability set.
    ResourceGroupName string
    The name of the resource group.
    availabilitySetName String
    The name of the availability set.
    resourceGroupName String
    The name of the resource group.
    availabilitySetName string
    The name of the availability set.
    resourceGroupName string
    The name of the resource group.
    availability_set_name str
    The name of the availability set.
    resource_group_name str
    The name of the resource group.
    availabilitySetName String
    The name of the availability set.
    resourceGroupName String
    The name of the resource group.

    getAvailabilitySet Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    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
    VirtualMachineScaleSetMigrationInfo Pulumi.AzureNative.Compute.Outputs.VirtualMachineScaleSetMigrationInfoResponse
    Describes the migration properties on the Availability Set.
    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.
    ScheduledEventsPolicy Pulumi.AzureNative.Compute.Outputs.ScheduledEventsPolicyResponse
    Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set.
    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.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Resource Id
    Location string
    Resource location
    Name string
    Resource name
    Statuses []InstanceViewStatusResponse
    The resource status information.
    Type string
    Resource type
    VirtualMachineScaleSetMigrationInfo VirtualMachineScaleSetMigrationInfoResponse
    Describes the migration properties on the Availability Set.
    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.
    ScheduledEventsPolicy ScheduledEventsPolicyResponse
    Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set.
    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.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Resource Id
    location String
    Resource location
    name String
    Resource name
    statuses List<InstanceViewStatusResponse>
    The resource status information.
    type String
    Resource type
    virtualMachineScaleSetMigrationInfo VirtualMachineScaleSetMigrationInfoResponse
    Describes the migration properties on the Availability Set.
    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.
    scheduledEventsPolicy ScheduledEventsPolicyResponse
    Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set.
    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.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Resource Id
    location string
    Resource location
    name string
    Resource name
    statuses InstanceViewStatusResponse[]
    The resource status information.
    type string
    Resource type
    virtualMachineScaleSetMigrationInfo VirtualMachineScaleSetMigrationInfoResponse
    Describes the migration properties on the Availability Set.
    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.
    scheduledEventsPolicy ScheduledEventsPolicyResponse
    Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set.
    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.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Resource Id
    location str
    Resource location
    name str
    Resource name
    statuses Sequence[InstanceViewStatusResponse]
    The resource status information.
    type str
    Resource type
    virtual_machine_scale_set_migration_info VirtualMachineScaleSetMigrationInfoResponse
    Describes the migration properties on the Availability Set.
    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.
    scheduled_events_policy ScheduledEventsPolicyResponse
    Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set.
    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.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Resource Id
    location String
    Resource location
    name String
    Resource name
    statuses List<Property Map>
    The resource status information.
    type String
    Resource type
    virtualMachineScaleSetMigrationInfo Property Map
    Describes the migration properties on the Availability Set.
    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.
    scheduledEventsPolicy Property Map
    Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set.
    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

    DefaultVirtualMachineScaleSetInfoResponse

    ConstrainedMaximumCapacity bool
    Indicates if the the maximum capacity of the default migrated Virtual Machine Scale Set after its migration will be constrained to a limited number of VMs.
    DefaultVirtualMachineScaleSet Pulumi.AzureNative.Compute.Inputs.SubResourceResponse
    The default Virtual Machine ScaleSet Uri that the Availability Set will be moved to upon triggering a seamless migration via the ConvertToVirtualMachineScaleSet API.
    ConstrainedMaximumCapacity bool
    Indicates if the the maximum capacity of the default migrated Virtual Machine Scale Set after its migration will be constrained to a limited number of VMs.
    DefaultVirtualMachineScaleSet SubResourceResponse
    The default Virtual Machine ScaleSet Uri that the Availability Set will be moved to upon triggering a seamless migration via the ConvertToVirtualMachineScaleSet API.
    constrainedMaximumCapacity Boolean
    Indicates if the the maximum capacity of the default migrated Virtual Machine Scale Set after its migration will be constrained to a limited number of VMs.
    defaultVirtualMachineScaleSet SubResourceResponse
    The default Virtual Machine ScaleSet Uri that the Availability Set will be moved to upon triggering a seamless migration via the ConvertToVirtualMachineScaleSet API.
    constrainedMaximumCapacity boolean
    Indicates if the the maximum capacity of the default migrated Virtual Machine Scale Set after its migration will be constrained to a limited number of VMs.
    defaultVirtualMachineScaleSet SubResourceResponse
    The default Virtual Machine ScaleSet Uri that the Availability Set will be moved to upon triggering a seamless migration via the ConvertToVirtualMachineScaleSet API.
    constrained_maximum_capacity bool
    Indicates if the the maximum capacity of the default migrated Virtual Machine Scale Set after its migration will be constrained to a limited number of VMs.
    default_virtual_machine_scale_set SubResourceResponse
    The default Virtual Machine ScaleSet Uri that the Availability Set will be moved to upon triggering a seamless migration via the ConvertToVirtualMachineScaleSet API.
    constrainedMaximumCapacity Boolean
    Indicates if the the maximum capacity of the default migrated Virtual Machine Scale Set after its migration will be constrained to a limited number of VMs.
    defaultVirtualMachineScaleSet Property Map
    The default Virtual Machine ScaleSet Uri that the Availability Set will be moved to upon triggering a seamless migration via the ConvertToVirtualMachineScaleSet API.

    EventGridAndResourceGraphResponse

    Enable bool
    Specifies if event grid and resource graph is enabled for Scheduled event related configurations.
    Enable bool
    Specifies if event grid and resource graph is enabled for Scheduled event related configurations.
    enable Boolean
    Specifies if event grid and resource graph is enabled for Scheduled event related configurations.
    enable boolean
    Specifies if event grid and resource graph is enabled for Scheduled event related configurations.
    enable bool
    Specifies if event grid and resource graph is enabled for Scheduled event related configurations.
    enable Boolean
    Specifies if event grid and resource graph is enabled for Scheduled event related configurations.

    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.

    ScheduledEventsAdditionalPublishingTargetsResponse

    EventGridAndResourceGraph Pulumi.AzureNative.Compute.Inputs.EventGridAndResourceGraphResponse
    The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting.
    EventGridAndResourceGraph EventGridAndResourceGraphResponse
    The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting.
    eventGridAndResourceGraph EventGridAndResourceGraphResponse
    The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting.
    eventGridAndResourceGraph EventGridAndResourceGraphResponse
    The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting.
    event_grid_and_resource_graph EventGridAndResourceGraphResponse
    The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting.
    eventGridAndResourceGraph Property Map
    The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting.

    ScheduledEventsPolicyResponse

    ScheduledEventsAdditionalPublishingTargets Pulumi.AzureNative.Compute.Inputs.ScheduledEventsAdditionalPublishingTargetsResponse
    The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets.
    UserInitiatedReboot Pulumi.AzureNative.Compute.Inputs.UserInitiatedRebootResponse
    The configuration parameters used while creating userInitiatedReboot scheduled event setting creation.
    UserInitiatedRedeploy Pulumi.AzureNative.Compute.Inputs.UserInitiatedRedeployResponse
    The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation.
    ScheduledEventsAdditionalPublishingTargets ScheduledEventsAdditionalPublishingTargetsResponse
    The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets.
    UserInitiatedReboot UserInitiatedRebootResponse
    The configuration parameters used while creating userInitiatedReboot scheduled event setting creation.
    UserInitiatedRedeploy UserInitiatedRedeployResponse
    The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation.
    scheduledEventsAdditionalPublishingTargets ScheduledEventsAdditionalPublishingTargetsResponse
    The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets.
    userInitiatedReboot UserInitiatedRebootResponse
    The configuration parameters used while creating userInitiatedReboot scheduled event setting creation.
    userInitiatedRedeploy UserInitiatedRedeployResponse
    The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation.
    scheduledEventsAdditionalPublishingTargets ScheduledEventsAdditionalPublishingTargetsResponse
    The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets.
    userInitiatedReboot UserInitiatedRebootResponse
    The configuration parameters used while creating userInitiatedReboot scheduled event setting creation.
    userInitiatedRedeploy UserInitiatedRedeployResponse
    The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation.
    scheduled_events_additional_publishing_targets ScheduledEventsAdditionalPublishingTargetsResponse
    The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets.
    user_initiated_reboot UserInitiatedRebootResponse
    The configuration parameters used while creating userInitiatedReboot scheduled event setting creation.
    user_initiated_redeploy UserInitiatedRedeployResponse
    The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation.
    scheduledEventsAdditionalPublishingTargets Property Map
    The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets.
    userInitiatedReboot Property Map
    The configuration parameters used while creating userInitiatedReboot scheduled event setting creation.
    userInitiatedRedeploy Property Map
    The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation.

    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

    UserInitiatedRebootResponse

    AutomaticallyApprove bool
    Specifies Reboot Scheduled Event related configurations.
    AutomaticallyApprove bool
    Specifies Reboot Scheduled Event related configurations.
    automaticallyApprove Boolean
    Specifies Reboot Scheduled Event related configurations.
    automaticallyApprove boolean
    Specifies Reboot Scheduled Event related configurations.
    automatically_approve bool
    Specifies Reboot Scheduled Event related configurations.
    automaticallyApprove Boolean
    Specifies Reboot Scheduled Event related configurations.

    UserInitiatedRedeployResponse

    AutomaticallyApprove bool
    Specifies Redeploy Scheduled Event related configurations.
    AutomaticallyApprove bool
    Specifies Redeploy Scheduled Event related configurations.
    automaticallyApprove Boolean
    Specifies Redeploy Scheduled Event related configurations.
    automaticallyApprove boolean
    Specifies Redeploy Scheduled Event related configurations.
    automatically_approve bool
    Specifies Redeploy Scheduled Event related configurations.
    automaticallyApprove Boolean
    Specifies Redeploy Scheduled Event related configurations.

    VirtualMachineScaleSetMigrationInfoResponse

    DefaultVirtualMachineScaleSetInfo Pulumi.AzureNative.Compute.Inputs.DefaultVirtualMachineScaleSetInfoResponse
    Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API.
    MigrateToVirtualMachineScaleSet Pulumi.AzureNative.Compute.Inputs.SubResourceResponse
    Specifies the Virtual Machine Scale Set that the Availability Set is migrated to.
    DefaultVirtualMachineScaleSetInfo DefaultVirtualMachineScaleSetInfoResponse
    Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API.
    MigrateToVirtualMachineScaleSet SubResourceResponse
    Specifies the Virtual Machine Scale Set that the Availability Set is migrated to.
    defaultVirtualMachineScaleSetInfo DefaultVirtualMachineScaleSetInfoResponse
    Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API.
    migrateToVirtualMachineScaleSet SubResourceResponse
    Specifies the Virtual Machine Scale Set that the Availability Set is migrated to.
    defaultVirtualMachineScaleSetInfo DefaultVirtualMachineScaleSetInfoResponse
    Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API.
    migrateToVirtualMachineScaleSet SubResourceResponse
    Specifies the Virtual Machine Scale Set that the Availability Set is migrated to.
    default_virtual_machine_scale_set_info DefaultVirtualMachineScaleSetInfoResponse
    Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API.
    migrate_to_virtual_machine_scale_set SubResourceResponse
    Specifies the Virtual Machine Scale Set that the Availability Set is migrated to.
    defaultVirtualMachineScaleSetInfo Property Map
    Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API.
    migrateToVirtualMachineScaleSet Property Map
    Specifies the Virtual Machine Scale Set that the Availability Set is migrated to.

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi