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

vw_proximity_placement_groups

Name	Datatype	Description
id	text	Resource Id
name	text	Resource name
availability_sets	text	field from the properties object
colocation_status	text	field from the properties object
intent	text	field from the properties object
location	text	Resource location
proximityPlacementGroupName	text	field from the properties object
proximity_placement_group_type	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags
type	text	Resource type
virtual_machine_scale_sets	text	field from the properties object
virtual_machines	text	field from the properties object
zones	text	Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created.

proximity_placement_groups

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

Name	Accessible by	Required Params	Description
get	SELECT	proximityPlacementGroupName, resourceGroupName, subscriptionId	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	proximityPlacementGroupName, resourceGroupName, subscriptionId	Create or update a proximity placement group.
delete	DELETE	proximityPlacementGroupName, resourceGroupName, subscriptionId	Delete a proximity placement group.
update	UPDATE	proximityPlacementGroupName, resourceGroupName, subscriptionId	Update a proximity placement group.

SELECT examples

Lists all proximity placement groups in a subscription.

vw_proximity_placement_groups

SELECT
id,
name,
availability_sets,
colocation_status,
intent,
location,
proximityPlacementGroupName,
proximity_placement_group_type,
resourceGroupName,
subscriptionId,
tags,
type,
virtual_machine_scale_sets,
virtual_machines,
zones
FROM azure.compute.vw_proximity_placement_groups
WHERE subscriptionId = '{{ subscriptionId }}';

proximity_placement_groups

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

INSERT example

Use the following StackQL query and manifest file to create a new proximity_placement_groups resource.

All Properties

/*+ create */
INSERT INTO azure.compute.proximity_placement_groups (
proximityPlacementGroupName,
resourceGroupName,
subscriptionId,
properties,
zones,
location,
tags
)
SELECT 
'{{ proximityPlacementGroupName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}',
'{{ zones }}',
'{{ location }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: proximityPlacementGroupType
          value: string
        - name: virtualMachines
          value:
            - - name: id
                value: string
              - name: colocationStatus
                value:
                  - name: code
                    value: string
                  - name: level
                    value: string
                  - name: displayStatus
                    value: string
                  - name: message
                    value: string
                  - name: time
                    value: string
        - name: virtualMachineScaleSets
          value:
            - - name: id
                value: string
        - name: availabilitySets
          value:
            - - name: id
                value: string
        - name: intent
          value:
            - name: vmSizes
              value:
                - string
    - name: zones
      value:
        - string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: tags
      value: object

UPDATE example

Updates a proximity_placement_groups resource.

/*+ update */
UPDATE azure.compute.proximity_placement_groups
SET 
tags = '{{ tags }}'
WHERE 
proximityPlacementGroupName = '{{ proximityPlacementGroupName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified proximity_placement_groups resource.

/*+ delete */
DELETE FROM azure.compute.proximity_placement_groups
WHERE proximityPlacementGroupName = '{{ proximityPlacementGroupName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';