machines

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

Overview

Name	machines
Type	Resource
Id	azure.container_service.machines

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
billing	object	The properties having to do with machine billing.
eTag	string	Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal eTag convention.
evictionPolicy	string	The eviction policy for machine. This cannot be specified unless the priority is 'Spot'. If not specified, the default is 'Delete'. Known values are: "Delete" and "Deallocate". (Delete, Deallocate)
hardware	object	The hardware and GPU settings of the machine.
kubernetes	object	The Kubernetes configurations used by the machine.
localDNSProfile	object	Configures the per-node local DNS, with VnetDNS and KubeDNS overrides. LocalDNS helps improve performance and reliability of DNS resolution in an AKS cluster. For more details see aka.ms/aks/localdns.
mode	string	Machine only allows 'System' and 'User' mode. Known values are: "System", "User", "Gateway", "ManagedSystem", and "Machines". (System, User, Gateway, ManagedSystem, Machines)
network	object	network properties of the machine.
nodeImageVersion	string	The version of node image.
operatingSystem	object	The operating system and disk used by the machine.
priority	string	The priority for the machine. If not specified, the default is 'Regular'. Known values are: "Spot" and "Regular". (Spot, Regular)
provisioningState	string	The current deployment or provisioning state.
resourceId	string	Azure resource id of the machine. It can be used to GET underlying VM Instance.
security	object	The security settings of the machine.
status	object	Contains read-only information about the machine.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	The tags to be persisted on the machine.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
zones	array	The Availability zone in which machine is located.

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
billing	object	The properties having to do with machine billing.
eTag	string	Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal eTag convention.
evictionPolicy	string	The eviction policy for machine. This cannot be specified unless the priority is 'Spot'. If not specified, the default is 'Delete'. Known values are: "Delete" and "Deallocate". (Delete, Deallocate)
hardware	object	The hardware and GPU settings of the machine.
kubernetes	object	The Kubernetes configurations used by the machine.
localDNSProfile	object	Configures the per-node local DNS, with VnetDNS and KubeDNS overrides. LocalDNS helps improve performance and reliability of DNS resolution in an AKS cluster. For more details see aka.ms/aks/localdns.
mode	string	Machine only allows 'System' and 'User' mode. Known values are: "System", "User", "Gateway", "ManagedSystem", and "Machines". (System, User, Gateway, ManagedSystem, Machines)
network	object	network properties of the machine.
nodeImageVersion	string	The version of node image.
operatingSystem	object	The operating system and disk used by the machine.
priority	string	The priority for the machine. If not specified, the default is 'Regular'. Known values are: "Spot" and "Regular". (Spot, Regular)
provisioningState	string	The current deployment or provisioning state.
resourceId	string	Azure resource id of the machine. It can be used to GET underlying VM Instance.
security	object	The security settings of the machine.
status	object	Contains read-only information about the machine.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	The tags to be persisted on the machine.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
zones	array	The Availability zone in which machine is located.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, resource_name, agent_pool_name, machine_name, subscription_id		Get a specific machine in the specified agent pool.
list	select	resource_group_name, resource_name, agent_pool_name, subscription_id		Gets a list of machines in the specified agent pool.
create_or_update	insert	resource_group_name, resource_name, agent_pool_name, machine_name, subscription_id		Creates or updates a machine in the specified agent pool.
create_or_update	replace	resource_group_name, resource_name, agent_pool_name, machine_name, subscription_id		Creates or updates a machine in the specified agent pool.

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
agent_pool_name	string	The name of the agent pool. Required.
machine_name	string	Host name of the machine. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the managed cluster resource. Required.
subscription_id	string

SELECT examples

get

Get a specific machine in the specified agent pool.

SELECT
id,
name,
billing,
eTag,
evictionPolicy,
hardware,
kubernetes,
localDNSProfile,
mode,
network,
nodeImageVersion,
operatingSystem,
priority,
provisioningState,
resourceId,
security,
status,
systemData,
tags,
type,
zones
FROM azure.container_service.machines
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND agent_pool_name = '{{ agent_pool_name }}' -- required
AND machine_name = '{{ machine_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets a list of machines in the specified agent pool.

SELECT
id,
name,
billing,
eTag,
evictionPolicy,
hardware,
kubernetes,
localDNSProfile,
mode,
network,
nodeImageVersion,
operatingSystem,
priority,
provisioningState,
resourceId,
security,
status,
systemData,
tags,
type,
zones
FROM azure.container_service.machines
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND agent_pool_name = '{{ agent_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a machine in the specified agent pool.

INSERT INTO azure.container_service.machines (
properties,
zones,
resource_group_name,
resource_name,
agent_pool_name,
machine_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ zones }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ agent_pool_name }}',
'{{ machine_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type,
zones
;

Manifest

# Description fields are for documentation purposes
- name: machines
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the machines resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the machines resource.
  - name: agent_pool_name
    value: "{{ agent_pool_name }}"
    description: Required parameter for the machines resource.
  - name: machine_name
    value: "{{ machine_name }}"
    description: Required parameter for the machines resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the machines resource.
  - name: properties
    description: |
      The properties of the machine.
    value:
      network:
        ipAddresses:
          - family: "{{ family }}"
            ip: "{{ ip }}"
        vnetSubnetID: "{{ vnetSubnetID }}"
        podSubnetID: "{{ podSubnetID }}"
        enableNodePublicIP: {{ enableNodePublicIP }}
        nodePublicIPPrefixID: "{{ nodePublicIPPrefixID }}"
        nodePublicIPTags:
          - ipTagType: "{{ ipTagType }}"
            tag: "{{ tag }}"
      resourceId: "{{ resourceId }}"
      hardware:
        vmSize: "{{ vmSize }}"
        gpuInstanceProfile: "{{ gpuInstanceProfile }}"
        gpuProfile:
          driver: "{{ driver }}"
          driverType: "{{ driverType }}"
          nvidia:
            managementMode: "{{ managementMode }}"
            migStrategy: "{{ migStrategy }}"
        ultraSsdEnabled: {{ ultraSsdEnabled }}
      operatingSystem:
        osType: "{{ osType }}"
        osSKU: "{{ osSKU }}"
        osDiskSizeGB: {{ osDiskSizeGB }}
        osDiskType: "{{ osDiskType }}"
        enableFIPS: {{ enableFIPS }}
        linuxProfile:
          linuxOSConfig:
            sysctls:
              netCoreSomaxconn: {{ netCoreSomaxconn }}
              netCoreNetdevMaxBacklog: {{ netCoreNetdevMaxBacklog }}
              netCoreRmemDefault: {{ netCoreRmemDefault }}
              netCoreRmemMax: {{ netCoreRmemMax }}
              netCoreWmemDefault: {{ netCoreWmemDefault }}
              netCoreWmemMax: {{ netCoreWmemMax }}
              netCoreOptmemMax: {{ netCoreOptmemMax }}
              netIpv4TcpMaxSynBacklog: {{ netIpv4TcpMaxSynBacklog }}
              netIpv4TcpMaxTwBuckets: {{ netIpv4TcpMaxTwBuckets }}
              netIpv4TcpFinTimeout: {{ netIpv4TcpFinTimeout }}
              netIpv4TcpKeepaliveTime: {{ netIpv4TcpKeepaliveTime }}
              netIpv4TcpKeepaliveProbes: {{ netIpv4TcpKeepaliveProbes }}
              netIpv4TcpkeepaliveIntvl: {{ netIpv4TcpkeepaliveIntvl }}
              netIpv4TcpTwReuse: {{ netIpv4TcpTwReuse }}
              netIpv4IpLocalPortRange: "{{ netIpv4IpLocalPortRange }}"
              netIpv4NeighDefaultGcThresh1: {{ netIpv4NeighDefaultGcThresh1 }}
              netIpv4NeighDefaultGcThresh2: {{ netIpv4NeighDefaultGcThresh2 }}
              netIpv4NeighDefaultGcThresh3: {{ netIpv4NeighDefaultGcThresh3 }}
              netNetfilterNfConntrackMax: {{ netNetfilterNfConntrackMax }}
              netNetfilterNfConntrackBuckets: {{ netNetfilterNfConntrackBuckets }}
              fsInotifyMaxUserWatches: {{ fsInotifyMaxUserWatches }}
              fsFileMax: {{ fsFileMax }}
              fsAioMaxNr: {{ fsAioMaxNr }}
              fsNrOpen: {{ fsNrOpen }}
              kernelThreadsMax: {{ kernelThreadsMax }}
              vmMaxMapCount: {{ vmMaxMapCount }}
              vmSwappiness: {{ vmSwappiness }}
              vmVfsCachePressure: {{ vmVfsCachePressure }}
            transparentHugePageEnabled: "{{ transparentHugePageEnabled }}"
            transparentHugePageDefrag: "{{ transparentHugePageDefrag }}"
            swapFileSizeMB: {{ swapFileSizeMB }}
          messageOfTheDay: "{{ messageOfTheDay }}"
        windowsProfile:
          disableOutboundNat: {{ disableOutboundNat }}
      kubernetes:
        nodeLabels: "{{ nodeLabels }}"
        orchestratorVersion: "{{ orchestratorVersion }}"
        currentOrchestratorVersion: "{{ currentOrchestratorVersion }}"
        kubeletDiskType: "{{ kubeletDiskType }}"
        kubeletConfig:
          cpuManagerPolicy: "{{ cpuManagerPolicy }}"
          cpuCfsQuota: {{ cpuCfsQuota }}
          cpuCfsQuotaPeriod: "{{ cpuCfsQuotaPeriod }}"
          imageGcHighThreshold: {{ imageGcHighThreshold }}
          imageGcLowThreshold: {{ imageGcLowThreshold }}
          topologyManagerPolicy: "{{ topologyManagerPolicy }}"
          allowedUnsafeSysctls:
            - "{{ allowedUnsafeSysctls }}"
          failSwapOn: {{ failSwapOn }}
          containerLogMaxSizeMB: {{ containerLogMaxSizeMB }}
          containerLogMaxFiles: {{ containerLogMaxFiles }}
          podMaxPids: {{ podMaxPids }}
          seccompDefault: "{{ seccompDefault }}"
          kubeReserved:
            cpuMillicores: {{ cpuMillicores }}
            memoryMB: {{ memoryMB }}
          hardEvictionThreshold:
            memoryAvailable: "{{ memoryAvailable }}"
            nodeFsAvailable: "{{ nodeFsAvailable }}"
            nodeFsInodesFree: "{{ nodeFsInodesFree }}"
        nodeInitializationTaints:
          - "{{ nodeInitializationTaints }}"
        nodeTaints:
          - "{{ nodeTaints }}"
        maxPods: {{ maxPods }}
        nodeName: "{{ nodeName }}"
        workloadRuntime: "{{ workloadRuntime }}"
        artifactStreamingProfile:
          enabled: {{ enabled }}
      mode: "{{ mode }}"
      security:
        enableVTPM: {{ enableVTPM }}
        enableSecureBoot: {{ enableSecureBoot }}
        sshAccess: "{{ sshAccess }}"
        enableEncryptionAtHost: {{ enableEncryptionAtHost }}
      priority: "{{ priority }}"
      evictionPolicy: "{{ evictionPolicy }}"
      billing:
        spotMaxPrice: {{ spotMaxPrice }}
      nodeImageVersion: "{{ nodeImageVersion }}"
      provisioningState: "{{ provisioningState }}"
      tags: "{{ tags }}"
      eTag: "{{ eTag }}"
      status:
        provisioningError:
          code: "{{ code }}"
          message: "{{ message }}"
          target: "{{ target }}"
          details:
            - code: "{{ code }}"
              message: "{{ message }}"
              target: "{{ target }}"
              details: "{{ details }}"
              additionalInfo: "{{ additionalInfo }}"
          additionalInfo:
            - type: "{{ type }}"
              info: "{{ info }}"
        creationTimestamp: "{{ creationTimestamp }}"
        driftAction: "{{ driftAction }}"
        driftReason: "{{ driftReason }}"
        vmState: "{{ vmState }}"
      localDNSProfile:
        mode: "{{ mode }}"
        state: "{{ state }}"
        vnetDNSOverrides: "{{ vnetDNSOverrides }}"
        kubeDNSOverrides: "{{ kubeDNSOverrides }}"
  - name: zones
    value:
      - "{{ zones }}"
    description: |
      The Availability zone in which machine is located.

REPLACE examples

create_or_update

Creates or updates a machine in the specified agent pool.

REPLACE azure.container_service.machines
SET 
properties = '{{ properties }}',
zones = '{{ zones }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND agent_pool_name = '{{ agent_pool_name }}' --required
AND machine_name = '{{ machine_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type,
zones;