Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. portal
  5. getUserSettingsWithLocation
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.portal.getUserSettingsWithLocation

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

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.

Uses Azure REST API version 2018-10-01.

Using getUserSettingsWithLocation

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getUserSettingsWithLocation(args: GetUserSettingsWithLocationArgs, opts?: InvokeOptions): Promise<GetUserSettingsWithLocationResult>
function getUserSettingsWithLocationOutput(args: GetUserSettingsWithLocationOutputArgs, opts?: InvokeOptions): Output<GetUserSettingsWithLocationResult>
Copy
def get_user_settings_with_location(location: Optional[str] = None,
                                    user_settings_name: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetUserSettingsWithLocationResult
def get_user_settings_with_location_output(location: Optional[pulumi.Input[str]] = None,
                                    user_settings_name: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetUserSettingsWithLocationResult]
Copy
func LookupUserSettingsWithLocation(ctx *Context, args *LookupUserSettingsWithLocationArgs, opts ...InvokeOption) (*LookupUserSettingsWithLocationResult, error)
func LookupUserSettingsWithLocationOutput(ctx *Context, args *LookupUserSettingsWithLocationOutputArgs, opts ...InvokeOption) LookupUserSettingsWithLocationResultOutput
Copy

> Note: This function is named LookupUserSettingsWithLocation in the Go SDK.

public static class GetUserSettingsWithLocation 
{
    public static Task<GetUserSettingsWithLocationResult> InvokeAsync(GetUserSettingsWithLocationArgs args, InvokeOptions? opts = null)
    public static Output<GetUserSettingsWithLocationResult> Invoke(GetUserSettingsWithLocationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetUserSettingsWithLocationResult> getUserSettingsWithLocation(GetUserSettingsWithLocationArgs args, InvokeOptions options)
public static Output<GetUserSettingsWithLocationResult> getUserSettingsWithLocation(GetUserSettingsWithLocationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:portal:getUserSettingsWithLocation
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Location
This property is required.
Changes to this property will trigger replacement.
string
The provider location
UserSettingsName
This property is required.
Changes to this property will trigger replacement.
string
The name of the user settings
Location
This property is required.
Changes to this property will trigger replacement.
string
The provider location
UserSettingsName
This property is required.
Changes to this property will trigger replacement.
string
The name of the user settings
location
This property is required.
Changes to this property will trigger replacement.
String
The provider location
userSettingsName
This property is required.
Changes to this property will trigger replacement.
String
The name of the user settings
location
This property is required.
Changes to this property will trigger replacement.
string
The provider location
userSettingsName
This property is required.
Changes to this property will trigger replacement.
string
The name of the user settings
location
This property is required.
Changes to this property will trigger replacement.
str
The provider location
user_settings_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the user settings
location
This property is required.
Changes to this property will trigger replacement.
String
The provider location
userSettingsName
This property is required.
Changes to this property will trigger replacement.
String
The name of the user settings

getUserSettingsWithLocation Result

The following output properties are available:

Properties UserPropertiesResponse
The cloud shell user settings properties.
properties UserPropertiesResponse
The cloud shell user settings properties.
properties UserPropertiesResponse
The cloud shell user settings properties.
properties UserPropertiesResponse
The cloud shell user settings properties.
properties Property Map
The cloud shell user settings properties.

Supporting Types

StorageProfileResponse

DiskSizeInGB int
Size of file share
FileShareName string
Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and -
StorageAccountResourceId string
Full resource ID of storage account.
DiskSizeInGB int
Size of file share
FileShareName string
Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and -
StorageAccountResourceId string
Full resource ID of storage account.
diskSizeInGB Integer
Size of file share
fileShareName String
Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and -
storageAccountResourceId String
Full resource ID of storage account.
diskSizeInGB number
Size of file share
fileShareName string
Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and -
storageAccountResourceId string
Full resource ID of storage account.
disk_size_in_gb int
Size of file share
file_share_name str
Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and -
storage_account_resource_id str
Full resource ID of storage account.
diskSizeInGB Number
Size of file share
fileShareName String
Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and -
storageAccountResourceId String
Full resource ID of storage account.

TerminalSettingsResponse

FontSize string
Size of terminal font.
FontStyle string
Style of terminal font.
FontSize string
Size of terminal font.
FontStyle string
Style of terminal font.
fontSize String
Size of terminal font.
fontStyle String
Style of terminal font.
fontSize string
Size of terminal font.
fontStyle string
Style of terminal font.
font_size str
Size of terminal font.
font_style str
Style of terminal font.
fontSize String
Size of terminal font.
fontStyle String
Style of terminal font.

UserPropertiesResponse

PreferredLocation This property is required. string
The preferred location of the cloud shell.
PreferredOsType This property is required. string
The operating system type of the cloud shell. Deprecated, use preferredShellType.
PreferredShellType This property is required. string
The shell type of the cloud shell.
StorageProfile This property is required. Pulumi.AzureNative.Portal.Inputs.StorageProfileResponse
The storage profile of the user settings.
TerminalSettings This property is required. Pulumi.AzureNative.Portal.Inputs.TerminalSettingsResponse
Settings for terminal appearance.
PreferredLocation This property is required. string
The preferred location of the cloud shell.
PreferredOsType This property is required. string
The operating system type of the cloud shell. Deprecated, use preferredShellType.
PreferredShellType This property is required. string
The shell type of the cloud shell.
StorageProfile This property is required. StorageProfileResponse
The storage profile of the user settings.
TerminalSettings This property is required. TerminalSettingsResponse
Settings for terminal appearance.
preferredLocation This property is required. String
The preferred location of the cloud shell.
preferredOsType This property is required. String
The operating system type of the cloud shell. Deprecated, use preferredShellType.
preferredShellType This property is required. String
The shell type of the cloud shell.
storageProfile This property is required. StorageProfileResponse
The storage profile of the user settings.
terminalSettings This property is required. TerminalSettingsResponse
Settings for terminal appearance.
preferredLocation This property is required. string
The preferred location of the cloud shell.
preferredOsType This property is required. string
The operating system type of the cloud shell. Deprecated, use preferredShellType.
preferredShellType This property is required. string
The shell type of the cloud shell.
storageProfile This property is required. StorageProfileResponse
The storage profile of the user settings.
terminalSettings This property is required. TerminalSettingsResponse
Settings for terminal appearance.
preferred_location This property is required. str
The preferred location of the cloud shell.
preferred_os_type This property is required. str
The operating system type of the cloud shell. Deprecated, use preferredShellType.
preferred_shell_type This property is required. str
The shell type of the cloud shell.
storage_profile This property is required. StorageProfileResponse
The storage profile of the user settings.
terminal_settings This property is required. TerminalSettingsResponse
Settings for terminal appearance.
preferredLocation This property is required. String
The preferred location of the cloud shell.
preferredOsType This property is required. String
The operating system type of the cloud shell. Deprecated, use preferredShellType.
preferredShellType This property is required. String
The shell type of the cloud shell.
storageProfile This property is required. Property Map
The storage profile of the user settings.
terminalSettings This property is required. Property Map
Settings for terminal appearance.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native