Skip to content

Commit 02bbe22

Browse files
authored
Updating content for initial cmdlets
1 parent 776d08a commit 02bbe22

File tree

1 file changed

+62
-0
lines changed

1 file changed

+62
-0
lines changed

tools/AzureRM.BootStrapper/help/about_version_profiles.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,88 @@ schema: 2.0.0
66

77
# About Version Profiles
88

9+
Different concrete instances of Azure (AzureCloud, AzureChinaCloud, AzureGermanCloud, AzureUSGovernmentCloud, AzureStack) may have different versions of Azure services installed, with different capabilities. Azure Version Profiles provide a mechanism for managing these version differences. Each Azure instance has a discoverable set of supported version profiles. A user can select a version profile supported by the instances of Azure they target, and this version profile corresponds to versions of the Azure PowerShell modules. Users cna then select these Azure PowerShell module versions and be confident that their scripts will work when targeting those Azure instances.
10+
11+
The AzureRM.Bootstrapper module provides cmdlets to discover, acquire, and use modules that are appropriate for the azure version profile you are targeting.
12+
13+
You can also use Tags in the AzureRM modules to discover profile information for each module version. Tags for a Profile use the form ```VersionProfile:2015-05```
14+
915
# Finding appropriate version profiles
1016

17+
Use the ```Get-AzureRMVersionProfile``` cmdlet to discover availabel profile versions, and profile versions supported by an Azure instance.
18+
19+
```Get-AzureRmProfile -ListAvailable``` lists all available version profiles.
20+
21+
```Get-AzureRMProfile -Environment AzureChinaCloud``` lists the profiles supported by the Azure China cloud.
22+
23+
```Get-AzureRMProfile -Endpoint https://manage.myazurestackinstance.com``` lists the profiles supported by the azure instance at the given endpoint
24+
1125
## Targeting a concrete Azure instance
1226

27+
```Get-AzureRMProfile -Environment AzureChinaCloud``` lists the profiles supported by the Azure China cloud.
28+
29+
Use ```Use-AzureRmProfile -Profile 2015-05``` to install and load cmdlets for one of the listed profiles.
30+
31+
```Get-AzureRMProfile -Endpoint https://manage.myazurestackinstance.com``` lists the profiles supported by the azure instance at the
32+
1333
## Targeting all Azure Instances
1434

35+
```Get-AzureRMProfile -Common``` lists the profiles that are supported by all Azure endpoints
36+
37+
Use ```Use-AzureRmProfile -Profile 2015-05``` to install and load cmdlets for one of the listed profiles.
38+
1539
## Targeting the Latest Stable Features
1640

41+
```Get-AzureRMProfile -Latest``` lists the latest profile supported by any Azure instance
42+
43+
Use ```Use-AzureRmProfile -Profile Latest``` to install and load cmdlets for one of the listed profiles.
44+
1745
## Targeting the latest preview features
1846

47+
Some very new Azure features may not be included in any Azure Profile. To access these features, Install and Load the latest version of the associated Azure module.
48+
49+
To load the latest version of Compute cmdlets, use:
50+
```Install-Module AzureRM.Compute```
51+
```Import-Module AzureRM.Compute```
52+
1953
# Using a Version Profile in a PowerShell Session
2054

55+
The AzureRM bootstrapper uses the PowerShell Gallery to install and load needed modules when you want to target a specific version profile.
56+
2157
## Acquire and Load All Azure modules using the BootStrapper
2258

59+
```
60+
Use-AzureRmProfile -Profile 2015-05 -Force
61+
```
62+
63+
Checks if the modules associated with the ```2015-05``` profile are installed in the current scope, downloads and installs the modules if necessary, and then loads the modules in the current session. You must open a new PowerShell session to target a different version profile. Using the ```Force``` parameter installs the necessary module swithout prompting.
64+
2365
## Acquire and Load Selected Azure modules using the Bootstrapper
2466

67+
```
68+
Use-AzureRmProfile -Profile 2015-05 -Module Compute, Storage, Network
69+
```
70+
71+
Checks if the AzureRM.Compute, AzureRM.Storage, and AzureRM.Network modules associated with the ```2015-05``` profile are installed in the current scope, downloads and installs the modules if necessary, and then loads the modules in the current session. You must open a new PowerShell session to target a different module.
72+
2573
## Acquire and Load Modules using PowerShellGet
2674

75+
```
76+
Find-Module -Name AzureRM -Tags "Profile:2015-05" | Install-Module
77+
```
78+
79+
Downloads the AzureRM modules associated with version Profile ```2015-05```
80+
2781
# Switching Between Version Profiles
2882

83+
To switch between version profiles on a machine, in a new PowerShell window, execute the following cmdlet:
84+
85+
```
86+
Use-AzureRmProfile -Profile 2015-05
87+
```
88+
89+
This loads the modules associated with the ```2015-05``` profile in the current session. You must open a new PowerShell session to target a different version profile.
90+
2991
# Setting the Default Version Profile for all PowerShell sessions
3092

3193
# Updating and Removing Profiles

0 commit comments

Comments
 (0)