Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. compute
  5. getProximityPlacementGroup
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.compute.getProximityPlacementGroup

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

    Retrieves information about a proximity placement group .

    Uses Azure REST API version 2024-11-01.

    Other available API versions: 2022-08-01, 2022-11-01, 2023-03-01, 2023-07-01, 2023-09-01, 2024-03-01, 2024-07-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native compute [ApiVersion]. See the version guide for details.

    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)
public static Output<GetProximityPlacementGroupResult> getProximityPlacementGroup(GetProximityPlacementGroupArgs args, InvokeOptions options)

    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.
    AzureApiVersion string
    The Azure API version of the resource.
    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.
    Intent Pulumi.AzureNative.Compute.Outputs.ProximityPlacementGroupPropertiesResponseIntent
    Specifies the user intent 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
    Zones List<string>
    Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created.
    AvailabilitySets []SubResourceWithColocationStatusResponse
    A list of references to all availability sets in the proximity placement group.
    AzureApiVersion string
    The Azure API version of the resource.
    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.
    Intent ProximityPlacementGroupPropertiesResponseIntent
    Specifies the user intent 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
    Zones []string
    Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created.
    availabilitySets List<SubResourceWithColocationStatusResponse>
    A list of references to all availability sets in the proximity placement group.
    azureApiVersion String
    The Azure API version of the resource.
    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.
    intent ProximityPlacementGroupPropertiesResponseIntent
    Specifies the user intent 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
    zones List<String>
    Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created.
    availabilitySets SubResourceWithColocationStatusResponse[]
    A list of references to all availability sets in the proximity placement group.
    azureApiVersion string
    The Azure API version of the resource.
    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.
    intent ProximityPlacementGroupPropertiesResponseIntent
    Specifies the user intent 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
    zones string[]
    Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created.
    availability_sets Sequence[SubResourceWithColocationStatusResponse]
    A list of references to all availability sets in the proximity placement group.
    azure_api_version str
    The Azure API version of the resource.
    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.
    intent ProximityPlacementGroupPropertiesResponseIntent
    Specifies the user intent 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
    zones Sequence[str]
    Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created.
    availabilitySets List<Property Map>
    A list of references to all availability sets in the proximity placement group.
    azureApiVersion String
    The Azure API version of the resource.
    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.
    intent Property Map
    Specifies the user intent 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
    zones List<String>
    Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created.

    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.

    ProximityPlacementGroupPropertiesResponseIntent

    VmSizes List<string>
    Specifies possible sizes of virtual machines that can be created in the proximity placement group.
    VmSizes []string
    Specifies possible sizes of virtual machines that can be created in the proximity placement group.
    vmSizes List<String>
    Specifies possible sizes of virtual machines that can be created in the proximity placement group.
    vmSizes string[]
    Specifies possible sizes of virtual machines that can be created in the proximity placement group.
    vm_sizes Sequence[str]
    Specifies possible sizes of virtual machines that can be created in the proximity placement group.
    vmSizes List<String>
    Specifies possible sizes of virtual machines that can be created in the proximity placement group.

    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
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native