machine_pools

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

Overview

Name	machine_pools
Type	Resource
Id	azure_isv.openshift_clusters.machine_pools

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	The MachinePool Properties
systemData	object	The system meta data relating to this resource.

list

Name	Datatype	Description
properties	object	The MachinePool Properties
systemData	object	The system meta data relating to this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, resourceName, childResourceName		The operation returns properties of a MachinePool.
list	select	subscriptionId, resourceGroupName, resourceName		The operation returns properties of each MachinePool.
create_or_update	insert	subscriptionId, resourceGroupName, resourceName, childResourceName		The operation returns properties of a MachinePool.
update	update	subscriptionId, resourceGroupName, resourceName, childResourceName		The operation returns properties of a MachinePool.
delete	delete	subscriptionId, resourceGroupName, resourceName, childResourceName		The operation returns nothing.

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
childResourceName	string	The name of the MachinePool resource.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
resourceName	string	The name of the OpenShift cluster resource.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

The operation returns properties of a MachinePool.

SELECT
properties,
systemData
FROM azure_isv.openshift_clusters.machine_pools
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND childResourceName = '{{ childResourceName }}' -- required
;

list

The operation returns properties of each MachinePool.

SELECT
properties,
systemData
FROM azure_isv.openshift_clusters.machine_pools
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;

INSERT examples

create_or_update

The operation returns properties of a MachinePool.

INSERT INTO azure_isv.openshift_clusters.machine_pools (
data__properties,
subscriptionId,
resourceGroupName,
resourceName,
childResourceName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ childResourceName }}'
RETURNING
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: machine_pools
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the machine_pools resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the machine_pools resource.
    - name: resourceName
      value: string
      description: Required parameter for the machine_pools resource.
    - name: childResourceName
      value: string
      description: Required parameter for the machine_pools resource.
    - name: properties
      value: object
      description: |
        The MachinePool Properties

UPDATE examples

update

The operation returns properties of a MachinePool.

UPDATE azure_isv.openshift_clusters.machine_pools
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
AND childResourceName = '{{ childResourceName }}' --required
RETURNING
properties,
systemData;

DELETE examples

delete

The operation returns nothing.

DELETE FROM azure_isv.openshift_clusters.machine_pools
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
AND childResourceName = '{{ childResourceName }}' --required
;