We recommend using Azure Native.
Azure Classic v5.81.0 published on Monday, Jun 24, 2024 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/v5/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)
// Output-based functions aren't available in Java yet
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.
 - Resource
Group 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.
 - Resource
Group 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.
 - resource
Group 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.
 - resource
Group 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.
 - resource
Group 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<Get
Orchestrated 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
 - Network
Interfaces List<GetOrchestrated Virtual Machine Scale Set Network Interface>  - A list of 
network_interfaceblocks as defined below. - Resource
Group stringName  
- Id string
 - The provider-assigned unique ID for this managed resource.
 - Identities
[]Get
Orchestrated 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
 - Network
Interfaces []GetOrchestrated Virtual Machine Scale Set Network Interface  - A list of 
network_interfaceblocks as defined below. - Resource
Group stringName  
- id String
 - The provider-assigned unique ID for this managed resource.
 - identities
List<Get
Orchestrated 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
 - network
Interfaces List<GetOrchestrated Virtual Machine Scale Set Network Interface>  - A list of 
network_interfaceblocks as defined below. - resource
Group StringName  
- id string
 - The provider-assigned unique ID for this managed resource.
 - identities
Get
Orchestrated 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
 - network
Interfaces GetOrchestrated Virtual Machine Scale Set Network Interface[]  - A list of 
network_interfaceblocks as defined below. - resource
Group stringName  
- id str
 - The provider-assigned unique ID for this managed resource.
 - identities
Sequence[Get
Orchestrated 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
 - network
Interfaces List<Property Map> - A list of 
network_interfaceblocks as defined below. - resource
Group StringName  
Supporting Types
GetOrchestratedVirtualMachineScaleSetIdentity      
- Identity
Ids List<string> - The list of User Assigned Managed Identity IDs assigned to this Orchestrated Virtual Machine Scale Set.
 - Principal
Id string - The Principal ID of the System Assigned Managed Service Identity that is configured on this Orchestrated Virtual Machine Scale Set.
 - Tenant
Id 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 []string - The list of User Assigned Managed Identity IDs assigned to this Orchestrated Virtual Machine Scale Set.
 - Principal
Id string - The Principal ID of the System Assigned Managed Service Identity that is configured on this Orchestrated Virtual Machine Scale Set.
 - Tenant
Id 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 List<String> - The list of User Assigned Managed Identity IDs assigned to this Orchestrated Virtual Machine Scale Set.
 - principal
Id String - The Principal ID of the System Assigned Managed Service Identity that is configured on this Orchestrated Virtual Machine Scale Set.
 - tenant
Id 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 string[] - The list of User Assigned Managed Identity IDs assigned to this Orchestrated Virtual Machine Scale Set.
 - principal
Id string - The Principal ID of the System Assigned Managed Service Identity that is configured on this Orchestrated Virtual Machine Scale Set.
 - tenant
Id 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.
 
- identity
Ids List<String> - The list of User Assigned Managed Identity IDs assigned to this Orchestrated Virtual Machine Scale Set.
 - principal
Id String - The Principal ID of the System Assigned Managed Service Identity that is configured on this Orchestrated Virtual Machine Scale Set.
 - tenant
Id 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       
- Accelerated
Networking boolEnabled  - Is accelerated networking enabled?
 - Dns
Servers List<string> - An array of the DNS servers in use.
 - Ip
Configurations List<GetOrchestrated Virtual Machine Scale Set Network Interface Ip Configuration>  - An 
ip_configurationblock as documented below. - Ip
Forwarding boolEnabled  - Is IP forwarding enabled?
 - Name string
 - The name of this Orchestrated Virtual Machine Scale Set.
 - Network
Security stringGroup Id  - The identifier for the network security group.
 - Primary bool
 - If this ip_configuration is the primary one.
 
- Accelerated
Networking boolEnabled  - Is accelerated networking enabled?
 - Dns
Servers []string - An array of the DNS servers in use.
 - Ip
Configurations []GetOrchestrated Virtual Machine Scale Set Network Interface Ip Configuration  - An 
ip_configurationblock as documented below. - Ip
Forwarding boolEnabled  - Is IP forwarding enabled?
 - Name string
 - The name of this Orchestrated Virtual Machine Scale Set.
 - Network
Security stringGroup Id  - The identifier for the network security group.
 - Primary bool
 - If this ip_configuration is the primary one.
 
- accelerated
Networking BooleanEnabled  - Is accelerated networking enabled?
 - dns
Servers List<String> - An array of the DNS servers in use.
 - ip
Configurations List<GetOrchestrated Virtual Machine Scale Set Network Interface Ip Configuration>  - An 
ip_configurationblock as documented below. - ip
Forwarding BooleanEnabled  - Is IP forwarding enabled?
 - name String
 - The name of this Orchestrated Virtual Machine Scale Set.
 - network
Security StringGroup Id  - The identifier for the network security group.
 - primary Boolean
 - If this ip_configuration is the primary one.
 
- accelerated
Networking booleanEnabled  - Is accelerated networking enabled?
 - dns
Servers string[] - An array of the DNS servers in use.
 - ip
Configurations GetOrchestrated Virtual Machine Scale Set Network Interface Ip Configuration[]  - An 
ip_configurationblock as documented below. - ip
Forwarding booleanEnabled  - Is IP forwarding enabled?
 - name string
 - The name of this Orchestrated Virtual Machine Scale Set.
 - network
Security 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.
 
- accelerated
Networking BooleanEnabled  - Is accelerated networking enabled?
 - dns
Servers List<String> - An array of the DNS servers in use.
 - ip
Configurations List<Property Map> - An 
ip_configurationblock as documented below. - ip
Forwarding BooleanEnabled  - Is IP forwarding enabled?
 - name String
 - The name of this Orchestrated Virtual Machine Scale Set.
 - network
Security StringGroup Id  - The identifier for the network security group.
 - primary Boolean
 - If this ip_configuration is the primary one.
 
GetOrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfiguration         
- Application
Gateway List<string>Backend Address Pool Ids  - An array of references to backend address pools of application gateways.
 - Application
Security List<string>Group Ids  - The application security group IDs to use.
 - Load
Balancer List<string>Backend Address Pool Ids  - An array of references to backend address pools of load balancers.
 - Load
Balancer 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.
 - Public
Ip 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. - Subnet
Id string - The identifier of the subnet.
 - Version string
 - The Internet Protocol Version of the public IP address.
 
- Application
Gateway []stringBackend Address Pool Ids  - An array of references to backend address pools of application gateways.
 - Application
Security []stringGroup Ids  - The application security group IDs to use.
 - Load
Balancer []stringBackend Address Pool Ids  - An array of references to backend address pools of load balancers.
 - Load
Balancer []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.
 - Public
Ip []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 string - The identifier of the subnet.
 - Version string
 - The Internet Protocol Version of the public IP address.
 
- application
Gateway List<String>Backend Address Pool Ids  - An array of references to backend address pools of application gateways.
 - application
Security List<String>Group Ids  - The application security group IDs to use.
 - load
Balancer List<String>Backend Address Pool Ids  - An array of references to backend address pools of load balancers.
 - load
Balancer 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.
 - public
Ip 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. - subnet
Id String - The identifier of the subnet.
 - version String
 - The Internet Protocol Version of the public IP address.
 
- application
Gateway string[]Backend Address Pool Ids  - An array of references to backend address pools of application gateways.
 - application
Security string[]Group Ids  - The application security group IDs to use.
 - load
Balancer string[]Backend Address Pool Ids  - An array of references to backend address pools of load balancers.
 - load
Balancer 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.
 - public
Ip 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 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.
 
- application
Gateway List<String>Backend Address Pool Ids  - An array of references to backend address pools of application gateways.
 - application
Security List<String>Group Ids  - The application security group IDs to use.
 - load
Balancer List<String>Backend Address Pool Ids  - An array of references to backend address pools of load balancers.
 - load
Balancer 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.
 - public
Ip List<Property Map>Addresses  - The virtual machines scale set IP Configuration's PublicIPAddress configuration. The 
public_ip_addressis documented below. - subnet
Id String - The identifier of the subnet.
 - version String
 - The Internet Protocol Version of the public IP address.
 
GetOrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress            
- Domain
Name stringLabel  - The domain name label for the DNS settings.
 - Idle
Timeout intIn Minutes  - The idle timeout in minutes.
 - 
List<Get
Orchestrated 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.
 - Public
Ip stringPrefix Id  - The ID of the public IP prefix.
 - Version string
 - The Internet Protocol Version of the public IP address.
 
- Domain
Name stringLabel  - The domain name label for the DNS settings.
 - Idle
Timeout intIn Minutes  - The idle timeout in minutes.
 - 
[]Get
Orchestrated 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.
 - Public
Ip stringPrefix Id  - The ID of the public IP prefix.
 - Version string
 - The Internet Protocol Version of the public IP address.
 
- domain
Name StringLabel  - The domain name label for the DNS settings.
 - idle
Timeout IntegerIn Minutes  - The idle timeout in minutes.
 - 
List<Get
Orchestrated 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.
 - public
Ip StringPrefix Id  - The ID of the public IP prefix.
 - version String
 - The Internet Protocol Version of the public IP address.
 
- domain
Name stringLabel  - The domain name label for the DNS settings.
 - idle
Timeout numberIn Minutes  - The idle timeout in minutes.
 - 
Get
Orchestrated 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.
 - public
Ip 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[Get
Orchestrated 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.
 
- domain
Name StringLabel  - The domain name label for the DNS settings.
 - idle
Timeout 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.
 - public
Ip 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.