PowerShell for Azure Stack をインストールするInstall PowerShell for Azure Stack

適用対象:Azure Stack 統合システムと Azure Stack Development KitApplies to: Azure Stack integrated systems and Azure Stack Development Kit

クラウドで動作させるには、Azure Stack と互換のある PowerShell モジュールをインストールする必要があります。To work with your cloud, you must install Azure Stack compatible PowerShell modules. 互換性は、API プロファイルと呼ばれる機能によって有効になります。Compatibility is enabled through a feature called API profiles.

API のプロファイルは、Azure と Azure Stack の間のバージョンの違いを管理するための方法を提供します。API profiles provide a way to manage version differences between Azure and Azure Stack. API バージョンのプロファイルは、特定の API バージョンを持つ一連の Azure Resource Manager PowerShell モジュールです。An API version profile is a set of Azure Resource Manager PowerShell modules with specific API versions. 各クラウド プラットフォームでは、一連の API バージョンのプロファイルがサポートされています。Each cloud platform has a set of supported API version profiles. たとえば、Azure Stack では 2018-03-01-hybrid などの特定のプロファイル バージョンがサポートされます。For example, Azure Stack supports a specific profile version such as 2018-03-01-hybrid. プロファイルをインストールすると、指定されたプロファイルに対応する Azure Resource Manager PowerShell モジュールがインストールされます。When you install a profile, the Azure Resource Manager PowerShell modules that correspond to the specified profile are installed.

Azure Stack と互換のある PowerShell モジュールのインストールは、インターネットに接続されたシナリオ、部分的に接続されたシナリオ、接続が切断されたシナリオのいずれでも可能です。You can install Azure Stack compatible PowerShell modules in Internet connected, partially connected, or disconnected scenarios. この記事では、各シナリオで PowerShell for Azure Stack をインストールするための詳しい手順を説明します。This article walks through the detailed instructions to install PowerShell for Azure Stack for these scenarios.

1.前提条件を確認する1. Verify your prerequisites

Azure Stack と PowerShell を開始する前に、次の前提条件が必要です。Before you get started with Azure Stack and PowerShell, you must have the following prerequisites:

  • PowerShell Version 5.0 使用しているバージョンを確認するには、$PSVersionTable.PSVersion を実行して、メジャー バージョンを比較します。PowerShell Version 5.0 To check your version, run $PSVersionTable.PSVersion and compare the Major version. PowerShell 5.0 を使用していない場合は、Installing Windows PowerShell (Windows PowerShell のインストール) に従ってください。If you do not have PowerShell 5.0, follow the Installing Windows PowerShell.

    注意

    PowerShell 5.0 には、Windows コンピューターが必要です。PowerShell 5.0 requires a Windows machine.

  • PowerShell の実行 (管理者特権でのコマンド プロンプト)Run Powershell in an elevated command prompt. PowerShell を管理特権で実行する必要があります。You must run PowerShell with administrative privileges.

  • PowerShell ギャラリーへのアクセス PowerShell ギャラリーにアクセスする必要があります。PowerShell Gallery access You need access to the PowerShell Gallery. ギャラリーとは、PowerShell コンテンツのための中央のリポジトリです。The gallery is the central repository for PowerShell content. PowerShellGet モジュールには、PowerShell ギャラリーやその他のプライベート リポジトリから PowerShell アーティファクト (モジュール、DSC リソース、ロール機能、スクリプトなど) を検出、インストール、更新、発行するためのコマンドレットが含まれています。The PowerShellGet module contains cmdlets for discovering, installing, updating, and publishing PowerShell artifacts such as modules, DSC resources, role capabilities, and scripts from the PowerShell Gallery and other private repositories. 切断されたシナリオで PowerShell を使用している場合は、インターネットに接続しているマシンからリソースを取得し、切断されたマシンがアクセスできる場所に格納する必要があります。If you are using PowerShell in a disconnected scenario, you must retrieve resources from a machine with a connection to the Internet and store them in a location accessible to your disconnected machine.

PSGallery がリポジトリとして登録されているかどうかを検証します。Validate if PSGallery is registered as a repository.

注意

この手順では、インターネットへのアクセスが必要です。This step requires Internet access.

管理者特権の PowerShell プロンプトを開き、次のコマンドレットを実行します。Open an elevated PowerShell prompt, and run the following cmdlets:

Import-Module -Name PowerShellGet -ErrorAction Stop
Import-Module -Name PackageManagement -ErrorAction Stop
Get-PSRepository -Name "PSGallery"

PSGallery リポジトリが登録されていない場合は、管理者特権の PowerShell セッションを開き、次のコマンドを実行します。If the repository is not registered, open an elevated PowerShell session and run the following command:

Register-PsRepository -Default
Set-PSRepository -Name "PSGallery" -InstallationPolicy Trusted

手順 3.既存のバージョンの Azure Stack PowerShell モジュールのアンインストール3. Uninstall existing versions of the Azure Stack PowerShell modules

必要なバージョンをインストールする前に、必ず以前にインストールした Azure Stack AzureRM PowerShell モジュールをアンインストールしてください。Before installing the required version, make sure that you uninstall any previously installed Azure Stack AzureRM PowerShell modules. アンインストールには、次の 2 つの方法の 1 つを使用できます。You can uninstall them by using one of the following two methods:

  1. 既存の AzureRM PowerShell モジュールをアンインストールするには、アクティブな PowerShell セッションをすべて終了し、次のコマンドレットを実行します。To uninstall the existing AzureRM PowerShell modules, close all the active PowerShell sessions, and run the following cmdlets:

    Get-Module -Name Azs.* -ListAvailable | Uninstall-Module -Force -Verbose
    Get-Module -Name Azure* -ListAvailable | Uninstall-Module -Force -Verbose
    

    「モジュールが既に使用されています」などのエラーが発生した場合には、そのモジュールを使用している PowerShell セッションを終了してから、上のスクリプトをもう一度実行してください。If you hit an error such as 'The module is already in use', please close the PowerShell sessions that are using the modules and rerun the above script.

  2. C:\Program Files\WindowsPowerShell\Modules フォルダーおよび C:\Users\{yourusername}\Documents\WindowsPowerShell\Modules フォルダーから、Azure または Azs. で始まるすべてのフォルダーを削除します。Delete all the folders that start with Azure or Azs. from the C:\Program Files\WindowsPowerShell\Modules and C:\Users\{yourusername}\Documents\WindowsPowerShell\Modules folders. これらのフォルダーを削除すると、既存の PowerShell モジュールがすべて削除されます。Deleting these folders removes any existing PowerShell modules.

4.接続済みの場合: インターネット接続を使用して PowerShell for Azure Stack をインストールする4. Connected: Install PowerShell for Azure Stack with Internet connectivity

Azure Stack では、Azure Stack バージョン 1808 以降の 2018-03-01-hybrid API バージョン プロファイルが必要です。Azure Stack requires the 2018-03-01-hybrid API version profile for Azure Stack version 1808 or later. このプロファイルは、AzureRM.BootStrapper モジュールをインストールすると使用できるようになります。The profile is available by installing the AzureRM.BootStrapper module. AzureRM モジュールだけでなく、Azure Stack 固有の PowerShell モジュールもインストールする必要があります。In addition, to the AzureRM modules, you should also install the Azure Stack-specific PowerShell modules. 必要な API バージョン プロファイルおよび Azure Stack PowerShell モジュールは、実行している Azure Stack のバージョンによって異なります。The API version profile and Azure Stack PowerShell modules you require will depend on the version of Azure Stack your are running.

インストールには 3 つの手順があります:Installation has three steps:

  1. Azure Stack のバージョンに応じて Azure Stack PowerShell をインストールするInstall Azure Stack PowerShell depending on your version of Azure Stack
  2. 追加のストレージ機能を有効にするEnable additional storage features
  3. PowerShell のインストールを確認するConfirm the installation of PowerShell

Azure Stack PowerShell のインストールInstall Azure Stack PowerShell

次の PowerShell スクリプトを実行して、これらのモジュールを開発用ワークステーションにインストールします。Run the following PowerShell script to install these modules on your development workstation:

  • Azure Stack 1901 以降:Azure Stack 1901 or later:

    # Install and import the API Version Profile required by Azure Stack into the current PowerShell session.
    
    Install-Module AzureRM -RequiredVersion 2.4.0
    Install-Module -Name AzureStack -RequiredVersion 1.7.1
    

    注意

    Azure Stack モジュール バージョン 1.7.1 は破壊的変更を伴うリリースです。The Azure Stack module version 1.7.1 is a breaking change release. Azure Stack 1.6.0 から移行するには、移行ガイドを参照してください。To migrate from Azure Stack 1.6.0 please refer to the migration guide. AzureRm モジュール バージョン 2.4.0 には、コマンドレット Remove-AzureRmStorageAccount について破壊的変更が存在します。The AzureRm module version 2.4.0 comes with a breaking change for the cmdlet Remove-AzureRmStorageAccount. このコマンドレットでは、確認なしでストレージ アカウントを削除する際に -Force パラメーターを指定する必要があります。This cmdlet expects -Force parameter to be specified for removing the storage account without confirmation.

  • Azure Stack 1811:Azure Stack 1811:

    # Install the AzureRM.BootStrapper module. Select Yes when prompted to install NuGet
    Install-Module -Name AzureRM.BootStrapper
    
    # Install and import the API Version Profile required by Azure Stack into the current PowerShell session.
    Use-AzureRmProfile -Profile 2018-03-01-hybrid -Force
    
    Install-Module -Name AzureStack -RequiredVersion 1.6.0
    
  • Azure Stack 1810 以前:Azure Stack 1810 or earlier:

    # Install the AzureRM.BootStrapper module. Select Yes when prompted to install NuGet
    Install-Module -Name AzureRM.BootStrapper
    
    # Install and import the API Version Profile required by Azure Stack into the current PowerShell session.
    Use-AzureRmProfile -Profile 2018-03-01-hybrid -Force
    
    Install-Module -Name AzureStack -RequiredVersion 1.5.0
    

注意

Azure PowerShell を 2017-03-09-profile から 2018-03-01-hybrid にアップグレードするには、移行ガイドを参照してください。To upgrade Azure PowerShell from the 2017-03-09-profile to 2018-03-01-hybrid, please see the Migration guide.

追加のストレージ機能を有効にするEnable additional storage features

「接続済みの場合」のセクションで触れた追加のストレージ機能を利用する場合は、次のパッケージもダウンロードしてインストールしてください。To make use of the additional storage features (mentioned in the connected section), download and install the following packages as well.

# Install the Azure.Storage module version 4.5.0
Install-Module -Name Azure.Storage -RequiredVersion 4.5.0 -Force -AllowClobber

# Install the AzureRm.Storage module version 5.0.4
Install-Module -Name AzureRM.Storage -RequiredVersion 5.0.4 -Force -AllowClobber

# Remove incompatible storage module installed by AzureRM.Storage
Uninstall-Module Azure.Storage -RequiredVersion 4.6.1 -Force

# Load the modules explicitly specifying the versions
Import-Module -Name Azure.Storage -RequiredVersion 4.5.0
Import-Module -Name AzureRM.Storage -RequiredVersion 5.0.4

PowerShell のインストールを確認するConfirm the installation of PowerShell

次のコマンドを実行してインストールを確認します。Confirm the installation by running the following command:

Get-Module -Name "Azure*" -ListAvailable
Get-Module -Name "Azs*" -ListAvailable

インストールに成功した場合、出力に AzureRM および AzureStack モジュールが表示されます。If the installation is successful, the AzureRM and AzureStack modules are displayed in the output.

5.切断状態の場合: インターネット接続なしで PowerShell をインストールする5. Disconnected: Install PowerShell without an Internet connection

接続が切断されたシナリオでは、まずインターネット接続が確立されたコンピューターに PowerShell モジュールをダウンロードしてから、モジュールを Azure Stack Development Kit に転送してインストールします。In a disconnected scenario, you must first download the PowerShell modules to a machine that has Internet connectivity, and then transfer them to the Azure Stack Development Kit for installation.

インターネット接続が確立されたコンピューターにサインインし、Azure Stack のバージョンに応じて次のスクリプトを使用して、Azure Resource Manager および AzureStack パッケージをダウンロードします。Sign in to a computer with Internet connectivity and use the following scripts to download the Azure Resource Manager and AzureStack packages, depending on your version of Azure Stack.

インストールには 4 つの手順があります:Installation has four steps:

  1. 接続されているコンピューターに Azure Stack PowerShell をインストールするInstall Azure Stack PowerShell to a connected machine
  2. 追加のストレージ機能を有効にするEnable additional storage features
  3. 接続が切断されたワークステーションに PowerShell パッケージを転送するTransport the PowerShell packages to your disconnected workstation
  4. PowerShell のインストールを確認するConfirm the installation of PowerShell

Azure Stack PowerShell のインストールInstall Azure Stack PowerShell

  • Azure Stack 1901 以降。Azure Stack 1901 or later.

    Import-Module -Name PowerShellGet -ErrorAction Stop
    Import-Module -Name PackageManagement -ErrorAction Stop
    
    $Path = "<Path that is used to save the packages>"
    Save-Package -ProviderName NuGet -Source https://www.powershellgallery.com/api/v2 -Name AzureRM -Path $Path -Force -RequiredVersion 2.4.0
    Save-Package -ProviderName NuGet -Source https://www.powershellgallery.com/api/v2 -Name AzureStack -Path $Path -Force -RequiredVersion 1.7.1
    

    注意

    Azure Stack モジュール バージョン 1.7.1 は破壊的変更です。The Azure Stack module version 1.7.1 is a breaking change. AzureStack 1.6.0 から移行するには、移行ガイドを参照してください。To migrate from AzureStack 1.6.0 please refer to the migration guide.

    • Azure Stack 1811 以前。Azure Stack 1811 or earlier.

      Import-Module -Name PowerShellGet -ErrorAction Stop
      Import-Module -Name PackageManagement -ErrorAction Stop
      
      $Path = "<Path that is used to save the packages>"
      Save-Package -ProviderName NuGet -Source https://www.powershellgallery.com/api/v2 -Name AzureRM -Path $Path -Force -RequiredVersion 2.3.0
      Save-Package -ProviderName NuGet -Source https://www.powershellgallery.com/api/v2 -Name AzureStack -Path $Path -Force -RequiredVersion 1.6.0
      
    • Azure Stack 1809 以前: Azure Stack 1809 or earlier.

      Import-Module -Name PowerShellGet -ErrorAction Stop
      Import-Module -Name PackageManagement -ErrorAction Stop
      
      $Path = "<Path that is used to save the packages>"
      Save-Package -ProviderName NuGet -Source https://www.powershellgallery.com/api/v2 -Name AzureRM -Path $Path -Force -RequiredVersion 2.3.0
      Save-Package -ProviderName NuGet -Source https://www.powershellgallery.com/api/v2 -Name AzureStack -Path $Path -Force -RequiredVersion 1.5.0
      

      注意

      インターネット接続のないマシンでは、次のコマンドレットを実行して利用統計情報の収集を無効にすることをお勧めします。On machines without an Internet connection, we recommend executing the following cmdlet for disabling the telemetry data collection. 利用統計情報の収集を無効にしないと、コマンドレットのパフォーマンスが低下することがあります。You may experience a performance degradation of the cmdlets without disabling the telemetry data collection. これは、インターネット接続のないマシンのみ該当します。This is applicable only for the machines without internet connections

      Disable-AzureRmDataCollection
      

追加のストレージ機能を有効にするEnable additional storage features

「接続済みの場合」のセクションで触れた追加のストレージ機能を利用する場合は、次のパッケージもダウンロードしてインストールしてください。To make use of the additional storage features (mentioned in the connected section), download and install the following packages as well.

$Path = "<Path that is used to save the packages>"
Save-Package -ProviderName NuGet -Source https://www.powershellgallery.com/api/v2 -Name Azure.Storage -Path $Path -Force -RequiredVersion 4.5.0
Save-Package -ProviderName NuGet -Source https://www.powershellgallery.com/api/v2 -Name AzureRm.Storage -Path $Path -Force -RequiredVersion 5.0.4

パッケージをワークステーションに追加するAdd your packages to your workstation

  1. ダウンロードしたパッケージを USB デバイスにコピーします。Copy the downloaded packages to a USB device.

  2. 接続が切断されたワークステーションにサインインし、パッケージを USB デバイスからワークステーション上の場所にコピーします。Sign in to the disconnected workstation and copy the packages from the USB device to a location on the workstation.

  3. ここで、その場所を既定のレポジトリとして登録し、そのレポジトリから AzureRM および AzureStack モジュールをインストールします。Now register this location as the default repository and install the AzureRM and AzureStack modules from this repository:

    #requires -Version 5
    #requires -RunAsAdministrator
    #requires -Module PowerShellGet
    #requires -Module PackageManagement
    
    $SourceLocation = "<Location on the development kit that contains the PowerShell packages>"
    $RepoName = "MyNuGetSource"
    
    Register-PSRepository -Name $RepoName -SourceLocation $SourceLocation  -InstallationPolicy Trusted
    
    Install-Module -Name AzureRM -Repository $RepoName
    
    Install-Module -Name AzureStack -Repository $RepoName
    

PowerShell のインストールを確認するConfirm the installation of PowerShell

次のコマンドを実行してインストールを確認します。Confirm the installation by running the following command:

Get-Module -Name "Azure*" -ListAvailable
Get-Module -Name "Azs*" -ListAvailable

6.プロキシ サーバーを使用するように PowerShell を構成する6. Configure PowerShell to use a proxy server

インターネットへのアクセスにプロキシ サーバーを必要とするシナリオでは、最初に既存のプロキシ サーバーを使用するように PowerShell を構成する必要があります。In scenarios that require a proxy server to access the Internet, you must first configure PowerShell to use an existing proxy server:

  1. 管理者特権の PowerShell プロンプトを開きます。Open an elevated PowerShell prompt.

  2. 次のコマンドを実行します。Run the following commands:

    #To use Windows credentials for proxy authentication
    [System.Net.WebRequest]::DefaultWebProxy.Credentials = [System.Net.CredentialCache]::DefaultCredentials
    
    #Alternatively, to prompt for separate credentials that can be used for #proxy authentication
    [System.Net.WebRequest]::DefaultWebProxy.Credentials = Get-Credential
    

次の手順Next steps