dedicated_hosts

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

Overview

Name	dedicated_hosts
Type	Resource
Id	azure.compute.dedicated_hosts

Fields

vw_dedicated_hosts

Name	Datatype	Description
id	text	Resource Id
name	text	Resource name
auto_replace_on_failure	text	field from the properties object
hostGroupName	text	field from the properties object
hostName	text	field from the properties object
host_id	text	field from the properties object
instance_view	text	field from the properties object
license_type	text	field from the properties object
location	text	Resource location
platform_fault_domain	text	field from the properties object
provisioning_state	text	field from the properties object
provisioning_time	text	field from the properties object
resourceGroupName	text	field from the properties object
sku	text	Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.
subscriptionId	text	field from the properties object
tags	text	Resource tags
time_created	text	field from the properties object
type	text	Resource type
virtual_machines	text	field from the properties object

dedicated_hosts

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	Properties of the dedicated host.
sku	object	Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.
tags	object	Resource tags
type	string	Resource type

Methods

Name	Accessible by	Required Params	Description
get	SELECT	hostGroupName, hostName, resourceGroupName, subscriptionId	Retrieves information about a dedicated host.
list_by_host_group	SELECT	hostGroupName, resourceGroupName, 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	hostGroupName, hostName, resourceGroupName, subscriptionId, data__sku	Create or update a dedicated host .
delete	DELETE	hostGroupName, hostName, resourceGroupName, subscriptionId	Delete a dedicated host.
update	UPDATE	hostGroupName, hostName, resourceGroupName, subscriptionId	Update a dedicated host .
redeploy	EXEC	hostGroupName, hostName, resourceGroupName, 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.
restart	EXEC	hostGroupName, hostName, resourceGroupName, 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.

SELECT examples

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.

vw_dedicated_hosts

SELECT
id,
name,
auto_replace_on_failure,
hostGroupName,
hostName,
host_id,
instance_view,
license_type,
location,
platform_fault_domain,
provisioning_state,
provisioning_time,
resourceGroupName,
sku,
subscriptionId,
tags,
time_created,
type,
virtual_machines
FROM azure.compute.vw_dedicated_hosts
WHERE hostGroupName = '{{ hostGroupName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

dedicated_hosts

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.compute.dedicated_hosts (
hostGroupName,
hostName,
resourceGroupName,
subscriptionId,
data__sku,
properties,
sku,
location,
tags
)
SELECT 
'{{ hostGroupName }}',
'{{ hostName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__sku }}',
'{{ properties }}',
'{{ sku }}',
'{{ location }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: platformFaultDomain
          value: integer
        - name: autoReplaceOnFailure
          value: boolean
        - name: hostId
          value: string
        - name: virtualMachines
          value:
            - - name: id
                value: string
        - name: licenseType
          value: []
        - name: provisioningTime
          value: string
        - name: provisioningState
          value: string
        - name: instanceView
          value:
            - 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: timeCreated
          value: string
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: string
        - name: capacity
          value: integer
    - 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_hosts resource.

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

DELETE example

Deletes the specified dedicated_hosts resource.

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