dedicated_host_groups

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

Overview

Name	dedicated_host_groups
Type	Resource
Id	azure.compute.dedicated_host_groups

Fields

vw_dedicated_host_groups

Name	Datatype	Description
id	text	Resource Id
name	text	Resource name
additional_capabilities	text	field from the properties object
hostGroupName	text	field from the properties object
hosts	text	field from the properties object
instance_view	text	field from the properties object
location	text	Resource location
platform_fault_domain_count	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
support_automatic_placement	text	field from the properties object
tags	text	Resource tags
type	text	Resource type
zones	text	Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone.

dedicated_host_groups

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	Dedicated Host Group Properties.
tags	object	Resource tags
type	string	Resource type
zones	array	Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	hostGroupName, resourceGroupName, subscriptionId	Retrieves information about a dedicated host group.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Lists all of the dedicated host groups in the specified resource group. Use the nextLink property in the response to get the next page of dedicated host groups.
list_by_subscription	SELECT	subscriptionId	Lists all of the dedicated host groups in the subscription. Use the nextLink property in the response to get the next page of dedicated host groups.
create_or_update	INSERT	hostGroupName, resourceGroupName, subscriptionId	Create or update a dedicated host group. For details of Dedicated Host and Dedicated Host Groups please see [Dedicated Host Documentation] (https://go.microsoft.com/fwlink/?linkid=2082596)
delete	DELETE	hostGroupName, resourceGroupName, subscriptionId	Delete a dedicated host group.
update	UPDATE	hostGroupName, resourceGroupName, subscriptionId	Update an dedicated host group.

SELECT examples

Lists all of the dedicated host groups in the subscription. Use the nextLink property in the response to get the next page of dedicated host groups.

vw_dedicated_host_groups

SELECT
id,
name,
additional_capabilities,
hostGroupName,
hosts,
instance_view,
location,
platform_fault_domain_count,
resourceGroupName,
subscriptionId,
support_automatic_placement,
tags,
type,
zones
FROM azure.compute.vw_dedicated_host_groups
WHERE subscriptionId = '{{ subscriptionId }}';

dedicated_host_groups

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

INSERT example

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

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: platformFaultDomainCount
          value: integer
        - name: hosts
          value:
            - - name: id
                value: string
        - name: instanceView
          value:
            - name: hosts
              value:
                - - name: name
                    value: string
                  - name: assetId
                    value: string
                  - name: availableCapacity
                    value:
                      - name: allocatableVMs
                        value:
                          - - name: vmSize
                              value: string
                            - name: count
                              value: number
                  - name: statuses
                    value:
                      - - name: code
                          value: string
                        - name: level
                          value: string
                        - name: displayStatus
                          value: string
                        - name: message
                          value: string
                        - name: time
                          value: string
        - name: supportAutomaticPlacement
          value: boolean
        - name: additionalCapabilities
          value:
            - name: ultraSSDEnabled
              value: boolean
    - 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 dedicated_host_groups resource.

/*+ update */
UPDATE azure.compute.dedicated_host_groups
SET 
properties = '{{ properties }}',
zones = '{{ zones }}',
tags = '{{ tags }}'
WHERE 
hostGroupName = '{{ hostGroupName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified dedicated_host_groups resource.

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