Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.1 published on Wednesday, May 18, 2022 by Pulumi

getProximityPlacementGroup

Specifies information about the proximity placement group. API Version: 2020-12-01.

Using getProximityPlacementGroup

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 getProximityPlacementGroup(args: GetProximityPlacementGroupArgs, opts?: InvokeOptions): Promise<GetProximityPlacementGroupResult>
function getProximityPlacementGroupOutput(args: GetProximityPlacementGroupOutputArgs, opts?: InvokeOptions): Output<GetProximityPlacementGroupResult>
def get_proximity_placement_group(include_colocation_status: Optional[str] = None,
                                  proximity_placement_group_name: Optional[str] = None,
                                  resource_group_name: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetProximityPlacementGroupResult
def get_proximity_placement_group_output(include_colocation_status: Optional[pulumi.Input[str]] = None,
                                  proximity_placement_group_name: Optional[pulumi.Input[str]] = None,
                                  resource_group_name: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetProximityPlacementGroupResult]
func LookupProximityPlacementGroup(ctx *Context, args *LookupProximityPlacementGroupArgs, opts ...InvokeOption) (*LookupProximityPlacementGroupResult, error)
func LookupProximityPlacementGroupOutput(ctx *Context, args *LookupProximityPlacementGroupOutputArgs, opts ...InvokeOption) LookupProximityPlacementGroupResultOutput

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

public static class GetProximityPlacementGroup 
{
    public static Task<GetProximityPlacementGroupResult> InvokeAsync(GetProximityPlacementGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetProximityPlacementGroupResult> Invoke(GetProximityPlacementGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetProximityPlacementGroupResult> getProximityPlacementGroup(GetProximityPlacementGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:compute:getProximityPlacementGroup
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ProximityPlacementGroupName string

The name of the proximity placement group.

ResourceGroupName string

The name of the resource group.

IncludeColocationStatus string

includeColocationStatus=true enables fetching the colocation status of all the resources in the proximity placement group.

ProximityPlacementGroupName string

The name of the proximity placement group.

ResourceGroupName string

The name of the resource group.

IncludeColocationStatus string

includeColocationStatus=true enables fetching the colocation status of all the resources in the proximity placement group.

proximityPlacementGroupName String

The name of the proximity placement group.

resourceGroupName String

The name of the resource group.

includeColocationStatus String

includeColocationStatus=true enables fetching the colocation status of all the resources in the proximity placement group.

proximityPlacementGroupName string

The name of the proximity placement group.

resourceGroupName string

The name of the resource group.

includeColocationStatus string

includeColocationStatus=true enables fetching the colocation status of all the resources in the proximity placement group.

proximity_placement_group_name str

The name of the proximity placement group.

resource_group_name str

The name of the resource group.

include_colocation_status str

includeColocationStatus=true enables fetching the colocation status of all the resources in the proximity placement group.

proximityPlacementGroupName String

The name of the proximity placement group.

resourceGroupName String

The name of the resource group.

includeColocationStatus String

includeColocationStatus=true enables fetching the colocation status of all the resources in the proximity placement group.

getProximityPlacementGroup Result

The following output properties are available:

AvailabilitySets List<Pulumi.AzureNative.Compute.Outputs.SubResourceWithColocationStatusResponse>

A list of references to all availability sets in the proximity placement group.

Id string

Resource Id

Location string

Resource location

Name string

Resource name

Type string

Resource type

VirtualMachineScaleSets List<Pulumi.AzureNative.Compute.Outputs.SubResourceWithColocationStatusResponse>

A list of references to all virtual machine scale sets in the proximity placement group.

VirtualMachines List<Pulumi.AzureNative.Compute.Outputs.SubResourceWithColocationStatusResponse>

A list of references to all virtual machines in the proximity placement group.

ColocationStatus Pulumi.AzureNative.Compute.Outputs.InstanceViewStatusResponse

Describes colocation status of the Proximity Placement Group.

ProximityPlacementGroupType string

Specifies the type of the proximity placement group. Possible values are: Standard : Co-locate resources within an Azure region or Availability Zone. Ultra : For future use.

Tags Dictionary<string, string>

Resource tags

AvailabilitySets []SubResourceWithColocationStatusResponse

A list of references to all availability sets in the proximity placement group.

Id string

Resource Id

Location string

Resource location

Name string

Resource name

Type string

Resource type

VirtualMachineScaleSets []SubResourceWithColocationStatusResponse

A list of references to all virtual machine scale sets in the proximity placement group.

VirtualMachines []SubResourceWithColocationStatusResponse

A list of references to all virtual machines in the proximity placement group.

ColocationStatus InstanceViewStatusResponse

Describes colocation status of the Proximity Placement Group.

ProximityPlacementGroupType string

Specifies the type of the proximity placement group. Possible values are: Standard : Co-locate resources within an Azure region or Availability Zone. Ultra : For future use.

Tags map[string]string

Resource tags

availabilitySets List<SubResourceWithColocationStatusResponse>

A list of references to all availability sets in the proximity placement group.

id String

Resource Id

location String

Resource location

name String

Resource name

type String

Resource type

virtualMachineScaleSets List<SubResourceWithColocationStatusResponse>

A list of references to all virtual machine scale sets in the proximity placement group.

virtualMachines List<SubResourceWithColocationStatusResponse>

A list of references to all virtual machines in the proximity placement group.

colocationStatus InstanceViewStatusResponse

Describes colocation status of the Proximity Placement Group.

proximityPlacementGroupType String

Specifies the type of the proximity placement group. Possible values are: Standard : Co-locate resources within an Azure region or Availability Zone. Ultra : For future use.

tags Map<String,String>

Resource tags

availabilitySets SubResourceWithColocationStatusResponse[]

A list of references to all availability sets in the proximity placement group.

id string

Resource Id

location string

Resource location

name string

Resource name

type string

Resource type

virtualMachineScaleSets SubResourceWithColocationStatusResponse[]

A list of references to all virtual machine scale sets in the proximity placement group.

virtualMachines SubResourceWithColocationStatusResponse[]

A list of references to all virtual machines in the proximity placement group.

colocationStatus InstanceViewStatusResponse

Describes colocation status of the Proximity Placement Group.

proximityPlacementGroupType string

Specifies the type of the proximity placement group. Possible values are: Standard : Co-locate resources within an Azure region or Availability Zone. Ultra : For future use.

tags {[key: string]: string}

Resource tags

availability_sets Sequence[SubResourceWithColocationStatusResponse]

A list of references to all availability sets in the proximity placement group.

id str

Resource Id

location str

Resource location

name str

Resource name

type str

Resource type

virtual_machine_scale_sets Sequence[SubResourceWithColocationStatusResponse]

A list of references to all virtual machine scale sets in the proximity placement group.

virtual_machines Sequence[SubResourceWithColocationStatusResponse]

A list of references to all virtual machines in the proximity placement group.

colocation_status InstanceViewStatusResponse

Describes colocation status of the Proximity Placement Group.

proximity_placement_group_type str

Specifies the type of the proximity placement group. Possible values are: Standard : Co-locate resources within an Azure region or Availability Zone. Ultra : For future use.

tags Mapping[str, str]

Resource tags

availabilitySets List<Property Map>

A list of references to all availability sets in the proximity placement group.

id String

Resource Id

location String

Resource location

name String

Resource name

type String

Resource type

virtualMachineScaleSets List<Property Map>

A list of references to all virtual machine scale sets in the proximity placement group.

virtualMachines List<Property Map>

A list of references to all virtual machines in the proximity placement group.

colocationStatus Property Map

Describes colocation status of the Proximity Placement Group.

proximityPlacementGroupType String

Specifies the type of the proximity placement group. Possible values are: Standard : Co-locate resources within an Azure region or Availability Zone. Ultra : For future use.

tags Map<String>

Resource tags

Supporting Types

InstanceViewStatusResponse

Code string

The status code.

DisplayStatus string

The short localizable label for the status.

Level string

The level code.

Message string

The detailed status message, including for alerts and error messages.

Time string

The time of the status.

Code string

The status code.

DisplayStatus string

The short localizable label for the status.

Level string

The level code.

Message string

The detailed status message, including for alerts and error messages.

Time string

The time of the status.

code String

The status code.

displayStatus String

The short localizable label for the status.

level String

The level code.

message String

The detailed status message, including for alerts and error messages.

time String

The time of the status.

code string

The status code.

displayStatus string

The short localizable label for the status.

level string

The level code.

message string

The detailed status message, including for alerts and error messages.

time string

The time of the status.

code str

The status code.

display_status str

The short localizable label for the status.

level str

The level code.

message str

The detailed status message, including for alerts and error messages.

time str

The time of the status.

code String

The status code.

displayStatus String

The short localizable label for the status.

level String

The level code.

message String

The detailed status message, including for alerts and error messages.

time String

The time of the status.

SubResourceWithColocationStatusResponse

ColocationStatus Pulumi.AzureNative.Compute.Inputs.InstanceViewStatusResponse

Describes colocation status of a resource in the Proximity Placement Group.

Id string

Resource Id

ColocationStatus InstanceViewStatusResponse

Describes colocation status of a resource in the Proximity Placement Group.

Id string

Resource Id

colocationStatus InstanceViewStatusResponse

Describes colocation status of a resource in the Proximity Placement Group.

id String

Resource Id

colocationStatus InstanceViewStatusResponse

Describes colocation status of a resource in the Proximity Placement Group.

id string

Resource Id

colocation_status InstanceViewStatusResponse

Describes colocation status of a resource in the Proximity Placement Group.

id str

Resource Id

colocationStatus Property Map

Describes colocation status of a resource in the Proximity Placement Group.

id String

Resource Id

Package Details

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