Documentation
¶
Index ¶
- type LookupPlacementGroupArgs
- type LookupPlacementGroupOutputArgs
- type LookupPlacementGroupResult
- type LookupPlacementGroupResultOutput
- func (LookupPlacementGroupResultOutput) ElementType() reflect.Type
- func (o LookupPlacementGroupResultOutput) Id() pulumi.StringOutput
- func (o LookupPlacementGroupResultOutput) Location() pulumi.StringOutput
- func (o LookupPlacementGroupResultOutput) Name() pulumi.StringOutput
- func (o LookupPlacementGroupResultOutput) ResourceGroupName() pulumi.StringOutput
- func (o LookupPlacementGroupResultOutput) Tags() pulumi.StringMapOutput
- func (o LookupPlacementGroupResultOutput) ToLookupPlacementGroupResultOutput() LookupPlacementGroupResultOutput
- func (o LookupPlacementGroupResultOutput) ToLookupPlacementGroupResultOutputWithContext(ctx context.Context) LookupPlacementGroupResultOutput
- type PlacementGroup
- type PlacementGroupArgs
- type PlacementGroupArray
- type PlacementGroupArrayInput
- type PlacementGroupArrayOutput
- func (PlacementGroupArrayOutput) ElementType() reflect.Type
- func (o PlacementGroupArrayOutput) Index(i pulumi.IntInput) PlacementGroupOutput
- func (o PlacementGroupArrayOutput) ToPlacementGroupArrayOutput() PlacementGroupArrayOutput
- func (o PlacementGroupArrayOutput) ToPlacementGroupArrayOutputWithContext(ctx context.Context) PlacementGroupArrayOutput
- type PlacementGroupInput
- type PlacementGroupMap
- type PlacementGroupMapInput
- type PlacementGroupMapOutput
- func (PlacementGroupMapOutput) ElementType() reflect.Type
- func (o PlacementGroupMapOutput) MapIndex(k pulumi.StringInput) PlacementGroupOutput
- func (o PlacementGroupMapOutput) ToPlacementGroupMapOutput() PlacementGroupMapOutput
- func (o PlacementGroupMapOutput) ToPlacementGroupMapOutputWithContext(ctx context.Context) PlacementGroupMapOutput
- type PlacementGroupOutput
- func (o PlacementGroupOutput) AllowedVmSizes() pulumi.StringArrayOutput
- func (PlacementGroupOutput) ElementType() reflect.Type
- func (o PlacementGroupOutput) Location() pulumi.StringOutput
- func (o PlacementGroupOutput) Name() pulumi.StringOutput
- func (o PlacementGroupOutput) ResourceGroupName() pulumi.StringOutput
- func (o PlacementGroupOutput) Tags() pulumi.StringMapOutput
- func (o PlacementGroupOutput) ToPlacementGroupOutput() PlacementGroupOutput
- func (o PlacementGroupOutput) ToPlacementGroupOutputWithContext(ctx context.Context) PlacementGroupOutput
- func (o PlacementGroupOutput) Zone() pulumi.StringPtrOutput
- type PlacementGroupState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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 LookupPlacementGroupOutputArgs ¶
type LookupPlacementGroupOutputArgs struct { // The name of the Proximity Placement Group. Name pulumi.StringInput `pulumi:"name"` // The name of the resource group in which the Proximity Placement Group exists. ResourceGroupName pulumi.StringInput `pulumi:"resourceGroupName"` }
A collection of arguments for invoking getPlacementGroup.
func (LookupPlacementGroupOutputArgs) ElementType ¶
func (LookupPlacementGroupOutputArgs) ElementType() reflect.Type
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-azure/sdk/v5/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 }) }
```
type LookupPlacementGroupResultOutput ¶
type LookupPlacementGroupResultOutput struct{ *pulumi.OutputState }
A collection of values returned by getPlacementGroup.
func LookupPlacementGroupOutput ¶
func LookupPlacementGroupOutput(ctx *pulumi.Context, args LookupPlacementGroupOutputArgs, opts ...pulumi.InvokeOption) LookupPlacementGroupResultOutput
func (LookupPlacementGroupResultOutput) ElementType ¶
func (LookupPlacementGroupResultOutput) ElementType() reflect.Type
func (LookupPlacementGroupResultOutput) Id ¶
func (o LookupPlacementGroupResultOutput) Id() pulumi.StringOutput
The provider-assigned unique ID for this managed resource.
func (LookupPlacementGroupResultOutput) Location ¶
func (o LookupPlacementGroupResultOutput) Location() pulumi.StringOutput
func (LookupPlacementGroupResultOutput) Name ¶
func (o LookupPlacementGroupResultOutput) Name() pulumi.StringOutput
func (LookupPlacementGroupResultOutput) ResourceGroupName ¶
func (o LookupPlacementGroupResultOutput) ResourceGroupName() pulumi.StringOutput
func (LookupPlacementGroupResultOutput) Tags ¶
func (o LookupPlacementGroupResultOutput) Tags() pulumi.StringMapOutput
func (LookupPlacementGroupResultOutput) ToLookupPlacementGroupResultOutput ¶
func (o LookupPlacementGroupResultOutput) ToLookupPlacementGroupResultOutput() LookupPlacementGroupResultOutput
func (LookupPlacementGroupResultOutput) ToLookupPlacementGroupResultOutputWithContext ¶
func (o LookupPlacementGroupResultOutput) ToLookupPlacementGroupResultOutputWithContext(ctx context.Context) LookupPlacementGroupResultOutput
type PlacementGroup ¶
type PlacementGroup struct { pulumi.CustomResourceState // Specifies the supported sizes of Virtual Machines that can be created in the Proximity Placement Group. // // > **NOTE:** Removing `allowedVmSizes` after it is set forces a new resource to be created. AllowedVmSizes pulumi.StringArrayOutput `pulumi:"allowedVmSizes"` // 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 proximity placement group. 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"` // Specifies the supported zone of the Proximity Placement Group. Changing this forces a new resource to be created. // // > **NOTE:** `allowedVmSizes` must be set when `zone` is specified. Zone pulumi.StringPtrOutput `pulumi:"zone"` }
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/v5/go/azure/core" "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/proximity" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{ Location: pulumi.String("West Europe"), }) if err != nil { return err } _, err = proximity.NewPlacementGroup(ctx, "examplePlacementGroup", &proximity.PlacementGroupArgs{ Location: exampleResourceGroup.Location, ResourceGroupName: exampleResourceGroup.Name, Tags: pulumi.StringMap{ "environment": pulumi.String("Production"), }, }) if err != nil { return err } return nil }) }
```
## Import
Proximity Placement Groups can be imported using the `resource id`, e.g.
```sh
$ pulumi import azure:proximity/placementGroup:PlacementGroup example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-rg/providers/Microsoft.Compute/proximityPlacementGroups/example-ppg
```
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.
func (*PlacementGroup) ElementType ¶
func (*PlacementGroup) ElementType() reflect.Type
func (*PlacementGroup) ToPlacementGroupOutput ¶
func (i *PlacementGroup) ToPlacementGroupOutput() PlacementGroupOutput
func (*PlacementGroup) ToPlacementGroupOutputWithContext ¶
func (i *PlacementGroup) ToPlacementGroupOutputWithContext(ctx context.Context) PlacementGroupOutput
type PlacementGroupArgs ¶
type PlacementGroupArgs struct { // Specifies the supported sizes of Virtual Machines that can be created in the Proximity Placement Group. // // > **NOTE:** Removing `allowedVmSizes` after it is set forces a new resource to be created. AllowedVmSizes pulumi.StringArrayInput // 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 proximity placement group. 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 // Specifies the supported zone of the Proximity Placement Group. Changing this forces a new resource to be created. // // > **NOTE:** `allowedVmSizes` must be set when `zone` is specified. Zone pulumi.StringPtrInput }
The set of arguments for constructing a PlacementGroup resource.
func (PlacementGroupArgs) ElementType ¶
func (PlacementGroupArgs) ElementType() reflect.Type
type PlacementGroupArray ¶
type PlacementGroupArray []PlacementGroupInput
func (PlacementGroupArray) ElementType ¶
func (PlacementGroupArray) ElementType() reflect.Type
func (PlacementGroupArray) ToPlacementGroupArrayOutput ¶
func (i PlacementGroupArray) ToPlacementGroupArrayOutput() PlacementGroupArrayOutput
func (PlacementGroupArray) ToPlacementGroupArrayOutputWithContext ¶
func (i PlacementGroupArray) ToPlacementGroupArrayOutputWithContext(ctx context.Context) PlacementGroupArrayOutput
type PlacementGroupArrayInput ¶
type PlacementGroupArrayInput interface { pulumi.Input ToPlacementGroupArrayOutput() PlacementGroupArrayOutput ToPlacementGroupArrayOutputWithContext(context.Context) PlacementGroupArrayOutput }
PlacementGroupArrayInput is an input type that accepts PlacementGroupArray and PlacementGroupArrayOutput values. You can construct a concrete instance of `PlacementGroupArrayInput` via:
PlacementGroupArray{ PlacementGroupArgs{...} }
type PlacementGroupArrayOutput ¶
type PlacementGroupArrayOutput struct{ *pulumi.OutputState }
func (PlacementGroupArrayOutput) ElementType ¶
func (PlacementGroupArrayOutput) ElementType() reflect.Type
func (PlacementGroupArrayOutput) Index ¶
func (o PlacementGroupArrayOutput) Index(i pulumi.IntInput) PlacementGroupOutput
func (PlacementGroupArrayOutput) ToPlacementGroupArrayOutput ¶
func (o PlacementGroupArrayOutput) ToPlacementGroupArrayOutput() PlacementGroupArrayOutput
func (PlacementGroupArrayOutput) ToPlacementGroupArrayOutputWithContext ¶
func (o PlacementGroupArrayOutput) ToPlacementGroupArrayOutputWithContext(ctx context.Context) PlacementGroupArrayOutput
type PlacementGroupInput ¶
type PlacementGroupInput interface { pulumi.Input ToPlacementGroupOutput() PlacementGroupOutput ToPlacementGroupOutputWithContext(ctx context.Context) PlacementGroupOutput }
type PlacementGroupMap ¶
type PlacementGroupMap map[string]PlacementGroupInput
func (PlacementGroupMap) ElementType ¶
func (PlacementGroupMap) ElementType() reflect.Type
func (PlacementGroupMap) ToPlacementGroupMapOutput ¶
func (i PlacementGroupMap) ToPlacementGroupMapOutput() PlacementGroupMapOutput
func (PlacementGroupMap) ToPlacementGroupMapOutputWithContext ¶
func (i PlacementGroupMap) ToPlacementGroupMapOutputWithContext(ctx context.Context) PlacementGroupMapOutput
type PlacementGroupMapInput ¶
type PlacementGroupMapInput interface { pulumi.Input ToPlacementGroupMapOutput() PlacementGroupMapOutput ToPlacementGroupMapOutputWithContext(context.Context) PlacementGroupMapOutput }
PlacementGroupMapInput is an input type that accepts PlacementGroupMap and PlacementGroupMapOutput values. You can construct a concrete instance of `PlacementGroupMapInput` via:
PlacementGroupMap{ "key": PlacementGroupArgs{...} }
type PlacementGroupMapOutput ¶
type PlacementGroupMapOutput struct{ *pulumi.OutputState }
func (PlacementGroupMapOutput) ElementType ¶
func (PlacementGroupMapOutput) ElementType() reflect.Type
func (PlacementGroupMapOutput) MapIndex ¶
func (o PlacementGroupMapOutput) MapIndex(k pulumi.StringInput) PlacementGroupOutput
func (PlacementGroupMapOutput) ToPlacementGroupMapOutput ¶
func (o PlacementGroupMapOutput) ToPlacementGroupMapOutput() PlacementGroupMapOutput
func (PlacementGroupMapOutput) ToPlacementGroupMapOutputWithContext ¶
func (o PlacementGroupMapOutput) ToPlacementGroupMapOutputWithContext(ctx context.Context) PlacementGroupMapOutput
type PlacementGroupOutput ¶
type PlacementGroupOutput struct{ *pulumi.OutputState }
func (PlacementGroupOutput) AllowedVmSizes ¶ added in v5.30.0
func (o PlacementGroupOutput) AllowedVmSizes() pulumi.StringArrayOutput
Specifies the supported sizes of Virtual Machines that can be created in the Proximity Placement Group.
> **NOTE:** Removing `allowedVmSizes` after it is set forces a new resource to be created.
func (PlacementGroupOutput) ElementType ¶
func (PlacementGroupOutput) ElementType() reflect.Type
func (PlacementGroupOutput) Location ¶ added in v5.5.0
func (o PlacementGroupOutput) Location() pulumi.StringOutput
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
func (PlacementGroupOutput) Name ¶ added in v5.5.0
func (o PlacementGroupOutput) Name() pulumi.StringOutput
Specifies the name of the proximity placement group. Changing this forces a new resource to be created.
func (PlacementGroupOutput) ResourceGroupName ¶ added in v5.5.0
func (o PlacementGroupOutput) ResourceGroupName() pulumi.StringOutput
The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.
func (PlacementGroupOutput) Tags ¶ added in v5.5.0
func (o PlacementGroupOutput) Tags() pulumi.StringMapOutput
A mapping of tags to assign to the resource.
func (PlacementGroupOutput) ToPlacementGroupOutput ¶
func (o PlacementGroupOutput) ToPlacementGroupOutput() PlacementGroupOutput
func (PlacementGroupOutput) ToPlacementGroupOutputWithContext ¶
func (o PlacementGroupOutput) ToPlacementGroupOutputWithContext(ctx context.Context) PlacementGroupOutput
func (PlacementGroupOutput) Zone ¶ added in v5.30.0
func (o PlacementGroupOutput) Zone() pulumi.StringPtrOutput
Specifies the supported zone of the Proximity Placement Group. Changing this forces a new resource to be created.
> **NOTE:** `allowedVmSizes` must be set when `zone` is specified.
type PlacementGroupState ¶
type PlacementGroupState struct { // Specifies the supported sizes of Virtual Machines that can be created in the Proximity Placement Group. // // > **NOTE:** Removing `allowedVmSizes` after it is set forces a new resource to be created. AllowedVmSizes pulumi.StringArrayInput // 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 proximity placement group. 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 // Specifies the supported zone of the Proximity Placement Group. Changing this forces a new resource to be created. // // > **NOTE:** `allowedVmSizes` must be set when `zone` is specified. Zone pulumi.StringPtrInput }
func (PlacementGroupState) ElementType ¶
func (PlacementGroupState) ElementType() reflect.Type