Boxstarter Azure Module

This is not the latest version of Boxstarter Azure Module available.

  • 1
  • 2
  • 3

2.4.209 | Updated: 26 Apr 2015



Downloads of v 2.4.209:


Software Author(s):

  • Matt Wrock

  • 1
  • 2
  • 3
Boxstarter Azure Module 2.4.209

This is not the latest version of Boxstarter Azure Module available.

  • 1
  • 2
  • 3

Some Checks Have Failed or Are Not Yet Complete

Not All Tests Have Passed

Validation Testing Unknown

Verification Testing Unknown

Scan Testing Successful:

No detections found in any package files

Learn More

Deployment Method: Individual Install, Upgrade, & Uninstall

To install Boxstarter Azure Module, run the following command from the command line or from PowerShell:


To upgrade Boxstarter Azure Module, run the following command from the command line or from PowerShell:


To uninstall Boxstarter Azure Module, run the following command from the command line or from PowerShell:


Deployment Method:

📝 NOTE: This applies to both open source and commercial editions of Chocolatey.

1. Enter Your Internal Repository Url

(this should look similar to

2. Setup Your Environment

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

2. Get the package into your environment

  • Open Source or Commercial:
    • Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
    • You can also just download the package and push it to a repository Download

3. Copy Your Script

choco upgrade -y --source="'INTERNAL REPO URL'" --version="'2.4.209'" [other options]

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:

choco upgrade -y --source="'INTERNAL REPO URL'" --version="'2.4.209'" 

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0

Exit $exitCode

- name: Install
    version: '2.4.209'
    state: present

See docs at

chocolatey_package '' do
  action    :install
  source   'INTERNAL REPO URL'
  version  '2.4.209'

See docs at

    Name     = ""
    Version  = "2.4.209"
    Source   = "INTERNAL REPO URL"

Requires cChoco DSC Resource. See docs at

package { '':
  ensure   => '2.4.209',
  provider => 'chocolatey',
  source   => 'INTERNAL REPO URL',

Requires Puppet Chocolatey Provider module. See docs at

4. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

This package was approved as a trusted package on 26 Apr 2015.


Boxstarter's Azure module includes functionality for targeting Azure VMs with the ability to save and restore checkpoints leveraging blob snapshots.

$unNormalized=(Get-Item "$PSScriptRoot\..\Boxstarter.Chocolatey\Boxstarter.Chocolatey.psd1")
Import-Module $unNormalized.FullName -global -DisableNameChecking -Force
Resolve-Path $PSScriptRoot\*-*.ps1 | 
    % { . $_.ProviderPath }

#There is a bug where the storage module will not load if loaded after the azure module
try {Get-Module Storage -ListAvailable | Import-Module -global} catch { Log-BoxstarterMessage $_ }


Export-ModuleMember Enable-BoxstarterVM, Get-AzureVMCheckpoint, Set-AzureVMCheckpoint, Restore-AzureVMCheckpoint, Remove-AzureVMCheckpoint, Test-VMStarted
function Enable-BoxstarterVM {
Finds the PowerShell Remote ConnectionURI of an Azure VM and ensures it can be accessed

Ensures that an Azure VM can be accessed by Boxstarter. Checks the Azure PowerShell 
SDK settings are set correctly and also examines the VM endpoints to ensure the correct 
settings for PowerShell remoting. If necessary and if running with administrative 
privileges, the WinRM certificate of the VM is downloaded and installed. If not running 
with admin privileges, a PowerShell SessionOption is used that skips the CA and CN 
check. The VM's PowerShell remoting ConnectionURI is located and returned via a 
BoxstarterConfig instance.

Enable-BoxstarterVM will also restore the VM to a specified 
checkpoint or create a new checkpoint if the given checkpoint 
does not exist.

.Parameter Provider
The VM Provider to use.

.PARAMETER CloudServiceName
The name of the Azure Cloud Service associated with the VM.

The name of the VM to enable.

.PARAMETER Credential
The Credential to use to test PSRemoting.

.PARAMETER CheckpointName
If a Checkpoint exists by this name, it will be restored. Otherwise one will be created.

Boxstarter uses Azure Blob snapshots to create and manage VM checkpoints. These 
will not be found in the Azure portal, but you can use Boxstarter's checkpoint 
commands to manage them: Set-AzureVMCheckpoint, Get-AzureVMCheckpoint, 
Restore-AzureVMCheckpoint and Remove-AzureVMCheckpoint.

The Windows Azure PowerShell SDK and the .NET Libraries SDK are both used to 
manage the Azure VMs and Blobs.

A BoxstarterConnectionConfig that contains the ConnectionURI of the VM Computer and 
the PSCredential needed to authenticate.

$cred=Get-Credential AzureAdmin
New-AzureQuickVM -ServiceName MyService -Windows -Name MyVM `
  -ImageName 3a50f22b388a4ff7ab41029918570fa6__Windows-Server-2012-Essentials-20131217-enus `
  -Password $cred.GetNetworkCredential().Password -AdminUsername $cred.UserName `
  -Location "West US" -WaitForBoot
Enable-BoxstarterVM -Provider Azure -CloudServiceName MyService -VMName MyVM $cred NewSnapshot | Install-BoxstarterPackage MyPackage

Uses the Azure PowerShell SDK to create a new VM. Enable-BoxstarterVM 
then installs the WinRM certificate and obtains the VM's ConnectionURI 
which is piped to Install-BoxstarterPackage to install MyPackage.

Enable-BoxstarterVM -Provider Azure -CloudServiceName MyService -VMName MyVM $cred

Installs the WinRM certificate associated with the VM and locates its ConnectionURI

Enable-BoxstarterVM -Provider Azure -CloudServiceName MyService -VMName MyVM $cred | Install-BoxstarterPackage MyPackage

Obtains the VM ConnectionURI and uses that to install MyPackage

Enable-BoxstarterVM -Provider Azure -CloudServiceName MyService -VMName MyVM $cred ExistingSnapshot | Install-BoxstarterPackage MyPackage

Gets MyVM's ConnectionURI, restores it to the state stored in ExistingSnapshot 
and then installs MyPackage

Enable-BoxstarterVM -Provider Azure -CloudServiceName MyService -VMName MyVM $cred NewSnapshot | Install-BoxstarterPackage MyPackage

Gets MyVM's ConnectionURI, creates a new snapshot named NewSnapshot and 
then installs MyPackage


        [parameter(Mandatory=$true, Position=0)]
        [parameter(Mandatory=$true, ValueFromPipeline=$True, Position=1)]
        [parameter(Mandatory=$true, Position=2)]
        [parameter(Mandatory=$false, Position=3)]
    Begin {

        $subscription=Get-AzureSubscription -Current
        if($subscription -eq $null){
            throw @"
Your Azure subscription information has not been sent.
Run Get-AzurePublishSettingsFile to download your Publisher settings.
Then run Import-AzurePublishSettingsFile with the settings file.
Once that is done, please run Enable-BoxstarterVM again.

        if($PSBoundParameters["Verbose"] -eq $true) {

    Process {
        try {
            $VMName | % { 
                Write-BoxstarterMessage "Locating Azure VM $_..."
                $vm = Invoke-RetriableScript { Get-AzureVM -ServiceName $args[0] -Name $args[1] } $CloudServiceName $_
                if($vm -eq $null){
                    throw New-Object -TypeName InvalidOperationException -ArgumentList "Could not find VM: $_"

                if($subscription.CurrentStorageAccountName -eq $null) {
                    Write-BoxstarterMessage "Getting OS Disk" -Verbose
                    $disk=Invoke-RetriableScript { Get-AzureOSDisk -VM $args[0] } $vm
                    Write-BoxstarterMessage "Getting Azure Storage Account" -Verbose
                    $storageAccount=Invoke-RetriableScript { Get-AzureStorageAccount } | ? { $_.Endpoints -contains $endpoint }
                    Set-AzureSubscription -SubscriptionName $subscription.SubscriptionName -CurrentStorageAccountName $storageAccount.Label

                if($CheckpointName -ne $null -and $CheckpointName.Length -gt 0){
                    $snapshot = Get-AzureVMCheckpoint -VM $vm -CheckpointName $CheckpointName
                    if($snapshot -ne $null) {
                        Restore-AzureVMCheckpoint -VM $vm -CheckpointName $CheckpointName

                if($vm.InstanceStatus -ne "ReadyRole"){
                    Write-BoxstarterMessage "Starting Azure VM $_..."
                    Invoke-RetriableScript { Start-AzureVM -Name $args[0] -ServiceName $args[1] } $_ $CloudServiceName | Out-Null
                    Wait-ReadyState -ServiceName $CloudServiceName  -VMName $_

                if(!(Test-Admin)) {
                    $PSSessionOption = New-PSSessionOption -SkipCACheck -SkipCNCheck
                else {
                    Install-WinRMCert $vm | Out-Null

                Write-BoxstarterMessage "Getting connection URI" -Verbose
                $uri = Invoke-RetriableScript { Get-AzureWinRMUri -serviceName $args[0] -Name $args[1] } $CloudServiceName $_
                if($uri -eq $null) {
                    throw New-Object -TypeName InvalidOperationException -ArgumentList "WinRM Endpoint is not configured on VM. Use Add-AzureEndpoint to add PowerShell remoting endpoint and use Enable-PSRemoting -Force on the VM to enable PowerShell remoting."
                Write-BoxstarterMessage "URI: $uri" -Verbose
                Enable-BoxstarterClientRemoting $ComputerName | out-Null
                Write-BoxstarterMessage "Testing remoting access on $ComputerName..."
                try {
                    Invoke-RetriableScript { Invoke-Command $args[0] { Get-WmiObject Win32_ComputerSystem } -Credential $args[1] -ErrorAction Stop | Out-Null } $uri $Credential 
                catch {
                    Write-BoxstarterMessage "Failed to establish a remote connection with $uri. Use Enable-PSRemoting -Force on the VM to enable PowerShell remoting. Install will continue since this may be a transient error. The error encountered was $($_.ToString())" -Verbose
                if(!$restored -and $CheckpointName -ne $null -and $CheckpointName.Length -gt 0) {
                    Write-BoxstarterMessage "Creating Checkpoint $CheckpointName for service $CloudServiceName VM $_ at $CheckpointFile"
                    Set-AzureVMCheckpoint -VM $vm -CheckpointName $CheckpointName | Out-Null

                $res=new-Object -TypeName BoxstarterConnectionConfig -ArgumentList $uri,$Credential,$PSSessionOption
                return $res
        finally {

function Wait-ReadyState($ServiceName, $vmName) {
    do {
        Start-Sleep -milliseconds 100
        Write-BoxstarterMessage "Checking VM for ReadyRole status...Hey VM!, are you ready to roll?..." -Verbose
    until (( Invoke-RetriableScript { (Get-AzureVM -ServiceName $args[0] -Name $args[1]).InstanceStatus } $ServiceName $vmName ) -eq "ReadyRole")
function Get-AzureVMCheckpoint {
Retrieves Azure Blob Snapshots for a VM

Blob snapshots created for a VM are returned. This command can return all 
snapshots for a specific VM or for a single checkpoint specified by name.

The VM Instance of the Azure Virtual Machine to query for checkpoints.

.PARAMETER $CheckpointName
The Name of a specific checkpoint to return. If not provided, all 
checkpoints for the VM will be returned.

$VM = Get-AzureVM -ServiceName "mycloudService" -Name "MyVM"
Get-AzureVMCheckpoint -VM $VM -CheckpointName "Clean"

Retrieves the "clean" checkpoint associated with the MyVM VM

$VM = Get-AzureVM -ServiceName "mycloudService" -Name "MyVM"
Get-AzureVMCheckpoint -VM $VM

Retrieves all checkpoints associated with the MyVM VM

    param (
        [parameter(Mandatory=$true, Position=0)]
        [parameter(Mandatory=$false, Position=1)]
    $blob=Get-Blob $VM
    if($CheckpointName -ne $null -and $CheckpointName.Length -gt 0){
        $CheckpointName = "$(Get-CheckpointPrefix $VM)-$CheckpointName"

    $options = New-Object Microsoft.WindowsAzure.StorageClient.BlobRequestOptions
    $options.BlobListingDetails = "Snapshots,Metadata"
    $options.UseFlatBlobListing = $true
    $snapshots = Query-BlobSnapshots $blob $options

    return $snapshots | ? { 
        ($CheckpointName -eq $null -or $CheckpointName.Length -eq 0 -or $_.Metadata["name"] -eq $CheckpointName) -and $_.SnapshotTime -ne $null
    } | % { 
        if($_.Metadata["name"].ToLower().StartsWith((Get-CheckpointPrefix $VM).ToLower())) {
            New-Object PSObject -Prop @{
                Name=$_.Metadata["name"].Substring((Get-CheckpointPrefix $VM).Length+1)

 function Query-BlobSnapshots($blob, $options) {
    return $blob.Container.ListBlobs($options)
function Get-Blob {
    param (

    $storageAccount = (Get-AzureSubscription -current).CurrentStorageAccountName
    if($storageAccount -eq $null){
        throw New-Object -TypeName InvalidOperationException -ArgumentList "The CurrentStorageAccountName has not been set. Use Set-AzureSubscription to set your current storage account"

    Write-BoxstarterMessage "Getting azure storage key..." -Verbose
    $key = Invoke-RetriableScript { (Get-AzureStorageKey -StorageAccountName $args[0]).Primary } $storageAccount
    $creds = New-Object Microsoft.WindowsAzure.StorageCredentialsAccountAndKey($storageAccount,$key)

    Write-BoxstarterMessage "Getting OS disk..." -Verbose
    $vmOSDisk=Invoke-RetriableScript { Get-AzureOSDisk -vm $args[0] } $VM
    $blobURI = $vmOSDisk.MediaLink
    $blobPath = $BlobUri.LocalPath.Substring(1)
    $blobClient = New-Object Microsoft.WindowsAzure.StorageClient.CloudBlobClient("http://$($blobUri.Host)", $creds)
    return $blobClient.GetBlobReference($blobPath)
function Get-CheckpointPrefix{
    param (
        return "$($VM.ServiceName)-$($VM.Name)"

function Import-AzureModule {
    $azureMod = Get-Module Azure -ListAvailable
    if(!$azureMod) {
        if(${env:ProgramFiles(x86)} -ne $null){ $programFiles86 = ${env:ProgramFiles(x86)} } else { $programFiles86 = $env:ProgramFiles }
        $modulePath="$programFiles86\Microsoft SDKs\Azure\PowerShell\ServiceManagement\Azure\Azure.psd1"
        if(Test-Path $modulePath) {
            Import-Module $modulePath -global
    else {
        $azureMod | Import-Module -global
function Install-WinRMCert($VM)
 $winRMCert = ($VM | select -ExpandProperty vm).DefaultWinRMCertificateThumbprint
 if($winRMCert -eq $null){ 
    $X509=Get-AzureCertificate -ServiceName $vm.serviceName -ThumbprintAlgorithm sha1
    else {
        Write-BoxstarterMessage "Could not find Certificate" -Verbose

 Write-BoxstarterMessage "Installing WinRM Certificate"
 $AzureX509cert = Get-AzureCertificate -ServiceName $vm.serviceName -Thumbprint $winRMCert -ThumbprintAlgorithm sha1
 $certTempFile = [IO.Path]::GetTempFileName()
 $AzureX509cert.Data | Out-File $certTempFile
 # Target The Cert That Needs To Be Imported
 $CertToImport = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2 $certTempFile
 $store = New-Object System.Security.Cryptography.X509Certificates.X509Store "Root", "LocalMachine"
 Remove-Item $certTempFile
function Remove-AzureVMCheckpoint {
Deletes an Azure Blob checkpoint associated with a VM

Deletes an Azure Blob checkpoint associated with a VM.

The VM instance of the Azure Virtual Machine associated with the checkpoint to delete

.PARAMETER $CheckpointName
The Name of a the checkpoint to delete

$VM = Get-AzureVM -ServiceName "mycloudService" -Name "MyVM"
Remove-AzureVMCheckpoint -VM $VM -CheckpointName "Clean"

Deletes the "clean" checkpoint associated with the MyVM VM

    param (
        [parameter(Mandatory=$true, Position=0)]
        [parameter(Mandatory=$true, Position=1)]
    $checkpoint=Get-AzureVMCheckpoint @PSBoundParameters

    if($checkpoint -eq $null) {
        throw New-Object -TypeName ArgumentException -ArgumentList "CheckpointName","No checkpoint found with name $checkpointname for VM $($VM.Name)"

function Restore-AzureVMCheckpoint {
Restores an Azure VM with a previously set checkpoint

Restores the state of a VM with a Blob snapshot previously created with Set-AzureVMCheckpoint.

The VM instance of the Azure Virtual Machine to restore

.PARAMETER $CheckpointName
The Name of a the checkpoint to apply

$VM = Get-AzureVM -ServiceName "mycloudService" -Name "MyVM"
Restore-AzureVMCheckpoint -VM $VM -CheckpointName "Clean"

Restores MyVM to the state it was in when the "clean" checkpoint was created

    param (
        [parameter(Mandatory=$true, Position=0)]
        [parameter(Mandatory=$true, Position=1)]
    $checkpoint = Get-AzureVMCheckpoint $vm $CheckpointName
    if($checkpoint -eq $null) {
        throw New-Object -TypeName ArgumentException -ArgumentList "CheckpointName","No checkpoint found with name $checkpointname for VM $($VM.Name)"

    $blob=Get-Blob $vm
    $exportPath = "$env:temp\boxstarterAzureCheckpoint$($vm.Name).xml"
    write-boxstartermessage "Getting OS Disk" -verbose
    $vmOSDisk=Invoke-RetriableScript { Get-AzureOSDisk -VM $args[0] } $VM

    Write-BoxstarterMessage "Exporting VM configuration for $($vm.ServiceName) of $serviceName service to $exportPath..."
    $exportResult = Export-AzureVM -ServiceName $vm.serviceName -Name $vm.Name -Path $exportPath
    if($exportResult -eq $null) {
        throw "Unable to export VM"

    Write-BoxstarterMessage "Removing Azure VM $($vm.Name)..."
    Invoke-RetriableScript { Remove-AzureVM -ServiceName $args[0].serviceName -Name $args[0].Name } $VM| Out-Null

    Write-BoxstarterMessage "Waiting for disk $($vmOSDisk.DiskName) to be free..."
    do {
        write-BoxstarterMessage "Still waiting..." -verbose
        Start-Sleep -milliseconds 100
    until ((Invoke-RetriableScript { (Get-AzureDisk -DiskName $args[0]).AttachedTo } $vmOSDisk.DiskName ) -eq $null)

    Write-BoxstarterMessage "Removing disk $($vmOSDisk.DiskName)..."
    Invoke-RetriableScript { Remove-AzureDisk -DiskName $args[0] } $vmOSDisk.DiskName | Out-Null

    Write-BoxstarterMessage "Copying $($checkpoint.snapshot.Uri) to blob..."

    Write-BoxstarterMessage "Creating new disk from blob..."
    Invoke-RetriableScript { Add-AzureDisk -DiskName $args[0] -MediaLocation $args[1] -OS Windows } $vmOSDisk.DiskName $blob.Uri | Out-Null

    Write-BoxstarterMessage "Creating new VM at Checkpoint..."
    Invoke-RetriableScript { Import-AzureVM -path $args[0] | New-AzureVM -ServiceName $args[1] -WaitForBoot } $exportPath $vm.serviceName | Out-Null
function Set-AzureVMCheckpoint {
Creates an Azure Blob checkpoint to capture the state of a VM

Creates an Azure Blob checkpoint to capture the state of a VM. This checkpoint can 
be later used to restore a VM to the state of the VM when the checkpoint was saved.

The VM instance of the Azure Virtual Machine to checkpoint

.PARAMETER $CheckpointName
The Name of a the checkpoint to save

$VM = Get-AzureVM -ServiceName "mycloudService" -Name "MyVM"
Set-AzureVMCheckpoint -VM $VM -CheckpointName "Clean"

Checkpoints MyVM with the label "clean" which can restore the VM to its current state

    param (
        [parameter(Mandatory=$true, Position=0)]
        [parameter(Mandatory=$true, Position=1)]
    $blob=Get-blob $VM

    $existingBlob = Get-AzureVMCheckpoint -VM $VM -CheckpointName $CheckpointName
    if($existingBlob -ne $null) {
    $CheckpointName = "$(Get-CheckpointPrefix $VM)-$CheckpointName"
    $attributes = New-Object System.Collections.Specialized.NameValueCollection
    return $blob.CreateSnapshot($attributes, $null)
function Test-VMStarted {
Checks if an Azure VM is in a running state

If the VM is running, Test-VMStarted returns $true

.PARAMETER CloudServiceName
The name of the Azure Cloud Service associated with the VM.

The name of the VM to enable.

$isStarted = Test-VMStarted -ServiceName "mycloudService" -Name "MyVM"

$isStarted will be $true if MyVM is running

        [parameter(Mandatory=$true, Position=0)]
        [parameter(Mandatory=$true, ValueFromPipeline=$True, Position=1)]

    Process {
        $VMName | % { 
            $vm = Invoke-RetriableScript { Get-AzureVM -ServiceName $args[0] -Name $args[1] } $CloudServiceName $_
            if($vm -eq $null){
                throw New-Object -TypeName InvalidOperationException -ArgumentList "Could not find VM: $_"
            if($vm.InstanceStatus -eq "ReadyRole"){
                Write-BoxStarterMessage "Testing service $CloudServiceName vm $_. VM is in ReadyRole." -verbose
                return $true
            else {
                Write-BoxStarterMessage "Testing service $CloudServiceName vm $_. VM is not in ReadyRole. Role: $($vm.InstanceStatus)" -verbose
                return $false
$tools = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
. (Join-Path $tools Setup.ps1)
try { 
    $ModuleName = (Get-ChildItem $tools | ?{ $_.PSIsContainer }).BaseName
    Install-Boxstarter "$(Split-Path -parent $MyInvocation.MyCommand.Definition)" $ModuleName $env:chocolateyPackageParameters
    Write-ChocolateySuccess $ModuleName
} catch {
    Write-ChocolateyFailure $ModuleName "$($_.Exception.Message)"
                                 Apache License
                           Version 2.0, January 2004


   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      implied, including, without limitation, any warranties or conditions
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.
function Install-Boxstarter($here, $ModuleName, $installArgs = "") {
    $boxstarterPath=Join-Path $env:AppData Boxstarter
    if(!(test-Path $boxstarterPath)){
        mkdir $boxstarterPath
    $packagePath=Join-Path $boxstarterPath BuildPackages
    if(!(test-Path $packagePath)){
        mkdir $packagePath
    foreach($ModulePath in (Get-ChildItem $here | ?{ $_.PSIsContainer })){
        $target=Join-Path $boxstarterPath $modulePath.BaseName
        if(test-Path $target){
            Remove-Item $target -Recurse -Force
    Copy-Item "$here\*" $boxstarterPath -Recurse -Force -Exclude ChocolateyInstall.ps1, Setup.*

    PersistBoxStarterPathToEnvironmentVariable "PSModulePath"
    PersistBoxStarterPathToEnvironmentVariable "Path"
    $binPath =  "$here\..\..\..\bin"
    $boxModule=Get-Module Boxstarter.Chocolatey
    if($boxModule) {
        if($boxModule.Path -like "$env:LOCALAPPDATA\Apps\*") {
        Import-Module "$boxstarterPath\$ModuleName" -DisableNameChecking -Force -ErrorAction SilentlyContinue
    $successMsg = @"
The $ModuleName Module has been copied to $boxstarterPath and added to your Module path. 
You will need to open a new console for the path to be visible.
Use 'Get-Module Boxstarter.* -ListAvailable' to list all Boxstarter Modules.
To list all available Boxstarter Commands, use:
PS:>Import-Module $ModuleName
PS:>Get-Command -Module Boxstarter.*

To find more info visit or use:
PS:>Import-Module $ModuleName
PS:>Get-Help Boxstarter
    Write-Host $successMsg

    if($ModuleName -eq "Boxstarter.Chocolatey" -and !$env:appdata.StartsWith($env:windir)) {
        $desktop = $([System.Environment]::GetFolderPath([System.Environment+SpecialFolder]::DesktopDirectory))
        $startMenu=$("$env:appdata\Microsoft\Windows\Start Menu\Programs\Boxstarter")
        if(!(Test-Path $startMenu)){
            mkdir $startMenu
        $targetArgs="-ExecutionPolicy bypass -NoExit -Command `"&'$boxstarterPath\BoxstarterShell.ps1'`""

		if($installArgs -inotcontains "nodesktopicon") {
			$link = Join-Path $desktop "Boxstarter Shell.lnk"
			Create-Shortcut $link $target $targetArgs $boxstarterPath
        $link = Join-Path $startMenu "Boxstarter Shell.lnk"
        Create-Shortcut $link $target $targetArgs $boxstarterPath

        Set-Content -Path "$binPath\BoxstarterShell.bat" -Force -Value "$target $TargetArgs"

function Create-Shortcut($location, $target, $targetArgs, $boxstarterPath) {
    $wshshell = New-Object -ComObject WScript.Shell
    $lnk = $wshshell.CreateShortcut($location)
    $lnk.TargetPath = $target
    $lnk.Arguments = "$targetArgs"
    $lnk.WorkingDirectory = $boxstarterPath

	$tempFile = "$env:temp\TempShortcut.lnk"
	$writer = new-object System.IO.FileStream $tempFile, ([System.IO.FileMode]::Create)
	$reader = new-object System.IO.FileStream $location, ([System.IO.FileMode]::Open)
	while ($reader.Position -lt $reader.Length)
		$byte = $reader.ReadByte()
		if ($reader.Position -eq 22) {
			$byte = 34
	Move-Item -Path $tempFile $location -Force
function PersistBoxStarterPathToEnvironmentVariable($variableName){
    $value = [Environment]::GetEnvironmentVariable($variableName, 'User')
        $values=($value -split ';' | ?{ !($_.ToLower() -match "\\boxstarter$")}) -join ';'
    elseif($variableName -eq "PSModulePath") {
        $values +="\WindowsPowerShell\Modules;$boxstarterPath"
    else {
        $values ="$boxstarterPath"
    if(!$value -or !($values -contains $boxstarterPath)){
        $values = $values.Replace(';;',';')
        [Environment]::SetEnvironmentVariable($variableName, $values, 'User')
        $varValue = Get-Content env:\$variableName
        $varValue += ";$boxstarterPath"
        $varValue = $varValue.Replace(';;',';')
        Set-Content env:\$variableName -value $varValue

Log in or click on link to see number of positives.

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Add to Builder Version Downloads Last Updated Status
Boxstarter Azure Module 2.12.0 1138 Tuesday, October 30, 2018 Approved
Boxstarter Azure Module 2.11.0 277 Wednesday, May 16, 2018 Approved
Boxstarter Azure Module 2.9.26 1091 Monday, June 19, 2017 Approved
Boxstarter Azure Module 2.9.24 345 Sunday, June 18, 2017 Approved
Boxstarter Azure Module 2.9.14 406 Friday, May 5, 2017 Approved
Boxstarter Azure Module 2.9.5 393 Thursday, March 30, 2017 Approved

  • Fixes boxstarte install hangs on PSv2 when installing boxstarter after the new chocolatey
    • Fixes PSModulePath that has the machine environment value stripped after chocolatey package installs
    • Restart Windows Updates service before beginning installation in case updates are already running in the background
    • Dont throw exception when removing the scheduled task and it did not exist
    • Fix remote installs on win 7 and 2008R2 by creating scheduled task before importing remote chocolatey module
    • Pass -y to chocolatey if the new one is installed to avoid red output looking like an error
    • Fix installing modules via the c# based chocolatey
    • Pin to last PS chocolatey version until we finih new choco compatibility
    • Fix running gists from weblauncher more than once in win7 and 2008 R2
    • Suppress caught errors in Invoke-FromScheduledTask from bubbling up to final result
    • Work around nuget.exe limitations of handling files in system profile directory
    • Provide improved error logging of chocolatey errors.
    • Fixes issue where windows update reboots maching in the midst of a run.
    • Fixes failures from exceptions thrown from bitlocker module even when bitlocker is not in use.
    • Fixes Invoke-Reboot from a nested package and bubbles up the reboot signal
    • Update docs to reflect github as repo home and remove all codeplex links
    • Fix for all write-host calls being logged to Boxstarter log file even when there is no install session in progress
    • fixing issue where auto login is not disabled after boxstarter run
    • fixing wait for published version to retry for a minute if the new version is not yet marked published
    • Improve initial connectin performance by skipping remoting check if it has already been tested in enable-BoxstarterVM
    • provide messaging for some winconfig functions
    • fix the setting of azure storage account by looking for https endpoints
    • load storage module before azure to workaround bug with the storage module loading
    • copy the root path passed to New_BoxstarerPackage
    • add a DisableRestart parameter which will suppress the restart file and UAC enabling
    • Greatly improve progress messaging during windows updates runs
    • Fix hang scenarios when waiting for remote machine to reboot and landing in a pending reboot state shortly after reboot
    • Support for auto login and restart in winrm sessions
    • Fix issue with remote check causing an indefinite loop
    • Silencing some handled errors and keep them from leaking to the pipeline
    • Reduce WMI calls and Improve performance of testing if the current session is remote
    • When forcing the install of the outer boxstarter package, make sure to delete the last install from the right repo
    • Check scheduled task output for pending reboots after a remote windows update since 32 bit processes cant read the wsus registry keys
    • Fix Remote check when running as a servise
    • System user logs to programdata
    • when accessing a 64 bit machine from a 32bit process, the windowsupdate reg key is hidden so skip it
    • Bubble up errors from windows update
    • Provide the same scheduled task wrapping for winrm as we do for ps remoting
    • fix explorer restart when there is no explorer process
    • Correcting fallback Chocolatey install path to match release
    • Fixing typo param name in redirect call to set-WindowsExplorerOptions
    • Fix InvalidArgument from Set-TaskbarOptions when using lock or unlock params
    • Fix issues where explorer terminates and cannot restart after caling one of the winconfig functions
    • Import azure module from the pipeline to avoid errors when loading
    • Suppress errors when reenabling windows update in case they had alrady been reenabled
    • Fix mis encoded dash in Install-Boxstarterackage
    • Fix issues when Chocolatey packages create a new module and call chocolatey functions from that module
    • When building packages, skip folders without a nuspec instead of throwing an error
    • Only restart the explore process of the current user when calling windows config functions
    • Fixing .net 4.5 install for local installs
    • Fixing TestRunner module loading for PSv2 clients
    • Add the following windows config features:
    • Enable/Disable showing charms when mouse is in the upper right corner
    • Enable/Disable switching apps when pointing in the upper left corner
    • Enable/Disable the option to launch powershell from win-x
    • Enable/Disable boot to desktop
    • Enable/Disable desktop background on the start screen
    • Enable/Disable showing the start screen on the active display
    • Enable/Disable showing the Apps View by default on the start screen
    • Enable/Disable searching everywhere in apps view. Not just apps.
    • Enable/Disable showing desktop apps first in results
    • Lock/Unlock task bar
    • Change taskbar icon size
    • Change location of taskbar docking
    • Add test and publish automation that can point to remote deployment targets
    • Provide build scripts for integration of tests and publishing in CI servers
    • Include configured nuget sources and local repo to all chocolatey install calls and not just the initial package
    • Fix enabling powershell remoting via WMI when password has ampersands
    • Avoid explorer.exe crashes when configuring explorer options
    • Fix Hyper-V heartbeat check in non US locales
    • Fix Azure module loading in 32 bit consoles
    • Fix shell shortcuts when user name has a space
    • Fix Azure VM Checkpoint listing when there are more than one VM in a service
    • Install .net 4.5 ONLY without affecting IIS settings when .net 4 is not present
    • Fix Azure VM integration when multiple subscriptions are present
    • Allow remote installs to be run by a non amin user
Discussion for the Boxstarter Azure Module Package

Ground Rules:

  • This discussion is only about Boxstarter Azure Module and the Boxstarter Azure Module package. If you have feedback for Chocolatey, please contact the Google Group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or Boxstarter Azure Module, or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.
comments powered by Disqus