1. Packages
  2. Azure Native
  3. API Docs
  4. portal
  5. UserSettingsWithLocation
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.9.0 published on Wednesday, Sep 27, 2023 by Pulumi

azure-native.portal.UserSettingsWithLocation

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.9.0 published on Wednesday, Sep 27, 2023 by Pulumi

    Response to get user settings Azure REST API version: 2018-10-01. Prior API version in Azure Native 1.x: 2018-10-01

    Example Usage

    PutUserSettings

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var userSettingsWithLocation = new AzureNative.Portal.UserSettingsWithLocation("userSettingsWithLocation", new()
        {
            Location = "eastus",
            Properties = new AzureNative.Portal.Inputs.UserPropertiesArgs
            {
                PreferredLocation = "eastus",
                PreferredOsType = "Linux",
                PreferredShellType = "bash",
                StorageProfile = new AzureNative.Portal.Inputs.StorageProfileArgs
                {
                    DiskSizeInGB = 5,
                    FileShareName = "string",
                    StorageAccountResourceId = "string",
                },
                TerminalSettings = new AzureNative.Portal.Inputs.TerminalSettingsArgs
                {
                    FontSize = "Medium",
                    FontStyle = "Monospace",
                },
            },
            UserSettingsName = "cloudconsole",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/portal/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := portal.NewUserSettingsWithLocation(ctx, "userSettingsWithLocation", &portal.UserSettingsWithLocationArgs{
    			Location: pulumi.String("eastus"),
    			Properties: portal.UserPropertiesResponse{
    				PreferredLocation:  pulumi.String("eastus"),
    				PreferredOsType:    pulumi.String("Linux"),
    				PreferredShellType: pulumi.String("bash"),
    				StorageProfile: &portal.StorageProfileArgs{
    					DiskSizeInGB:             pulumi.Int(5),
    					FileShareName:            pulumi.String("string"),
    					StorageAccountResourceId: pulumi.String("string"),
    				},
    				TerminalSettings: &portal.TerminalSettingsArgs{
    					FontSize:  pulumi.String("Medium"),
    					FontStyle: pulumi.String("Monospace"),
    				},
    			},
    			UserSettingsName: pulumi.String("cloudconsole"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.portal.UserSettingsWithLocation;
    import com.pulumi.azurenative.portal.UserSettingsWithLocationArgs;
    import java.util.List;
    import java.util.ArrayList;
    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 userSettingsWithLocation = new UserSettingsWithLocation("userSettingsWithLocation", UserSettingsWithLocationArgs.builder()        
                .location("eastus")
                .properties(Map.ofEntries(
                    Map.entry("preferredLocation", "eastus"),
                    Map.entry("preferredOsType", "Linux"),
                    Map.entry("preferredShellType", "bash"),
                    Map.entry("storageProfile", Map.ofEntries(
                        Map.entry("diskSizeInGB", 5),
                        Map.entry("fileShareName", "string"),
                        Map.entry("storageAccountResourceId", "string")
                    )),
                    Map.entry("terminalSettings", Map.ofEntries(
                        Map.entry("fontSize", "Medium"),
                        Map.entry("fontStyle", "Monospace")
                    ))
                ))
                .userSettingsName("cloudconsole")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    user_settings_with_location = azure_native.portal.UserSettingsWithLocation("userSettingsWithLocation",
        location="eastus",
        properties=azure_native.portal.UserPropertiesResponseArgs(
            preferred_location="eastus",
            preferred_os_type="Linux",
            preferred_shell_type="bash",
            storage_profile=azure_native.portal.StorageProfileArgs(
                disk_size_in_gb=5,
                file_share_name="string",
                storage_account_resource_id="string",
            ),
            terminal_settings=azure_native.portal.TerminalSettingsArgs(
                font_size="Medium",
                font_style="Monospace",
            ),
        ),
        user_settings_name="cloudconsole")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const userSettingsWithLocation = new azure_native.portal.UserSettingsWithLocation("userSettingsWithLocation", {
        location: "eastus",
        properties: {
            preferredLocation: "eastus",
            preferredOsType: "Linux",
            preferredShellType: "bash",
            storageProfile: {
                diskSizeInGB: 5,
                fileShareName: "string",
                storageAccountResourceId: "string",
            },
            terminalSettings: {
                fontSize: "Medium",
                fontStyle: "Monospace",
            },
        },
        userSettingsName: "cloudconsole",
    });
    
    resources:
      userSettingsWithLocation:
        type: azure-native:portal:UserSettingsWithLocation
        properties:
          location: eastus
          properties:
            preferredLocation: eastus
            preferredOsType: Linux
            preferredShellType: bash
            storageProfile:
              diskSizeInGB: 5
              fileShareName: string
              storageAccountResourceId: string
            terminalSettings:
              fontSize: Medium
              fontStyle: Monospace
          userSettingsName: cloudconsole
    

    Create UserSettingsWithLocation Resource

    new UserSettingsWithLocation(name: string, args: UserSettingsWithLocationArgs, opts?: CustomResourceOptions);
    @overload
    def UserSettingsWithLocation(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 location: Optional[str] = None,
                                 properties: Optional[UserPropertiesArgs] = None,
                                 user_settings_name: Optional[str] = None)
    @overload
    def UserSettingsWithLocation(resource_name: str,
                                 args: UserSettingsWithLocationArgs,
                                 opts: Optional[ResourceOptions] = None)
    func NewUserSettingsWithLocation(ctx *Context, name string, args UserSettingsWithLocationArgs, opts ...ResourceOption) (*UserSettingsWithLocation, error)
    public UserSettingsWithLocation(string name, UserSettingsWithLocationArgs args, CustomResourceOptions? opts = null)
    public UserSettingsWithLocation(String name, UserSettingsWithLocationArgs args)
    public UserSettingsWithLocation(String name, UserSettingsWithLocationArgs args, CustomResourceOptions options)
    
    type: azure-native:portal:UserSettingsWithLocation
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args UserSettingsWithLocationArgs
    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 UserSettingsWithLocationArgs
    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 UserSettingsWithLocationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserSettingsWithLocationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserSettingsWithLocationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    UserSettingsWithLocation Resource Properties

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

    Inputs

    The UserSettingsWithLocation resource accepts the following input properties:

    Location string

    The provider location

    Properties Pulumi.AzureNative.Portal.Inputs.UserProperties

    The cloud shell user settings properties.

    UserSettingsName string

    The name of the user settings

    Location string

    The provider location

    Properties UserPropertiesArgs

    The cloud shell user settings properties.

    UserSettingsName string

    The name of the user settings

    location String

    The provider location

    properties UserProperties

    The cloud shell user settings properties.

    userSettingsName String

    The name of the user settings

    location string

    The provider location

    properties UserProperties

    The cloud shell user settings properties.

    userSettingsName string

    The name of the user settings

    location str

    The provider location

    properties UserPropertiesArgs

    The cloud shell user settings properties.

    user_settings_name str

    The name of the user settings

    location String

    The provider location

    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 UserSettingsWithLocation resource produces the following output properties:

    Id string

    The provider-assigned unique ID for this managed resource.

    Id string

    The provider-assigned unique ID for this managed resource.

    id String

    The provider-assigned unique ID for this managed resource.

    id string

    The provider-assigned unique ID for this managed resource.

    id str

    The provider-assigned unique ID for this managed resource.

    id String

    The provider-assigned unique ID for this managed resource.

    Supporting Types

    FontSize, FontSizeArgs

    NotSpecified
    NotSpecified
    Small
    Small
    Medium
    Medium
    Large
    Large
    FontSizeNotSpecified
    NotSpecified
    FontSizeSmall
    Small
    FontSizeMedium
    Medium
    FontSizeLarge
    Large
    NotSpecified
    NotSpecified
    Small
    Small
    Medium
    Medium
    Large
    Large
    NotSpecified
    NotSpecified
    Small
    Small
    Medium
    Medium
    Large
    Large
    NOT_SPECIFIED
    NotSpecified
    SMALL
    Small
    MEDIUM
    Medium
    LARGE
    Large
    "NotSpecified"
    NotSpecified
    "Small"
    Small
    "Medium"
    Medium
    "Large"
    Large

    FontStyle, FontStyleArgs

    NotSpecified
    NotSpecified
    Monospace
    Monospace
    Courier
    Courier
    FontStyleNotSpecified
    NotSpecified
    FontStyleMonospace
    Monospace
    FontStyleCourier
    Courier
    NotSpecified
    NotSpecified
    Monospace
    Monospace
    Courier
    Courier
    NotSpecified
    NotSpecified
    Monospace
    Monospace
    Courier
    Courier
    NOT_SPECIFIED
    NotSpecified
    MONOSPACE
    Monospace
    COURIER
    Courier
    "NotSpecified"
    NotSpecified
    "Monospace"
    Monospace
    "Courier"
    Courier

    OsType, OsTypeArgs

    Windows
    Windows
    Linux
    Linux
    OsTypeWindows
    Windows
    OsTypeLinux
    Linux
    Windows
    Windows
    Linux
    Linux
    Windows
    Windows
    Linux
    Linux
    WINDOWS
    Windows
    LINUX
    Linux
    "Windows"
    Windows
    "Linux"
    Linux

    ShellType, ShellTypeArgs

    Bash
    bash
    Pwsh
    pwsh
    Powershell
    powershell
    ShellTypeBash
    bash
    ShellTypePwsh
    pwsh
    ShellTypePowershell
    powershell
    Bash
    bash
    Pwsh
    pwsh
    Powershell
    powershell
    Bash
    bash
    Pwsh
    pwsh
    Powershell
    powershell
    BASH
    bash
    PWSH
    pwsh
    POWERSHELL
    powershell
    "bash"
    bash
    "pwsh"
    pwsh
    "powershell"
    powershell

    StorageProfile, StorageProfileArgs

    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.

    StorageProfileResponse, StorageProfileResponseArgs

    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.

    TerminalSettings, TerminalSettingsArgs

    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, TerminalSettingsResponseArgs

    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.

    UserProperties, UserPropertiesArgs

    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.

    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, UserPropertiesResponseArgs

    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.

    Import

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

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.9.0 published on Wednesday, Sep 27, 2023 by Pulumi