Microsoft.Portal userSettings

Bicep resource definition

The userSettings resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Portal/userSettings resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Portal/userSettings@2018-10-01' = {
  name: 'string'
  properties: {
    preferredLocation: 'string'
    preferredOsType: 'string'
    preferredShellType: 'string'
    storageProfile: {
      diskSizeInGB: int
      fileShareName: 'string'
      storageAccountResourceId: 'string'
    }
    terminalSettings: {
      fontSize: 'string'
      fontStyle: 'string'
    }
  }
}

Property Values

Microsoft.Portal/userSettings

Name Description Value
name The resource name string (required)
properties The cloud shell user settings properties. UserProperties (required)

StorageProfile

Name Description Value
diskSizeInGB Size of file share int
fileShareName Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and - string
storageAccountResourceId Full resource ID of storage account. string

TerminalSettings

Name Description Value
fontSize Size of terminal font. 'Large'
'Medium'
'NotSpecified'
'Small'
fontStyle Style of terminal font. 'Courier'
'Monospace'
'NotSpecified'

UserProperties

Name Description Value
preferredLocation The preferred location of the cloud shell. string (required)
preferredOsType The operating system type of the cloud shell. Deprecated, use preferredShellType. 'Linux'
'Windows' (required)
preferredShellType The shell type of the cloud shell. 'bash'
'powershell'
'pwsh' (required)
storageProfile The storage profile of the user settings. StorageProfile (required)
terminalSettings Settings for terminal appearance. TerminalSettings (required)

ARM template resource definition

The userSettings resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Portal/userSettings resource, add the following JSON to your template.

{
  "type": "Microsoft.Portal/userSettings",
  "apiVersion": "2018-10-01",
  "name": "string",
  "properties": {
    "preferredLocation": "string",
    "preferredOsType": "string",
    "preferredShellType": "string",
    "storageProfile": {
      "diskSizeInGB": "int",
      "fileShareName": "string",
      "storageAccountResourceId": "string"
    },
    "terminalSettings": {
      "fontSize": "string",
      "fontStyle": "string"
    }
  }
}

Property Values

Microsoft.Portal/userSettings

Name Description Value
apiVersion The api version '2018-10-01'
name The resource name string (required)
properties The cloud shell user settings properties. UserProperties (required)
type The resource type 'Microsoft.Portal/userSettings'

StorageProfile

Name Description Value
diskSizeInGB Size of file share int
fileShareName Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and - string
storageAccountResourceId Full resource ID of storage account. string

TerminalSettings

Name Description Value
fontSize Size of terminal font. 'Large'
'Medium'
'NotSpecified'
'Small'
fontStyle Style of terminal font. 'Courier'
'Monospace'
'NotSpecified'

UserProperties

Name Description Value
preferredLocation The preferred location of the cloud shell. string (required)
preferredOsType The operating system type of the cloud shell. Deprecated, use preferredShellType. 'Linux'
'Windows' (required)
preferredShellType The shell type of the cloud shell. 'bash'
'powershell'
'pwsh' (required)
storageProfile The storage profile of the user settings. StorageProfile (required)
terminalSettings Settings for terminal appearance. TerminalSettings (required)

Usage Examples

Terraform (AzAPI provider) resource definition

The userSettings resource type can be deployed with operations that target:

  • Tenant

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Portal/userSettings resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Portal/userSettings@2018-10-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      preferredLocation = "string"
      preferredOsType = "string"
      preferredShellType = "string"
      storageProfile = {
        diskSizeInGB = int
        fileShareName = "string"
        storageAccountResourceId = "string"
      }
      terminalSettings = {
        fontSize = "string"
        fontStyle = "string"
      }
    }
  }
}

Property Values

Microsoft.Portal/userSettings

Name Description Value
name The resource name string (required)
properties The cloud shell user settings properties. UserProperties (required)
type The resource type "Microsoft.Portal/userSettings@2018-10-01"

StorageProfile

Name Description Value
diskSizeInGB Size of file share int
fileShareName Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and - string
storageAccountResourceId Full resource ID of storage account. string

TerminalSettings

Name Description Value
fontSize Size of terminal font. 'Large'
'Medium'
'NotSpecified'
'Small'
fontStyle Style of terminal font. 'Courier'
'Monospace'
'NotSpecified'

UserProperties

Name Description Value
preferredLocation The preferred location of the cloud shell. string (required)
preferredOsType The operating system type of the cloud shell. Deprecated, use preferredShellType. 'Linux'
'Windows' (required)
preferredShellType The shell type of the cloud shell. 'bash'
'powershell'
'pwsh' (required)
storageProfile The storage profile of the user settings. StorageProfile (required)
terminalSettings Settings for terminal appearance. TerminalSettings (required)
  • Last updated on