hardware_settings

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

Overview

Name	hardware_settings
Type	Resource
Id	azure_stack.disconnected_operations.hardware_settings

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.
deviceId	string	The unique Id of the device. Required.
diskSpaceInGb	integer	The disk space in GB. Required.
hardwareSku	string	The hardware SKU. Required.
memoryInGb	integer	The memory in GB. Required.
nodes	integer	The number of nodes. Required.
oem	string	The OEM. Required.
provisioningState	string	The resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
solutionBuilderExtension	string	The solution builder extension at registration. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
totalCores	integer	The total number of cores. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
versionAtRegistration	string	The active version at registration. Required.

list_by_parent

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.
deviceId	string	The unique Id of the device. Required.
diskSpaceInGb	integer	The disk space in GB. Required.
hardwareSku	string	The hardware SKU. Required.
memoryInGb	integer	The memory in GB. Required.
nodes	integer	The number of nodes. Required.
oem	string	The OEM. Required.
provisioningState	string	The resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
solutionBuilderExtension	string	The solution builder extension at registration. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
totalCores	integer	The total number of cores. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
versionAtRegistration	string	The active version at registration. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, name, hardware_setting_name, subscription_id		Get the hardware settings resource.
list_by_parent	select	resource_group_name, name, subscription_id		List by parent.
create_or_update	insert	resource_group_name, name, hardware_setting_name, subscription_id		Create or update hardware settings.
create_or_update	replace	resource_group_name, name, hardware_setting_name, subscription_id		Create or update hardware settings.
delete	delete	resource_group_name, name, hardware_setting_name, subscription_id		Delete hardware settings.

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
hardware_setting_name	string	The name of the HardwareSetting. Required.
name	string	Name of the resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get the hardware settings resource.

SELECT
id,
name,
deviceId,
diskSpaceInGb,
hardwareSku,
memoryInGb,
nodes,
oem,
provisioningState,
solutionBuilderExtension,
systemData,
totalCores,
type,
versionAtRegistration
FROM azure_stack.disconnected_operations.hardware_settings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND hardware_setting_name = '{{ hardware_setting_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_parent

List by parent.

SELECT
id,
name,
deviceId,
diskSpaceInGb,
hardwareSku,
memoryInGb,
nodes,
oem,
provisioningState,
solutionBuilderExtension,
systemData,
totalCores,
type,
versionAtRegistration
FROM azure_stack.disconnected_operations.hardware_settings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update hardware settings.

INSERT INTO azure_stack.disconnected_operations.hardware_settings (
properties,
resource_group_name,
name,
hardware_setting_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ name }}',
'{{ hardware_setting_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: hardware_settings
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the hardware_settings resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the hardware_settings resource.
  - name: hardware_setting_name
    value: "{{ hardware_setting_name }}"
    description: Required parameter for the hardware_settings resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the hardware_settings resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      totalCores: {{ totalCores }}
      diskSpaceInGb: {{ diskSpaceInGb }}
      memoryInGb: {{ memoryInGb }}
      oem: "{{ oem }}"
      hardwareSku: "{{ hardwareSku }}"
      nodes: {{ nodes }}
      versionAtRegistration: "{{ versionAtRegistration }}"
      solutionBuilderExtension: "{{ solutionBuilderExtension }}"
      deviceId: "{{ deviceId }}"

REPLACE examples

create_or_update

Create or update hardware settings.

REPLACE azure_stack.disconnected_operations.hardware_settings
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND name = '{{ name }}' --required
AND hardware_setting_name = '{{ hardware_setting_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete hardware settings.

DELETE FROM azure_stack.disconnected_operations.hardware_settings
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND name = '{{ name }}' --required
AND hardware_setting_name = '{{ hardware_setting_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;