1. Packages
  2. Azure Native v1
  3. API Docs
  4. portal
  5. getUserSettings
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

azure-native.portal.getUserSettings

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

    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. API Version: 2018-10-01.

    Using getUserSettings

    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 getUserSettings(args: GetUserSettingsArgs, opts?: InvokeOptions): Promise<GetUserSettingsResult>
    function getUserSettingsOutput(args: GetUserSettingsOutputArgs, opts?: InvokeOptions): Output<GetUserSettingsResult>
    def get_user_settings(user_settings_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetUserSettingsResult
    def get_user_settings_output(user_settings_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetUserSettingsResult]
    func LookupUserSettings(ctx *Context, args *LookupUserSettingsArgs, opts ...InvokeOption) (*LookupUserSettingsResult, error)
    func LookupUserSettingsOutput(ctx *Context, args *LookupUserSettingsOutputArgs, opts ...InvokeOption) LookupUserSettingsResultOutput

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

    public static class GetUserSettings 
    {
        public static Task<GetUserSettingsResult> InvokeAsync(GetUserSettingsArgs args, InvokeOptions? opts = null)
        public static Output<GetUserSettingsResult> Invoke(GetUserSettingsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetUserSettingsResult> getUserSettings(GetUserSettingsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:portal:getUserSettings
      arguments:
        # arguments dictionary

    The following arguments are supported:

    UserSettingsName string
    The name of the user settings
    UserSettingsName string
    The name of the user settings
    userSettingsName String
    The name of the user settings
    userSettingsName string
    The name of the user settings
    user_settings_name str
    The name of the user settings
    userSettingsName String
    The name of the user settings

    getUserSettings 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 string
    The preferred location of the cloud shell.
    PreferredOsType string
    The operating system type of the cloud shell. Deprecated, use preferredShellType.
    PreferredShellType string
    The shell type of the cloud shell.
    StorageProfile Pulumi.AzureNative.Portal.Inputs.StorageProfileResponse
    The storage profile of the user settings.
    TerminalSettings Pulumi.AzureNative.Portal.Inputs.TerminalSettingsResponse
    Settings for terminal appearance.
    PreferredLocation string
    The preferred location of the cloud shell.
    PreferredOsType string
    The operating system type of the cloud shell. Deprecated, use preferredShellType.
    PreferredShellType string
    The shell type of the cloud shell.
    StorageProfile StorageProfileResponse
    The storage profile of the user settings.
    TerminalSettings TerminalSettingsResponse
    Settings for terminal appearance.
    preferredLocation String
    The preferred location of the cloud shell.
    preferredOsType String
    The operating system type of the cloud shell. Deprecated, use preferredShellType.
    preferredShellType String
    The shell type of the cloud shell.
    storageProfile StorageProfileResponse
    The storage profile of the user settings.
    terminalSettings TerminalSettingsResponse
    Settings for terminal appearance.
    preferredLocation string
    The preferred location of the cloud shell.
    preferredOsType string
    The operating system type of the cloud shell. Deprecated, use preferredShellType.
    preferredShellType string
    The shell type of the cloud shell.
    storageProfile StorageProfileResponse
    The storage profile of the user settings.
    terminalSettings TerminalSettingsResponse
    Settings for terminal appearance.
    preferred_location str
    The preferred location of the cloud shell.
    preferred_os_type str
    The operating system type of the cloud shell. Deprecated, use preferredShellType.
    preferred_shell_type str
    The shell type of the cloud shell.
    storage_profile StorageProfileResponse
    The storage profile of the user settings.
    terminal_settings TerminalSettingsResponse
    Settings for terminal appearance.
    preferredLocation String
    The preferred location of the cloud shell.
    preferredOsType String
    The operating system type of the cloud shell. Deprecated, use preferredShellType.
    preferredShellType String
    The shell type of the cloud shell.
    storageProfile Property Map
    The storage profile of the user settings.
    terminalSettings Property Map
    Settings for terminal appearance.

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi