machines

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

Overview

Name	machines
Type	Resource
Id	azure.aks.machines

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties	object	The properties of the machine
type	string	Resource type

list

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties	object	The properties of the machine
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, resourceName, agentPoolName, machineName
list	select	subscriptionId, resourceGroupName, resourceName, agentPoolName

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
agentPoolName	string	The name of the agent pool.
machineName	string	host name of the machine
resourceGroupName	string	The name of the resource group. The name is case insensitive.
resourceName	string	The name of the managed cluster resource.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

OK

SELECT
id,
name,
properties,
type
FROM azure.aks.machines
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND agentPoolName = '{{ agentPoolName }}' -- required
AND machineName = '{{ machineName }}' -- required
;

list

OK

SELECT
id,
name,
properties,
type
FROM azure.aks.machines
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND agentPoolName = '{{ agentPoolName }}' -- required
;