Microsoft.Portal (stable:2018-10-01)

2025/09/26 • 16 new, 16 deleted methods

getUserSettingsWithLocation (new)
Description :  Get current user settings for current signed in user. This operation returns settings for the user's cloud shell preferences including preferred location, storage profile, shell type, font and size settings.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Portal/locations/{location}/userSettings/{userSettingsName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
userSettingsName:
{
Description: The name of the user settings ,
Required: True ,
}
string ,
location:
{
Description: The provider location ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-console-required-location-code:
{
Description: normalized required location code ,
}
string ,
x-ms-console-preview-user:
{
Description: indicates whether user is a previous usr. ,
}
boolean ,
}
,
$schema:
{
Description: Response to get user settings ,
}
{
properties:
{
Description: The cloud shell user settings properties. ,
Required: True ,
}
{
preferredOsType:
{
Description: The operating system type of the cloud shell. Deprecated, use preferredShellType. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
preferredLocation:
{
Description: The preferred location of the cloud shell. ,
Required: True ,
}
string ,
storageProfile:
{
Description: The storage profile of the user settings. ,
Required: True ,
}
{
storageAccountResourceId:
{
Description: Full resource ID of storage account. ,
Required: False ,
}
string ,
fileShareName:
{
Description: Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and - ,
Required: False ,
}
string ,
diskSizeInGB:
{
Description: Size of file share ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
terminalSettings:
{
Description: Settings for terminal appearance. ,
Required: True ,
}
{
fontSize:
{
Description: Size of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
Required: False ,
}
enum ,
fontStyle:
{
Description: Style of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Monospace: No description available. ,
Courier: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
preferredShellType:
{
Description: The shell type of the cloud shell. ,
Enum:
{
bash: No description available. ,
pwsh: No description available. ,
powershell: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
patchUserSettingsWithLocation (new)
Description :  Patch cloud shell settings for current signed in user
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Portal/locations/{location}/userSettings/{userSettingsName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
userSettingsName:
{
Description: The name of the user settings ,
Required: True ,
}
string ,
location:
{
Description: The provider location ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the user settings to be updated. ,
Required: True ,
}
{
properties:
{
Description: The cloud shell user settings properties. ,
Required: False ,
}
{
preferredOsType:
{
Description: The operating system type of the cloud shell. Deprecated, use preferredShellType. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
preferredLocation:
{
Description: The preferred location of the cloud shell. ,
Required: True ,
}
string ,
storageProfile:
{
Description: The storage profile of the user settings. ,
Required: True ,
}
{
storageAccountResourceId:
{
Description: Full resource ID of storage account. ,
Required: False ,
}
string ,
fileShareName:
{
Description: Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and - ,
Required: False ,
}
string ,
diskSizeInGB:
{
Description: Size of file share ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
terminalSettings:
{
Description: Settings for terminal appearance. ,
Required: True ,
}
{
fontSize:
{
Description: Size of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
Required: False ,
}
enum ,
fontStyle:
{
Description: Style of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Monospace: No description available. ,
Courier: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
preferredShellType:
{
Description: The shell type of the cloud shell. ,
Enum:
{
bash: No description available. ,
pwsh: No description available. ,
powershell: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The cloud shell user settings properties. ,
Required: True ,
}
{
preferredOsType:
{
Description: The operating system type of the cloud shell. Deprecated, use preferredShellType. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
preferredLocation:
{
Description: The preferred location of the cloud shell. ,
Required: True ,
}
string ,
storageProfile:
{
Description: The storage profile of the user settings. ,
Required: True ,
}
{
storageAccountResourceId:
{
Description: Full resource ID of storage account. ,
Required: False ,
}
string ,
fileShareName:
{
Description: Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and - ,
Required: False ,
}
string ,
diskSizeInGB:
{
Description: Size of file share ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
terminalSettings:
{
Description: Settings for terminal appearance. ,
Required: True ,
}
{
fontSize:
{
Description: Size of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
Required: False ,
}
enum ,
fontStyle:
{
Description: Style of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Monospace: No description available. ,
Courier: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
preferredShellType:
{
Description: The shell type of the cloud shell. ,
Enum:
{
bash: No description available. ,
pwsh: No description available. ,
powershell: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
deleteUserSettingsWithLocation (new)
Description :  Delete cloud shell settings for current signed in user
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Portal/locations/{location}/userSettings/{userSettingsName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
userSettingsName:
{
Description: The name of the user settings ,
Required: True ,
}
string ,
location:
{
Description: The provider location ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
putUserSettingsWithLocation (new)
Description :  Create or update cloud shell settings for current signed in user
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Portal/locations/{location}/userSettings/{userSettingsName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
userSettingsName:
{
Description: The name of the user settings ,
Required: True ,
}
string ,
location:
{
Description: The provider location ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the user settings to be created or updated. ,
Required: True ,
}
{
properties:
{
Description: The cloud shell user settings properties. ,
Required: True ,
}
{
preferredOsType:
{
Description: The operating system type of the cloud shell. Deprecated, use preferredShellType. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
preferredLocation:
{
Description: The preferred location of the cloud shell. ,
Required: True ,
}
string ,
storageProfile:
{
Description: The storage profile of the user settings. ,
Required: True ,
}
{
storageAccountResourceId:
{
Description: Full resource ID of storage account. ,
Required: False ,
}
string ,
fileShareName:
{
Description: Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and - ,
Required: False ,
}
string ,
diskSizeInGB:
{
Description: Size of file share ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
terminalSettings:
{
Description: Settings for terminal appearance. ,
Required: True ,
}
{
fontSize:
{
Description: Size of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
Required: False ,
}
enum ,
fontStyle:
{
Description: Style of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Monospace: No description available. ,
Courier: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
preferredShellType:
{
Description: The shell type of the cloud shell. ,
Enum:
{
bash: No description available. ,
pwsh: No description available. ,
powershell: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The cloud shell user settings properties. ,
Required: True ,
}
{
preferredOsType:
{
Description: The operating system type of the cloud shell. Deprecated, use preferredShellType. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
preferredLocation:
{
Description: The preferred location of the cloud shell. ,
Required: True ,
}
string ,
storageProfile:
{
Description: The storage profile of the user settings. ,
Required: True ,
}
{
storageAccountResourceId:
{
Description: Full resource ID of storage account. ,
Required: False ,
}
string ,
fileShareName:
{
Description: Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and - ,
Required: False ,
}
string ,
diskSizeInGB:
{
Description: Size of file share ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
terminalSettings:
{
Description: Settings for terminal appearance. ,
Required: True ,
}
{
fontSize:
{
Description: Size of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
Required: False ,
}
enum ,
fontStyle:
{
Description: Style of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Monospace: No description available. ,
Courier: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
preferredShellType:
{
Description: The shell type of the cloud shell. ,
Enum:
{
bash: No description available. ,
pwsh: No description available. ,
powershell: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
getConsoleWithLocation (new)
Description :  Gets the console for the user.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Portal/locations/{location}/consoles/{consoleName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
consoleName:
{
Description: The name of the console ,
Required: True ,
}
string ,
location:
{
Description: The provider location ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Cloud shell console properties. ,
Required: True ,
}
{
osType:
{
Description: The operating system type of the cloud shell. ,
Enum:
{
Linux: No description available. ,
Windows: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the console. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Pending: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Repairing: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: Uri of the console. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
putConsoleWithLocation (new)
Description :  Puts a request for a console
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Portal/locations/{location}/consoles/{consoleName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
consoleName:
{
Description: The name of the console ,
Required: True ,
}
string ,
location:
{
Description: The provider location ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Cloud shell console properties. ,
Required: True ,
}
{
osType:
{
Description: The operating system type of the cloud shell. ,
Enum:
{
Linux: No description available. ,
Windows: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the console. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Pending: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Repairing: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: Uri of the console. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Cloud shell console properties. ,
Required: True ,
}
{
osType:
{
Description: The operating system type of the cloud shell. ,
Enum:
{
Linux: No description available. ,
Windows: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the console. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Pending: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Repairing: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: Uri of the console. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
deleteConsoleWithLocation (new)
Description :  Deletes the console
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Portal/locations/{location}/consoles/{consoleName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
consoleName:
{
Description: The name of the console ,
Required: True ,
}
string ,
location:
{
Description: The provider location ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
keepAliveWithLocation (new)
Description :  Keep console alive
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Portal/locations/{location}/consoles/{consoleName}/keepAlive
{
consoleName:
{
Description: The name of the console ,
Required: True ,
}
string ,
location:
{
Description: The provider location ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
x-ms-console-remaining-seconds:
{
Description: Remaining time left in session, in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
GetUserSettings (new)
Description :  Get current user settings for current signed in user. This operation returns settings for the user's cloud shell preferences including preferred location, storage profile, shell type, font and size settings.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Portal/userSettings/{userSettingsName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
userSettingsName:
{
Description: The name of the user settings ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-console-required-location-code:
{
Description: normalized required location code ,
}
string ,
x-ms-console-preview-user:
{
Description: indicates whether user is a previous usr. ,
}
boolean ,
}
,
$schema:
{
Description: Response to get user settings ,
}
{
properties:
{
Description: The cloud shell user settings properties. ,
Required: True ,
}
{
preferredOsType:
{
Description: The operating system type of the cloud shell. Deprecated, use preferredShellType. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
preferredLocation:
{
Description: The preferred location of the cloud shell. ,
Required: True ,
}
string ,
storageProfile:
{
Description: The storage profile of the user settings. ,
Required: True ,
}
{
storageAccountResourceId:
{
Description: Full resource ID of storage account. ,
Required: False ,
}
string ,
fileShareName:
{
Description: Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and - ,
Required: False ,
}
string ,
diskSizeInGB:
{
Description: Size of file share ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
terminalSettings:
{
Description: Settings for terminal appearance. ,
Required: True ,
}
{
fontSize:
{
Description: Size of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
Required: False ,
}
enum ,
fontStyle:
{
Description: Style of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Monospace: No description available. ,
Courier: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
preferredShellType:
{
Description: The shell type of the cloud shell. ,
Enum:
{
bash: No description available. ,
pwsh: No description available. ,
powershell: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
PatchUserSettings (new)
Description :  Patch cloud shell settings for current signed in user
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Portal/userSettings/{userSettingsName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
userSettingsName:
{
Description: The name of the user settings ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the user settings to be updated. ,
Required: True ,
}
{
properties:
{
Description: The cloud shell user settings properties. ,
Required: False ,
}
{
preferredOsType:
{
Description: The operating system type of the cloud shell. Deprecated, use preferredShellType. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
preferredLocation:
{
Description: The preferred location of the cloud shell. ,
Required: True ,
}
string ,
storageProfile:
{
Description: The storage profile of the user settings. ,
Required: True ,
}
{
storageAccountResourceId:
{
Description: Full resource ID of storage account. ,
Required: False ,
}
string ,
fileShareName:
{
Description: Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and - ,
Required: False ,
}
string ,
diskSizeInGB:
{
Description: Size of file share ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
terminalSettings:
{
Description: Settings for terminal appearance. ,
Required: True ,
}
{
fontSize:
{
Description: Size of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
Required: False ,
}
enum ,
fontStyle:
{
Description: Style of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Monospace: No description available. ,
Courier: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
preferredShellType:
{
Description: The shell type of the cloud shell. ,
Enum:
{
bash: No description available. ,
pwsh: No description available. ,
powershell: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The cloud shell user settings properties. ,
Required: True ,
}
{
preferredOsType:
{
Description: The operating system type of the cloud shell. Deprecated, use preferredShellType. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
preferredLocation:
{
Description: The preferred location of the cloud shell. ,
Required: True ,
}
string ,
storageProfile:
{
Description: The storage profile of the user settings. ,
Required: True ,
}
{
storageAccountResourceId:
{
Description: Full resource ID of storage account. ,
Required: False ,
}
string ,
fileShareName:
{
Description: Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and - ,
Required: False ,
}
string ,
diskSizeInGB:
{
Description: Size of file share ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
terminalSettings:
{
Description: Settings for terminal appearance. ,
Required: True ,
}
{
fontSize:
{
Description: Size of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
Required: False ,
}
enum ,
fontStyle:
{
Description: Style of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Monospace: No description available. ,
Courier: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
preferredShellType:
{
Description: The shell type of the cloud shell. ,
Enum:
{
bash: No description available. ,
pwsh: No description available. ,
powershell: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
DeleteUserSettings (new)
Description :  Delete cloud shell settings for current signed in user
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Portal/userSettings/{userSettingsName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
userSettingsName:
{
Description: The name of the user settings ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
PutUserSettings (new)
Description :  Create or update cloud shell settings for current signed in user
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Portal/userSettings/{userSettingsName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
userSettingsName:
{
Description: The name of the user settings ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the user settings to be created or updated. ,
Required: True ,
}
{
properties:
{
Description: The cloud shell user settings properties. ,
Required: True ,
}
{
preferredOsType:
{
Description: The operating system type of the cloud shell. Deprecated, use preferredShellType. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
preferredLocation:
{
Description: The preferred location of the cloud shell. ,
Required: True ,
}
string ,
storageProfile:
{
Description: The storage profile of the user settings. ,
Required: True ,
}
{
storageAccountResourceId:
{
Description: Full resource ID of storage account. ,
Required: False ,
}
string ,
fileShareName:
{
Description: Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and - ,
Required: False ,
}
string ,
diskSizeInGB:
{
Description: Size of file share ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
terminalSettings:
{
Description: Settings for terminal appearance. ,
Required: True ,
}
{
fontSize:
{
Description: Size of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
Required: False ,
}
enum ,
fontStyle:
{
Description: Style of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Monospace: No description available. ,
Courier: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
preferredShellType:
{
Description: The shell type of the cloud shell. ,
Enum:
{
bash: No description available. ,
pwsh: No description available. ,
powershell: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The cloud shell user settings properties. ,
Required: True ,
}
{
preferredOsType:
{
Description: The operating system type of the cloud shell. Deprecated, use preferredShellType. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
preferredLocation:
{
Description: The preferred location of the cloud shell. ,
Required: True ,
}
string ,
storageProfile:
{
Description: The storage profile of the user settings. ,
Required: True ,
}
{
storageAccountResourceId:
{
Description: Full resource ID of storage account. ,
Required: False ,
}
string ,
fileShareName:
{
Description: Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and - ,
Required: False ,
}
string ,
diskSizeInGB:
{
Description: Size of file share ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
terminalSettings:
{
Description: Settings for terminal appearance. ,
Required: True ,
}
{
fontSize:
{
Description: Size of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
Required: False ,
}
enum ,
fontStyle:
{
Description: Style of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Monospace: No description available. ,
Courier: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
preferredShellType:
{
Description: The shell type of the cloud shell. ,
Enum:
{
bash: No description available. ,
pwsh: No description available. ,
powershell: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
GetConsole (new)
Description :  Gets the console for the user.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Portal/consoles/{consoleName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
consoleName:
{
Description: The name of the console ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Cloud shell console properties. ,
Required: True ,
}
{
osType:
{
Description: The operating system type of the cloud shell. ,
Enum:
{
Linux: No description available. ,
Windows: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the console. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Pending: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Repairing: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: Uri of the console. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
PutConsole (new)
Description :  Puts a request for a console
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Portal/consoles/{consoleName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
consoleName:
{
Description: The name of the console ,
Required: True ,
}
string ,
parameters:
{
Description: The console definition. ,
Required: True ,
}
{
properties:
{
Description: Cloud shell properties for creating a console. ,
Required: True ,
}
{
osType:
{
Description: The operating system type of the cloud shell. ,
Enum:
{
Linux: No description available. ,
Windows: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the console. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Pending: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Repairing: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: Uri of the console. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Cloud shell console properties. ,
Required: True ,
}
{
osType:
{
Description: The operating system type of the cloud shell. ,
Enum:
{
Linux: No description available. ,
Windows: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the console. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Pending: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Repairing: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: Uri of the console. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Cloud shell console properties. ,
Required: True ,
}
{
osType:
{
Description: The operating system type of the cloud shell. ,
Enum:
{
Linux: No description available. ,
Windows: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the console. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Pending: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Repairing: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: Uri of the console. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
DeleteConsole (new)
Description :  Deletes the console
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Portal/consoles/{consoleName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
consoleName:
{
Description: The name of the console ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
KeepAlive (new)
Description :  Keep console alive
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Portal/consoles/{consoleName}/keepAlive
{
consoleName:
{
Description: The name of the console ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
x-ms-console-remaining-seconds:
{
Description: Remaining time left in session, in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
getUserSettingsWithLocation (removed)
Description :  Get current user settings for current signed in user. This operation returns settings for the user's cloud shell preferences including preferred location, storage profile, shell type, font and size settings.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Portal/locations/{location}/userSettings/{userSettingsName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
userSettingsName:
{
Description: The name of the user settings ,
Required: True ,
}
string ,
location:
{
Description: The provider location ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-console-required-location-code:
{
Description: normalized required location code ,
}
string ,
x-ms-console-preview-user:
{
Description: indicates whether user is a previous usr. ,
}
boolean ,
}
,
$schema:
{
Description: Response to get user settings ,
}
{
properties:
{
Description: The cloud shell user settings properties. ,
Required: True ,
}
{
preferredOsType:
{
Description: The operating system type of the cloud shell. Deprecated, use preferredShellType. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
preferredLocation:
{
Description: The preferred location of the cloud shell. ,
Required: True ,
}
string ,
storageProfile:
{
Description: The storage profile of the user settings. ,
Required: True ,
}
{
storageAccountResourceId:
{
Description: Full resource ID of storage account. ,
Required: False ,
}
string ,
fileShareName:
{
Description: Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and - ,
Required: False ,
}
string ,
diskSizeInGB:
{
Description: Size of file share ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
terminalSettings:
{
Description: Settings for terminal appearance. ,
Required: True ,
}
{
fontSize:
{
Description: Size of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
Required: False ,
}
enum ,
fontStyle:
{
Description: Style of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Monospace: No description available. ,
Courier: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
preferredShellType:
{
Description: The shell type of the cloud shell. ,
Enum:
{
bash: No description available. ,
pwsh: No description available. ,
powershell: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
patchUserSettingsWithLocation (removed)
Description :  Patch cloud shell settings for current signed in user
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Portal/locations/{location}/userSettings/{userSettingsName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
userSettingsName:
{
Description: The name of the user settings ,
Required: True ,
}
string ,
location:
{
Description: The provider location ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the user settings to be updated. ,
Required: True ,
}
{
properties:
{
Description: The cloud shell user settings properties. ,
Required: False ,
}
{
preferredOsType:
{
Description: The operating system type of the cloud shell. Deprecated, use preferredShellType. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
preferredLocation:
{
Description: The preferred location of the cloud shell. ,
Required: True ,
}
string ,
storageProfile:
{
Description: The storage profile of the user settings. ,
Required: True ,
}
{
storageAccountResourceId:
{
Description: Full resource ID of storage account. ,
Required: False ,
}
string ,
fileShareName:
{
Description: Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and - ,
Required: False ,
}
string ,
diskSizeInGB:
{
Description: Size of file share ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
terminalSettings:
{
Description: Settings for terminal appearance. ,
Required: True ,
}
{
fontSize:
{
Description: Size of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
Required: False ,
}
enum ,
fontStyle:
{
Description: Style of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Monospace: No description available. ,
Courier: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
preferredShellType:
{
Description: The shell type of the cloud shell. ,
Enum:
{
bash: No description available. ,
pwsh: No description available. ,
powershell: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The cloud shell user settings properties. ,
Required: True ,
}
{
preferredOsType:
{
Description: The operating system type of the cloud shell. Deprecated, use preferredShellType. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
preferredLocation:
{
Description: The preferred location of the cloud shell. ,
Required: True ,
}
string ,
storageProfile:
{
Description: The storage profile of the user settings. ,
Required: True ,
}
{
storageAccountResourceId:
{
Description: Full resource ID of storage account. ,
Required: False ,
}
string ,
fileShareName:
{
Description: Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and - ,
Required: False ,
}
string ,
diskSizeInGB:
{
Description: Size of file share ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
terminalSettings:
{
Description: Settings for terminal appearance. ,
Required: True ,
}
{
fontSize:
{
Description: Size of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
Required: False ,
}
enum ,
fontStyle:
{
Description: Style of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Monospace: No description available. ,
Courier: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
preferredShellType:
{
Description: The shell type of the cloud shell. ,
Enum:
{
bash: No description available. ,
pwsh: No description available. ,
powershell: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
deleteUserSettingsWithLocation (removed)
Description :  Delete cloud shell settings for current signed in user
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Portal/locations/{location}/userSettings/{userSettingsName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
userSettingsName:
{
Description: The name of the user settings ,
Required: True ,
}
string ,
location:
{
Description: The provider location ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
putUserSettingsWithLocation (removed)
Description :  Create or update cloud shell settings for current signed in user
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Portal/locations/{location}/userSettings/{userSettingsName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
userSettingsName:
{
Description: The name of the user settings ,
Required: True ,
}
string ,
location:
{
Description: The provider location ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the user settings to be created or updated. ,
Required: True ,
}
{
properties:
{
Description: The cloud shell user settings properties. ,
Required: True ,
}
{
preferredOsType:
{
Description: The operating system type of the cloud shell. Deprecated, use preferredShellType. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
preferredLocation:
{
Description: The preferred location of the cloud shell. ,
Required: True ,
}
string ,
storageProfile:
{
Description: The storage profile of the user settings. ,
Required: True ,
}
{
storageAccountResourceId:
{
Description: Full resource ID of storage account. ,
Required: False ,
}
string ,
fileShareName:
{
Description: Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and - ,
Required: False ,
}
string ,
diskSizeInGB:
{
Description: Size of file share ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
terminalSettings:
{
Description: Settings for terminal appearance. ,
Required: True ,
}
{
fontSize:
{
Description: Size of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
Required: False ,
}
enum ,
fontStyle:
{
Description: Style of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Monospace: No description available. ,
Courier: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
preferredShellType:
{
Description: The shell type of the cloud shell. ,
Enum:
{
bash: No description available. ,
pwsh: No description available. ,
powershell: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The cloud shell user settings properties. ,
Required: True ,
}
{
preferredOsType:
{
Description: The operating system type of the cloud shell. Deprecated, use preferredShellType. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
preferredLocation:
{
Description: The preferred location of the cloud shell. ,
Required: True ,
}
string ,
storageProfile:
{
Description: The storage profile of the user settings. ,
Required: True ,
}
{
storageAccountResourceId:
{
Description: Full resource ID of storage account. ,
Required: False ,
}
string ,
fileShareName:
{
Description: Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and - ,
Required: False ,
}
string ,
diskSizeInGB:
{
Description: Size of file share ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
terminalSettings:
{
Description: Settings for terminal appearance. ,
Required: True ,
}
{
fontSize:
{
Description: Size of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
Required: False ,
}
enum ,
fontStyle:
{
Description: Style of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Monospace: No description available. ,
Courier: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
preferredShellType:
{
Description: The shell type of the cloud shell. ,
Enum:
{
bash: No description available. ,
pwsh: No description available. ,
powershell: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
getConsoleWithLocation (removed)
Description :  Gets the console for the user.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Portal/locations/{location}/consoles/{consoleName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
consoleName:
{
Description: The name of the console ,
Required: True ,
}
string ,
location:
{
Description: The provider location ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Cloud shell console properties. ,
Required: True ,
}
{
osType:
{
Description: The operating system type of the cloud shell. ,
Enum:
{
Linux: No description available. ,
Windows: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the console. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Pending: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Repairing: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: Uri of the console. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
putConsoleWithLocation (removed)
Description :  Puts a request for a console
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Portal/locations/{location}/consoles/{consoleName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
consoleName:
{
Description: The name of the console ,
Required: True ,
}
string ,
location:
{
Description: The provider location ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Cloud shell console properties. ,
Required: True ,
}
{
osType:
{
Description: The operating system type of the cloud shell. ,
Enum:
{
Linux: No description available. ,
Windows: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the console. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Pending: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Repairing: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: Uri of the console. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Cloud shell console properties. ,
Required: True ,
}
{
osType:
{
Description: The operating system type of the cloud shell. ,
Enum:
{
Linux: No description available. ,
Windows: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the console. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Pending: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Repairing: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: Uri of the console. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
deleteConsoleWithLocation (removed)
Description :  Deletes the console
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Portal/locations/{location}/consoles/{consoleName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
consoleName:
{
Description: The name of the console ,
Required: True ,
}
string ,
location:
{
Description: The provider location ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
keepAliveWithLocation (removed)
Description :  Keep console alive
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Portal/locations/{location}/consoles/{consoleName}/keepAlive
{
consoleName:
{
Description: The name of the console ,
Required: True ,
}
string ,
location:
{
Description: The provider location ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
x-ms-console-remaining-seconds:
{
Description: Remaining time left in session, in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
GetUserSettings (removed)
Description :  Get current user settings for current signed in user. This operation returns settings for the user's cloud shell preferences including preferred location, storage profile, shell type, font and size settings.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Portal/userSettings/{userSettingsName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
userSettingsName:
{
Description: The name of the user settings ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-console-required-location-code:
{
Description: normalized required location code ,
}
string ,
x-ms-console-preview-user:
{
Description: indicates whether user is a previous usr. ,
}
boolean ,
}
,
$schema:
{
Description: Response to get user settings ,
}
{
properties:
{
Description: The cloud shell user settings properties. ,
Required: True ,
}
{
preferredOsType:
{
Description: The operating system type of the cloud shell. Deprecated, use preferredShellType. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
preferredLocation:
{
Description: The preferred location of the cloud shell. ,
Required: True ,
}
string ,
storageProfile:
{
Description: The storage profile of the user settings. ,
Required: True ,
}
{
storageAccountResourceId:
{
Description: Full resource ID of storage account. ,
Required: False ,
}
string ,
fileShareName:
{
Description: Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and - ,
Required: False ,
}
string ,
diskSizeInGB:
{
Description: Size of file share ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
terminalSettings:
{
Description: Settings for terminal appearance. ,
Required: True ,
}
{
fontSize:
{
Description: Size of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
Required: False ,
}
enum ,
fontStyle:
{
Description: Style of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Monospace: No description available. ,
Courier: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
preferredShellType:
{
Description: The shell type of the cloud shell. ,
Enum:
{
bash: No description available. ,
pwsh: No description available. ,
powershell: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
PatchUserSettings (removed)
Description :  Patch cloud shell settings for current signed in user
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Portal/userSettings/{userSettingsName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
userSettingsName:
{
Description: The name of the user settings ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the user settings to be updated. ,
Required: True ,
}
{
properties:
{
Description: The cloud shell user settings properties. ,
Required: False ,
}
{
preferredOsType:
{
Description: The operating system type of the cloud shell. Deprecated, use preferredShellType. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
preferredLocation:
{
Description: The preferred location of the cloud shell. ,
Required: True ,
}
string ,
storageProfile:
{
Description: The storage profile of the user settings. ,
Required: True ,
}
{
storageAccountResourceId:
{
Description: Full resource ID of storage account. ,
Required: False ,
}
string ,
fileShareName:
{
Description: Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and - ,
Required: False ,
}
string ,
diskSizeInGB:
{
Description: Size of file share ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
terminalSettings:
{
Description: Settings for terminal appearance. ,
Required: True ,
}
{
fontSize:
{
Description: Size of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
Required: False ,
}
enum ,
fontStyle:
{
Description: Style of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Monospace: No description available. ,
Courier: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
preferredShellType:
{
Description: The shell type of the cloud shell. ,
Enum:
{
bash: No description available. ,
pwsh: No description available. ,
powershell: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The cloud shell user settings properties. ,
Required: True ,
}
{
preferredOsType:
{
Description: The operating system type of the cloud shell. Deprecated, use preferredShellType. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
preferredLocation:
{
Description: The preferred location of the cloud shell. ,
Required: True ,
}
string ,
storageProfile:
{
Description: The storage profile of the user settings. ,
Required: True ,
}
{
storageAccountResourceId:
{
Description: Full resource ID of storage account. ,
Required: False ,
}
string ,
fileShareName:
{
Description: Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and - ,
Required: False ,
}
string ,
diskSizeInGB:
{
Description: Size of file share ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
terminalSettings:
{
Description: Settings for terminal appearance. ,
Required: True ,
}
{
fontSize:
{
Description: Size of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
Required: False ,
}
enum ,
fontStyle:
{
Description: Style of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Monospace: No description available. ,
Courier: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
preferredShellType:
{
Description: The shell type of the cloud shell. ,
Enum:
{
bash: No description available. ,
pwsh: No description available. ,
powershell: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
DeleteUserSettings (removed)
Description :  Delete cloud shell settings for current signed in user
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Portal/userSettings/{userSettingsName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
userSettingsName:
{
Description: The name of the user settings ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
PutUserSettings (removed)
Description :  Create or update cloud shell settings for current signed in user
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Portal/userSettings/{userSettingsName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
userSettingsName:
{
Description: The name of the user settings ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the user settings to be created or updated. ,
Required: True ,
}
{
properties:
{
Description: The cloud shell user settings properties. ,
Required: True ,
}
{
preferredOsType:
{
Description: The operating system type of the cloud shell. Deprecated, use preferredShellType. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
preferredLocation:
{
Description: The preferred location of the cloud shell. ,
Required: True ,
}
string ,
storageProfile:
{
Description: The storage profile of the user settings. ,
Required: True ,
}
{
storageAccountResourceId:
{
Description: Full resource ID of storage account. ,
Required: False ,
}
string ,
fileShareName:
{
Description: Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and - ,
Required: False ,
}
string ,
diskSizeInGB:
{
Description: Size of file share ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
terminalSettings:
{
Description: Settings for terminal appearance. ,
Required: True ,
}
{
fontSize:
{
Description: Size of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
Required: False ,
}
enum ,
fontStyle:
{
Description: Style of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Monospace: No description available. ,
Courier: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
preferredShellType:
{
Description: The shell type of the cloud shell. ,
Enum:
{
bash: No description available. ,
pwsh: No description available. ,
powershell: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The cloud shell user settings properties. ,
Required: True ,
}
{
preferredOsType:
{
Description: The operating system type of the cloud shell. Deprecated, use preferredShellType. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
preferredLocation:
{
Description: The preferred location of the cloud shell. ,
Required: True ,
}
string ,
storageProfile:
{
Description: The storage profile of the user settings. ,
Required: True ,
}
{
storageAccountResourceId:
{
Description: Full resource ID of storage account. ,
Required: False ,
}
string ,
fileShareName:
{
Description: Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and - ,
Required: False ,
}
string ,
diskSizeInGB:
{
Description: Size of file share ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
terminalSettings:
{
Description: Settings for terminal appearance. ,
Required: True ,
}
{
fontSize:
{
Description: Size of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Small: No description available. ,
Medium: No description available. ,
Large: No description available. ,
}
,
Required: False ,
}
enum ,
fontStyle:
{
Description: Style of terminal font. ,
Enum:
{
NotSpecified: No description available. ,
Monospace: No description available. ,
Courier: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
preferredShellType:
{
Description: The shell type of the cloud shell. ,
Enum:
{
bash: No description available. ,
pwsh: No description available. ,
powershell: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
GetConsole (removed)
Description :  Gets the console for the user.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Portal/consoles/{consoleName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
consoleName:
{
Description: The name of the console ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Cloud shell console properties. ,
Required: True ,
}
{
osType:
{
Description: The operating system type of the cloud shell. ,
Enum:
{
Linux: No description available. ,
Windows: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the console. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Pending: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Repairing: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: Uri of the console. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
PutConsole (removed)
Description :  Puts a request for a console
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Portal/consoles/{consoleName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
consoleName:
{
Description: The name of the console ,
Required: True ,
}
string ,
parameters:
{
Description: The console definition. ,
Required: True ,
}
{
properties:
{
Description: Cloud shell properties for creating a console. ,
Required: True ,
}
{
osType:
{
Description: The operating system type of the cloud shell. ,
Enum:
{
Linux: No description available. ,
Windows: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the console. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Pending: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Repairing: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: Uri of the console. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Cloud shell console properties. ,
Required: True ,
}
{
osType:
{
Description: The operating system type of the cloud shell. ,
Enum:
{
Linux: No description available. ,
Windows: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the console. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Pending: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Repairing: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: Uri of the console. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Cloud shell console properties. ,
Required: True ,
}
{
osType:
{
Description: The operating system type of the cloud shell. ,
Enum:
{
Linux: No description available. ,
Windows: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the console. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Pending: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Repairing: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Succeeded: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: Uri of the console. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
DeleteConsole (removed)
Description :  Deletes the console
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Portal/consoles/{consoleName}
{
api-version:
{
Description: Client API version ,
Required: True ,
}
string ,
consoleName:
{
Description: The name of the console ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}
KeepAlive (removed)
Description :  Keep console alive
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Portal/consoles/{consoleName}/keepAlive
{
consoleName:
{
Description: The name of the console ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
x-ms-console-remaining-seconds:
{
Description: Remaining time left in session, in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
}
,
}