scale_unit_nodes

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

Overview

Name	scale_unit_nodes
Type	Resource
Id	azure_stack.fabric_admin.scale_unit_nodes

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
properties	object	Holds all properties related to a scale unit node.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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
properties	object	Holds all properties related to a scale unit node.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, location, scaleUnitNode		Return the requested scale unit node.
list	select	subscriptionId, resourceGroupName, location	$filter	Returns a list of all scale unit nodes in a location.
shutdown	exec	subscriptionId, resourceGroupName, location, scaleUnitNode		Shutdown a scale unit node.
power_off	exec	subscriptionId, resourceGroupName, location, scaleUnitNode		Power off a scale unit node.
power_on	exec	subscriptionId, resourceGroupName, location, scaleUnitNode		Power on a scale unit node.
start_maintenance_mode	exec	subscriptionId, resourceGroupName, location, scaleUnitNode		Start maintenance mode for a scale unit node.
stop_maintenance_mode	exec	subscriptionId, resourceGroupName, location, scaleUnitNode		Stop maintenance mode for a scale unit node.
repair	exec	subscriptionId, resourceGroupName, location, scaleUnitNode		Repairs a node of the cluster.

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
location	string	The name of Azure region.
resourceGroupName	string	Name of the resource group.
scaleUnitNode	string	Name of the scale unit node.
subscriptionId	string	The ID of the target subscription.
$filter	string	OData filter parameter.

SELECT examples

get

Return the requested scale unit node.

SELECT
id,
name,
properties,
type
FROM azure_stack.fabric_admin.scale_unit_nodes
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND location = '{{ location }}' -- required
AND scaleUnitNode = '{{ scaleUnitNode }}' -- required
;

list

Returns a list of all scale unit nodes in a location.

SELECT
id,
name,
properties,
type
FROM azure_stack.fabric_admin.scale_unit_nodes
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND location = '{{ location }}' -- required
AND $filter = '{{ $filter }}'
;

Lifecycle Methods

shutdown

Shutdown a scale unit node.

EXEC azure_stack.fabric_admin.scale_unit_nodes.shutdown 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@location='{{ location }}' --required, 
@scaleUnitNode='{{ scaleUnitNode }}' --required
;

power_off

Power off a scale unit node.

EXEC azure_stack.fabric_admin.scale_unit_nodes.power_off 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@location='{{ location }}' --required, 
@scaleUnitNode='{{ scaleUnitNode }}' --required
;

power_on

Power on a scale unit node.

EXEC azure_stack.fabric_admin.scale_unit_nodes.power_on 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@location='{{ location }}' --required, 
@scaleUnitNode='{{ scaleUnitNode }}' --required
;

start_maintenance_mode

Start maintenance mode for a scale unit node.

EXEC azure_stack.fabric_admin.scale_unit_nodes.start_maintenance_mode 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@location='{{ location }}' --required, 
@scaleUnitNode='{{ scaleUnitNode }}' --required
;

stop_maintenance_mode

Stop maintenance mode for a scale unit node.

EXEC azure_stack.fabric_admin.scale_unit_nodes.stop_maintenance_mode 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@location='{{ location }}' --required, 
@scaleUnitNode='{{ scaleUnitNode }}' --required
;

repair

Repairs a node of the cluster.

EXEC azure_stack.fabric_admin.scale_unit_nodes.repair 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@location='{{ location }}' --required, 
@scaleUnitNode='{{ scaleUnitNode }}' --required 
@@json=
'{
"bmcIpv4Address": "{{ bmcIpv4Address }}", 
"vendor": "{{ vendor }}", 
"model": "{{ model }}", 
"serialNumber": "{{ serialNumber }}", 
"biosVersion": "{{ biosVersion }}", 
"computerName": "{{ computerName }}", 
"clusterName": "{{ clusterName }}", 
"macAddress": "{{ macAddress }}"
}'
;