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

The following fields are returned by SELECT queries:

get

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional 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.
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
delete	delete	userSettingsName		Delete cloud shell settings for current signed in user
patch_with_location	exec	userSettingsName, location		Patch cloud shell settings for current signed in user
put_with_location	exec	userSettingsName, location, properties		Create or update cloud shell settings for current signed in user

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 provider location
userSettingsName	string	The name of the user settings

SELECT examples

get

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.

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

UPDATE examples

patch

Patch cloud shell settings for current signed in user

UPDATE azure.cloud_shell.user_settings
SET 
data__properties = '{{ properties }}'
WHERE 
userSettingsName = '{{ userSettingsName }}' --required
RETURNING
properties;

REPLACE examples

put

Create or update cloud shell settings for current signed in user

REPLACE azure.cloud_shell.user_settings
SET 
data__properties = '{{ properties }}'
WHERE 
userSettingsName = '{{ userSettingsName }}' --required
AND data__properties = '{{ properties }}' --required
RETURNING
properties;

DELETE examples

delete

Delete cloud shell settings for current signed in user

DELETE FROM azure.cloud_shell.user_settings
WHERE userSettingsName = '{{ userSettingsName }}' --required
;

Lifecycle Methods

patch_with_location

Patch cloud shell settings for current signed in user

EXEC azure.cloud_shell.user_settings.patch_with_location 
@userSettingsName='{{ userSettingsName }}' --required, 
@location='{{ location }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

put_with_location

Create or update cloud shell settings for current signed in user

EXEC azure.cloud_shell.user_settings.put_with_location 
@userSettingsName='{{ userSettingsName }}' --required, 
@location='{{ location }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;