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

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.
additionalCapabilities	object	Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01.
hosts	array	A list of references to all dedicated hosts in the dedicated host group.
instanceView	object	The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group.
location	string	The geo-location where the resource lives. Required.
platformFaultDomainCount	integer	Number of fault domains that the host group can span. Required.
supportAutomaticPlacement	boolean	Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. Minimum api-version: 2020-06-01.
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".
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.
additionalCapabilities	object	Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01.
hosts	array	A list of references to all dedicated hosts in the dedicated host group.
instanceView	object	The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group.
location	string	The geo-location where the resource lives. Required.
platformFaultDomainCount	integer	Number of fault domains that the host group can span. Required.
supportAutomaticPlacement	boolean	Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. Minimum api-version: 2020-06-01.
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".
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.
additionalCapabilities	object	Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01.
hosts	array	A list of references to all dedicated hosts in the dedicated host group.
instanceView	object	The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group.
location	string	The geo-location where the resource lives. Required.
platformFaultDomainCount	integer	Number of fault domains that the host group can span. Required.
supportAutomaticPlacement	boolean	Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. Minimum api-version: 2020-06-01.
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".
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, host_group_name, subscription_id	$expand	Retrieves information about a dedicated host group.
list_by_resource_group	select	resource_group_name, subscription_id		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	subscription_id		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	resource_group_name, host_group_name, subscription_id, location		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 _).
update	update	resource_group_name, host_group_name, subscription_id		Update an dedicated host group.
create_or_update	replace	resource_group_name, host_group_name, subscription_id, location		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	resource_group_name, host_group_name, subscription_id		Delete a dedicated host 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
host_group_name	string	The name of the dedicated host group. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$expand	string	The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the dedicated hosts under the dedicated host group. 'UserData' is not supported for dedicated host group. Known values are: "instanceView", "userData", and "resiliencyView". Default value is None.

SELECT examples

get

Retrieves information about a dedicated host group.

SELECT
id,
name,
additionalCapabilities,
hosts,
instanceView,
location,
platformFaultDomainCount,
supportAutomaticPlacement,
systemData,
tags,
type,
zones
FROM azure.compute.dedicated_host_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND host_group_name = '{{ host_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_resource_group

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.

SELECT
id,
name,
additionalCapabilities,
hosts,
instanceView,
location,
platformFaultDomainCount,
supportAutomaticPlacement,
systemData,
tags,
type,
zones
FROM azure.compute.dedicated_host_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

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.

SELECT
id,
name,
additionalCapabilities,
hosts,
instanceView,
location,
platformFaultDomainCount,
supportAutomaticPlacement,
systemData,
tags,
type,
zones
FROM azure.compute.dedicated_host_groups
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

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 _).

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

Manifest

# Description fields are for documentation purposes
- name: dedicated_host_groups
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the dedicated_host_groups resource.
  - name: host_group_name
    value: "{{ host_group_name }}"
    description: Required parameter for the dedicated_host_groups resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the dedicated_host_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: |
      Dedicated Host Group Properties.
    value:
      platformFaultDomainCount: {{ platformFaultDomainCount }}
      hosts:
        - id: "{{ id }}"
      instanceView:
        hosts:
          - assetId: "{{ assetId }}"
            availableCapacity:
              allocatableVMs:
                - vmSize: "{{ vmSize }}"
                  count: {{ count }}
            statuses: "{{ statuses }}"
            name: "{{ name }}"
      supportAutomaticPlacement: {{ supportAutomaticPlacement }}
      additionalCapabilities:
        ultraSSDEnabled: {{ ultraSSDEnabled }}
  - name: zones
    value:
      - "{{ zones }}"
    description: |
      The availability zones.

UPDATE examples

update

Update an dedicated host group.

UPDATE azure.compute.dedicated_host_groups
SET 
tags = '{{ tags }}',
properties = '{{ properties }}',
zones = '{{ zones }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND host_group_name = '{{ host_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 dedicated host group. For details of Dedicated Host and Dedicated Host Groups please see [Dedicated Host Documentation] (https://go.microsoft.com/fwlink/?linkid=2082596 _).

REPLACE azure.compute.dedicated_host_groups
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
zones = '{{ zones }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND host_group_name = '{{ host_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 dedicated host group.

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