proximity_placement_groups

Creates, updates, deletes, gets or lists a proximity_placement_groups resource.

Overview

Name	proximity_placement_groups
Type	Resource
Id	azure.compute.proximity_placement_groups

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
availabilitySets	array	A list of references to all availability sets in the proximity placement group.
colocationStatus	object	Instance view status.
intent	object	Specifies the user intent of the proximity placement group.
location	string	The geo-location where the resource lives. Required.
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. Known values are: "Standard" and "Ultra". (Standard, Ultra)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualMachineScaleSets	array	A list of references to all virtual machine scale sets in the proximity placement group.
virtualMachines	array	A list of references to all virtual machines in the proximity placement group.
zones	array	The availability zones.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
availabilitySets	array	A list of references to all availability sets in the proximity placement group.
colocationStatus	object	Instance view status.
intent	object	Specifies the user intent of the proximity placement group.
location	string	The geo-location where the resource lives. Required.
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. Known values are: "Standard" and "Ultra". (Standard, Ultra)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualMachineScaleSets	array	A list of references to all virtual machine scale sets in the proximity placement group.
virtualMachines	array	A list of references to all virtual machines in the proximity placement group.
zones	array	The availability zones.

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
availabilitySets	array	A list of references to all availability sets in the proximity placement group.
colocationStatus	object	Instance view status.
intent	object	Specifies the user intent of the proximity placement group.
location	string	The geo-location where the resource lives. Required.
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. Known values are: "Standard" and "Ultra". (Standard, Ultra)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualMachineScaleSets	array	A list of references to all virtual machine scale sets in the proximity placement group.
virtualMachines	array	A list of references to all virtual machines in the proximity placement group.
zones	array	The availability zones.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, proximity_placement_group_name, subscription_id	includeColocationStatus	Retrieves information about a proximity placement group .
list_by_resource_group	select	resource_group_name, subscription_id		Lists all proximity placement groups in a resource group.
list_by_subscription	select	subscription_id		Lists all proximity placement groups in a subscription.
create_or_update	insert	resource_group_name, proximity_placement_group_name, subscription_id, location		Create or update a proximity placement group.
update	update	resource_group_name, proximity_placement_group_name, subscription_id		Update a proximity placement group.
create_or_update	replace	resource_group_name, proximity_placement_group_name, subscription_id, location		Create or update a proximity placement group.
delete	delete	resource_group_name, proximity_placement_group_name, subscription_id		Delete a proximity placement group.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
proximity_placement_group_name	string	The name of the proximity placement group. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
includeColocationStatus	string	includeColocationStatus=true enables fetching the colocation status of all the resources in the proximity placement group. Default value is None.

SELECT examples

get

Retrieves information about a proximity placement group .

SELECT
id,
name,
availabilitySets,
colocationStatus,
intent,
location,
proximityPlacementGroupType,
systemData,
tags,
type,
virtualMachineScaleSets,
virtualMachines,
zones
FROM azure.compute.proximity_placement_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND proximity_placement_group_name = '{{ proximity_placement_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND includeColocationStatus = '{{ includeColocationStatus }}'
;

list_by_resource_group

Lists all proximity placement groups in a resource group.

SELECT
id,
name,
availabilitySets,
colocationStatus,
intent,
location,
proximityPlacementGroupType,
systemData,
tags,
type,
virtualMachineScaleSets,
virtualMachines,
zones
FROM azure.compute.proximity_placement_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists all proximity placement groups in a subscription.

SELECT
id,
name,
availabilitySets,
colocationStatus,
intent,
location,
proximityPlacementGroupType,
systemData,
tags,
type,
virtualMachineScaleSets,
virtualMachines,
zones
FROM azure.compute.proximity_placement_groups
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a proximity placement group.

INSERT INTO azure.compute.proximity_placement_groups (
tags,
location,
properties,
zones,
resource_group_name,
proximity_placement_group_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ zones }}',
'{{ resource_group_name }}',
'{{ proximity_placement_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type,
zones
;

Manifest

# Description fields are for documentation purposes
- name: proximity_placement_groups
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the proximity_placement_groups resource.
  - name: proximity_placement_group_name
    value: "{{ proximity_placement_group_name }}"
    description: Required parameter for the proximity_placement_groups resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the proximity_placement_groups resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Describes the properties of a Proximity Placement Group.
    value:
      proximityPlacementGroupType: "{{ proximityPlacementGroupType }}"
      virtualMachines:
        - id: "{{ id }}"
          colocationStatus:
            code: "{{ code }}"
            level: "{{ level }}"
            displayStatus: "{{ displayStatus }}"
            message: "{{ message }}"
            time: "{{ time }}"
      virtualMachineScaleSets:
        - id: "{{ id }}"
          colocationStatus:
            code: "{{ code }}"
            level: "{{ level }}"
            displayStatus: "{{ displayStatus }}"
            message: "{{ message }}"
            time: "{{ time }}"
      availabilitySets:
        - id: "{{ id }}"
          colocationStatus:
            code: "{{ code }}"
            level: "{{ level }}"
            displayStatus: "{{ displayStatus }}"
            message: "{{ message }}"
            time: "{{ time }}"
      colocationStatus:
        code: "{{ code }}"
        level: "{{ level }}"
        displayStatus: "{{ displayStatus }}"
        message: "{{ message }}"
        time: "{{ time }}"
      intent:
        vmSizes:
          - "{{ vmSizes }}"
  - name: zones
    value:
      - "{{ zones }}"
    description: |
      The availability zones.

UPDATE examples

update

Update a proximity placement group.

UPDATE azure.compute.proximity_placement_groups
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND proximity_placement_group_name = '{{ proximity_placement_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type,
zones;

REPLACE examples

create_or_update

Create or update a proximity placement group.

REPLACE azure.compute.proximity_placement_groups
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
zones = '{{ zones }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND proximity_placement_group_name = '{{ proximity_placement_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type,
zones;

DELETE examples

delete

Delete a proximity placement group.

DELETE FROM azure.compute.proximity_placement_groups
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND proximity_placement_group_name = '{{ proximity_placement_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;