azure-native.compute.getAvailabilitySet
Explore with Pulumi AI
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:
- Availability
Set stringName - The name of the availability set.
- Resource
Group stringName - The name of the resource group.
- Availability
Set stringName - The name of the availability set.
- Resource
Group stringName - The name of the resource group.
- availability
Set StringName - The name of the availability set.
- resource
Group StringName - The name of the resource group.
- availability
Set stringName - The name of the availability set.
- resource
Group stringName - The name of the resource group.
- availability_
set_ strname - The name of the availability set.
- resource_
group_ strname - The name of the resource group.
- availability
Set StringName - The name of the availability set.
- resource
Group StringName - The name of the resource group.
getAvailabilitySet Result
The following output properties are available:
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- Resource Id
- Location string
- Resource location
- Name string
- Resource name
- Statuses
List<Pulumi.
Azure Native. Compute. Outputs. Instance View Status Response> - The resource status information.
- Type string
- Resource type
- Virtual
Machine Pulumi.Scale Set Migration Info Azure Native. Compute. Outputs. Virtual Machine Scale Set Migration Info Response - Describes the migration properties on the Availability Set.
- Platform
Fault intDomain Count - Fault Domain count.
- Platform
Update intDomain Count - Update Domain count.
- Proximity
Placement Pulumi.Group Azure Native. Compute. Outputs. Sub Resource Response - Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01.
- Scheduled
Events Pulumi.Policy Azure Native. Compute. Outputs. Scheduled Events Policy Response - Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set.
- Sku
Pulumi.
Azure Native. Compute. Outputs. Sku Response - 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'.
- Dictionary<string, string>
- Resource tags
- Virtual
Machines List<Pulumi.Azure Native. Compute. Outputs. Sub Resource Response> - A list of references to all virtual machines in the availability set.
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- Resource Id
- Location string
- Resource location
- Name string
- Resource name
- Statuses
[]Instance
View Status Response - The resource status information.
- Type string
- Resource type
- Virtual
Machine VirtualScale Set Migration Info Machine Scale Set Migration Info Response - Describes the migration properties on the Availability Set.
- Platform
Fault intDomain Count - Fault Domain count.
- Platform
Update intDomain Count - Update Domain count.
- Proximity
Placement SubGroup Resource Response - Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01.
- Scheduled
Events ScheduledPolicy Events Policy Response - Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set.
- Sku
Sku
Response - 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'.
- map[string]string
- Resource tags
- Virtual
Machines []SubResource Response - A list of references to all virtual machines in the availability set.
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- Resource Id
- location String
- Resource location
- name String
- Resource name
- statuses
List<Instance
View Status Response> - The resource status information.
- type String
- Resource type
- virtual
Machine VirtualScale Set Migration Info Machine Scale Set Migration Info Response - Describes the migration properties on the Availability Set.
- platform
Fault IntegerDomain Count - Fault Domain count.
- platform
Update IntegerDomain Count - Update Domain count.
- proximity
Placement SubGroup Resource Response - Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01.
- scheduled
Events ScheduledPolicy Events Policy Response - Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set.
- sku
Sku
Response - 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'.
- Map<String,String>
- Resource tags
- virtual
Machines List<SubResource Response> - A list of references to all virtual machines in the availability set.
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- Resource Id
- location string
- Resource location
- name string
- Resource name
- statuses
Instance
View Status Response[] - The resource status information.
- type string
- Resource type
- virtual
Machine VirtualScale Set Migration Info Machine Scale Set Migration Info Response - Describes the migration properties on the Availability Set.
- platform
Fault numberDomain Count - Fault Domain count.
- platform
Update numberDomain Count - Update Domain count.
- proximity
Placement SubGroup Resource Response - Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01.
- scheduled
Events ScheduledPolicy Events Policy Response - Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set.
- sku
Sku
Response - 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'.
- {[key: string]: string}
- Resource tags
- virtual
Machines SubResource Response[] - A list of references to all virtual machines in the availability set.
- azure_
api_ strversion - The Azure API version of the resource.
- id str
- Resource Id
- location str
- Resource location
- name str
- Resource name
- statuses
Sequence[Instance
View Status Response] - The resource status information.
- type str
- Resource type
- virtual_
machine_ Virtualscale_ set_ migration_ info Machine Scale Set Migration Info Response - Describes the migration properties on the Availability Set.
- platform_
fault_ intdomain_ count - Fault Domain count.
- platform_
update_ intdomain_ count - Update Domain count.
- proximity_
placement_ Subgroup Resource Response - Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01.
- scheduled_
events_ Scheduledpolicy Events Policy Response - Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set.
- sku
Sku
Response - 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'.
- Mapping[str, str]
- Resource tags
- virtual_
machines Sequence[SubResource Response] - A list of references to all virtual machines in the availability set.
- azure
Api StringVersion - 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
- virtual
Machine Property MapScale Set Migration Info - Describes the migration properties on the Availability Set.
- platform
Fault NumberDomain Count - Fault Domain count.
- platform
Update NumberDomain Count - Update Domain count.
- proximity
Placement Property MapGroup - Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01.
- scheduled
Events Property MapPolicy - 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'.
- Map<String>
- Resource tags
- virtual
Machines List<Property Map> - A list of references to all virtual machines in the availability set.
Supporting Types
DefaultVirtualMachineScaleSetInfoResponse
- Constrained
Maximum boolCapacity - 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 Pulumi.Machine Scale Set Azure Native. Compute. Inputs. Sub Resource Response - 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 boolCapacity - 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 SubMachine Scale Set Resource Response - 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 BooleanCapacity - 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 SubMachine Scale Set Resource Response - 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 booleanCapacity - 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 SubMachine Scale Set Resource Response - 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_ boolcapacity - 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_ Submachine_ scale_ set Resource Response - 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 BooleanCapacity - 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 Property MapMachine Scale Set - 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.
- Display
Status 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.
- Display
Status 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.
- display
Status 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.
- display
Status 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.
- display
Status 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
- Event
Grid Pulumi.And Resource Graph Azure Native. Compute. Inputs. Event Grid And Resource Graph Response - The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting.
- Event
Grid EventAnd Resource Graph Grid And Resource Graph Response - The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting.
- event
Grid EventAnd Resource Graph Grid And Resource Graph Response - The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting.
- event
Grid EventAnd Resource Graph Grid And Resource Graph Response - The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting.
- event_
grid_ Eventand_ resource_ graph Grid And Resource Graph Response - The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting.
- event
Grid Property MapAnd Resource Graph - The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting.
ScheduledEventsPolicyResponse
- Scheduled
Events Pulumi.Additional Publishing Targets Azure Native. Compute. Inputs. Scheduled Events Additional Publishing Targets Response - The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets.
- User
Initiated Pulumi.Reboot Azure Native. Compute. Inputs. User Initiated Reboot Response - The configuration parameters used while creating userInitiatedReboot scheduled event setting creation.
- User
Initiated Pulumi.Redeploy Azure Native. Compute. Inputs. User Initiated Redeploy Response - The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation.
- Scheduled
Events ScheduledAdditional Publishing Targets Events Additional Publishing Targets Response - The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets.
- User
Initiated UserReboot Initiated Reboot Response - The configuration parameters used while creating userInitiatedReboot scheduled event setting creation.
- User
Initiated UserRedeploy Initiated Redeploy Response - The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation.
- scheduled
Events ScheduledAdditional Publishing Targets Events Additional Publishing Targets Response - The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets.
- user
Initiated UserReboot Initiated Reboot Response - The configuration parameters used while creating userInitiatedReboot scheduled event setting creation.
- user
Initiated UserRedeploy Initiated Redeploy Response - The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation.
- scheduled
Events ScheduledAdditional Publishing Targets Events Additional Publishing Targets Response - The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets.
- user
Initiated UserReboot Initiated Reboot Response - The configuration parameters used while creating userInitiatedReboot scheduled event setting creation.
- user
Initiated UserRedeploy Initiated Redeploy Response - The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation.
- scheduled_
events_ Scheduledadditional_ publishing_ targets Events Additional Publishing Targets Response - The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets.
- user_
initiated_ Userreboot Initiated Reboot Response - The configuration parameters used while creating userInitiatedReboot scheduled event setting creation.
- user_
initiated_ Userredeploy Initiated Redeploy Response - The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation.
- scheduled
Events Property MapAdditional Publishing Targets - The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets.
- user
Initiated Property MapReboot - The configuration parameters used while creating userInitiatedReboot scheduled event setting creation.
- user
Initiated Property MapRedeploy - The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation.
SkuResponse
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
- Automatically
Approve bool - Specifies Reboot Scheduled Event related configurations.
- Automatically
Approve bool - Specifies Reboot Scheduled Event related configurations.
- automatically
Approve Boolean - Specifies Reboot Scheduled Event related configurations.
- automatically
Approve boolean - Specifies Reboot Scheduled Event related configurations.
- automatically_
approve bool - Specifies Reboot Scheduled Event related configurations.
- automatically
Approve Boolean - Specifies Reboot Scheduled Event related configurations.
UserInitiatedRedeployResponse
- Automatically
Approve bool - Specifies Redeploy Scheduled Event related configurations.
- Automatically
Approve bool - Specifies Redeploy Scheduled Event related configurations.
- automatically
Approve Boolean - Specifies Redeploy Scheduled Event related configurations.
- automatically
Approve boolean - Specifies Redeploy Scheduled Event related configurations.
- automatically_
approve bool - Specifies Redeploy Scheduled Event related configurations.
- automatically
Approve Boolean - Specifies Redeploy Scheduled Event related configurations.
VirtualMachineScaleSetMigrationInfoResponse
- Default
Virtual Pulumi.Machine Scale Set Info Azure Native. Compute. Inputs. Default Virtual Machine Scale Set Info Response - Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API.
- Migrate
To Pulumi.Virtual Machine Scale Set Azure Native. Compute. Inputs. Sub Resource Response - Specifies the Virtual Machine Scale Set that the Availability Set is migrated to.
- Default
Virtual DefaultMachine Scale Set Info Virtual Machine Scale Set Info Response - Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API.
- Migrate
To SubVirtual Machine Scale Set Resource Response - Specifies the Virtual Machine Scale Set that the Availability Set is migrated to.
- default
Virtual DefaultMachine Scale Set Info Virtual Machine Scale Set Info Response - Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API.
- migrate
To SubVirtual Machine Scale Set Resource Response - Specifies the Virtual Machine Scale Set that the Availability Set is migrated to.
- default
Virtual DefaultMachine Scale Set Info Virtual Machine Scale Set Info Response - Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API.
- migrate
To SubVirtual Machine Scale Set Resource Response - Specifies the Virtual Machine Scale Set that the Availability Set is migrated to.
- default_
virtual_ Defaultmachine_ scale_ set_ info Virtual Machine Scale Set Info Response - Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API.
- migrate_
to_ Subvirtual_ machine_ scale_ set Resource Response - Specifies the Virtual Machine Scale Set that the Availability Set is migrated to.
- default
Virtual Property MapMachine Scale Set Info - Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API.
- migrate
To Property MapVirtual Machine Scale Set - 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