Skip to content

Commit 1ec8563

Browse files
authored
Merge pull request #4262 from Azure/stack-dev-help-1210
Add examples to default profile setting
2 parents 4326a20 + 12ede47 commit 1ec8563

File tree

3 files changed

+10
-5
lines changed

3 files changed

+10
-5
lines changed

tools/AzureRM.BootStrapper/help/Set-AzureRmDefaultProfile.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,16 @@ Sets the given profile as a default profile to be used with all API version prof
2424
PS C:\> Set-AzureRmDefaultProfile -Profile '2017-03-09-profile'
2525
```
2626

27-
Set profile '2017-03-09-profile' as a default profile. After setting, any API Version profile cmdlet can be executed as follows:
27+
Set profile '2017-03-09-profile' as a default profile. After setting, any API Version profile cmdlet can be executed without providing a profile parameter as follows:
2828
```
2929
Install-AzureRmProfile
3030
```
31-
This will install profile '2017-03-09-profile'
31+
This will install profile '2017-03-09-profile'. Additionally, when importing AzureRM modules, you will import the version of the module associated with the default profile setting, unless you explicitly specify a RequiredVersion.
32+
33+
```
34+
Import-Module AzureRM.Compute
35+
```
36+
Imports a version of the Compute module compatible with the ```2017-03-09-profile``` profile.
3237

3338

3439
## PARAMETERS

tools/AzureRM.BootStrapper/help/Uninstall-AzureRmProfile.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Accept wildcard characters: False
5959
```
6060
6161
### -Profile
62-
The profile version to load in the current PowerShell session.
62+
The profile version to uninstall.
6363
6464
```yaml
6565
Type: String

tools/AzureRM.BootStrapper/help/Update-AzureRmProfile.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ schema: 2.0.0
66

77
# Update-AzureRmProfile
88
## SYNOPSIS
9-
Update a profile to the latest versions in that profile and import updated modules to the current session. This should always be executed in a new PowerShell session.
9+
Update modules to the latest versions consitent with the given profile and import updated modules to the current session. This should always be executed in a new PowerShell session.
1010

1111
## SYNTAX
1212

@@ -15,7 +15,7 @@ Update-AzureRmProfile [-WhatIf] [-Confirm] [-Profile] <String> [-Module <String[
1515
```
1616

1717
## DESCRIPTION
18-
Update a profile to the latest versions in that profile and import updated modules to the current session. This should always be executed in a new PowerShell session.
18+
Update modules to the latest versions consitent with the given profile and import updated modules to the current session. This should always be executed in a new PowerShell session.
1919

2020
## EXAMPLES
2121

0 commit comments

Comments
 (0)