proximity

Documentation

Index

• type LookupPlacementGroupArgs
• type LookupPlacementGroupResult
  • func LookupPlacementGroup(ctx *pulumi.Context, args *LookupPlacementGroupArgs, ...) (*LookupPlacementGroupResult, error)
• type PlacementGroup
  • func GetPlacementGroup(ctx *pulumi.Context, name string, id pulumi.IDInput, ...) (*PlacementGroup, error)
  • func NewPlacementGroup(ctx *pulumi.Context, name string, args *PlacementGroupArgs, ...) (*PlacementGroup, error)
• type PlacementGroupArgs
  • func (PlacementGroupArgs) ElementType() reflect.Type
• type PlacementGroupState
  • func (PlacementGroupState) ElementType() reflect.Type

Types

type LookupPlacementGroupArgs

type LookupPlacementGroupArgs struct {
	// The name of the Proximity Placement Group.
	Name string `pulumi:"name"`
	// The name of the resource group in which the Proximity Placement Group exists.
	ResourceGroupName string `pulumi:"resourceGroupName"`
}

A collection of arguments for invoking getPlacementGroup.

type LookupPlacementGroupResult

type LookupPlacementGroupResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id                string            `pulumi:"id"`
	Location          string            `pulumi:"location"`
	Name              string            `pulumi:"name"`
	ResourceGroupName string            `pulumi:"resourceGroupName"`
	Tags              map[string]string `pulumi:"tags"`
}

A collection of values returned by getPlacementGroup.

func LookupPlacementGroup

func LookupPlacementGroup(ctx *pulumi.Context, args *LookupPlacementGroupArgs, opts ...pulumi.InvokeOption) (*LookupPlacementGroupResult, error)

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

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi/sdk/v2/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
	})
}

```

type PlacementGroup

type PlacementGroup struct {
	pulumi.CustomResourceState

	// Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
	Location pulumi.StringOutput `pulumi:"location"`
	// Specifies the name of the availability set. Changing this forces a new resource to be created.
	Name pulumi.StringOutput `pulumi:"name"`
	// The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"`
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
}

Manages a proximity placement group for virtual machines, virtual machine scale sets and availability sets.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/proximity"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West US"),
		})
		if err != nil {
			return err
		}
		examplePlacementGroup, err := proximity.NewPlacementGroup(ctx, "examplePlacementGroup", &proximity.PlacementGroupArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			Tags: map[string]interface{}{
				"environment": "Production",
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetPlacementGroup

func GetPlacementGroup(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *PlacementGroupState, opts ...pulumi.ResourceOption) (*PlacementGroup, error)

GetPlacementGroup gets an existing PlacementGroup resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewPlacementGroup

func NewPlacementGroup(ctx *pulumi.Context,
	name string, args *PlacementGroupArgs, opts ...pulumi.ResourceOption) (*PlacementGroup, error)

NewPlacementGroup registers a new resource with the given unique name, arguments, and options.

type PlacementGroupArgs

type PlacementGroupArgs struct {
	// Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
	Location pulumi.StringPtrInput
	// Specifies the name of the availability set. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a PlacementGroup resource.

func (PlacementGroupArgs) ElementType

func (PlacementGroupArgs) ElementType() reflect.Type

type PlacementGroupState

type PlacementGroupState struct {
	// Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
	Location pulumi.StringPtrInput
	// Specifies the name of the availability set. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringPtrInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapInput
}

func (PlacementGroupState) ElementType

func (PlacementGroupState) ElementType() reflect.Type