1. Registry
  2. Packages
  3. Azure Native
  4. API Docs
  5. portal
  6. UserSettings
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.32.0
published on Wednesday, Nov 18, 2026 by Pulumi
azure-native logo Azure Native
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.32.0
published on Wednesday, Nov 18, 2026 by Pulumi

    Response to get user settings

    Uses Azure REST API version 2018-10-01. In version 2.x of the Azure Native provider, it used API version 2018-10-01.

    Example Usage

    PutUserSettings

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var userSettings = new AzureNative.Portal.UserSettings("userSettings", new()
        {
            Properties = new AzureNative.Portal.Inputs.UserPropertiesArgs
            {
                PreferredLocation = "eastus",
                PreferredOsType = AzureNative.Portal.OsType.Linux,
                PreferredShellType = AzureNative.Portal.ShellType.Bash,
                StorageProfile = new AzureNative.Portal.Inputs.StorageProfileArgs
                {
                    DiskSizeInGB = 5,
                    FileShareName = "string",
                    StorageAccountResourceId = "string",
                },
                TerminalSettings = new AzureNative.Portal.Inputs.TerminalSettingsArgs
                {
                    FontSize = AzureNative.Portal.FontSize.Medium,
                    FontStyle = AzureNative.Portal.FontStyle.Monospace,
                },
            },
            UserSettingsName = "cloudconsole",
        });
    
    });
    
    package main
    
    import (
    	portal "github.com/pulumi/pulumi-azure-native-sdk/portal/v3"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := portal.NewUserSettings(ctx, "userSettings", &portal.UserSettingsArgs{
    			Properties: &portal.UserPropertiesArgs{
    				PreferredLocation:  pulumi.String("eastus"),
    				PreferredOsType:    pulumi.String(portal.OsTypeLinux),
    				PreferredShellType: pulumi.String(portal.ShellTypeBash),
    				StorageProfile: &portal.StorageProfileArgs{
    					DiskSizeInGB:             pulumi.Int(5),
    					FileShareName:            pulumi.String("string"),
    					StorageAccountResourceId: pulumi.String("string"),
    				},
    				TerminalSettings: &portal.TerminalSettingsArgs{
    					FontSize:  pulumi.String(portal.FontSizeMedium),
    					FontStyle: pulumi.String(portal.FontStyleMonospace),
    				},
    			},
    			UserSettingsName: pulumi.String("cloudconsole"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    terraform {
      required_providers {
        azure-native = {
          source = "pulumi/azure-native"
        }
      }
    }
    
    resource "azure-native_portal_user_settings" "userSettings" {
      lifecycle {
        create_before_destroy = true
      }
      properties = {
        preferred_location   = "eastus"
        preferred_os_type    = "Linux"
        preferred_shell_type = "bash"
        storage_profile = {
          disk_size_in_gb             = 5
          file_share_name             = "string"
          storage_account_resource_id = "string"
        }
        terminal_settings = {
          font_size  = "Medium"
          font_style = "Monospace"
        }
      }
      user_settings_name = "cloudconsole"
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.portal.UserSettings;
    import com.pulumi.azurenative.portal.UserSettingsArgs;
    import com.pulumi.azurenative.portal.inputs.UserPropertiesArgs;
    import com.pulumi.azurenative.portal.inputs.StorageProfileArgs;
    import com.pulumi.azurenative.portal.inputs.TerminalSettingsArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var userSettings = new UserSettings("userSettings", UserSettingsArgs.builder()
                .properties(UserPropertiesArgs.builder()
                    .preferredLocation("eastus")
                    .preferredOsType("Linux")
                    .preferredShellType("bash")
                    .storageProfile(StorageProfileArgs.builder()
                        .diskSizeInGB(5)
                        .fileShareName("string")
                        .storageAccountResourceId("string")
                        .build())
                    .terminalSettings(TerminalSettingsArgs.builder()
                        .fontSize("Medium")
                        .fontStyle("Monospace")
                        .build())
                    .build())
                .userSettingsName("cloudconsole")
                .build());
    
        }
    }
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const userSettings = new azure_native.portal.UserSettings("userSettings", {
        properties: {
            preferredLocation: "eastus",
            preferredOsType: azure_native.portal.OsType.Linux,
            preferredShellType: azure_native.portal.ShellType.Bash,
            storageProfile: {
                diskSizeInGB: 5,
                fileShareName: "string",
                storageAccountResourceId: "string",
            },
            terminalSettings: {
                fontSize: azure_native.portal.FontSize.Medium,
                fontStyle: azure_native.portal.FontStyle.Monospace,
            },
        },
        userSettingsName: "cloudconsole",
    });
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    user_settings = azure_native.portal.UserSettings("userSettings",
        properties={
            "preferred_location": "eastus",
            "preferred_os_type": azure_native.portal.OsType.LINUX,
            "preferred_shell_type": azure_native.portal.ShellType.BASH,
            "storage_profile": {
                "disk_size_in_gb": 5,
                "file_share_name": "string",
                "storage_account_resource_id": "string",
            },
            "terminal_settings": {
                "font_size": azure_native.portal.FontSize.MEDIUM,
                "font_style": azure_native.portal.FontStyle.MONOSPACE,
            },
        },
        user_settings_name="cloudconsole")
    
    resources:
      userSettings:
        type: azure-native:portal:UserSettings
        properties:
          properties:
            preferredLocation: eastus
            preferredOsType: Linux
            preferredShellType: bash
            storageProfile:
              diskSizeInGB: 5
              fileShareName: string
              storageAccountResourceId: string
            terminalSettings:
              fontSize: Medium
              fontStyle: Monospace
          userSettingsName: cloudconsole
    

    Create UserSettings Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new UserSettings(name: string, args: UserSettingsArgs, opts?: CustomResourceOptions);
    @overload
    def UserSettings(resource_name: str,
                     args: UserSettingsArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def UserSettings(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     properties: Optional[UserPropertiesArgs] = None,
                     user_settings_name: Optional[str] = None)
    func NewUserSettings(ctx *Context, name string, args UserSettingsArgs, opts ...ResourceOption) (*UserSettings, error)
    public UserSettings(string name, UserSettingsArgs args, CustomResourceOptions? opts = null)
    public UserSettings(String name, UserSettingsArgs args)
    public UserSettings(String name, UserSettingsArgs args, CustomResourceOptions options)
    
    type: azure-native:portal:UserSettings
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "azure-native_portal_user_settings" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args UserSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args UserSettingsArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args UserSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserSettingsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var userSettingsResource = new AzureNative.Portal.UserSettings("userSettingsResource", new()
    {
        Properties = new AzureNative.Portal.Inputs.UserPropertiesArgs
        {
            PreferredLocation = "string",
            PreferredOsType = "string",
            PreferredShellType = "string",
            StorageProfile = new AzureNative.Portal.Inputs.StorageProfileArgs
            {
                DiskSizeInGB = 0,
                FileShareName = "string",
                StorageAccountResourceId = "string",
            },
            TerminalSettings = new AzureNative.Portal.Inputs.TerminalSettingsArgs
            {
                FontSize = "string",
                FontStyle = "string",
            },
        },
        UserSettingsName = "string",
    });
    
    example, err := portal.NewUserSettings(ctx, "userSettingsResource", &portal.UserSettingsArgs{
    	Properties: &portal.UserPropertiesArgs{
    		PreferredLocation:  pulumi.String("string"),
    		PreferredOsType:    pulumi.String("string"),
    		PreferredShellType: pulumi.String("string"),
    		StorageProfile: &portal.StorageProfileArgs{
    			DiskSizeInGB:             pulumi.Int(0),
    			FileShareName:            pulumi.String("string"),
    			StorageAccountResourceId: pulumi.String("string"),
    		},
    		TerminalSettings: &portal.TerminalSettingsArgs{
    			FontSize:  pulumi.String("string"),
    			FontStyle: pulumi.String("string"),
    		},
    	},
    	UserSettingsName: pulumi.String("string"),
    })
    
    resource "azure-native_portal_user_settings" "userSettingsResource" {
      lifecycle {
        create_before_destroy = true
      }
      properties = {
        preferred_location   = "string"
        preferred_os_type    = "string"
        preferred_shell_type = "string"
        storage_profile = {
          disk_size_in_gb             = 0
          file_share_name             = "string"
          storage_account_resource_id = "string"
        }
        terminal_settings = {
          font_size  = "string"
          font_style = "string"
        }
      }
      user_settings_name = "string"
    }
    
    var userSettingsResource = new UserSettings("userSettingsResource", UserSettingsArgs.builder()
        .properties(com.pulumi.azurenative.portal.inputs.UserPropertiesArgs.builder()
            .preferredLocation("string")
            .preferredOsType("string")
            .preferredShellType("string")
            .storageProfile(com.pulumi.azurenative.portal.inputs.StorageProfileArgs.builder()
                .diskSizeInGB(0)
                .fileShareName("string")
                .storageAccountResourceId("string")
                .build())
            .terminalSettings(TerminalSettingsArgs.builder()
                .fontSize("string")
                .fontStyle("string")
                .build())
            .build())
        .userSettingsName("string")
        .build());
    
    user_settings_resource = azure_native.portal.UserSettings("userSettingsResource",
        properties={
            "preferred_location": "string",
            "preferred_os_type": "string",
            "preferred_shell_type": "string",
            "storage_profile": {
                "disk_size_in_gb": 0,
                "file_share_name": "string",
                "storage_account_resource_id": "string",
            },
            "terminal_settings": {
                "font_size": "string",
                "font_style": "string",
            },
        },
        user_settings_name="string")
    
    const userSettingsResource = new azure_native.portal.UserSettings("userSettingsResource", {
        properties: {
            preferredLocation: "string",
            preferredOsType: "string",
            preferredShellType: "string",
            storageProfile: {
                diskSizeInGB: 0,
                fileShareName: "string",
                storageAccountResourceId: "string",
            },
            terminalSettings: {
                fontSize: "string",
                fontStyle: "string",
            },
        },
        userSettingsName: "string",
    });
    
    type: azure-native:portal:UserSettings
    properties:
        properties:
            preferredLocation: string
            preferredOsType: string
            preferredShellType: string
            storageProfile:
                diskSizeInGB: 0
                fileShareName: string
                storageAccountResourceId: string
            terminalSettings:
                fontSize: string
                fontStyle: string
        userSettingsName: string
    

    UserSettings Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The UserSettings resource accepts the following input properties:

    Properties Pulumi.AzureNative.Portal.Inputs.UserProperties
    The cloud shell user settings properties.
    UserSettingsName string
    The name of the user settings
    Properties UserPropertiesArgs
    The cloud shell user settings properties.
    UserSettingsName string
    The name of the user settings
    properties object
    The cloud shell user settings properties.
    user_settings_name string
    The name of the user settings
    properties UserProperties
    The cloud shell user settings properties.
    userSettingsName String
    The name of the user settings
    properties UserProperties
    The cloud shell user settings properties.
    userSettingsName string
    The name of the user settings
    properties UserPropertiesArgs
    The cloud shell user settings properties.
    user_settings_name str
    The name of the user settings
    properties Property Map
    The cloud shell user settings properties.
    userSettingsName String
    The name of the user settings

    Outputs

    All input properties are implicitly available as output properties. Additionally, the UserSettings resource produces the following output properties:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    azure_api_version string
    The Azure API version of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    azure_api_version str
    The Azure API version of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing UserSettings Resource

    Get an existing UserSettings resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): UserSettings
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> UserSettings
    func GetUserSettings(ctx *Context, name string, id IDInput, state *UserSettingsState, opts ...ResourceOption) (*UserSettings, error)
    public static UserSettings Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static UserSettings get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingUserSettings:    type: azure-native:portal:UserSettings    get:      id: ${id}
    import {
      to = azure-native_portal_user_settings.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state UserSettingsState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Supporting Types

    FontSize

    Size of terminal font.

    NameValue
    NotSpecifiedNotSpecified
    SmallSmall
    MediumMedium
    LargeLarge
    NameValue
    FontSizeNotSpecifiedNotSpecified
    FontSizeSmallSmall
    FontSizeMediumMedium
    FontSizeLargeLarge
    Value
    NotSpecified
    Small
    Medium
    Large
    NameValue
    NotSpecifiedNotSpecified
    SmallSmall
    MediumMedium
    LargeLarge
    NameValue
    NotSpecifiedNotSpecified
    SmallSmall
    MediumMedium
    LargeLarge
    NameValue
    NOT_SPECIFIEDNotSpecified
    SMALLSmall
    MEDIUMMedium
    LARGELarge
    Value
    NotSpecified
    Small
    Medium
    Large

    FontStyle

    Style of terminal font.

    NameValue
    NotSpecifiedNotSpecified
    MonospaceMonospace
    CourierCourier
    NameValue
    FontStyleNotSpecifiedNotSpecified
    FontStyleMonospaceMonospace
    FontStyleCourierCourier
    Value
    NotSpecified
    Monospace
    Courier
    NameValue
    NotSpecifiedNotSpecified
    MonospaceMonospace
    CourierCourier
    NameValue
    NotSpecifiedNotSpecified
    MonospaceMonospace
    CourierCourier
    NameValue
    NOT_SPECIFIEDNotSpecified
    MONOSPACEMonospace
    COURIERCourier
    Value
    NotSpecified
    Monospace
    Courier

    OsType

    The operating system type of the cloud shell. Deprecated, use preferredShellType.

    NameValue
    WindowsWindows
    LinuxLinux
    NameValue
    OsTypeWindowsWindows
    OsTypeLinuxLinux
    Value
    Windows
    Linux
    NameValue
    WindowsWindows
    LinuxLinux
    NameValue
    WindowsWindows
    LinuxLinux
    NameValue
    WINDOWSWindows
    LINUXLinux
    Value
    Windows
    Linux

    ShellType

    The shell type of the cloud shell.

    NameValue
    Bashbash
    Pwshpwsh
    Powershellpowershell
    NameValue
    ShellTypeBashbash
    ShellTypePwshpwsh
    ShellTypePowershellpowershell
    Value
    bash
    pwsh
    powershell
    NameValue
    Bashbash
    Pwshpwsh
    Powershellpowershell
    NameValue
    Bashbash
    Pwshpwsh
    Powershellpowershell
    NameValue
    BASHbash
    PWSHpwsh
    POWERSHELLpowershell
    Value
    bash
    pwsh
    powershell

    StorageProfile, StorageProfileArgs

    The storage profile of the user settings.

    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.
    disk_size_in_gb number
    Size of file share
    file_share_name string
    Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and -
    storage_account_resource_id 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.

    StorageProfileResponse

    The storage profile of the user settings.

    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.
    disk_size_in_gb number
    Size of file share
    file_share_name string
    Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and -
    storage_account_resource_id 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.

    TerminalSettings, TerminalSettingsArgs

    Settings for terminal appearance.

    FontSize string | Pulumi.AzureNative.Portal.FontSize
    Size of terminal font.
    FontStyle string | Pulumi.AzureNative.Portal.FontStyle
    Style of terminal font.
    FontSize string | FontSize
    Size of terminal font.
    FontStyle string | FontStyle
    Style of terminal font.
    fontSize String | FontSize
    Size of terminal font.
    fontStyle String | FontStyle
    Style of terminal font.
    fontSize string | FontSize
    Size of terminal font.
    fontStyle string | FontStyle
    Style of terminal font.
    font_size str | FontSize
    Size of terminal font.
    font_style str | FontStyle
    Style of terminal font.

    TerminalSettingsResponse

    Settings for terminal appearance.

    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 string
    Size of terminal font.
    font_style 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.

    UserProperties, UserPropertiesArgs

    The cloud shell user settings properties.

    PreferredLocation string
    The preferred location of the cloud shell.
    PreferredOsType string | Pulumi.AzureNative.Portal.OsType
    The operating system type of the cloud shell. Deprecated, use preferredShellType.
    PreferredShellType string | Pulumi.AzureNative.Portal.ShellType
    The shell type of the cloud shell.
    StorageProfile Pulumi.AzureNative.Portal.Inputs.StorageProfile
    The storage profile of the user settings.
    TerminalSettings Pulumi.AzureNative.Portal.Inputs.TerminalSettings
    Settings for terminal appearance.
    PreferredLocation string
    The preferred location of the cloud shell.
    PreferredOsType string | OsType
    The operating system type of the cloud shell. Deprecated, use preferredShellType.
    PreferredShellType string | ShellType
    The shell type of the cloud shell.
    StorageProfile StorageProfile
    The storage profile of the user settings.
    TerminalSettings TerminalSettings
    Settings for terminal appearance.
    preferred_location string
    The preferred location of the cloud shell.
    preferred_os_type string | "Windows" | "Linux"
    The operating system type of the cloud shell. Deprecated, use preferredShellType.
    preferred_shell_type string | "bash" | "pwsh" | "powershell"
    The shell type of the cloud shell.
    storage_profile object
    The storage profile of the user settings.
    terminal_settings object
    Settings for terminal appearance.
    preferredLocation String
    The preferred location of the cloud shell.
    preferredOsType String | OsType
    The operating system type of the cloud shell. Deprecated, use preferredShellType.
    preferredShellType String | ShellType
    The shell type of the cloud shell.
    storageProfile StorageProfile
    The storage profile of the user settings.
    terminalSettings TerminalSettings
    Settings for terminal appearance.
    preferredLocation string
    The preferred location of the cloud shell.
    preferredOsType string | OsType
    The operating system type of the cloud shell. Deprecated, use preferredShellType.
    preferredShellType string | ShellType
    The shell type of the cloud shell.
    storageProfile StorageProfile
    The storage profile of the user settings.
    terminalSettings TerminalSettings
    Settings for terminal appearance.
    preferred_location str
    The preferred location of the cloud shell.
    preferred_os_type str | OsType
    The operating system type of the cloud shell. Deprecated, use preferredShellType.
    preferred_shell_type str | ShellType
    The shell type of the cloud shell.
    storage_profile StorageProfile
    The storage profile of the user settings.
    terminal_settings TerminalSettings
    Settings for terminal appearance.
    preferredLocation String
    The preferred location of the cloud shell.
    preferredOsType String | "Windows" | "Linux"
    The operating system type of the cloud shell. Deprecated, use preferredShellType.
    preferredShellType String | "bash" | "pwsh" | "powershell"
    The shell type of the cloud shell.
    storageProfile Property Map
    The storage profile of the user settings.
    terminalSettings Property Map
    Settings for terminal appearance.

    UserPropertiesResponse

    The cloud shell user settings properties.

    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.
    preferred_location string
    The preferred location of the cloud shell.
    preferred_os_type string
    The operating system type of the cloud shell. Deprecated, use preferredShellType.
    preferred_shell_type string
    The shell type of the cloud shell.
    storage_profile object
    The storage profile of the user settings.
    terminal_settings object
    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.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:portal:UserSettings myresource1 /providers/Microsoft.Portal/userSettings/{userSettingsName} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo Azure Native
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Viewing docs for Azure Native v3.32.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial