getGroup

Use this data source to access information about an existing Container Group instance.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.ContainerService.GetGroup.Invoke(new()
    {
        Name = "existing",
        ResourceGroupName = "existing",
    });

    return new Dictionary<string, object?>
    {
        ["id"] = example.Apply(getGroupResult => getGroupResult.Id),
        ["ipAddress"] = example.Apply(getGroupResult => getGroupResult.IpAddress),
        ["fqdn"] = example.Apply(getGroupResult => getGroupResult.Fqdn),
    };
});
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/containerservice"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := containerservice.LookupGroup(ctx, &containerservice.LookupGroupArgs{
			Name:              "existing",
			ResourceGroupName: "existing",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("id", example.Id)
		ctx.Export("ipAddress", example.IpAddress)
		ctx.Export("fqdn", example.Fqdn)
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.containerservice.ContainerserviceFunctions;
import com.pulumi.azure.apimanagement.inputs.GetGroupArgs;
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 = ContainerserviceFunctions.getGroup(GetGroupArgs.builder()
            .name("existing")
            .resourceGroupName("existing")
            .build());

        ctx.export("id", example.applyValue(getGroupResult -> getGroupResult.id()));
        ctx.export("ipAddress", example.applyValue(getGroupResult -> getGroupResult.ipAddress()));
        ctx.export("fqdn", example.applyValue(getGroupResult -> getGroupResult.fqdn()));
    }
}
import pulumi
import pulumi_azure as azure

example = azure.containerservice.get_group(name="existing",
    resource_group_name="existing")
pulumi.export("id", example.id)
pulumi.export("ipAddress", example.ip_address)
pulumi.export("fqdn", example.fqdn)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.containerservice.getGroup({
    name: "existing",
    resourceGroupName: "existing",
});
export const id = example.then(example => example.id);
export const ipAddress = example.then(example => example.ipAddress);
export const fqdn = example.then(example => example.fqdn);
variables:
  example:
    Fn::Invoke:
      Function: azure:containerservice:getGroup
      Arguments:
        name: existing
        resourceGroupName: existing
outputs:
  id: ${example.id}
  ipAddress: ${example.ipAddress}
  fqdn: ${example.fqdn}

Using getGroup

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 getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
function getGroupOutput(args: GetGroupOutputArgs, opts?: InvokeOptions): Output<GetGroupResult>
def get_group(name: Optional[str] = None,
              resource_group_name: Optional[str] = None,
              zones: Optional[Sequence[str]] = None,
              opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(name: Optional[pulumi.Input[str]] = None,
              resource_group_name: Optional[pulumi.Input[str]] = None,
              zones: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetGroupResult]
func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)
func LookupGroupOutput(ctx *Context, args *LookupGroupOutputArgs, opts ...InvokeOption) LookupGroupResultOutput

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

public static class GetGroup 
{
    public static Task<GetGroupResult> InvokeAsync(GetGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupResult> Invoke(GetGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: azure:containerservice/getGroup:getGroup
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string

The name of this Container Group instance.

ResourceGroupName string

The name of the Resource Group where the Container Group instance exists.

Zones List<string>

A list of Availability Zones in which this Container Group is located.

Name string

The name of this Container Group instance.

ResourceGroupName string

The name of the Resource Group where the Container Group instance exists.

Zones []string

A list of Availability Zones in which this Container Group is located.

name String

The name of this Container Group instance.

resourceGroupName String

The name of the Resource Group where the Container Group instance exists.

zones List<String>

A list of Availability Zones in which this Container Group is located.

name string

The name of this Container Group instance.

resourceGroupName string

The name of the Resource Group where the Container Group instance exists.

zones string[]

A list of Availability Zones in which this Container Group is located.

name str

The name of this Container Group instance.

resource_group_name str

The name of the Resource Group where the Container Group instance exists.

zones Sequence[str]

A list of Availability Zones in which this Container Group is located.

name String

The name of this Container Group instance.

resourceGroupName String

The name of the Resource Group where the Container Group instance exists.

zones List<String>

A list of Availability Zones in which this Container Group is located.

getGroup Result

The following output properties are available:

Fqdn string

The FQDN of the Container Group instance derived from dns_name_label.

Id string

The provider-assigned unique ID for this managed resource.

Identities List<GetGroupIdentity>

A identity block as defined below.

IpAddress string

The IP address allocated to the Container Group instance.

Location string

The Azure Region where the Container Group instance exists.

Name string
ResourceGroupName string
SubnetIds List<string>

The subnet resource IDs for a container group.

Tags Dictionary<string, string>

A mapping of tags assigned to the Container Group instance.

Zones List<string>

A list of Availability Zones in which this Container Group is located.

Fqdn string

The FQDN of the Container Group instance derived from dns_name_label.

Id string

The provider-assigned unique ID for this managed resource.

Identities []GetGroupIdentity

A identity block as defined below.

IpAddress string

The IP address allocated to the Container Group instance.

Location string

The Azure Region where the Container Group instance exists.

Name string
ResourceGroupName string
SubnetIds []string

The subnet resource IDs for a container group.

Tags map[string]string

A mapping of tags assigned to the Container Group instance.

Zones []string

A list of Availability Zones in which this Container Group is located.

fqdn String

The FQDN of the Container Group instance derived from dns_name_label.

id String

The provider-assigned unique ID for this managed resource.

identities List<GetGroupIdentity>

A identity block as defined below.

ipAddress String

The IP address allocated to the Container Group instance.

location String

The Azure Region where the Container Group instance exists.

name String
resourceGroupName String
subnetIds List<String>

The subnet resource IDs for a container group.

tags Map<String,String>

A mapping of tags assigned to the Container Group instance.

zones List<String>

A list of Availability Zones in which this Container Group is located.

fqdn string

The FQDN of the Container Group instance derived from dns_name_label.

id string

The provider-assigned unique ID for this managed resource.

identities GetGroupIdentity[]

A identity block as defined below.

ipAddress string

The IP address allocated to the Container Group instance.

location string

The Azure Region where the Container Group instance exists.

name string
resourceGroupName string
subnetIds string[]

The subnet resource IDs for a container group.

tags {[key: string]: string}

A mapping of tags assigned to the Container Group instance.

zones string[]

A list of Availability Zones in which this Container Group is located.

fqdn str

The FQDN of the Container Group instance derived from dns_name_label.

id str

The provider-assigned unique ID for this managed resource.

identities Sequence[GetGroupIdentity]

A identity block as defined below.

ip_address str

The IP address allocated to the Container Group instance.

location str

The Azure Region where the Container Group instance exists.

name str
resource_group_name str
subnet_ids Sequence[str]

The subnet resource IDs for a container group.

tags Mapping[str, str]

A mapping of tags assigned to the Container Group instance.

zones Sequence[str]

A list of Availability Zones in which this Container Group is located.

fqdn String

The FQDN of the Container Group instance derived from dns_name_label.

id String

The provider-assigned unique ID for this managed resource.

identities List<Property Map>

A identity block as defined below.

ipAddress String

The IP address allocated to the Container Group instance.

location String

The Azure Region where the Container Group instance exists.

name String
resourceGroupName String
subnetIds List<String>

The subnet resource IDs for a container group.

tags Map<String>

A mapping of tags assigned to the Container Group instance.

zones List<String>

A list of Availability Zones in which this Container Group is located.

Supporting Types

GetGroupIdentity

IdentityIds List<string>

The list of User Assigned Managed Identity IDs assigned to this Container Group.

PrincipalId string

The Principal ID of the System Assigned Managed Service Identity that is configured on this Container Group.

TenantId string

The Tenant ID of the System Assigned Managed Service Identity that is configured on this Container Group.

Type string

Type of Managed Service Identity configured on this Container Group.

IdentityIds []string

The list of User Assigned Managed Identity IDs assigned to this Container Group.

PrincipalId string

The Principal ID of the System Assigned Managed Service Identity that is configured on this Container Group.

TenantId string

The Tenant ID of the System Assigned Managed Service Identity that is configured on this Container Group.

Type string

Type of Managed Service Identity configured on this Container Group.

identityIds List<String>

The list of User Assigned Managed Identity IDs assigned to this Container Group.

principalId String

The Principal ID of the System Assigned Managed Service Identity that is configured on this Container Group.

tenantId String

The Tenant ID of the System Assigned Managed Service Identity that is configured on this Container Group.

type String

Type of Managed Service Identity configured on this Container Group.

identityIds string[]

The list of User Assigned Managed Identity IDs assigned to this Container Group.

principalId string

The Principal ID of the System Assigned Managed Service Identity that is configured on this Container Group.

tenantId string

The Tenant ID of the System Assigned Managed Service Identity that is configured on this Container Group.

type string

Type of Managed Service Identity configured on this Container Group.

identity_ids Sequence[str]

The list of User Assigned Managed Identity IDs assigned to this Container Group.

principal_id str

The Principal ID of the System Assigned Managed Service Identity that is configured on this Container Group.

tenant_id str

The Tenant ID of the System Assigned Managed Service Identity that is configured on this Container Group.

type str

Type of Managed Service Identity configured on this Container Group.

identityIds List<String>

The list of User Assigned Managed Identity IDs assigned to this Container Group.

principalId String

The Principal ID of the System Assigned Managed Service Identity that is configured on this Container Group.

tenantId String

The Tenant ID of the System Assigned Managed Service Identity that is configured on this Container Group.

type String

Type of Managed Service Identity configured on this Container Group.

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.