Skip to content

Commit 7f8360d

Browse files
Merge pull request #263838 from sdwheeler/sdw-newux
Reorg and add new UX docs
2 parents 142f676 + 64e78d1 commit 7f8360d

36 files changed

+501
-87
lines changed

articles/cloud-shell/.openpublishing.redirection.cloud-shell.json

Lines changed: 48 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,88 @@
11
{
22
"redirections": [
33
{
4-
"source_path_from_root": "/articles/cloud-shell/troubleshooting.md",
5-
"redirect_url": "/azure/cloud-shell/faq-troubleshooting",
6-
"redirect_document_id": true
4+
"redirect_url": "/azure/cloud-shell/overview",
5+
"source_path_from_root": "/articles/cloud-shell/index.md",
6+
"redirect_document_id": false
77
},
88
{
9-
"source_path_from_root": "/articles/cloud-shell/limitations.md",
109
"redirect_url": "/azure/cloud-shell/faq-troubleshooting",
10+
"source_path_from_root": "/articles/cloud-shell/limitations.md",
1111
"redirect_document_id": false
1212
},
1313
{
14-
"source_path_from_root": "/articles/cloud-shell/private-vnet.md",
15-
"redirect_url": "/azure/cloud-shell/vnet-overview",
14+
"redirect_url": "/azure/cloud-shell/faq-troubleshooting",
15+
"source_path_from_root": "/articles/cloud-shell/troubleshooting.md",
1616
"redirect_document_id": true
1717
},
1818
{
19-
"source_path_from_root": "/articles/cloud-shell/quickstart-deploy-vnet.md",
20-
"redirect_url": "/azure/cloud-shell/vnet-deployment",
21-
"redirect_document_id": true
19+
"redirect_url": "/azure/cloud-shell/features",
20+
"source_path_from_root": "/articles/cloud-shell/features-powershell.md",
21+
"redirect_document_id": false
2222
},
2323
{
24-
"source_path_from_root": "/articles/cloud-shell/msi-authorization.md",
25-
"redirect_url": "/azure/active-directory/managed-identities-azure-resources/managed-identities-status",
26-
"redirect_document_id": true
24+
"redirect_url": "/azure/cloud-shell/get-started/classic",
25+
"source_path_from_root": "/articles/cloud-shell/cloud-shell-windows-users.md",
26+
"redirect_document_id": false
2727
},
2828
{
29+
"redirect_url": "/azure/cloud-shell/get-started/classic",
2930
"source_path_from_root": "/articles/cloud-shell/quickstart.md",
30-
"redirect_url": "/azure/cloud-shell/get-started",
31-
"redirect_document_id": true
31+
"redirect_document_id": false
3232
},
3333
{
34+
"redirect_url": "/azure/cloud-shell/get-started/classic",
3435
"source_path_from_root": "/articles/cloud-shell/quickstart-powershell.md",
35-
"redirect_url": "/azure/cloud-shell/get-started",
3636
"redirect_document_id": false
3737
},
3838
{
39-
"source_path_from_root": "/articles/cloud-shell/cloud-shell-windows-users.md",
40-
"redirect_url": "/azure/cloud-shell/get-started",
41-
"redirect_document_id": false
39+
"redirect_url": "/azure/cloud-shell/get-started/classic",
40+
"source_path_from_root": "/articles/cloud-shell/get-started.md",
41+
"redirect_document_id": true
4242
},
4343
{
44-
"source_path_from_root": "/articles/cloud-shell/features-powershell.md",
45-
"redirect_url": "/azure/cloud-shell/features",
44+
"redirect_url": "/azure/cloud-shell/persisting-shell-storage",
45+
"source_path_from_root": "/articles/cloud-shell/persisting-shell-storage-powershell.md",
4646
"redirect_document_id": false
4747
},
4848
{
49-
"source_path_from_root": "/articles/cloud-shell/persisting-shell-storage-powershell.md",
50-
"redirect_url": "/azure/cloud-shell/persisting-shell-storage",
49+
"redirect_url": "/azure/cloud-shell/vnet/deployment",
50+
"source_path_from_root": "/articles/cloud-shell/quickstart-deploy-vnet.md",
5151
"redirect_document_id": false
5252
},
5353
{
54-
"source_path_from_root": "/articles/cloud-shell/example-terraform-bash.md",
55-
"redirect_url": "/azure/developer/terraform/quickstart-configure",
54+
"redirect_url": "/azure/cloud-shell/vnet/deployment",
55+
"source_path_from_root": "/articles/cloud-shell/vnet-deployment.md",
56+
"redirect_document_id": true
57+
},
58+
{
59+
"redirect_url": "/azure/cloud-shell/vnet/overview",
60+
"source_path_from_root": "/articles/cloud-shell/private-vnet.md",
5661
"redirect_document_id": false
5762
},
5863
{
59-
"source_path_from_root": "/articles/cloud-shell/security-baseline.md",
60-
"redirect_url": "/security/benchmark/azure/baselines/cloud-shell-security-baseline",
64+
"redirect_url": "/azure/cloud-shell/vnet/overview",
65+
"source_path_from_root": "/articles/cloud-shell/vnet-overview.md",
66+
"redirect_document_id": true
67+
},
68+
{
69+
"redirect_url": "/azure/cloud-shell/vnet/troubleshooting",
70+
"source_path_from_root": "/articles/cloud-shell/vnet-troubleshooting.md",
71+
"redirect_document_id": true
72+
},
73+
{
74+
"redirect_url": "/azure/active-directory/managed-identities-azure-resources/managed-identities-status",
75+
"source_path_from_root": "/articles/cloud-shell/msi-authorization.md",
76+
"redirect_document_id": true
77+
},
78+
{
79+
"redirect_url": "/azure/developer/terraform/quickstart-configure",
80+
"source_path_from_root": "/articles/cloud-shell/example-terraform-bash.md",
6181
"redirect_document_id": false
6282
},
6383
{
64-
"source_path_from_root": "/articles/cloud-shell/index.md",
65-
"redirect_url": "/azure/cloud-shell/overview",
84+
"redirect_url": "/security/benchmark/azure/baselines/cloud-shell-security-baseline",
85+
"source_path_from_root": "/articles/cloud-shell/security-baseline.md",
6686
"redirect_document_id": false
6787
}
6888
]

articles/cloud-shell/TOC.yml

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,15 @@ items:
66
- name: Features & tools
77
href: features.md
88
- name: Get started with Cloud Shell
9-
href: get-started.md
9+
items:
10+
- name: Get started (Classic)
11+
href: get-started/classic.md
12+
- name: Get started (New UI)
13+
href: get-started/ephemeral.md
14+
- name: Get started with new storage account (New UI)
15+
href: get-started/new-storage.md
16+
- name: Get started with existing storage account (New UI)
17+
href: get-started/existing-storage.md
1018
- name: How to use Cloud Shell
1119
items:
1220
- name: Persist files in storage
@@ -24,11 +32,11 @@ items:
2432
- name: Deploy Cloud Shell in a virtual network
2533
items:
2634
- name: Overview
27-
href: vnet-overview.md
35+
href: vnet/overview.md
2836
- name: Deploy using quickstart templates
29-
href: vnet-deployment.md
37+
href: vnet/deployment.md
3038
- name: Troubleshoot Azure Cloud Shell in a virtual network
31-
href: vnet-troubleshooting.md
39+
href: vnet/troubleshooting.md
3240
- name: Pricing
3341
items:
3442
- name: Cloud Shell pricing

articles/cloud-shell/cloud-shell-predictive-intellisense.md

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ title: Predictive IntelliSense in Azure Cloud Shell
77

88
# Predictive IntelliSense in Azure Cloud Shell
99

10-
Beginning January 2023 Azure Cloud Shell uses the version of [PSReadLine][01] that has Predictive
10+
Beginning January 2023 Azure Cloud Shell uses the version of [PSReadLine][03] that has Predictive
1111
IntelliSense enabled by default. We've also installed and enabled the Azure PowerShell predictor
12-
[Az.Tools.Predictor][02]] module. Together, these changes enhance the command-line experience by
12+
[Az.Tools.Predictor][01] module. Together, these changes enhance the command-line experience by
1313
providing suggestions that help new and experienced users of Azure discover, edit, and execute
1414
complete commands.
1515

@@ -24,11 +24,11 @@ the default `InlineView` of the suggestion. Pressing <kbd>RightArrow</kbd> key a
2424
suggestion. After accepting the suggestion, you can edit the command line before hitting
2525
<kbd>Enter</kbd> to run the command.
2626

27-
![Suggestion in InlineView mode](./media/predictive-intellisense/cloud-shell-inline.png)
27+
![Suggestion in InlineView mode][06]
2828

2929
PSReadLine also offers a `ListView` presentation of the suggestions.
3030

31-
![Suggestions in ListView mode](./media/predictive-intellisense/cloud-shell-list-view.png)
31+
![Suggestions in ListView mode][07]
3232

3333
In `ListView` mode, use the arrow keys to scroll through the available suggestions. List view also
3434
shows the source of the prediction.
@@ -43,10 +43,12 @@ configure the color of the suggestions.
4343
The following command changes the color of inline suggestions to white text on a gray background.
4444

4545
```powershell
46-
Set-PSReadLineOption -Colors @{ InlinePrediction = $PSStyle.Foreground.White + $PSStyle.Background.BrightBlack }
46+
Set-PSReadLineOption -Colors @{
47+
InlinePrediction = $PSStyle.Foreground.White + $PSStyle.Background.BrightBlack
48+
}
4749
```
4850

49-
Learn more about color settings for [Set-PSReadLineOption][03].
51+
Learn more about color settings for [Set-PSReadLineOption][04].
5052

5153
## How to disable Predictive IntelliSense
5254

@@ -65,7 +67,7 @@ Set-PSReadLineOption -PredictionSource None
6567
The commands to change the prediction color and enable or disable predictions only affect the
6668
current session. Add these commands to your PowerShell profile so that they're available every time
6769
you start Cloud Shell. The following instructions will guide you through configuring a profile for
68-
Cloud Shell. For more information on PowerShell profiles, see [About_Profiles][06]
70+
Cloud Shell. For more information on PowerShell profiles, see [About_Profiles][02]
6971

7072
### How to check if you have a PowerShell profile in Cloud Shell
7173

@@ -96,7 +98,8 @@ UnixMode User Group LastWriteTime Size N
9698
-rw-r--r-- jason jason 11/19/2022 18:21 0 Microsoft.PowerShell_profile.ps1
9799
```
98100

99-
Use the built-in open-source editor to edit the profile. To learn more, see [Azure Cloud Shell editor][04].
101+
Use the built-in open-source editor to edit the profile. To learn more, see
102+
[Azure Cloud Shell editor][08].
100103

101104
The following example shows the profile commands that set the prediction color to default light grey
102105
and enables History predictions.
@@ -110,7 +113,7 @@ Set-PSReadLineOption -Colors @{ InLinePrediction = '#8d8d8d' }
110113

111114
If the output is **True**, then a profile already exists. Edit the existing profile to add the
112115
commands to configure the color and behavior of Predictive IntelliSense. Use the built-in
113-
open-source editor to edit the profile. To learn more, see [Azure Cloud Shell editor][04].
116+
open-source editor to edit the profile. To learn more, see [Azure Cloud Shell editor][08].
114117

115118
Use the built-in Cloud Shell editor to edit the profile:
116119

@@ -123,13 +126,15 @@ code $Profile
123126
For more information about configuring PSReadLine and managing predictors, see
124127
[Using predictors in PSReadLine][05].
125128

126-
For more information on PowerShell profiles, see [About_Profiles][06].
129+
For more information on PowerShell profiles, see [About_Profiles][02].
127130

128131

129132
<!-- link references -->
130-
[01]: /powershell/module/psreadline/about/about_psreadline
131-
[02]: /powershell/azure/az-predictor
132-
[03]: /powershell/module/psreadline/set-psreadlineoption
133-
[04]: ./using-cloud-shell-editor.md
133+
[01]: /powershell/azure/az-predictor
134+
[02]: /powershell/module/microsoft.powershell.core/about/about_profiles
135+
[03]: /powershell/module/psreadline/about/about_psreadline
136+
[04]: /powershell/module/psreadline/set-psreadlineoption
134137
[05]: /powershell/scripting/learn/shell/using-predictors
135-
[06]: /powershell/module/microsoft.powershell.core/about/about_profiles
138+
[06]: media/predictive-intellisense/cloud-shell-inline.png
139+
[07]: media/predictive-intellisense/cloud-shell-list-view.png
140+
[08]: using-cloud-shell-editor.md

articles/cloud-shell/get-started.md renamed to articles/cloud-shell/get-started/classic.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: Learn how to start using Azure Cloud Shell.
33
ms.contributor: jahelmic
4-
ms.date: 10/30/2023
4+
ms.date: 01/22/2024
55
ms.topic: article
66
tags: azure-resource-manager
77
title: Get started with Azure Cloud Shell
@@ -135,12 +135,12 @@ Get-AzCommand
135135
- [Learn about Azure Files storage][01]
136136

137137
<!-- link references -->
138-
[01]: ../storage/files/storage-files-introduction.md
138+
[01]: /azure/storage/files/storage-files-introduction
139139
[02]: /cli/azure/
140140
[03]: /powershell/azure/
141141
[04]: https://portal.azure.com/
142-
[05]: media/get-started/choose-shell.png
143-
[06]: media/get-started/create-storage.png
144-
[07]: media/get-started/resource-provider.png
145-
[08]: media/get-started/shell-icon.png
146-
[09]: persisting-shell-storage.md
142+
[05]: media/classic/choose-shell.png
143+
[06]: media/classic/create-storage.png
144+
[07]: media/classic/resource-provider.png
145+
[08]: media/classic/shell-icon.png
146+
[09]: ../persisting-shell-storage.md
Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
---
2+
description: Learn how to start using Azure Cloud Shell without a storage account.
3+
ms.contributor: jahelmic
4+
ms.date: 01/22/2024
5+
ms.topic: article
6+
tags: azure-resource-manager
7+
title: Get started with Azure Cloud Shell ephemeral sessions
8+
---
9+
# Get started with Azure Cloud Shell ephemeral sessions
10+
11+
Using Cloud Shell ephemeral sessions is the fastest way to start using Cloud Shell. Ephemeral
12+
sessions don't require a storage account. When you close the Cloud Shell window, all files you saved
13+
are deleted and don't persist across sessions.
14+
15+
## Start Cloud Shell
16+
17+
1. Sign into the [Azure portal][04].
18+
1. Launch **Cloud Shell** from the top navigation of the Azure portal.
19+
20+
![Screenshot showing how to start Azure Cloud Shell in the Azure portal.][07]
21+
22+
1. The first time you start Cloud Shell you're prompted to which shell to use. Select **Bash** or
23+
**PowerShell**.
24+
25+
![Screenshot showing the prompt to select the shell.][05]
26+
27+
1. In the **Getting started** pane, select **No storage account required** for an ephemeral session.
28+
Using the dropdown menu, select the subscription you want to use for Cloud Shell, then select
29+
the **Apply** button.
30+
31+
![Screenshot showing the select subscription and optional storage prompt.][06]
32+
33+
### Set your subscription
34+
35+
1. List subscriptions you have access to.
36+
37+
<!-- markdownlint-disable MD023 MD024 MD051-->
38+
#### [Azure CLI](#tab/azurecli)
39+
40+
```azurecli-interactive
41+
az account list
42+
```
43+
44+
#### [Azure PowerShell](#tab/powershell)
45+
46+
```azurepowershell-interactive
47+
Get-AzSubscription
48+
```
49+
50+
1. Set your preferred subscription:
51+
52+
#### [Azure CLI](#tab/azurecli)
53+
54+
```azurecli-interactive
55+
az account set --subscription 'my-subscription-name'
56+
```
57+
58+
#### [Azure PowerShell](#tab/powershell)
59+
60+
```azurepowershell-interactive
61+
Set-AzContext -Subscription <SubscriptionId>
62+
```
63+
<!-- markdownlint-enable MD023 MD024 MD051-->
64+
---
65+
66+
> [!TIP]
67+
> Your subscription is remembered for future sessions using `/home/<user>/.azure/azureProfile.json`.
68+
69+
### Get a list of Azure commands
70+
71+
<!-- markdownlint-disable MD023 MD024 MD051-->
72+
#### [Azure CLI](#tab/azurecli)
73+
74+
Run the following command to see a list of all Azure CLI commands.
75+
76+
```azurecli-interactive
77+
az
78+
```
79+
80+
Run the following command to get a list of Azure CLI commands that apply to WebApps:
81+
82+
```azurecli-interactive
83+
az webapp --help
84+
```
85+
86+
#### [Azure PowerShell](#tab/powershell)
87+
88+
Run the following command to see a list of all Azure PowerShell cmdlets.
89+
90+
```azurepowershell-interactive
91+
Get-Command -Module Az.*
92+
```
93+
94+
Under `Azure` drive, the `Get-AzCommand` lists context-specific Azure commands.
95+
96+
Run the following commands to get a list the Azure PowerShell commands that apply to WebApps.
97+
98+
```azurepowershell-interactive
99+
cd 'Azure:/My Subscription/WebApps'
100+
Get-AzCommand
101+
```
102+
<!-- markdownlint-enable MD023 MD024 MD051-->
103+
104+
---
105+
106+
## Next steps
107+
108+
- [Learn about Azure PowerShell][03]
109+
- [Learn about Azure CLI][02]
110+
- [Learn about persisting files in Cloud Shell][08]
111+
- [Learn about Azure Files storage][01]
112+
113+
<!-- link references -->
114+
[01]: /azure/storage/files/storage-files-introduction
115+
[02]: /cli/azure/
116+
[03]: /powershell/azure/
117+
[04]: https://portal.azure.com/
118+
[05]: media/ephemeral/choose-shell.png
119+
[06]: media/ephemeral/getting-started.png
120+
[07]: media/ephemeral/shell-icon.png
121+
[08]: ../persisting-shell-storage.md

0 commit comments

Comments
 (0)