user_settings_with_locations
Creates, updates, deletes, gets or lists a user_settings_with_locations resource.
Overview
| Name | user_settings_with_locations |
| Type | Resource |
| Id | azure.cloud_shell.user_settings_with_locations |
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, location | 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, location | Delete 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_with_locations
WHERE userSettingsName = '{{ userSettingsName }}' -- required
AND location = '{{ location }}' -- required
;
DELETE examples
- delete
Delete cloud shell settings for current signed in user
DELETE FROM azure.cloud_shell.user_settings_with_locations
WHERE userSettingsName = '{{ userSettingsName }}' --required
AND location = '{{ location }}' --required
;