machines

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

Overview

Name	machines
Type	Resource
Id	azure.hybrid_compute.machines

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
identity	object	Hybrid Compute Machine Managed Identity (title: Managed Identity.)
location	string	Resource location
properties	object	Hybrid Compute Machine properties
tags	object	Resource tags
type	string	Resource type

list_by_resource_group

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
identity	object	Hybrid Compute Machine Managed Identity (title: Managed Identity.)
location	string	Resource location
properties	object	Hybrid Compute Machine properties
tags	object	Resource tags
type	string	Resource type

list_by_subscription

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
identity	object	Hybrid Compute Machine Managed Identity (title: Managed Identity.)
location	string	Resource location
properties	object	Hybrid Compute Machine properties
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	subscriptionId, resourceGroupName, name	$expand	Retrieves information about the model view or the instance view of a hybrid machine.
list_by_resource_group	select	subscriptionId, resourceGroupName		Lists all the hybrid machines in the specified resource group. Use the nextLink property in the response to get the next page of hybrid machines.
list_by_subscription	select	subscriptionId		Lists all the hybrid machines in the specified subscription. Use the nextLink property in the response to get the next page of hybrid machines.
create_or_update	insert	subscriptionId, resourceGroupName, name		The operation to create or update a hybrid machine resource identity in Azure.
update	update	subscriptionId, resourceGroupName, name		The operation to update a hybrid machine.
delete	delete	subscriptionId, resourceGroupName, name		The operation to remove a hybrid machine identity in Azure.
reconnect	exec	subscriptionId, resourceGroupName, name		The operation to reconnect a hybrid machine resource to its identity in Azure.

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
name	string	The name of the hybrid machine.
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.

SELECT examples

get

Retrieves information about the model view or the instance view of a hybrid machine.

SELECT
id,
name,
identity,
location,
properties,
tags,
type
FROM azure.hybrid_compute.machines
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_resource_group

Lists all the hybrid machines in the specified resource group. Use the nextLink property in the response to get the next page of hybrid machines.

SELECT
id,
name,
identity,
location,
properties,
tags,
type
FROM azure.hybrid_compute.machines
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Lists all the hybrid machines in the specified subscription. Use the nextLink property in the response to get the next page of hybrid machines.

SELECT
id,
name,
identity,
location,
properties,
tags,
type
FROM azure.hybrid_compute.machines
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

The operation to create or update a hybrid machine resource identity in Azure.

INSERT INTO azure.hybrid_compute.machines (
data__properties,
data__location,
data__tags,
data__identity,
subscriptionId,
resourceGroupName,
name
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ tags }}',
'{{ identity }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ name }}'
RETURNING
id,
name,
identity,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: machines
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the machines resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the machines resource.
    - name: name
      value: string
      description: Required parameter for the machines resource.
    - name: properties
      value: object
      description: |
        Hybrid Compute Machine properties
    - name: location
      value: string
      description: |
        Resource location
    - name: tags
      value: object
      description: |
        Resource tags
    - name: identity
      value: object
      description: |
        Hybrid Compute Machine Managed Identity

UPDATE examples

update

The operation to update a hybrid machine.

UPDATE azure.hybrid_compute.machines
SET 
data__identity = '{{ identity }}',
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
RETURNING
id,
name,
identity,
location,
properties,
tags,
type;

DELETE examples

delete

The operation to remove a hybrid machine identity in Azure.

DELETE FROM azure.hybrid_compute.machines
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
;

Lifecycle Methods

reconnect

The operation to reconnect a hybrid machine resource to its identity in Azure.

EXEC azure.hybrid_compute.machines.reconnect 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;