scale_units

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

Overview

Name	scale_units
Type	Resource
Id	azure_stack.fabric_admin.scale_units

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	Properties of a scale unit.
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	Properties of a scale unit.
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, scaleUnit		Returns the requested scale unit.
list	select	subscriptionId, resourceGroupName, location	$filter	Returns a list of all scale units at a location.
scale_out	exec	subscriptionId, resourceGroupName, location, scaleUnit		Scales out a scale unit.
set_gpu_partition_size	exec	subscriptionId, resourceGroupName, location, scaleUnit		Set GPU partition size.

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.
scaleUnit	string	Name of the scale units.
subscriptionId	string	The ID of the target subscription.
$filter	string	OData filter parameter.

SELECT examples

get

Returns the requested scale unit.

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

list

Returns a list of all scale units at a location.

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

Lifecycle Methods

scale_out

Scales out a scale unit.

EXEC azure_stack.fabric_admin.scale_units.scale_out 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@location='{{ location }}' --required, 
@scaleUnit='{{ scaleUnit }}' --required 
@@json=
'{
"nodeList": "{{ nodeList }}", 
"awaitStorageConvergence": {{ awaitStorageConvergence }}
}'
;

set_gpu_partition_size

Set GPU partition size.

EXEC azure_stack.fabric_admin.scale_units.set_gpu_partition_size 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@location='{{ location }}' --required, 
@scaleUnit='{{ scaleUnit }}' --required 
@@json=
'{
"gpuPartitionSize": {{ gpuPartitionSize }}
}'
;