user_settings

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

Overview

Name	user_settings
Type	Resource
Id	azure.cloud_shell.user_settings

Fields

vw_user_settings

Name	Datatype	Description
preferred_location	text	field from the properties object
preferred_os_type	text	field from the properties object
preferred_shell_type	text	field from the properties object
storage_profile	text	field from the properties object
terminal_settings	text	field from the properties object
userSettingsName	text	field from the properties object

user_settings

Name	Datatype	Description
properties	object	The cloud shell user settings properties.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	userSettingsName	Get current user settings for current signed in user. This operation returns settings for the user's cloud shell preferences including preferred location, storage profile, shell type, font and size settings.
delete	DELETE	userSettingsName	Delete cloud shell settings for current signed in user
patch	UPDATE	userSettingsName	Patch cloud shell settings for current signed in user
put	REPLACE	userSettingsName, data__properties	Create or update cloud shell settings for current signed in user
patch_with_location	EXEC	location, userSettingsName	Patch cloud shell settings for current signed in user
put_with_location	EXEC	location, userSettingsName, data__properties	Create or update cloud shell settings for current signed in user

SELECT examples

Get current user settings for current signed in user. This operation returns settings for the user's cloud shell preferences including preferred location, storage profile, shell type, font and size settings.

vw_user_settings

SELECT
preferred_location,
preferred_os_type,
preferred_shell_type,
storage_profile,
terminal_settings,
userSettingsName
FROM azure.cloud_shell.vw_user_settings
WHERE userSettingsName = '{{ userSettingsName }}';

user_settings

SELECT
properties
FROM azure.cloud_shell.user_settings
WHERE userSettingsName = '{{ userSettingsName }}';

UPDATE example

Updates a user_settings resource.

/*+ update */
UPDATE azure.cloud_shell.user_settings
SET 
properties = '{{ properties }}'
WHERE 
userSettingsName = '{{ userSettingsName }}';

REPLACE example

Replaces all fields in the specified user_settings resource.

/*+ update */
REPLACE azure.cloud_shell.user_settings
SET 
properties = '{{ properties }}'
WHERE 
userSettingsName = '{{ userSettingsName }}'
AND data__properties = '{{ data__properties }}';

DELETE example

Deletes the specified user_settings resource.

/*+ delete */
DELETE FROM azure.cloud_shell.user_settings
WHERE userSettingsName = '{{ userSettingsName }}';