Skip to content

Commit 624f793

Browse files
markcowlmarkcowl
committed
Updating help for new default profile cmdlets
1 parent dc91d49 commit 624f793

File tree

6 files changed

+194
-125
lines changed

6 files changed

+194
-125
lines changed

‎tools/AzureRM.BootStrapper/AzureRM.BootStrapper.psd1

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#
44
# Generated by: Microsoft Corporation
55
#
6-
# Generated on: 3/10/2017
6+
# Generated on: 7/6/2017
77
#
88

99
@{
@@ -63,20 +63,23 @@ CLRVersion = '4.0'
6363
# TypesToProcess = @()
6464

6565
# Format files (.ps1xml) to be loaded when importing this module
66-
FormatsToProcess = '.\AzureRM.Bootstrapper.Format.ps1xml'
66+
FormatsToProcess = 'AzureRM.Bootstrapper.Format.ps1xml'
6767

6868
# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
6969
# NestedModules = @()
7070

7171
# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
72-
FunctionsToExport = 'Set-BootstrapRepo', 'Update-AzureRmProfile', 'Uninstall-AzureRmProfile',
73-
'Install-AzureRmProfile', 'Use-AzureRmProfile', 'Get-AzureRmProfile',
74-
'Get-AzureRmModule', 'Set-AzureRmDefaultProfile', 'Remove-AzureRmDefaultProfile', 'Get-ModuleVersion'
72+
FunctionsToExport = 'Set-BootstrapRepo', 'Update-AzureRmProfile',
73+
'Uninstall-AzureRmProfile', 'Install-AzureRmProfile',
74+
'Use-AzureRmProfile', 'Get-AzureRmProfile', 'Get-AzureRmModule',
75+
'Set-AzureRmDefaultProfile', 'Remove-AzureRmDefaultProfile',
76+
'Get-ModuleVersion'
7577

7678
# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
7779
CmdletsToExport = 'Update-AzureRmProfile', 'Uninstall-AzureRmProfile',
7880
'Install-AzureRmProfile', 'Use-AzureRmProfile', 'Get-AzureRmProfile',
79-
'Get-AzureRmModule', 'Set-AzureRmDefaultProfile', 'Remove-AzureRmDefaultProfile'
81+
'Get-AzureRmModule', 'Set-AzureRmDefaultProfile',
82+
'Remove-AzureRmDefaultProfile'
8083

8184
# Variables to export from this module
8285
# VariablesToExport = @()

‎tools/AzureRM.BootStrapper/help/AzureRM.Bootstrapper-help.xml

Lines changed: 33 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@
171171
</maml:para>
172172
</maml:description>
173173
</command:details>
174-
<maml:description><maml:para>Install all the latest modules associated with a particular AzureRM Profile on the machine. Modules for a particular profile can be loaded in a new PowerShell session using Use-AzureRmProfile .
174+
<maml:description><maml:para>Install all the latest modules associated with a particular AzureRM Profile on the machine. Modules for a particular profile can be loaded in a new PowerShell session using 'Use-AzureRmProfile'.
175175
</maml:para>
176176
</maml:description>
177177
<command:syntax><command:syntaxItem><maml:name>Install-AzureRmProfile</maml:name>
@@ -299,49 +299,25 @@
299299
<command:relatedLinks></command:relatedLinks>
300300
</command:command>
301301
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
302-
<command:details><command:name>Install-AzureRmProfile</command:name>
303-
<command:verb>Install</command:verb>
304-
<command:noun>AzureRmProfile</command:noun>
305-
<maml:description><maml:para>Install all the latest modules associated with a particular AzureRM Profile on the machine.
302+
<command:details><command:name>Remove-AzureRmDefaultProfile</command:name>
303+
<command:verb>Remove</command:verb>
304+
<command:noun>AzureRmDefaultProfile</command:noun>
305+
<maml:description><maml:para>Removes the default profile setting.
306306
</maml:para>
307307
</maml:description>
308308
</command:details>
309-
<maml:description><maml:para>Install all the latest modules associated with a particular AzureRM Profile on the machine. Modules for a particular profile can be loaded in a new PowerShell session using Use-AzureRmProfile .
309+
<maml:description><maml:para>Removes the default profile setting that was set using 'Set-AzureRmDefaultProfile' cmdlet.
310310
</maml:para>
311311
</maml:description>
312-
<command:syntax><command:syntaxItem><maml:name>Install-AzureRmProfile</maml:name>
313-
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Profile</maml:name>
314-
<maml:Description><maml:para>The profile version to install. You can get a list of available profile versions using Get-AzureRmProfile -ListAvailable
315-
</maml:para>
316-
</maml:Description>
317-
<command:parameterValueGroup><command:parameterValue required="false" variableLength="false">2017-03-09-profile</command:parameterValue>
318-
<command:parameterValue required="false" variableLength="false">&lt;others&gt;</command:parameterValue>
319-
</command:parameterValueGroup>
320-
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
321-
<dev:type><maml:name>String</maml:name>
322-
<maml:uri /></dev:type>
323-
<dev:defaultValue>None</dev:defaultValue>
324-
</command:parameter>
312+
<command:syntax><command:syntaxItem><maml:name>Remove-AzureRmDefaultProfile</maml:name>
325313
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Force</maml:name>
326-
<maml:Description><maml:para>Automatically install modules for the given profile if they are not already installed.
314+
<maml:Description><maml:para>Removes the default profile setting without prompting for confirmation.
327315
</maml:para>
328316
</maml:Description>
329317
<dev:type><maml:name>SwitchParameter</maml:name>
330318
<maml:uri /></dev:type>
331319
<dev:defaultValue>False</dev:defaultValue>
332320
</command:parameter>
333-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Scope</maml:name>
334-
<maml:Description><maml:para>Specifies the installation scope of the modules. The acceptable values for this parameter are: AllUsers and CurrentUser. The AllUsers scope lets modules be installed in a location that is accessible to all users of the computer. The CurrentUser scope lets modules be installed in a location that is available only to the current user.
335-
</maml:para>
336-
</maml:Description>
337-
<command:parameterValueGroup><command:parameterValue required="false" variableLength="false">CurrentUser</command:parameterValue>
338-
<command:parameterValue required="false" variableLength="false">AllUsers</command:parameterValue>
339-
</command:parameterValueGroup>
340-
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
341-
<dev:type><maml:name>String</maml:name>
342-
<maml:uri /></dev:type>
343-
<dev:defaultValue>None</dev:defaultValue>
344-
</command:parameter>
345321
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name>
346322
<maml:Description><maml:para>Prompts you for confirmation before running the cmdlet.
347323
</maml:para>
@@ -361,32 +337,14 @@
361337
</command:syntaxItem>
362338
</command:syntax>
363339
<command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Force</maml:name>
364-
<maml:Description><maml:para>Automatically install modules for the given profile if they are not already installed.
340+
<maml:Description><maml:para>Removes the default profile setting without prompting for confirmation.
365341
</maml:para>
366342
</maml:Description>
367343
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
368344
<dev:type><maml:name>SwitchParameter</maml:name>
369345
<maml:uri /></dev:type>
370346
<dev:defaultValue>False</dev:defaultValue>
371347
</command:parameter>
372-
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Profile</maml:name>
373-
<maml:Description><maml:para>The profile version to install. You can get a list of available profile versions using Get-AzureRmProfile -ListAvailable
374-
</maml:para>
375-
</maml:Description>
376-
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
377-
<dev:type><maml:name>String</maml:name>
378-
<maml:uri /></dev:type>
379-
<dev:defaultValue>None</dev:defaultValue>
380-
</command:parameter>
381-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Scope</maml:name>
382-
<maml:Description><maml:para>Specifies the installation scope of the modules. The acceptable values for this parameter are: AllUsers and CurrentUser. The AllUsers scope lets modules be installed in a location that is accessible to all users of the computer. The CurrentUser scope lets modules be installed in a location that is available only to the current user.
383-
</maml:para>
384-
</maml:Description>
385-
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
386-
<dev:type><maml:name>String</maml:name>
387-
<maml:uri /></dev:type>
388-
<dev:defaultValue>None</dev:defaultValue>
389-
</command:parameter>
390348
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name>
391349
<maml:Description><maml:para>Prompts you for confirmation before running the cmdlet.
392350
</maml:para>
@@ -425,31 +383,32 @@
425383
</maml:alert>
426384
</maml:alertSet>
427385
<command:examples><command:example><maml:title>Example 1</maml:title>
428-
<dev:code>PS C:\&gt; Install-AzureRmProfile -Profile '2017-03-09-profile'</dev:code>
429-
<dev:remarks><maml:para>Install all the modules associated with profile '2017-03-09-profile'
386+
<dev:code>PS C:\&gt; Remove-AzureRmDefaultProfile</dev:code>
387+
<dev:remarks><maml:para>
430388
</maml:para>
431389
</dev:remarks>
432390
</command:example>
433391
</command:examples>
434392
<command:relatedLinks></command:relatedLinks>
435393
</command:command>
436394
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
437-
<command:details><command:name>Install-AzureRmProfile</command:name>
438-
<command:verb>Install</command:verb>
439-
<command:noun>AzureRmProfile</command:noun>
440-
<maml:description><maml:para>Install all the latest modules associated with a particular AzureRM Profile on the machine.
395+
<command:details><command:name>Set-AzureRmDefaultProfile</command:name>
396+
<command:verb>Set</command:verb>
397+
<command:noun>AzureRmDefaultProfile</command:noun>
398+
<maml:description><maml:para>Sets the given profile as a default profile to be used with all API version profile cmdlets.
441399
</maml:para>
442400
</maml:description>
443401
</command:details>
444-
<maml:description><maml:para>Install all the latest modules associated with a particular AzureRM Profile on the machine. Modules for a particular profile can be loaded in a new PowerShell session using Use-AzureRmProfile .
402+
<maml:description><maml:para>Sets the given profile as a default profile to be used with all API version profile cmdlets. Default profile selection is persisted across sessions and shells.
445403
</maml:para>
446404
</maml:description>
447-
<command:syntax><command:syntaxItem><maml:name>Install-AzureRmProfile</maml:name>
405+
<command:syntax><command:syntaxItem><maml:name>Set-AzureRmDefaultProfile</maml:name>
448406
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Profile</maml:name>
449-
<maml:Description><maml:para>The profile version to install. You can get a list of available profile versions using Get-AzureRmProfile -ListAvailable
407+
<maml:Description><maml:para>The profile version to set as default. You can get a list of available profile versions using Get-AzureRmProfile -ListAvailable
450408
</maml:para>
451409
</maml:Description>
452410
<command:parameterValueGroup><command:parameterValue required="false" variableLength="false">2017-03-09-profile</command:parameterValue>
411+
<command:parameterValue required="false" variableLength="false">latest</command:parameterValue>
453412
<command:parameterValue required="false" variableLength="false">&lt;others&gt;</command:parameterValue>
454413
</command:parameterValueGroup>
455414
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
@@ -458,7 +417,7 @@
458417
<dev:defaultValue>None</dev:defaultValue>
459418
</command:parameter>
460419
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Force</maml:name>
461-
<maml:Description><maml:para>Automatically install modules for the given profile if they are not already installed.
420+
<maml:Description><maml:para>Set the given profile as default without prompting for confirmation.
462421
</maml:para>
463422
</maml:Description>
464423
<dev:type><maml:name>SwitchParameter</maml:name>
@@ -496,7 +455,7 @@
496455
</command:syntaxItem>
497456
</command:syntax>
498457
<command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Force</maml:name>
499-
<maml:Description><maml:para>Automatically install modules for the given profile if they are not already installed.
458+
<maml:Description><maml:para>Set the given profile as default without prompting for confirmation.
500459
</maml:para>
501460
</maml:Description>
502461
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
@@ -505,7 +464,7 @@
505464
<dev:defaultValue>False</dev:defaultValue>
506465
</command:parameter>
507466
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Profile</maml:name>
508-
<maml:Description><maml:para>The profile version to install. You can get a list of available profile versions using Get-AzureRmProfile -ListAvailable
467+
<maml:Description><maml:para>The profile version to set as default. You can get a list of available profile versions using Get-AzureRmProfile -ListAvailable
509468
</maml:para>
510469
</maml:Description>
511470
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
@@ -559,9 +518,17 @@
559518
</maml:para>
560519
</maml:alert>
561520
</maml:alertSet>
562-
<command:examples><command:example><maml:title>Example 1</maml:title>
563-
<dev:code>PS C:\&gt; Install-AzureRmProfile -Profile '2017-03-09-profile'</dev:code>
564-
<dev:remarks><maml:para>Install all the modules associated with profile '2017-03-09-profile'
521+
<command:examples><command:example><maml:title>Example 1 - Using Default Version Profile to Automatically Load Module Versions</maml:title>
522+
<dev:code>PS C:\&gt; Set-AzureRmDefaultProfile -Profile '2017-03-09-profile'
523+
PS C:\&gt; Import-Module AzureRM.Compute</dev:code>
524+
<dev:remarks><maml:para>Sets profile '2017-03-09-profile' as the default profile. When importing AzureRM modules like AzureRM.Compute, you will automatically import a version of the module compatible with the default profile setting, unless you explicitly specify a RequiredVersion.
525+
</maml:para>
526+
</dev:remarks>
527+
</command:example>
528+
<command:example><maml:title>Example 2 - Using Default Version Profile to Set Default Profile for BootStrapper cmdlets</maml:title>
529+
<dev:code>PS C:\&gt; Set-AzureRmDefaultProfile -Profile '2017-03-09-profile'
530+
PS c:\&gt; Install-AzureRmProfile</dev:code>
531+
<dev:remarks><maml:para>Sets the default profile as '2017-03-09-profile'. After this, BootStrapper cmdlets will automatically use the default profile if no profile is set. In this case, 'Install-AzureRmProfile' will install profile '2017-03-09-profile', since this profile was set as the default.
565532
</maml:para>
566533
</dev:remarks>
567534
</command:example>

‎tools/AzureRM.BootStrapper/help/Install-AzureRmProfile.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Install-AzureRmProfile [-WhatIf] [-Confirm] [-Profile] <String> [-Scope <String>
1616
```
1717

1818
## DESCRIPTION
19-
Install all the latest modules associated with a particular AzureRM Profile on the machine. Modules for a particular profile can be loaded in a new PowerShell session using *Use-AzureRmProfile*.
19+
Install all the latest modules associated with a particular AzureRM Profile on the machine. Modules for a particular profile can be loaded in a new PowerShell session using 'Use-AzureRmProfile'.
2020

2121
## EXAMPLES
2222

‎tools/AzureRM.BootStrapper/help/Remove-AzureRmDefaultProfile.md

Lines changed: 6 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,31 @@ online version:
44
schema: 2.0.0
55
---
66

7-
# Install-AzureRmProfile
7+
# Remove-AzureRmDefaultProfile
88

99
## SYNOPSIS
10-
Install all the latest modules associated with a particular AzureRM Profile on the machine.
10+
Removes the default profile setting.
1111

1212
## SYNTAX
1313

1414
```
15-
Install-AzureRmProfile [-WhatIf] [-Confirm] [-Profile] <String> [-Scope <String>] [-Force] [<CommonParameters>]
15+
Remove-AzureRmDefaultProfile [-WhatIf] [-Confirm] [-Force] [<CommonParameters>]
1616
```
1717

1818
## DESCRIPTION
19-
Install all the latest modules associated with a particular AzureRM Profile on the machine. Modules for a particular profile can be loaded in a new PowerShell session using *Use-AzureRmProfile*.
19+
Removes the default profile setting that was set using 'Set-AzureRmDefaultProfile' cmdlet.
2020

2121
## EXAMPLES
2222

2323
### Example 1
2424
```
25-
PS C:\> Install-AzureRmProfile -Profile '2017-03-09-profile'
25+
PS C:\> Remove-AzureRmDefaultProfile
2626
```
2727

28-
Install all the modules associated with profile '2017-03-09-profile'
29-
3028
## PARAMETERS
3129

3230
### -Force
33-
Automatically install modules for the given profile if they are not already installed.
31+
Removes the default profile setting without prompting for confirmation.
3432

3533
```yaml
3634
Type: SwitchParameter
@@ -44,40 +42,6 @@ Accept pipeline input: False
4442
Accept wildcard characters: False
4543
```
4644
47-
### -Profile
48-
The profile version to install. You can get a list of available profile versions using *Get-AzureRmProfile -ListAvailable*
49-
50-
```yaml
51-
Type: String
52-
Parameter Sets: (All)
53-
Aliases:
54-
Accepted values: 2017-03-09-profile, <others>
55-
56-
Required: True
57-
Position: 0
58-
Default value: None
59-
Accept pipeline input: True (ByValue)
60-
Accept wildcard characters: False
61-
```
62-
63-
### -Scope
64-
Specifies the installation scope of the modules. The acceptable values for this parameter are: AllUsers and CurrentUser.
65-
The AllUsers scope lets modules be installed in a location that is accessible to all users of the computer.
66-
The CurrentUser scope lets modules be installed in a location that is available only to the current user.
67-
68-
```yaml
69-
Type: String
70-
Parameter Sets: (All)
71-
Aliases:
72-
Accepted values: CurrentUser, AllUsers
73-
74-
Required: False
75-
Position: Named
76-
Default value: None
77-
Accept pipeline input: False
78-
Accept wildcard characters: False
79-
```
80-
8145
### -Confirm
8246
Prompts you for confirmation before running the cmdlet.
8347

0 commit comments

Comments
 (0)