dedicated_hosts

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

Overview

Name	dedicated_hosts
Type	Resource
Id	azure.compute.dedicated_hosts

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	Properties of the dedicated host.
sku	object	SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values.
tags	object	Resource tags
type	string	Resource type

list_by_host_group

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	Properties of the dedicated host.
sku	object	SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values.
tags	object	Resource tags
type	string	Resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, hostGroupName, hostName, subscriptionId	$expand	Retrieves information about a dedicated host.
list_by_host_group	select	resourceGroupName, hostGroupName, subscriptionId		Lists all of the dedicated hosts in the specified dedicated host group. Use the nextLink property in the response to get the next page of dedicated hosts.
create_or_update	insert	resourceGroupName, hostGroupName, hostName, subscriptionId, data__sku		Create or update a dedicated host .
update	update	resourceGroupName, hostGroupName, hostName, subscriptionId		Update a dedicated host .
delete	delete	resourceGroupName, hostGroupName, hostName, subscriptionId		Delete a dedicated host.
restart	exec	resourceGroupName, hostGroupName, hostName, subscriptionId		Restart the dedicated host. The operation will complete successfully once the dedicated host has restarted and is running. To determine the health of VMs deployed on the dedicated host after the restart check the Resource Health Center in the Azure Portal. Please refer to https://docs.microsoft.com/azure/service-health/resource-health-overview for more details.
redeploy	exec	resourceGroupName, hostGroupName, hostName, subscriptionId		Redeploy the dedicated host. The operation will complete successfully once the dedicated host has migrated to a new node and is running. To determine the health of VMs deployed on the dedicated host after the redeploy check the Resource Health Center in the Azure Portal. Please refer to https://docs.microsoft.com/azure/service-health/resource-health-overview for more details.

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.
hostName	string	The name of the dedicated host.
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 host. 'UserData' is not supported for dedicated host.

SELECT examples

get

Retrieves information about a dedicated host.

SELECT
id,
name,
location,
properties,
sku,
tags,
type
FROM azure.compute.dedicated_hosts
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND hostGroupName = '{{ hostGroupName }}' -- required
AND hostName = '{{ hostName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_host_group

Lists all of the dedicated hosts in the specified dedicated host group. Use the nextLink property in the response to get the next page of dedicated hosts.

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

INSERT examples

create_or_update

Create or update a dedicated host .

INSERT INTO azure.compute.dedicated_hosts (
data__properties,
data__sku,
data__location,
data__tags,
resourceGroupName,
hostGroupName,
hostName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ sku }}' /* required */,
'{{ location }}',
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ hostGroupName }}',
'{{ hostName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
location,
properties,
sku,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: dedicated_hosts
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the dedicated_hosts resource.
    - name: hostGroupName
      value: string
      description: Required parameter for the dedicated_hosts resource.
    - name: hostName
      value: string
      description: Required parameter for the dedicated_hosts resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the dedicated_hosts resource.
    - name: properties
      value: object
      description: |
        Properties of the dedicated host.
    - name: sku
      value: object
      description: |
        SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values.
    - name: location
      value: string
      description: |
        Resource location
    - name: tags
      value: object
      description: |
        Resource tags

UPDATE examples

update

Update a dedicated host .

UPDATE azure.compute.dedicated_hosts
SET 
data__properties = '{{ properties }}',
data__sku = '{{ sku }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND hostGroupName = '{{ hostGroupName }}' --required
AND hostName = '{{ hostName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
location,
properties,
sku,
tags,
type;

DELETE examples

delete

Delete a dedicated host.

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

Lifecycle Methods

restart

Restart the dedicated host. The operation will complete successfully once the dedicated host has restarted and is running. To determine the health of VMs deployed on the dedicated host after the restart check the Resource Health Center in the Azure Portal. Please refer to https://docs.microsoft.com/azure/service-health/resource-health-overview for more details.

EXEC azure.compute.dedicated_hosts.restart 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@hostGroupName='{{ hostGroupName }}' --required, 
@hostName='{{ hostName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

redeploy

Redeploy the dedicated host. The operation will complete successfully once the dedicated host has migrated to a new node and is running. To determine the health of VMs deployed on the dedicated host after the redeploy check the Resource Health Center in the Azure Portal. Please refer to https://docs.microsoft.com/azure/service-health/resource-health-overview for more details.

EXEC azure.compute.dedicated_hosts.redeploy 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@hostGroupName='{{ hostGroupName }}' --required, 
@hostName='{{ hostName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;