Azure v6.22.0, Apr 1 25

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

azure.compute.getOrchestratedVirtualMachineScaleSet

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

pulumi/pulumi-azure

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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.

TypeScript
Python
Go
C#
Java
YAML

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 dictionary

The following arguments are supported:

Name string: The name of this Orchestrated Virtual Machine Scale Set.
ResourceGroupName string: 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.
ResourceGroupName string: 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.
resourceGroupName String: 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.
resourceGroupName string: 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_name str: 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.
resourceGroupName String: 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<GetOrchestratedVirtualMachineScaleSetIdentity>: A identity block 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<GetOrchestratedVirtualMachineScaleSetNetworkInterface>: A list of network_interface blocks as defined below.
ResourceGroupName string

Id string: The provider-assigned unique ID for this managed resource.
Identities []GetOrchestratedVirtualMachineScaleSetIdentity: A identity block 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 []GetOrchestratedVirtualMachineScaleSetNetworkInterface: A list of network_interface blocks as defined below.
ResourceGroupName string

id String: The provider-assigned unique ID for this managed resource.
identities List<GetOrchestratedVirtualMachineScaleSetIdentity>: A identity block 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<GetOrchestratedVirtualMachineScaleSetNetworkInterface>: A list of network_interface blocks as defined below.
resourceGroupName String

id string: The provider-assigned unique ID for this managed resource.
identities GetOrchestratedVirtualMachineScaleSetIdentity[]: A identity block 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 GetOrchestratedVirtualMachineScaleSetNetworkInterface[]: A list of network_interface blocks as defined below.
resourceGroupName string

id str: The provider-assigned unique ID for this managed resource.
identities Sequence[GetOrchestratedVirtualMachineScaleSetIdentity]: A identity block 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[GetOrchestratedVirtualMachineScaleSetNetworkInterface]: A list of network_interface blocks as defined below.
resource_group_name str

id String: The provider-assigned unique ID for this managed resource.
identities List<Property Map>: A identity block 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_interface blocks as defined below.
resourceGroupName String

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

AcceleratedNetworkingEnabled bool: Is accelerated networking enabled?
DnsServers List<string>: An array of the DNS servers in use.
IpConfigurations List<GetOrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfiguration>: An ip_configuration block as documented below.
IpForwardingEnabled bool: Is IP forwarding enabled?
Name string: The name of this Orchestrated Virtual Machine Scale Set.
NetworkSecurityGroupId string: The identifier for the network security group.
Primary bool: If this ip_configuration is the primary one.

AcceleratedNetworkingEnabled bool: Is accelerated networking enabled?
DnsServers []string: An array of the DNS servers in use.
IpConfigurations []GetOrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfiguration: An ip_configuration block as documented below.
IpForwardingEnabled bool: Is IP forwarding enabled?
Name string: The name of this Orchestrated Virtual Machine Scale Set.
NetworkSecurityGroupId string: The identifier for the network security group.
Primary bool: If this ip_configuration is the primary one.

acceleratedNetworkingEnabled Boolean: Is accelerated networking enabled?
dnsServers List<String>: An array of the DNS servers in use.
ipConfigurations List<GetOrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfiguration>: An ip_configuration block as documented below.
ipForwardingEnabled Boolean: Is IP forwarding enabled?
name String: The name of this Orchestrated Virtual Machine Scale Set.
networkSecurityGroupId String: The identifier for the network security group.
primary Boolean: If this ip_configuration is the primary one.

acceleratedNetworkingEnabled boolean: Is accelerated networking enabled?
dnsServers string[]: An array of the DNS servers in use.
ipConfigurations GetOrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfiguration[]: An ip_configuration block as documented below.
ipForwardingEnabled boolean: Is IP forwarding enabled?
name string: The name of this Orchestrated Virtual Machine Scale Set.
networkSecurityGroupId string: The identifier for the network security group.
primary boolean: If this ip_configuration is the primary one.

accelerated_networking_enabled bool: Is accelerated networking enabled?
dns_servers Sequence[str]: An array of the DNS servers in use.
ip_configurations Sequence[GetOrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfiguration]: An ip_configuration block as documented below.
ip_forwarding_enabled bool: Is IP forwarding enabled?
name str: The name of this Orchestrated Virtual Machine Scale Set.
network_security_group_id str: The identifier for the network security group.
primary bool: If this ip_configuration is the primary one.

acceleratedNetworkingEnabled Boolean: Is accelerated networking enabled?
dnsServers List<String>: An array of the DNS servers in use.
ipConfigurations List<Property Map>: An ip_configuration block as documented below.
ipForwardingEnabled Boolean: Is IP forwarding enabled?
name String: The name of this Orchestrated Virtual Machine Scale Set.
networkSecurityGroupId String: The identifier for the network security group.
primary Boolean: If this ip_configuration is the primary one.

GetOrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfiguration

ApplicationGatewayBackendAddressPoolIds List<string>: An array of references to backend address pools of application gateways.
ApplicationSecurityGroupIds List<string>: The application security group IDs to use.
LoadBalancerBackendAddressPoolIds List<string>: An array of references to backend address pools of load balancers.
LoadBalancerInboundNatRulesIds List<string>: 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.
PublicIpAddresses List<GetOrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress>: The virtual machines scale set IP Configuration's PublicIPAddress configuration. The public_ip_address is documented below.
SubnetId string: The identifier of the subnet.
Version string: The Internet Protocol Version of the public IP address.

ApplicationGatewayBackendAddressPoolIds []string: An array of references to backend address pools of application gateways.
ApplicationSecurityGroupIds []string: The application security group IDs to use.
LoadBalancerBackendAddressPoolIds []string: An array of references to backend address pools of load balancers.
LoadBalancerInboundNatRulesIds []string: 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.
PublicIpAddresses []GetOrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress: The virtual machines scale set IP Configuration's PublicIPAddress configuration. The public_ip_address is documented below.
SubnetId string: The identifier of the subnet.
Version string: The Internet Protocol Version of the public IP address.

applicationGatewayBackendAddressPoolIds List<String>: An array of references to backend address pools of application gateways.
applicationSecurityGroupIds List<String>: The application security group IDs to use.
loadBalancerBackendAddressPoolIds List<String>: An array of references to backend address pools of load balancers.
loadBalancerInboundNatRulesIds List<String>: 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.
publicIpAddresses List<GetOrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress>: The virtual machines scale set IP Configuration's PublicIPAddress configuration. The public_ip_address is documented below.
subnetId String: The identifier of the subnet.
version String: The Internet Protocol Version of the public IP address.

applicationGatewayBackendAddressPoolIds string[]: An array of references to backend address pools of application gateways.
applicationSecurityGroupIds string[]: The application security group IDs to use.
loadBalancerBackendAddressPoolIds string[]: An array of references to backend address pools of load balancers.
loadBalancerInboundNatRulesIds string[]: 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.
publicIpAddresses GetOrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress[]: The virtual machines scale set IP Configuration's PublicIPAddress configuration. The public_ip_address is documented below.
subnetId string: The identifier of the subnet.
version string: The Internet Protocol Version of the public IP address.

application_gateway_backend_address_pool_ids Sequence[str]: An array of references to backend address pools of application gateways.
application_security_group_ids Sequence[str]: The application security group IDs to use.
load_balancer_backend_address_pool_ids Sequence[str]: An array of references to backend address pools of load balancers.
load_balancer_inbound_nat_rules_ids Sequence[str]: 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_addresses Sequence[GetOrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress]: The virtual machines scale set IP Configuration's PublicIPAddress configuration. The public_ip_address is documented below.
subnet_id str: The identifier of the subnet.
version str: The Internet Protocol Version of the public IP address.

applicationGatewayBackendAddressPoolIds List<String>: An array of references to backend address pools of application gateways.
applicationSecurityGroupIds List<String>: The application security group IDs to use.
loadBalancerBackendAddressPoolIds List<String>: An array of references to backend address pools of load balancers.
loadBalancerInboundNatRulesIds List<String>: 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.
publicIpAddresses List<Property Map>: The virtual machines scale set IP Configuration's PublicIPAddress configuration. The public_ip_address is documented below.
subnetId String: The identifier of the subnet.
version String: The Internet Protocol Version of the public IP address.

GetOrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress

DomainNameLabel string: The domain name label for the DNS settings.
IdleTimeoutInMinutes int: The idle timeout in minutes.
IpTags List<GetOrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTag>: A list of ip_tag blocks as defined below.
Name string: The name of this Orchestrated Virtual Machine Scale Set.
PublicIpPrefixId string: The ID of the public IP prefix.
Version string: The Internet Protocol Version of the public IP address.

DomainNameLabel string: The domain name label for the DNS settings.
IdleTimeoutInMinutes int: The idle timeout in minutes.
IpTags []GetOrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTag: A list of ip_tag blocks as defined below.
Name string: The name of this Orchestrated Virtual Machine Scale Set.
PublicIpPrefixId string: The ID of the public IP prefix.
Version string: The Internet Protocol Version of the public IP address.

domainNameLabel String: The domain name label for the DNS settings.
idleTimeoutInMinutes Integer: The idle timeout in minutes.
ipTags List<GetOrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTag>: A list of ip_tag blocks as defined below.
name String: The name of this Orchestrated Virtual Machine Scale Set.
publicIpPrefixId String: The ID of the public IP prefix.
version String: The Internet Protocol Version of the public IP address.

domainNameLabel string: The domain name label for the DNS settings.
idleTimeoutInMinutes number: The idle timeout in minutes.
ipTags GetOrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTag[]: A list of ip_tag blocks as defined below.
name string: The name of this Orchestrated Virtual Machine Scale Set.
publicIpPrefixId string: The ID of the public IP prefix.
version string: The Internet Protocol Version of the public IP address.

domain_name_label str: The domain name label for the DNS settings.
idle_timeout_in_minutes int: The idle timeout in minutes.
ip_tags Sequence[GetOrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTag]: A list of ip_tag blocks as defined below.
name str: The name of this Orchestrated Virtual Machine Scale Set.
public_ip_prefix_id str: The ID of the public IP prefix.
version str: The Internet Protocol Version of the public IP address.

domainNameLabel String: The domain name label for the DNS settings.
idleTimeoutInMinutes Number: The idle timeout in minutes.
ipTags List<Property Map>: A list of ip_tag blocks as defined below.
name String: The name of this Orchestrated Virtual Machine Scale Set.
publicIpPrefixId String: The ID of the public IP prefix.
version String: The Internet Protocol Version of the public IP address.

GetOrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTag

Tag string: The IP Tag associated with the Public IP.
Type string: The Type of IP Tag.

Tag string: The IP Tag associated with the Public IP.
Type string: The Type of IP Tag.

tag String: The IP Tag associated with the Public IP.
type String: The Type of IP Tag.

tag string: The IP Tag associated with the Public IP.
type string: The Type of IP Tag.

tag str: The IP Tag associated with the Public IP.
type str: The Type of IP Tag.

tag String: The IP Tag associated with the Public IP.
type String: The Type of IP Tag.

Package Details

Repository: Azure Classic pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

pulumi/pulumi-azure

azure.compute.getOrchestratedVirtualMachineScaleSet

On this page

On this page

Example Usage

Using getOrchestratedVirtualMachineScaleSet

getOrchestratedVirtualMachineScaleSet Result

Supporting Types

GetOrchestratedVirtualMachineScaleSetIdentity

GetOrchestratedVirtualMachineScaleSetNetworkInterface

GetOrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfiguration

GetOrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress

GetOrchestratedVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTag

Package Details

On this page

On this page