azure-native.portal.UserSettingsWithLocation
Explore with Pulumi AI
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 = 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/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.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
})
}
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 com.pulumi.azurenative.portal.inputs.UserPropertiesArgs;
import com.pulumi.azurenative.portal.inputs.StorageProfileArgs;
import com.pulumi.azurenative.portal.inputs.TerminalSettingsArgs;
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(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 pulumi
import pulumi_azure_native as azure_native
user_settings_with_location = azure_native.portal.UserSettingsWithLocation("userSettingsWithLocation",
location="eastus",
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")
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: 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",
});
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
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new UserSettingsWithLocation(name: string, args: UserSettingsWithLocationArgs, opts?: CustomResourceOptions);
@overload
def UserSettingsWithLocation(resource_name: str,
args: UserSettingsWithLocationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def UserSettingsWithLocation(resource_name: str,
opts: Optional[ResourceOptions] = None,
location: Optional[str] = None,
properties: Optional[UserPropertiesArgs] = None,
user_settings_name: Optional[str] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var userSettingsWithLocationResource = new AzureNative.Portal.UserSettingsWithLocation("userSettingsWithLocationResource", new()
{
Location = "string",
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.NewUserSettingsWithLocation(ctx, "userSettingsWithLocationResource", &portal.UserSettingsWithLocationArgs{
Location: pulumi.String("string"),
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"),
})
var userSettingsWithLocationResource = new UserSettingsWithLocation("userSettingsWithLocationResource", UserSettingsWithLocationArgs.builder()
.location("string")
.properties(UserPropertiesArgs.builder()
.preferredLocation("string")
.preferredOsType("string")
.preferredShellType("string")
.storageProfile(StorageProfileArgs.builder()
.diskSizeInGB(0)
.fileShareName("string")
.storageAccountResourceId("string")
.build())
.terminalSettings(TerminalSettingsArgs.builder()
.fontSize("string")
.fontStyle("string")
.build())
.build())
.userSettingsName("string")
.build());
user_settings_with_location_resource = azure_native.portal.UserSettingsWithLocation("userSettingsWithLocationResource",
location="string",
properties={
"preferredLocation": "string",
"preferredOsType": "string",
"preferredShellType": "string",
"storageProfile": {
"diskSizeInGB": 0,
"fileShareName": "string",
"storageAccountResourceId": "string",
},
"terminalSettings": {
"fontSize": "string",
"fontStyle": "string",
},
},
user_settings_name="string")
const userSettingsWithLocationResource = new azure_native.portal.UserSettingsWithLocation("userSettingsWithLocationResource", {
location: "string",
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:UserSettingsWithLocation
properties:
location: string
properties:
preferredLocation: string
preferredOsType: string
preferredShellType: string
storageProfile:
diskSizeInGB: 0
fileShareName: string
storageAccountResourceId: string
terminalSettings:
fontSize: string
fontStyle: string
userSettingsName: string
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.
Azure Native. Portal. Inputs. User Properties - The cloud shell user settings properties.
- User
Settings stringName - The name of the user settings
- Location string
- The provider location
- Properties
User
Properties Args - The cloud shell user settings properties.
- User
Settings stringName - The name of the user settings
- location String
- The provider location
- properties
User
Properties - The cloud shell user settings properties.
- user
Settings StringName - The name of the user settings
- location string
- The provider location
- properties
User
Properties - The cloud shell user settings properties.
- user
Settings stringName - The name of the user settings
- location str
- The provider location
- properties
User
Properties Args - The cloud shell user settings properties.
- user_
settings_ strname - The name of the user settings
- location String
- The provider location
- properties Property Map
- The cloud shell user settings properties.
- user
Settings StringName - 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
- Not
Specified - NotSpecified
- Small
- Small
- Medium
- Medium
- Large
- Large
- Font
Size Not Specified - NotSpecified
- Font
Size Small - Small
- Font
Size Medium - Medium
- Font
Size Large - Large
- Not
Specified - NotSpecified
- Small
- Small
- Medium
- Medium
- Large
- Large
- Not
Specified - NotSpecified
- Small
- Small
- Medium
- Medium
- Large
- Large
- NOT_SPECIFIED
- NotSpecified
- SMALL
- Small
- MEDIUM
- Medium
- LARGE
- Large
- "Not
Specified" - NotSpecified
- "Small"
- Small
- "Medium"
- Medium
- "Large"
- Large
FontStyle, FontStyleArgs
- Not
Specified - NotSpecified
- Monospace
- Monospace
- Courier
- Courier
- Font
Style Not Specified - NotSpecified
- Font
Style Monospace - Monospace
- Font
Style Courier - Courier
- Not
Specified - NotSpecified
- Monospace
- Monospace
- Courier
- Courier
- Not
Specified - NotSpecified
- Monospace
- Monospace
- Courier
- Courier
- NOT_SPECIFIED
- NotSpecified
- MONOSPACE
- Monospace
- COURIER
- Courier
- "Not
Specified" - NotSpecified
- "Monospace"
- Monospace
- "Courier"
- Courier
OsType, OsTypeArgs
- Windows
- Windows
- Linux
- Linux
- Os
Type Windows - Windows
- Os
Type Linux - 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
- Shell
Type Bash - bash
- Shell
Type Pwsh - pwsh
- Shell
Type Powershell - 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
- Disk
Size intIn GB - Size of file share
- string
- Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and -
- Storage
Account stringResource Id - Full resource ID of storage account.
- Disk
Size intIn GB - Size of file share
- string
- Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and -
- Storage
Account stringResource Id - Full resource ID of storage account.
- disk
Size IntegerIn GB - Size of file share
- String
- Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and -
- storage
Account StringResource Id - Full resource ID of storage account.
- disk
Size numberIn GB - Size of file share
- string
- Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and -
- storage
Account stringResource Id - Full resource ID of storage account.
- disk_
size_ intin_ gb - Size of file share
- str
- Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and -
- storage_
account_ strresource_ id - Full resource ID of storage account.
- disk
Size NumberIn GB - Size of file share
- String
- Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and -
- storage
Account StringResource Id - Full resource ID of storage account.
StorageProfileResponse, StorageProfileResponseArgs
- Disk
Size intIn GB - Size of file share
- string
- Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and -
- Storage
Account stringResource Id - Full resource ID of storage account.
- Disk
Size intIn GB - Size of file share
- string
- Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and -
- Storage
Account stringResource Id - Full resource ID of storage account.
- disk
Size IntegerIn GB - Size of file share
- String
- Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and -
- storage
Account StringResource Id - Full resource ID of storage account.
- disk
Size numberIn GB - Size of file share
- string
- Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and -
- storage
Account stringResource Id - Full resource ID of storage account.
- disk_
size_ intin_ gb - Size of file share
- str
- Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and -
- storage_
account_ strresource_ id - Full resource ID of storage account.
- disk
Size NumberIn GB - Size of file share
- String
- Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and -
- storage
Account StringResource Id - Full resource ID of storage account.
TerminalSettings, TerminalSettingsArgs
- Font
Size string | Pulumi.Azure Native. Portal. Font Size - Size of terminal font.
- Font
Style string | Pulumi.Azure Native. Portal. Font Style - Style of terminal font.
- font_
size str | FontSize - Size of terminal font.
- font_
style str | FontStyle - Style of terminal font.
- font
Size String | "NotSpecified" | "Small" | "Medium" | "Large" - Size of terminal font.
- font
Style String | "NotSpecified" | "Monospace" | "Courier" - Style of terminal font.
TerminalSettingsResponse, TerminalSettingsResponseArgs
- font_
size str - Size of terminal font.
- font_
style str - Style of terminal font.
UserProperties, UserPropertiesArgs
- Preferred
Location string - The preferred location of the cloud shell.
- Preferred
Os string | Pulumi.Type Azure Native. Portal. Os Type - The operating system type of the cloud shell. Deprecated, use preferredShellType.
- Preferred
Shell string | Pulumi.Type Azure Native. Portal. Shell Type - The shell type of the cloud shell.
- Storage
Profile Pulumi.Azure Native. Portal. Inputs. Storage Profile - The storage profile of the user settings.
- Terminal
Settings Pulumi.Azure Native. Portal. Inputs. Terminal Settings - Settings for terminal appearance.
- Preferred
Location string - The preferred location of the cloud shell.
- Preferred
Os string | OsType Type - The operating system type of the cloud shell. Deprecated, use preferredShellType.
- Preferred
Shell string | ShellType Type - The shell type of the cloud shell.
- Storage
Profile StorageProfile - The storage profile of the user settings.
- Terminal
Settings TerminalSettings - Settings for terminal appearance.
- preferred
Location String - The preferred location of the cloud shell.
- preferred
Os String | OsType Type - The operating system type of the cloud shell. Deprecated, use preferredShellType.
- preferred
Shell String | ShellType Type - The shell type of the cloud shell.
- storage
Profile StorageProfile - The storage profile of the user settings.
- terminal
Settings TerminalSettings - Settings for terminal appearance.
- preferred
Location string - The preferred location of the cloud shell.
- preferred
Os string | OsType Type - The operating system type of the cloud shell. Deprecated, use preferredShellType.
- preferred
Shell string | ShellType Type - The shell type of the cloud shell.
- storage
Profile StorageProfile - The storage profile of the user settings.
- terminal
Settings TerminalSettings - Settings for terminal appearance.
- preferred_
location str - The preferred location of the cloud shell.
- preferred_
os_ str | Ostype Type - The operating system type of the cloud shell. Deprecated, use preferredShellType.
- preferred_
shell_ str | Shelltype Type - The shell type of the cloud shell.
- storage_
profile StorageProfile - The storage profile of the user settings.
- terminal_
settings TerminalSettings - Settings for terminal appearance.
- preferred
Location String - The preferred location of the cloud shell.
- preferred
Os String | "Windows" | "Linux"Type - The operating system type of the cloud shell. Deprecated, use preferredShellType.
- preferred
Shell String | "bash" | "pwsh" | "powershell"Type - The shell type of the cloud shell.
- storage
Profile Property Map - The storage profile of the user settings.
- terminal
Settings Property Map - Settings for terminal appearance.
UserPropertiesResponse, UserPropertiesResponseArgs
- Preferred
Location string - The preferred location of the cloud shell.
- Preferred
Os stringType - The operating system type of the cloud shell. Deprecated, use preferredShellType.
- Preferred
Shell stringType - The shell type of the cloud shell.
- Storage
Profile Pulumi.Azure Native. Portal. Inputs. Storage Profile Response - The storage profile of the user settings.
- Terminal
Settings Pulumi.Azure Native. Portal. Inputs. Terminal Settings Response - Settings for terminal appearance.
- Preferred
Location string - The preferred location of the cloud shell.
- Preferred
Os stringType - The operating system type of the cloud shell. Deprecated, use preferredShellType.
- Preferred
Shell stringType - The shell type of the cloud shell.
- Storage
Profile StorageProfile Response - The storage profile of the user settings.
- Terminal
Settings TerminalSettings Response - Settings for terminal appearance.
- preferred
Location String - The preferred location of the cloud shell.
- preferred
Os StringType - The operating system type of the cloud shell. Deprecated, use preferredShellType.
- preferred
Shell StringType - The shell type of the cloud shell.
- storage
Profile StorageProfile Response - The storage profile of the user settings.
- terminal
Settings TerminalSettings Response - Settings for terminal appearance.
- preferred
Location string - The preferred location of the cloud shell.
- preferred
Os stringType - The operating system type of the cloud shell. Deprecated, use preferredShellType.
- preferred
Shell stringType - The shell type of the cloud shell.
- storage
Profile StorageProfile Response - The storage profile of the user settings.
- terminal
Settings TerminalSettings Response - Settings for terminal appearance.
- preferred_
location str - The preferred location of the cloud shell.
- preferred_
os_ strtype - The operating system type of the cloud shell. Deprecated, use preferredShellType.
- preferred_
shell_ strtype - The shell type of the cloud shell.
- storage_
profile StorageProfile Response - The storage profile of the user settings.
- terminal_
settings TerminalSettings Response - Settings for terminal appearance.
- preferred
Location String - The preferred location of the cloud shell.
- preferred
Os StringType - The operating system type of the cloud shell. Deprecated, use preferredShellType.
- preferred
Shell StringType - The shell type of the cloud shell.
- storage
Profile Property Map - The storage profile of the user settings.
- terminal
Settings 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}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0