settings

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

Overview

Name	settings
Type	Resource
Id	azure.hybrid_compute.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.
gatewayProperties	object	Settings Gateway properties.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantId	string	Azure resource tenant Id.
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	resource_group_name, base_provider, base_resource_type, base_resource_name, settings_resource_name, subscription_id		Returns the base Settings for the target resource.
update	update	resource_group_name, base_provider, base_resource_type, base_resource_name, settings_resource_name, subscription_id		Updates the base Settings of the target resource.
patch	exec	resource_group_name, base_provider, base_resource_type, base_resource_name, settings_resource_name, subscription_id		Update the base Settings of the target resource.

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
base_provider	string	The name of the base Resource Provider. Required.
base_resource_name	string	The name of the base resource. Required.
base_resource_type	string	The name of the base Resource Type. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
settings_resource_name	string	The name of the settings resource. Required.
subscription_id	string

SELECT examples

get

Returns the base Settings for the target resource.

SELECT
id,
name,
gatewayProperties,
systemData,
tenantId,
type
FROM azure.hybrid_compute.settings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND base_provider = '{{ base_provider }}' -- required
AND base_resource_type = '{{ base_resource_type }}' -- required
AND base_resource_name = '{{ base_resource_name }}' -- required
AND settings_resource_name = '{{ settings_resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

UPDATE examples

update

Updates the base Settings of the target resource.

UPDATE azure.hybrid_compute.settings
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND base_provider = '{{ base_provider }}' --required
AND base_resource_type = '{{ base_resource_type }}' --required
AND base_resource_name = '{{ base_resource_name }}' --required
AND settings_resource_name = '{{ settings_resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

Lifecycle Methods

patch

Update the base Settings of the target resource.

EXEC azure.hybrid_compute.settings.patch 
@resource_group_name='{{ resource_group_name }}' --required, 
@base_provider='{{ base_provider }}' --required, 
@base_resource_type='{{ base_resource_type }}' --required, 
@base_resource_name='{{ base_resource_name }}' --required, 
@settings_resource_name='{{ settings_resource_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;