We recommend using Azure Native.
Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
azure.compute.getOrchestratedVirtualMachineScaleSet
Explore with Pulumi AI
Use this data source to access information about an existing Orchestrated Virtual Machine Scale Set.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = azure.compute.getOrchestratedVirtualMachineScaleSet({
    name: "existing",
    resourceGroupName: "existing",
});
export const id = example.then(example => example.id);
import pulumi
import pulumi_azure as azure
example = azure.compute.get_orchestrated_virtual_machine_scale_set(name="existing",
    resource_group_name="existing")
pulumi.export("id", example.id)
package main
import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := compute.LookupOrchestratedVirtualMachineScaleSet(ctx, &compute.LookupOrchestratedVirtualMachineScaleSetArgs{
			Name:              "existing",
			ResourceGroupName: "existing",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("id", example.Id)
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() => 
{
    var example = Azure.Compute.GetOrchestratedVirtualMachineScaleSet.Invoke(new()
    {
        Name = "existing",
        ResourceGroupName = "existing",
    });
    return new Dictionary<string, object?>
    {
        ["id"] = example.Apply(getOrchestratedVirtualMachineScaleSetResult => getOrchestratedVirtualMachineScaleSetResult.Id),
    };
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.compute.ComputeFunctions;
import com.pulumi.azure.compute.inputs.GetOrchestratedVirtualMachineScaleSetArgs;
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) {
        final var example = ComputeFunctions.getOrchestratedVirtualMachineScaleSet(GetOrchestratedVirtualMachineScaleSetArgs.builder()
            .name("existing")
            .resourceGroupName("existing")
            .build());
        ctx.export("id", example.applyValue(getOrchestratedVirtualMachineScaleSetResult -> getOrchestratedVirtualMachineScaleSetResult.id()));
    }
}
variables:
  example:
    fn::invoke:
      function: azure:compute:getOrchestratedVirtualMachineScaleSet
      arguments:
        name: existing
        resourceGroupName: existing
outputs:
  id: ${example.id}
Using getOrchestratedVirtualMachineScaleSet
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 getOrchestratedVirtualMachineScaleSet(args: GetOrchestratedVirtualMachineScaleSetArgs, opts?: InvokeOptions): Promise<GetOrchestratedVirtualMachineScaleSetResult>
function getOrchestratedVirtualMachineScaleSetOutput(args: GetOrchestratedVirtualMachineScaleSetOutputArgs, opts?: InvokeOptions): Output<GetOrchestratedVirtualMachineScaleSetResult>def get_orchestrated_virtual_machine_scale_set(name: Optional[str] = None,
                                               resource_group_name: Optional[str] = None,
                                               opts: Optional[InvokeOptions] = None) -> GetOrchestratedVirtualMachineScaleSetResult
def get_orchestrated_virtual_machine_scale_set_output(name: Optional[pulumi.Input[str]] = None,
                                               resource_group_name: Optional[pulumi.Input[str]] = None,
                                               opts: Optional[InvokeOptions] = None) -> Output[GetOrchestratedVirtualMachineScaleSetResult]func LookupOrchestratedVirtualMachineScaleSet(ctx *Context, args *LookupOrchestratedVirtualMachineScaleSetArgs, opts ...InvokeOption) (*LookupOrchestratedVirtualMachineScaleSetResult, error)
func LookupOrchestratedVirtualMachineScaleSetOutput(ctx *Context, args *LookupOrchestratedVirtualMachineScaleSetOutputArgs, opts ...InvokeOption) LookupOrchestratedVirtualMachineScaleSetResultOutput> Note: This function is named LookupOrchestratedVirtualMachineScaleSet in the Go SDK.
public static class GetOrchestratedVirtualMachineScaleSet 
{
    public static Task<GetOrchestratedVirtualMachineScaleSetResult> InvokeAsync(GetOrchestratedVirtualMachineScaleSetArgs args, InvokeOptions? opts = null)
    public static Output<GetOrchestratedVirtualMachineScaleSetResult> Invoke(GetOrchestratedVirtualMachineScaleSetInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetOrchestratedVirtualMachineScaleSetResult> getOrchestratedVirtualMachineScaleSet(GetOrchestratedVirtualMachineScaleSetArgs args, InvokeOptions options)
public static Output<GetOrchestratedVirtualMachineScaleSetResult> getOrchestratedVirtualMachineScaleSet(GetOrchestratedVirtualMachineScaleSetArgs args, InvokeOptions options)
fn::invoke:
  function: azure:compute/getOrchestratedVirtualMachineScaleSet:getOrchestratedVirtualMachineScaleSet
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Name string
- The name of this Orchestrated Virtual Machine Scale Set.
- ResourceGroup stringName 
- The name of the Resource Group where the Orchestrated Virtual Machine Scale Set exists.
- Name string
- The name of this Orchestrated Virtual Machine Scale Set.
- ResourceGroup stringName 
- The name of the Resource Group where the Orchestrated Virtual Machine Scale Set exists.
- name String
- The name of this Orchestrated Virtual Machine Scale Set.
- resourceGroup StringName 
- The name of the Resource Group where the Orchestrated Virtual Machine Scale Set exists.
- name string
- The name of this Orchestrated Virtual Machine Scale Set.
- resourceGroup stringName 
- The name of the Resource Group where the Orchestrated Virtual Machine Scale Set exists.
- name str
- The name of this Orchestrated Virtual Machine Scale Set.
- resource_group_ strname 
- The name of the Resource Group where the Orchestrated Virtual Machine Scale Set exists.
- name String
- The name of this Orchestrated Virtual Machine Scale Set.
- resourceGroup StringName 
- The name of the Resource Group where the Orchestrated Virtual Machine Scale Set exists.
getOrchestratedVirtualMachineScaleSet Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Identities
List<GetOrchestrated Virtual Machine Scale Set Identity> 
- A identityblock as defined below.
- Location string
- The Azure Region in which this Orchestrated Virtual Machine Scale Set exists.
- Name string
- The name of the public IP address configuration
- NetworkInterfaces List<GetOrchestrated Virtual Machine Scale Set Network Interface> 
- A list of network_interfaceblocks as defined below.
- ResourceGroup stringName 
- Id string
- The provider-assigned unique ID for this managed resource.
- Identities
[]GetOrchestrated Virtual Machine Scale Set Identity 
- A identityblock as defined below.
- Location string
- The Azure Region in which this Orchestrated Virtual Machine Scale Set exists.
- Name string
- The name of the public IP address configuration
- NetworkInterfaces []GetOrchestrated Virtual Machine Scale Set Network Interface 
- A list of network_interfaceblocks as defined below.
- ResourceGroup stringName 
- id String
- The provider-assigned unique ID for this managed resource.
- identities
List<GetOrchestrated Virtual Machine Scale Set Identity> 
- A identityblock as defined below.
- location String
- The Azure Region in which this Orchestrated Virtual Machine Scale Set exists.
- name String
- The name of the public IP address configuration
- networkInterfaces List<GetOrchestrated Virtual Machine Scale Set Network Interface> 
- A list of network_interfaceblocks as defined below.
- resourceGroup StringName 
- id string
- The provider-assigned unique ID for this managed resource.
- identities
GetOrchestrated Virtual Machine Scale Set Identity[] 
- A identityblock as defined below.
- location string
- The Azure Region in which this Orchestrated Virtual Machine Scale Set exists.
- name string
- The name of the public IP address configuration
- networkInterfaces GetOrchestrated Virtual Machine Scale Set Network Interface[] 
- A list of network_interfaceblocks as defined below.
- resourceGroup stringName 
- id str
- The provider-assigned unique ID for this managed resource.
- identities
Sequence[GetOrchestrated Virtual Machine Scale Set Identity] 
- A identityblock as defined below.
- location str
- The Azure Region in which this Orchestrated Virtual Machine Scale Set exists.
- name str
- The name of the public IP address configuration
- network_interfaces Sequence[GetOrchestrated Virtual Machine Scale Set Network Interface] 
- A list of network_interfaceblocks as defined below.
- resource_group_ strname 
- id String
- The provider-assigned unique ID for this managed resource.
- identities List<Property Map>
- A identityblock as defined below.
- location String
- The Azure Region in which this Orchestrated Virtual Machine Scale Set exists.
- name String
- The name of the public IP address configuration
- networkInterfaces List<Property Map>
- A list of network_interfaceblocks as defined below.
- resourceGroup StringName 
Supporting Types
GetOrchestratedVirtualMachineScaleSetIdentity      
- IdentityIds List<string>
- The list of User Assigned Managed Identity IDs assigned to this Orchestrated Virtual Machine Scale Set.
- PrincipalId string
- The Principal ID of the System Assigned Managed Service Identity that is configured on this Orchestrated Virtual Machine Scale Set.
- TenantId string
- The Tenant ID of the System Assigned Managed Service Identity that is configured on this Orchestrated Virtual Machine Scale Set.
- Type string
- The Type of IP Tag.
- IdentityIds []string
- The list of User Assigned Managed Identity IDs assigned to this Orchestrated Virtual Machine Scale Set.
- PrincipalId string
- The Principal ID of the System Assigned Managed Service Identity that is configured on this Orchestrated Virtual Machine Scale Set.
- TenantId string
- The Tenant ID of the System Assigned Managed Service Identity that is configured on this Orchestrated Virtual Machine Scale Set.
- Type string
- The Type of IP Tag.
- identityIds List<String>
- The list of User Assigned Managed Identity IDs assigned to this Orchestrated Virtual Machine Scale Set.
- principalId String
- The Principal ID of the System Assigned Managed Service Identity that is configured on this Orchestrated Virtual Machine Scale Set.
- tenantId String
- The Tenant ID of the System Assigned Managed Service Identity that is configured on this Orchestrated Virtual Machine Scale Set.
- type String
- The Type of IP Tag.
- identityIds string[]
- The list of User Assigned Managed Identity IDs assigned to this Orchestrated Virtual Machine Scale Set.
- principalId string
- The Principal ID of the System Assigned Managed Service Identity that is configured on this Orchestrated Virtual Machine Scale Set.
- tenantId string
- The Tenant ID of the System Assigned Managed Service Identity that is configured on this Orchestrated Virtual Machine Scale Set.
- type string
- The Type of IP Tag.
- identity_ids Sequence[str]
- The list of User Assigned Managed Identity IDs assigned to this Orchestrated Virtual Machine Scale Set.
- principal_id str
- The Principal ID of the System Assigned Managed Service Identity that is configured on this Orchestrated Virtual Machine Scale Set.
- tenant_id str
- The Tenant ID of the System Assigned Managed Service Identity that is configured on this Orchestrated Virtual Machine Scale Set.
- type str
- The Type of IP Tag.
- identityIds List<String>
- The list of User Assigned Managed Identity IDs assigned to this Orchestrated Virtual Machine Scale Set.
- principalId String
- The Principal ID of the System Assigned Managed Service Identity that is configured on this Orchestrated Virtual Machine Scale Set.
- tenantId String
- The Tenant ID of the System Assigned Managed Service Identity that is configured on this Orchestrated Virtual Machine Scale Set.
- type String
- The Type of IP Tag.
GetOrchestratedVirtualMachineScaleSetNetworkInterface       
- AcceleratedNetworking boolEnabled 
- Is accelerated networking enabled?
- DnsServers List<string>
- An array of the DNS servers in use.
- IpConfigurations List<GetOrchestrated Virtual Machine Scale Set Network Interface Ip Configuration> 
- An ip_configurationblock as documented below.
- IpForwarding boolEnabled 
- Is IP forwarding enabled?
- Name string
- The name of this Orchestrated Virtual Machine Scale Set.
- NetworkSecurity stringGroup Id 
- The identifier for the network security group.
- Primary bool
- If this ip_configuration is the primary one.
- AcceleratedNetworking boolEnabled 
- Is accelerated networking enabled?
- DnsServers []string
- An array of the DNS servers in use.
- IpConfigurations []GetOrchestrated Virtual Machine Scale Set Network Interface Ip Configuration 
- An ip_configurationblock as documented below.
- IpForwarding boolEnabled 
- Is IP forwarding enabled?
- Name string
- The name of this Orchestrated Virtual Machine Scale Set.
- NetworkSecurity stringGroup Id 
- The identifier for the network security group.
- Primary bool
- If this ip_configuration is the primary one.
- acceleratedNetworking BooleanEnabled 
- Is accelerated networking enabled?
- dnsServers List<String>
- An array of the DNS servers in use.
- ipConfigurations List<GetOrchestrated Virtual Machine Scale Set Network Interface Ip Configuration> 
- An ip_configurationblock as documented below.
- ipForwarding BooleanEnabled 
- Is IP forwarding enabled?
- name String
- The name of this Orchestrated Virtual Machine Scale Set.
- networkSecurity StringGroup Id 
- The identifier for the network security group.
- primary Boolean
- If this ip_configuration is the primary one.
- acceleratedNetworking booleanEnabled 
- Is accelerated networking enabled?
- dnsServers string[]
- An array of the DNS servers in use.
- ipConfigurations GetOrchestrated Virtual Machine Scale Set Network Interface Ip Configuration[] 
- An ip_configurationblock as documented below.
- ipForwarding booleanEnabled 
- Is IP forwarding enabled?
- name string
- The name of this Orchestrated Virtual Machine Scale Set.
- networkSecurity stringGroup Id 
- The identifier for the network security group.
- primary boolean
- If this ip_configuration is the primary one.
- accelerated_networking_ boolenabled 
- Is accelerated networking enabled?
- dns_servers Sequence[str]
- An array of the DNS servers in use.
- ip_configurations Sequence[GetOrchestrated Virtual Machine Scale Set Network Interface Ip Configuration] 
- An ip_configurationblock as documented below.
- ip_forwarding_ boolenabled 
- Is IP forwarding enabled?
- name str
- The name of this Orchestrated Virtual Machine Scale Set.
- network_security_ strgroup_ id 
- The identifier for the network security group.
- primary bool
- If this ip_configuration is the primary one.
- acceleratedNetworking BooleanEnabled 
- Is accelerated networking enabled?
- dnsServers List<String>
- An array of the DNS servers in use.
- ipConfigurations List<Property Map>
- An ip_configurationblock as documented below.
- ipForwarding BooleanEnabled 
- Is IP forwarding enabled?
- name String
- The name of this Orchestrated Virtual Machine Scale Set.
- networkSecurity StringGroup Id 
- The identifier for the network security group.
- primary Boolean
- If this ip_configuration is the primary one.
GetOrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfiguration         
- ApplicationGateway List<string>Backend Address Pool Ids 
- An array of references to backend address pools of application gateways.
- ApplicationSecurity List<string>Group Ids 
- The application security group IDs to use.
- LoadBalancer List<string>Backend Address Pool Ids 
- An array of references to backend address pools of load balancers.
- LoadBalancer List<string>Inbound Nat Rules Ids 
- An array of references to inbound NAT pools for load balancers.
- Name string
- The name of this Orchestrated Virtual Machine Scale Set.
- Primary bool
- If this ip_configuration is the primary one.
- PublicIp List<GetAddresses Orchestrated Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address> 
- The virtual machines scale set IP Configuration's PublicIPAddress configuration. The public_ip_addressis documented below.
- SubnetId string
- The identifier of the subnet.
- Version string
- The Internet Protocol Version of the public IP address.
- ApplicationGateway []stringBackend Address Pool Ids 
- An array of references to backend address pools of application gateways.
- ApplicationSecurity []stringGroup Ids 
- The application security group IDs to use.
- LoadBalancer []stringBackend Address Pool Ids 
- An array of references to backend address pools of load balancers.
- LoadBalancer []stringInbound Nat Rules Ids 
- An array of references to inbound NAT pools for load balancers.
- Name string
- The name of this Orchestrated Virtual Machine Scale Set.
- Primary bool
- If this ip_configuration is the primary one.
- PublicIp []GetAddresses Orchestrated Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address 
- The virtual machines scale set IP Configuration's PublicIPAddress configuration. The public_ip_addressis documented below.
- SubnetId string
- The identifier of the subnet.
- Version string
- The Internet Protocol Version of the public IP address.
- applicationGateway List<String>Backend Address Pool Ids 
- An array of references to backend address pools of application gateways.
- applicationSecurity List<String>Group Ids 
- The application security group IDs to use.
- loadBalancer List<String>Backend Address Pool Ids 
- An array of references to backend address pools of load balancers.
- loadBalancer List<String>Inbound Nat Rules Ids 
- An array of references to inbound NAT pools for load balancers.
- name String
- The name of this Orchestrated Virtual Machine Scale Set.
- primary Boolean
- If this ip_configuration is the primary one.
- publicIp List<GetAddresses Orchestrated Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address> 
- The virtual machines scale set IP Configuration's PublicIPAddress configuration. The public_ip_addressis documented below.
- subnetId String
- The identifier of the subnet.
- version String
- The Internet Protocol Version of the public IP address.
- applicationGateway string[]Backend Address Pool Ids 
- An array of references to backend address pools of application gateways.
- applicationSecurity string[]Group Ids 
- The application security group IDs to use.
- loadBalancer string[]Backend Address Pool Ids 
- An array of references to backend address pools of load balancers.
- loadBalancer string[]Inbound Nat Rules Ids 
- An array of references to inbound NAT pools for load balancers.
- name string
- The name of this Orchestrated Virtual Machine Scale Set.
- primary boolean
- If this ip_configuration is the primary one.
- publicIp GetAddresses Orchestrated Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address[] 
- The virtual machines scale set IP Configuration's PublicIPAddress configuration. The public_ip_addressis documented below.
- subnetId string
- The identifier of the subnet.
- version string
- The Internet Protocol Version of the public IP address.
- application_gateway_ Sequence[str]backend_ address_ pool_ ids 
- An array of references to backend address pools of application gateways.
- application_security_ Sequence[str]group_ ids 
- The application security group IDs to use.
- load_balancer_ Sequence[str]backend_ address_ pool_ ids 
- An array of references to backend address pools of load balancers.
- load_balancer_ Sequence[str]inbound_ nat_ rules_ ids 
- An array of references to inbound NAT pools for load balancers.
- name str
- The name of this Orchestrated Virtual Machine Scale Set.
- primary bool
- If this ip_configuration is the primary one.
- public_ip_ Sequence[Getaddresses Orchestrated Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address] 
- The virtual machines scale set IP Configuration's PublicIPAddress configuration. The public_ip_addressis documented below.
- subnet_id str
- The identifier of the subnet.
- version str
- The Internet Protocol Version of the public IP address.
- applicationGateway List<String>Backend Address Pool Ids 
- An array of references to backend address pools of application gateways.
- applicationSecurity List<String>Group Ids 
- The application security group IDs to use.
- loadBalancer List<String>Backend Address Pool Ids 
- An array of references to backend address pools of load balancers.
- loadBalancer List<String>Inbound Nat Rules Ids 
- An array of references to inbound NAT pools for load balancers.
- name String
- The name of this Orchestrated Virtual Machine Scale Set.
- primary Boolean
- If this ip_configuration is the primary one.
- publicIp List<Property Map>Addresses 
- The virtual machines scale set IP Configuration's PublicIPAddress configuration. The public_ip_addressis documented below.
- subnetId String
- The identifier of the subnet.
- version String
- The Internet Protocol Version of the public IP address.
GetOrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress            
- DomainName stringLabel 
- The domain name label for the DNS settings.
- IdleTimeout intIn Minutes 
- The idle timeout in minutes.
- 
List<GetOrchestrated Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address Ip Tag> 
- A list of ip_tagblocks as defined below.
- Name string
- The name of this Orchestrated Virtual Machine Scale Set.
- PublicIp stringPrefix Id 
- The ID of the public IP prefix.
- Version string
- The Internet Protocol Version of the public IP address.
- DomainName stringLabel 
- The domain name label for the DNS settings.
- IdleTimeout intIn Minutes 
- The idle timeout in minutes.
- 
[]GetOrchestrated Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address Ip Tag 
- A list of ip_tagblocks as defined below.
- Name string
- The name of this Orchestrated Virtual Machine Scale Set.
- PublicIp stringPrefix Id 
- The ID of the public IP prefix.
- Version string
- The Internet Protocol Version of the public IP address.
- domainName StringLabel 
- The domain name label for the DNS settings.
- idleTimeout IntegerIn Minutes 
- The idle timeout in minutes.
- 
List<GetOrchestrated Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address Ip Tag> 
- A list of ip_tagblocks as defined below.
- name String
- The name of this Orchestrated Virtual Machine Scale Set.
- publicIp StringPrefix Id 
- The ID of the public IP prefix.
- version String
- The Internet Protocol Version of the public IP address.
- domainName stringLabel 
- The domain name label for the DNS settings.
- idleTimeout numberIn Minutes 
- The idle timeout in minutes.
- 
GetOrchestrated Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address Ip Tag[] 
- A list of ip_tagblocks as defined below.
- name string
- The name of this Orchestrated Virtual Machine Scale Set.
- publicIp stringPrefix Id 
- The ID of the public IP prefix.
- version string
- The Internet Protocol Version of the public IP address.
- domain_name_ strlabel 
- The domain name label for the DNS settings.
- idle_timeout_ intin_ minutes 
- The idle timeout in minutes.
- 
Sequence[GetOrchestrated Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address Ip Tag] 
- A list of ip_tagblocks as defined below.
- name str
- The name of this Orchestrated Virtual Machine Scale Set.
- public_ip_ strprefix_ id 
- The ID of the public IP prefix.
- version str
- The Internet Protocol Version of the public IP address.
- domainName StringLabel 
- The domain name label for the DNS settings.
- idleTimeout NumberIn Minutes 
- The idle timeout in minutes.
- List<Property Map>
- A list of ip_tagblocks as defined below.
- name String
- The name of this Orchestrated Virtual Machine Scale Set.
- publicIp StringPrefix Id 
- The ID of the public IP prefix.
- version String
- The Internet Protocol Version of the public IP address.
GetOrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTag              
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the azurermTerraform Provider.