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	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	Describes the properties of a Proximity Placement Group.
tags	object	Resource tags
type	string	Resource type
zones	array	Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created.

list_by_resource_group

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	Describes the properties of a Proximity Placement Group.
tags	object	Resource tags
type	string	Resource type
zones	array	Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created.

list_by_subscription

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	Describes the properties of a Proximity Placement Group.
tags	object	Resource tags
type	string	Resource type
zones	array	Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, proximityPlacementGroupName, subscriptionId	includeColocationStatus	Retrieves information about a proximity placement group .
list_by_resource_group	select	resourceGroupName, subscriptionId		Lists all proximity placement groups in a resource group.
list_by_subscription	select	subscriptionId		Lists all proximity placement groups in a subscription.
create_or_update	insert	resourceGroupName, proximityPlacementGroupName, subscriptionId		Create or update a proximity placement group.
update	update	resourceGroupName, proximityPlacementGroupName, subscriptionId		Update a proximity placement group.
delete	delete	resourceGroupName, proximityPlacementGroupName, subscriptionId		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
proximityPlacementGroupName	string	The name of the proximity placement group.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
includeColocationStatus	string	includeColocationStatus=true enables fetching the colocation status of all the resources in the proximity placement group.

SELECT examples

get

Retrieves information about a proximity placement group .

SELECT
id,
name,
location,
properties,
tags,
type,
zones
FROM azure.compute.proximity_placement_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND proximityPlacementGroupName = '{{ proximityPlacementGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND includeColocationStatus = '{{ includeColocationStatus }}'
;

list_by_resource_group

Lists all proximity placement groups in a resource group.

SELECT
id,
name,
location,
properties,
tags,
type,
zones
FROM azure.compute.proximity_placement_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_subscription

Lists all proximity placement groups in a subscription.

SELECT
id,
name,
location,
properties,
tags,
type,
zones
FROM azure.compute.proximity_placement_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create or update a proximity placement group.

INSERT INTO azure.compute.proximity_placement_groups (
data__properties,
data__zones,
data__location,
data__tags,
resourceGroupName,
proximityPlacementGroupName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ zones }}',
'{{ location }}',
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ proximityPlacementGroupName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
location,
properties,
tags,
type,
zones
;

Manifest

# Description fields are for documentation purposes
- name: proximity_placement_groups
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the proximity_placement_groups resource.
    - name: proximityPlacementGroupName
      value: string
      description: Required parameter for the proximity_placement_groups resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the proximity_placement_groups resource.
    - name: properties
      value: object
      description: |
        Describes the properties of a Proximity Placement Group.
    - name: zones
      value: array
      description: |
        Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the  proximity placement group can be created.
    - name: location
      value: string
      description: |
        Resource location
    - name: tags
      value: object
      description: |
        Resource tags

UPDATE examples

update

Update a proximity placement group.

UPDATE azure.compute.proximity_placement_groups
SET 
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND proximityPlacementGroupName = '{{ proximityPlacementGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type,
zones;

DELETE examples

delete

Delete a proximity placement group.

DELETE FROM azure.compute.proximity_placement_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND proximityPlacementGroupName = '{{ proximityPlacementGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;