1. Docs
  2. Reference
  3. API
  4. Azure
  5. compute
  6. GetVirtualMachineScaleSet

GetVirtualMachineScaleSet

Use this data source to access information about an existing Virtual Machine Scale Set.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.Compute.GetVirtualMachineScaleSet.InvokeAsync(new Azure.Compute.GetVirtualMachineScaleSetArgs
        {
            Name = "existing",
            ResourceGroupName = "existing",
        }));
        this.Id = example.Apply(example => example.Id);
    }

    [Output("id")]
    public Output<string> Id { get; set; }
}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/compute"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        example, err := compute.GetVirtualMachineScaleSet(ctx, &compute.GetVirtualMachineScaleSetArgs{
            Name:              "existing",
            ResourceGroupName: "existing",
        }, nil)
        if err != nil {
            return err
        }
        ctx.Export("id", example.Id)
        return nil
    })
}
import pulumi
import pulumi_azure as azure

example = azure.compute.get_virtual_machine_scale_set(name="existing",
    resource_group_name="existing")
pulumi.export("id", example.id)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.compute.getVirtualMachineScaleSet({
    name: "existing",
    resourceGroupName: "existing",
});
export const id = example.then(example => example.id);

Using GetVirtualMachineScaleSet

function getVirtualMachineScaleSet(args: GetVirtualMachineScaleSetArgs, opts?: InvokeOptions): Promise<GetVirtualMachineScaleSetResult>
function  get_virtual_machine_scale_set(name=None, resource_group_name=None, opts=None)
func GetVirtualMachineScaleSet(ctx *Context, args *GetVirtualMachineScaleSetArgs, opts ...InvokeOption) (*GetVirtualMachineScaleSetResult, error)
public static class GetVirtualMachineScaleSet {
    public static Task<GetVirtualMachineScaleSetResult> InvokeAsync(GetVirtualMachineScaleSetArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string

The name of this Virtual Machine Scale Set.

ResourceGroupName string

The name of the Resource Group where the Virtual Machine Scale Set exists.

Name string

The name of this Virtual Machine Scale Set.

ResourceGroupName string

The name of the Resource Group where the Virtual Machine Scale Set exists.

name string

The name of this Virtual Machine Scale Set.

resourceGroupName string

The name of the Resource Group where the Virtual Machine Scale Set exists.

name str

The name of this Virtual Machine Scale Set.

resource_group_name str

The name of the Resource Group where the Virtual Machine Scale Set exists.

GetVirtualMachineScaleSet Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

Identities List<GetVirtualMachineScaleSetIdentity>

A identity block as defined below.

Location string
Name string
ResourceGroupName string
Id string

The provider-assigned unique ID for this managed resource.

Identities []GetVirtualMachineScaleSetIdentity

A identity block as defined below.

Location string
Name string
ResourceGroupName string
id string

The provider-assigned unique ID for this managed resource.

identities GetVirtualMachineScaleSetIdentity[]

A identity block as defined below.

location string
name string
resourceGroupName string
id str

The provider-assigned unique ID for this managed resource.

identities List[GetVirtualMachineScaleSetIdentity]

A identity block as defined below.

location str
name str
resource_group_name str

Supporting Types

GetVirtualMachineScaleSetIdentity

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

IdentityIds List<string>

The list of User Managed Identity ID’s which are assigned to the Virtual Machine Scale Set.

PrincipalId string

The ID of the System Managed Service Principal assigned to the Virtual Machine Scale Set.

Type string

The identity type of the Managed Identity assigned to the Virtual Machine Scale Set.

IdentityIds []string

The list of User Managed Identity ID’s which are assigned to the Virtual Machine Scale Set.

PrincipalId string

The ID of the System Managed Service Principal assigned to the Virtual Machine Scale Set.

Type string

The identity type of the Managed Identity assigned to the Virtual Machine Scale Set.

identityIds string[]

The list of User Managed Identity ID’s which are assigned to the Virtual Machine Scale Set.

principalId string

The ID of the System Managed Service Principal assigned to the Virtual Machine Scale Set.

type string

The identity type of the Managed Identity assigned to the Virtual Machine Scale Set.

identityIds List[str]

The list of User Managed Identity ID’s which are assigned to the Virtual Machine Scale Set.

principal_id str

The ID of the System Managed Service Principal assigned to the Virtual Machine Scale Set.

type str

The identity type of the Managed Identity assigned to the Virtual Machine Scale Set.

Package Details

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