1. Packages
  2. Azure Classic
  3. API Docs
  4. proximity
  5. getPlacementGroup

We recommend using Azure Native.

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

azure.proximity.getPlacementGroup

Explore with Pulumi AI

We recommend using Azure Native.

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

Use this data source to access information about an existing Proximity Placement Group.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.proximity.getPlacementGroup({
    name: "tf-appsecuritygroup",
    resourceGroupName: "my-resource-group",
});
export const proximityPlacementGroupId = example.then(example => example.id);
Copy
import pulumi
import pulumi_azure as azure

example = azure.proximity.get_placement_group(name="tf-appsecuritygroup",
    resource_group_name="my-resource-group")
pulumi.export("proximityPlacementGroupId", example.id)
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/proximity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := proximity.LookupPlacementGroup(ctx, &proximity.LookupPlacementGroupArgs{
			Name:              "tf-appsecuritygroup",
			ResourceGroupName: "my-resource-group",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("proximityPlacementGroupId", example.Id)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.Proximity.GetPlacementGroup.Invoke(new()
    {
        Name = "tf-appsecuritygroup",
        ResourceGroupName = "my-resource-group",
    });

    return new Dictionary<string, object?>
    {
        ["proximityPlacementGroupId"] = example.Apply(getPlacementGroupResult => getPlacementGroupResult.Id),
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.proximity.ProximityFunctions;
import com.pulumi.azure.proximity.inputs.GetPlacementGroupArgs;
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 = ProximityFunctions.getPlacementGroup(GetPlacementGroupArgs.builder()
            .name("tf-appsecuritygroup")
            .resourceGroupName("my-resource-group")
            .build());

        ctx.export("proximityPlacementGroupId", example.applyValue(getPlacementGroupResult -> getPlacementGroupResult.id()));
    }
}
Copy
variables:
  example:
    fn::invoke:
      function: azure:proximity:getPlacementGroup
      arguments:
        name: tf-appsecuritygroup
        resourceGroupName: my-resource-group
outputs:
  proximityPlacementGroupId: ${example.id}
Copy

Using getPlacementGroup

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 getPlacementGroup(args: GetPlacementGroupArgs, opts?: InvokeOptions): Promise<GetPlacementGroupResult>
function getPlacementGroupOutput(args: GetPlacementGroupOutputArgs, opts?: InvokeOptions): Output<GetPlacementGroupResult>
Copy
def get_placement_group(name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetPlacementGroupResult
def get_placement_group_output(name: Optional[pulumi.Input[str]] = None,
                        resource_group_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetPlacementGroupResult]
Copy
func LookupPlacementGroup(ctx *Context, args *LookupPlacementGroupArgs, opts ...InvokeOption) (*LookupPlacementGroupResult, error)
func LookupPlacementGroupOutput(ctx *Context, args *LookupPlacementGroupOutputArgs, opts ...InvokeOption) LookupPlacementGroupResultOutput
Copy

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

public static class GetPlacementGroup 
{
    public static Task<GetPlacementGroupResult> InvokeAsync(GetPlacementGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetPlacementGroupResult> Invoke(GetPlacementGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPlacementGroupResult> getPlacementGroup(GetPlacementGroupArgs args, InvokeOptions options)
public static Output<GetPlacementGroupResult> getPlacementGroup(GetPlacementGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure:proximity/getPlacementGroup:getPlacementGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
The name of the Proximity Placement Group.
ResourceGroupName This property is required. string
The name of the resource group in which the Proximity Placement Group exists.
Name This property is required. string
The name of the Proximity Placement Group.
ResourceGroupName This property is required. string
The name of the resource group in which the Proximity Placement Group exists.
name This property is required. String
The name of the Proximity Placement Group.
resourceGroupName This property is required. String
The name of the resource group in which the Proximity Placement Group exists.
name This property is required. string
The name of the Proximity Placement Group.
resourceGroupName This property is required. string
The name of the resource group in which the Proximity Placement Group exists.
name This property is required. str
The name of the Proximity Placement Group.
resource_group_name This property is required. str
The name of the resource group in which the Proximity Placement Group exists.
name This property is required. String
The name of the Proximity Placement Group.
resourceGroupName This property is required. String
The name of the resource group in which the Proximity Placement Group exists.

getPlacementGroup Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Location string
Name string
ResourceGroupName string
Tags Dictionary<string, string>
Id string
The provider-assigned unique ID for this managed resource.
Location string
Name string
ResourceGroupName string
Tags map[string]string
id String
The provider-assigned unique ID for this managed resource.
location String
name String
resourceGroupName String
tags Map<String,String>
id string
The provider-assigned unique ID for this managed resource.
location string
name string
resourceGroupName string
tags {[key: string]: string}
id str
The provider-assigned unique ID for this managed resource.
location str
name str
resource_group_name str
tags Mapping[str, str]
id String
The provider-assigned unique ID for this managed resource.
location String
name String
resourceGroupName String
tags Map<String>

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