Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. standbypool
  5. getStandbyVirtualMachinePool
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.standbypool.getStandbyVirtualMachinePool

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Get a StandbyVirtualMachinePoolResource Azure REST API version: 2023-12-01-preview.

Other available API versions: 2024-03-01, 2024-03-01-preview.

Using getStandbyVirtualMachinePool

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 getStandbyVirtualMachinePool(args: GetStandbyVirtualMachinePoolArgs, opts?: InvokeOptions): Promise<GetStandbyVirtualMachinePoolResult>
function getStandbyVirtualMachinePoolOutput(args: GetStandbyVirtualMachinePoolOutputArgs, opts?: InvokeOptions): Output<GetStandbyVirtualMachinePoolResult>
Copy
def get_standby_virtual_machine_pool(resource_group_name: Optional[str] = None,
                                     standby_virtual_machine_pool_name: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetStandbyVirtualMachinePoolResult
def get_standby_virtual_machine_pool_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                                     standby_virtual_machine_pool_name: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetStandbyVirtualMachinePoolResult]
Copy
func LookupStandbyVirtualMachinePool(ctx *Context, args *LookupStandbyVirtualMachinePoolArgs, opts ...InvokeOption) (*LookupStandbyVirtualMachinePoolResult, error)
func LookupStandbyVirtualMachinePoolOutput(ctx *Context, args *LookupStandbyVirtualMachinePoolOutputArgs, opts ...InvokeOption) LookupStandbyVirtualMachinePoolResultOutput
Copy

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

public static class GetStandbyVirtualMachinePool 
{
    public static Task<GetStandbyVirtualMachinePoolResult> InvokeAsync(GetStandbyVirtualMachinePoolArgs args, InvokeOptions? opts = null)
    public static Output<GetStandbyVirtualMachinePoolResult> Invoke(GetStandbyVirtualMachinePoolInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetStandbyVirtualMachinePoolResult> getStandbyVirtualMachinePool(GetStandbyVirtualMachinePoolArgs args, InvokeOptions options)
public static Output<GetStandbyVirtualMachinePoolResult> getStandbyVirtualMachinePool(GetStandbyVirtualMachinePoolArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:standbypool:getStandbyVirtualMachinePool
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
StandbyVirtualMachinePoolName
This property is required.
Changes to this property will trigger replacement.
string
Name of the standby virtual machine pool
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
StandbyVirtualMachinePoolName
This property is required.
Changes to this property will trigger replacement.
string
Name of the standby virtual machine pool
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
standbyVirtualMachinePoolName
This property is required.
Changes to this property will trigger replacement.
String
Name of the standby virtual machine pool
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
standbyVirtualMachinePoolName
This property is required.
Changes to this property will trigger replacement.
string
Name of the standby virtual machine pool
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
standby_virtual_machine_pool_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the standby virtual machine pool
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
standbyVirtualMachinePoolName
This property is required.
Changes to this property will trigger replacement.
String
Name of the standby virtual machine pool

getStandbyVirtualMachinePool Result

The following output properties are available:

Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
Name string
The name of the resource
ProvisioningState string
The status of the last operation.
SystemData Pulumi.AzureNative.StandbyPool.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
VirtualMachineState string
Specifies the desired state of virtual machines in the pool.
AttachedVirtualMachineScaleSetId string
Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
ElasticityProfile Pulumi.AzureNative.StandbyPool.Outputs.StandbyVirtualMachinePoolElasticityProfileResponse
Specifies the elasticity profile of the standby virtual machine pools.
Tags Dictionary<string, string>
Resource tags.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
Name string
The name of the resource
ProvisioningState string
The status of the last operation.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
VirtualMachineState string
Specifies the desired state of virtual machines in the pool.
AttachedVirtualMachineScaleSetId string
Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
ElasticityProfile StandbyVirtualMachinePoolElasticityProfileResponse
Specifies the elasticity profile of the standby virtual machine pools.
Tags map[string]string
Resource tags.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
name String
The name of the resource
provisioningState String
The status of the last operation.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
virtualMachineState String
Specifies the desired state of virtual machines in the pool.
attachedVirtualMachineScaleSetId String
Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
elasticityProfile StandbyVirtualMachinePoolElasticityProfileResponse
Specifies the elasticity profile of the standby virtual machine pools.
tags Map<String,String>
Resource tags.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location string
The geo-location where the resource lives
name string
The name of the resource
provisioningState string
The status of the last operation.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
virtualMachineState string
Specifies the desired state of virtual machines in the pool.
attachedVirtualMachineScaleSetId string
Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
elasticityProfile StandbyVirtualMachinePoolElasticityProfileResponse
Specifies the elasticity profile of the standby virtual machine pools.
tags {[key: string]: string}
Resource tags.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location str
The geo-location where the resource lives
name str
The name of the resource
provisioning_state str
The status of the last operation.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
virtual_machine_state str
Specifies the desired state of virtual machines in the pool.
attached_virtual_machine_scale_set_id str
Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
elasticity_profile StandbyVirtualMachinePoolElasticityProfileResponse
Specifies the elasticity profile of the standby virtual machine pools.
tags Mapping[str, str]
Resource tags.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
name String
The name of the resource
provisioningState String
The status of the last operation.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
virtualMachineState String
Specifies the desired state of virtual machines in the pool.
attachedVirtualMachineScaleSetId String
Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
elasticityProfile Property Map
Specifies the elasticity profile of the standby virtual machine pools.
tags Map<String>
Resource tags.

Supporting Types

StandbyVirtualMachinePoolElasticityProfileResponse

MaxReadyCapacity This property is required. double
Specifies the maximum number of virtual machines in the standby virtual machine pool.
MaxReadyCapacity This property is required. float64
Specifies the maximum number of virtual machines in the standby virtual machine pool.
maxReadyCapacity This property is required. Double
Specifies the maximum number of virtual machines in the standby virtual machine pool.
maxReadyCapacity This property is required. number
Specifies the maximum number of virtual machines in the standby virtual machine pool.
max_ready_capacity This property is required. float
Specifies the maximum number of virtual machines in the standby virtual machine pool.
maxReadyCapacity This property is required. Number
Specifies the maximum number of virtual machines in the standby virtual machine pool.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native