azure-native-v2.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.
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
This property is required. string - The unique name of the resource.
- args
This property is required. UserSettingsWithLocationArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. 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
This property is required. string - The unique name of the resource.
- args
This property is required. UserSettingsWithLocationArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. UserSettingsWithLocationArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. 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 =
{
{ "preferredLocation", "string" },
{ "preferredOsType", "string" },
{ "preferredShellType", "string" },
{ "storageProfile",
{
{ "diskSizeInGB", 0 },
{ "fileShareName", "string" },
{ "storageAccountResourceId", "string" },
} },
{ "terminalSettings",
{
{ "fontSize", "string" },
{ "fontStyle", "string" },
} },
},
UserSettingsName = "string",
});
example, err := portal.NewUserSettingsWithLocation(ctx, "userSettingsWithLocationResource", &portal.UserSettingsWithLocationArgs{
Location: "string",
Properties: map[string]interface{}{
"preferredLocation": "string",
"preferredOsType": "string",
"preferredShellType": "string",
"storageProfile": map[string]interface{}{
"diskSizeInGB": 0,
"fileShareName": "string",
"storageAccountResourceId": "string",
},
"terminalSettings": map[string]interface{}{
"fontSize": "string",
"fontStyle": "string",
},
},
UserSettingsName: "string",
})
var userSettingsWithLocationResource = new UserSettingsWithLocation("userSettingsWithLocationResource", UserSettingsWithLocationArgs.builder()
.location("string")
.properties(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The UserSettingsWithLocation resource accepts the following input properties:
- Location
This property is required. Changes to this property will trigger replacement.
- The provider location
- Properties
This property is required. Pulumi.Azure Native. Portal. Inputs. User Properties - The cloud shell user settings properties.
- User
Settings Name Changes to this property will trigger replacement.
- The name of the user settings
- Location
This property is required. Changes to this property will trigger replacement.
- The provider location
- Properties
This property is required. UserProperties Args - The cloud shell user settings properties.
- User
Settings Name Changes to this property will trigger replacement.
- The name of the user settings
- location
This property is required. Changes to this property will trigger replacement.
- The provider location
- properties
This property is required. UserProperties - The cloud shell user settings properties.
- user
Settings Name Changes to this property will trigger replacement.
- The name of the user settings
- location
This property is required. Changes to this property will trigger replacement.
- The provider location
- properties
This property is required. UserProperties - The cloud shell user settings properties.
- user
Settings Name Changes to this property will trigger replacement.
- The name of the user settings
- location
This property is required. Changes to this property will trigger replacement.
- The provider location
- properties
This property is required. UserProperties Args - The cloud shell user settings properties.
- user_
settings_ name Changes to this property will trigger replacement.
- The name of the user settings
- location
This property is required. Changes to this property will trigger replacement.
- The provider location
- properties
This property is required. Property Map - The cloud shell user settings properties.
- user
Settings Name Changes to this property will trigger replacement.
- 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 This property is required. string - The preferred location of the cloud shell.
- Preferred
Os Type This property is required. string | Pulumi.Azure Native. Portal. Os Type - The operating system type of the cloud shell. Deprecated, use preferredShellType.
- Preferred
Shell Type This property is required. string | Pulumi.Azure Native. Portal. Shell Type - The shell type of the cloud shell.
- Storage
Profile This property is required. Pulumi.Azure Native. Portal. Inputs. Storage Profile - The storage profile of the user settings.
- Terminal
Settings This property is required. Pulumi.Azure Native. Portal. Inputs. Terminal Settings - Settings for terminal appearance.
- Preferred
Location This property is required. string - The preferred location of the cloud shell.
- Preferred
Os Type This property is required. string | OsType - The operating system type of the cloud shell. Deprecated, use preferredShellType.
- Preferred
Shell Type This property is required. string | ShellType - The shell type of the cloud shell.
- Storage
Profile This property is required. StorageProfile - The storage profile of the user settings.
- Terminal
Settings This property is required. TerminalSettings - Settings for terminal appearance.
- preferred
Location This property is required. String - The preferred location of the cloud shell.
- preferred
Os Type This property is required. String | OsType - The operating system type of the cloud shell. Deprecated, use preferredShellType.
- preferred
Shell Type This property is required. String | ShellType - The shell type of the cloud shell.
- storage
Profile This property is required. StorageProfile - The storage profile of the user settings.
- terminal
Settings This property is required. TerminalSettings - Settings for terminal appearance.
- preferred
Location This property is required. string - The preferred location of the cloud shell.
- preferred
Os Type This property is required. string | OsType - The operating system type of the cloud shell. Deprecated, use preferredShellType.
- preferred
Shell Type This property is required. string | ShellType - The shell type of the cloud shell.
- storage
Profile This property is required. StorageProfile - The storage profile of the user settings.
- terminal
Settings This property is required. TerminalSettings - 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 | OsType - The operating system type of the cloud shell. Deprecated, use preferredShellType.
- preferred_
shell_ type This property is required. str | ShellType - The shell type of the cloud shell.
- storage_
profile This property is required. StorageProfile - The storage profile of the user settings.
- terminal_
settings This property is required. TerminalSettings - Settings for terminal appearance.
- preferred
Location This property is required. String - The preferred location of the cloud shell.
- preferred
Os Type This property is required. String | "Windows" | "Linux" - The operating system type of the cloud shell. Deprecated, use preferredShellType.
- preferred
Shell Type This property is required. String | "bash" | "pwsh" | "powershell" - The shell type of the cloud shell.
- storage
Profile This property is required. Property Map - The storage profile of the user settings.
- terminal
Settings This property is required. Property Map - Settings for terminal appearance.
UserPropertiesResponse, UserPropertiesResponseArgs
- Preferred
Location This property is required. string - The preferred location of the cloud shell.
- Preferred
Os Type This property is required. string - The operating system type of the cloud shell. Deprecated, use preferredShellType.
- Preferred
Shell Type This property is required. string - The shell type of the cloud shell.
- Storage
Profile This property is required. Pulumi.Azure Native. Portal. Inputs. Storage Profile Response - The storage profile of the user settings.
- Terminal
Settings This property is required. Pulumi.Azure Native. Portal. Inputs. Terminal Settings Response - Settings for terminal appearance.
- Preferred
Location This property is required. string - The preferred location of the cloud shell.
- Preferred
Os Type This property is required. string - The operating system type of the cloud shell. Deprecated, use preferredShellType.
- Preferred
Shell Type This property is required. string - The shell type of the cloud shell.
- Storage
Profile This property is required. StorageProfile Response - The storage profile of the user settings.
- Terminal
Settings This property is required. TerminalSettings Response - Settings for terminal appearance.
- preferred
Location This property is required. String - The preferred location of the cloud shell.
- preferred
Os Type This property is required. String - The operating system type of the cloud shell. Deprecated, use preferredShellType.
- preferred
Shell Type This property is required. String - The shell type of the cloud shell.
- storage
Profile This property is required. StorageProfile Response - The storage profile of the user settings.
- terminal
Settings This property is required. TerminalSettings Response - Settings for terminal appearance.
- preferred
Location This property is required. string - The preferred location of the cloud shell.
- preferred
Os Type This property is required. string - The operating system type of the cloud shell. Deprecated, use preferredShellType.
- preferred
Shell Type This property is required. string - The shell type of the cloud shell.
- storage
Profile This property is required. StorageProfile Response - The storage profile of the user settings.
- terminal
Settings This property is required. TerminalSettings Response - 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. StorageProfile Response - The storage profile of the user settings.
- terminal_
settings This property is required. TerminalSettings Response - Settings for terminal appearance.
- preferred
Location This property is required. String - The preferred location of the cloud shell.
- preferred
Os Type This property is required. String - The operating system type of the cloud shell. Deprecated, use preferredShellType.
- preferred
Shell Type This property is required. String - The shell type of the cloud shell.
- storage
Profile This property is required. Property Map - The storage profile of the user settings.
- terminal
Settings This property is required. 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-v2 pulumi/pulumi-azure-native
- License
- Apache-2.0