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

list_by_resource_group

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.

list_by_subscription

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

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, hostGroupName, subscriptionId	$expand	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	resourceGroupName, hostGroupName, 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)
update	update	resourceGroupName, hostGroupName, subscriptionId		Update an dedicated host group.
delete	delete	resourceGroupName, hostGroupName, subscriptionId		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
hostGroupName	string	The name of the dedicated host 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.
$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.

SELECT examples

get

Retrieves information about a dedicated host group.

SELECT
id,
name,
location,
properties,
tags,
type,
zones
FROM azure.compute.dedicated_host_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND hostGroupName = '{{ hostGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- 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,
location,
properties,
tags,
type,
zones
FROM azure.compute.dedicated_host_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- 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,
location,
properties,
tags,
type,
zones
FROM azure.compute.dedicated_host_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- 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 (
data__properties,
data__zones,
data__location,
data__tags,
resourceGroupName,
hostGroupName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ zones }}',
'{{ location }}',
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ hostGroupName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
location,
properties,
tags,
type,
zones
;

Manifest

# Description fields are for documentation purposes
- name: dedicated_host_groups
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the dedicated_host_groups resource.
    - name: hostGroupName
      value: string
      description: Required parameter for the dedicated_host_groups resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the dedicated_host_groups resource.
    - name: properties
      value: object
      description: |
        Dedicated Host Group Properties.
    - name: zones
      value: array
      description: |
        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.
    - name: location
      value: string
      description: |
        Resource location
    - name: tags
      value: object
      description: |
        Resource tags

UPDATE examples

update

Update an dedicated host group.

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

DELETE examples

delete

Delete a dedicated host group.

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