Skip to content

Fixing spelling mistakes #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 11, 2016
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions tools/AzureRM.BootStrapper/help/about_version_profiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,39 +6,39 @@ schema: 2.0.0

# About Version Profiles

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.
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 can then select these Azure PowerShell module versions and be confident that their scripts will work when targeting those Azure instances.

The AzureRM.Bootstrapper module provides cmdlets to discover, acquire, and use modules that are appropriate for the azure version profile you are targeting.

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```

# Finding appropriate version profiles

Use the ```Get-AzureRMVersionProfile``` cmdlet to discover availabel profile versions, and profile versions supported by an Azure instance.
Use the ```Get-AzureRMVersionProfile``` cmdlet to discover available profile versions, and profile versions supported by an Azure instance.

```Get-AzureRmProfile -ListAvailable``` lists all available version profiles.

```Get-AzureRMProfile -Environment AzureChinaCloud``` lists the profiles supported by the Azure China cloud.

```Get-AzureRMProfile -Endpoint https://manage.myazurestackinstance.com``` lists the profiles supported by the azure instance at the given endpoint
```Get-AzureRMProfile -Endpoint https://manage.myazurestackinstance.com``` lists the profiles supported by the azure instance at the given endpoint.

## Targeting a concrete Azure instance

```Get-AzureRMProfile -Environment AzureChinaCloud``` lists the profiles supported by the Azure China cloud.

Use ```Use-AzureRmProfile -Profile 2015-05``` to install and load cmdlets for one of the listed profiles.

```Get-AzureRMProfile -Endpoint https://manage.myazurestackinstance.com``` lists the profiles supported by the azure instance at the
```Get-AzureRMProfile -Endpoint https://manage.myazurestackinstance.com``` lists the profiles supported by the azure instance at the given endpoint.

## Targeting all Azure Instances

```Get-AzureRMProfile -Common``` lists the profiles that are supported by all Azure endpoints
```Get-AzureRMProfile -Common``` lists the profiles that are supported by all Azure endpoints.

Use ```Use-AzureRmProfile -Profile 2015-05``` to install and load cmdlets for one of the listed profiles.

## Targeting the Latest Stable Features

```Get-AzureRMProfile -Latest``` lists the latest profile supported by any Azure instance
```Get-AzureRMProfile -Latest``` lists the latest profile supported by any Azure instance.

Use ```Use-AzureRmProfile -Profile Latest``` to install and load cmdlets for one of the listed profiles.

Expand All @@ -60,7 +60,7 @@ The AzureRM bootstrapper uses the PowerShell Gallery to install and load needed
Use-AzureRmProfile -Profile 2015-05 -Force
```

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.
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 modules without prompting.

## Acquire and Load Selected Azure modules using the Bootstrapper

Expand Down