PowerShell コマンドレットで Batch リソースを管理する

[アーティクル]
06/02/2023

Azure Batch PowerShell コマンドレットを使用すると、多くの一般的な Batch タスクを実行したり、そのスクリプトを作成したりできます。この記事では、Batch アカウントを管理したり、プール、ジョブ、タスクといった Batch リソースを操作したりするときに使用できるコマンドレットについて説明します。

すべての Batch コマンドレットの一覧およびコマンドレットの詳細な構文については、 Azure Batch コマンドレットのリファレンスを参照してください。

最新のサービスや機能強化を活かすためにも、Azure PowerShell モジュールは定期的に更新することをお勧めします。

前提条件

Azure PowerShell モジュールをインストールして構成します。特定の Azure Batch モジュール (プレリリースモジュールなど) をインストールする方法については、PowerShell ギャラリーを参照してください。
Connect-AzAccount コマンドレットを実行してサブスクリプションに接続します (Azure Batch コマンドレットは、Azure Resource Manager モジュールに付属しています)。
```
Connect-AzAccount
```
Batch プロバイダーの名前空間に登録します。この操作は、サブスクリプションごとに 1 回実行するだけでかまいません。
```
Register-AzResourceProvider -ProviderNamespace Microsoft.Batch
```

Batch アカウントとキーを管理する

Batch アカウントを作成する

New-AzBatchAccount は、指定したリソースグループに Batch アカウントを作成します。リソースグループがまだない場合は、New-AzResourceGroup コマンドレットを実行して作成します。 location パラメーターで Azure リージョンのいずれか (例: "Central US") を指定します。次に例を示します。

New-AzResourceGroup –Name MyBatchResourceGroup –Location "Central US"

次に、リソースグループに Batch アカウントを作成します。 <account_name> にアカウントの名前を指定し、リソースグループの場所と名前を指定します。 Batch アカウントの作成は、完了までにしばらく時間がかかる場合があります。次に例を示します。

New-AzBatchAccount –AccountName <account_name> –Location "Central US" –ResourceGroupName <res_group_name>

注意

Batch アカウント名は、リソースグループの Azure リージョン内で重複しないこと、文字数が 3 ～ 24 文字であること、小文字と数字のみで構成されていることが必要になります。

アカウントのアクセスキーを取得する

Get-AzBatchAccountKeys は、Azure Batch アカウントに関連付けられているアクセスキーを示します。たとえば、作成したアカウントのプライマリキーとセカンダリキーを取得するには、次のように実行します。

$Account = Get-AzBatchAccountKeys –AccountName <account_name>

$Account.PrimaryAccountKey

$Account.SecondaryAccountKey

新しいアクセスキーを生成する

New-AzBatchAccountKey は、Azure Batch アカウントの新しいプライマリアカウントキーまたはセカンダリアカウントキーを生成します。たとえば、Batch アカウントの新しいプライマリキーを生成するには、次のように入力します。

New-AzBatchAccountKey -AccountName <account_name> -KeyType Primary

Note

新しいセカンダリキーを生成するには、 KeyType パラメーターの "Secondary" を指定します。プライマリキーとセカンダリキーは個別に再生成する必要があります。

Batch アカウントを削除する

Remove-AzBatchAccount は、Batch アカウントを削除します。次に例を示します。

Remove-AzBatchAccount -AccountName <account_name>

メッセージが表示されたら、削除するアカウントを確認します。アカウントの削除は完了するまでに時間がかかる場合があります。

BatchAccountContext オブジェクトを作成する

Batch リソースを管理するための認証は、共有キー認証または Microsoft Entra 認証を使用して行うことができます。 Batch PowerShell コマンドレットを使用して認証を行うにはまず、自分のアカウントの資格情報または ID を格納するための BatchAccountContext オブジェクトを作成します。 BatchAccountContext オブジェクトは、 BatchContext パラメーターを引数として受け取るコマンドレットに渡します。

共有キー認証

$context = Get-AzBatchAccountKeys -AccountName <account_name>

注意

既定では、アカウントのプライマリキーは認証に使用されますが、BatchAccountContext オブジェクトの KeyInUse プロパティを変更することで使用するキーを明示的に選択できます (例: $context.KeyInUse = "Secondary")。

Microsoft Entra 認証

$context = Get-AzBatchAccount -AccountName <account_name>

Batch リソースを作成および変更する

Batch アカウントでリソースを作成するには、New-AzBatchPool、New-AzBatchJob、New-AzBatchTask などのコマンドレットを使用します。既存のリソースのプロパティを更新するための対応する Get- コマンドレットと Set- コマンドレットがあり、Batch アカウントのリソースを削除するための Remove- コマンドレットがあります。

以下の例を見るとわかるように、これらのコマンドレットの多くは、その使用時に、BatchContext オブジェクトを渡すことに加え、リソースの詳細な設定を含んだオブジェクトを作成するか、引数として渡す必要があります。その他の例については、各コマンドレットの詳細なヘルプを参照してください。

Create a Batch pool

Batch プールを作成または更新するときは、構成を指定します。プールは通常、仮想マシンの構成を使用して構成する必要があります。これを使用すると、Azure Virtual Machines Marketplace に記載されているサポート対象の Linux または Windows VM イメージのいずれかを指定したり、準備したカスタムイメージを指定したりできます。 Cloud Services 構成プールでは、Windows コンピューティングノードのみが提供されており、すべての Batch 機能がサポートされているわけではありません。

New-AzBatchPool を実行するときに、オペレーティングシステムの設定を PSVirtualMachineConfiguration または PSCloudServiceConfiguration オブジェクトで渡します。たとえば、以下のスニペットは、仮想マシンの構成を選び、Ubuntu Server 20.04-LTS のイメージを使用して、Standard_A1 サイズのコンピューティングノードで Batch プールを作成しています。ここでは、VirtualMachineConfiguration パラメーターに PSVirtualMachineConfiguration オブジェクトとして $configuration 変数を指定しています。 BatchContext パラメーターには、先ほど定義した $context 変数を BatchAccountContext オブジェクトとして指定しています。

$imageRef = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSImageReference" -ArgumentList @("UbuntuServer","Canonical","20.04-LTS")

$configuration = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSVirtualMachineConfiguration" -ArgumentList @($imageRef, "batch.node.ubuntu 20.04")

New-AzBatchPool -Id "mypspool" -VirtualMachineSize "Standard_a1" -VirtualMachineConfiguration $configuration -AutoScaleFormula '$TargetDedicated=4;' -BatchContext $context

新しいプール内のコンピューティングノードの目標数は、自動スケーリングの式によって計算されます。この例では、式は $TargetDedicated=4という簡単なものであり、プールのコンピューティングノードの数が最大 4 であることを示します。

プール、ジョブ、タスク、およびその他の詳細のクエリ

Batch アカウントで作成されたエンティティを照会するには、Get-AzBatchPool、Get-AzBatchJob、Get-AzBatchTask などのコマンドレットを使用します。

データのクエリ

たとえば、Get-AzBatchPools を使用してプールを検索します。既定では、これは、既に BatchAccountContext オブジェクトが $contextに格納されていると仮定して、自分のアカウントのすべてのプールを照会します。

Get-AzBatchPool -BatchContext $context

OData フィルターを使用する

Filter パラメーターを使用して OData フィルターを指定すると、関心のあるオブジェクトのみを検索できます。たとえば、ID が "myPool" で始まるすべてのプールを検索できます。

$filter = "startswith(id,'myPool')"

Get-AzBatchPool -Filter $filter -BatchContext $context

このメソッドは、ローカルのパイプラインで “Where-Object” を使用するほど柔軟ではありません。ただし、クエリは Batch サービスに直接送信されるため、すべてのフィルター処理がサーバー側で行われ、インターネットの帯域幅を節約できます。

ID パラメーターの使用

OData フィルターに代わる方法として、 ID パラメーターを使用します。 "myPool" という ID の特定のプールを照会するには:

Get-AzBatchPool -Id "myPool" -BatchContext $context

Id パラメーターは、完全 ID の検索のみをサポートし、ワイルドカードや OData 形式のフィルターはサポートしません。

MaxCount パラメーターを使用する

既定では、各コマンドレットは最大で 1000 のオブジェクトを返します。この制限に達した場合は、オブジェクトが少なくなるようにフィルターで絞り込むか、 MaxCount パラメーターを使用して明示的に最大値を設定してください。次に例を示します。

Get-AzBatchTask -MaxCount 2500 -BatchContext $context

上限を削除するには、 MaxCount を 0 以下に設定します。

PowerShell パイプラインを使用する

Batch コマンドレットは、コマンドレット間でデータを送信するために PowerShell パイプラインを使用します。これは、パラメーターを指定するのと同じ効果がありますが、複数のエンティティを簡単に操作できます。

たとえば、自分のアカウントのすべてのタスクを検索して表示します。

Get-AzBatchJob -BatchContext $context | Get-AzBatchTask -BatchContext $context

プール内のすべてのコンピューティングノードを再起動します。

Get-AzBatchComputeNode -PoolId "myPool" -BatchContext $context | Restart-AzBatchComputeNode -BatchContext $context

アプリケーションパッケージの管理

アプリケーションパッケージを利用すると、プール内のコンピューティングノードにアプリケーションを簡単にデプロイできます。 Batch PowerShell コマンドレットを使用して、Batch アカウントのアプリケーションパッケージをアップロードおよび管理し、パッケージバージョンをコンピューティングノードにデプロイできます。

重要

アプリケーションパッケージを使用するには、お使いの Batch アカウントに Azure ストレージアカウントをリンクする必要があります。

作成する:

New-AzBatchApplication -AccountName <account_name> -ResourceGroupName <res_group_name> -ApplicationId "MyBatchApplication"

追加する:

New-AzBatchApplicationPackage -AccountName <account_name> -ResourceGroupName <res_group_name> -ApplicationId "MyBatchApplication" -ApplicationVersion "1.0" -Format zip -FilePath package001.zip

アプリケーションの既定のバージョンを設定する:

Set-AzBatchApplication -AccountName <account_name> -ResourceGroupName <res_group_name> -ApplicationId "MyBatchApplication" -DefaultVersion "1.0"

アプリケーションのパッケージを一覧表示する:

$application = Get-AzBatchApplication -AccountName <account_name> -ResourceGroupName <res_group_name> -ApplicationId "MyBatchApplication"

$application.ApplicationPackages

アプリケーションパッケージを削除する:

Remove-AzBatchApplicationPackage -AccountName <account_name> -ResourceGroupName <res_group_name> -ApplicationId "MyBatchApplication" -ApplicationVersion "1.0"

アプリケーションを削除する:

Remove-AzBatchApplication -AccountName <account_name> -ResourceGroupName <res_group_name> -ApplicationId "MyBatchApplication"

Note

アプリケーションを削除する前に、アプリケーションのアプリケーションパッケージのすべてのバージョンを削除する必要があります。現在アプリケーションパッケージがあるアプリケーションを削除しようとすると、"競合" エラーが発生します。

アプリケーションパッケージをデプロイする

プールの作成時に、デプロイ用の 1 つ以上のアプリケーションパッケージを指定できます。プールの作成時にパッケージを指定すると、ノードがプールに参加する際にパッケージが各ノードにデプロイされます。ノードが再起動または再イメージ化されるときにも、パッケージがデプロイされます。

プールのノードがそこに参加するタイミングでアプリケーションパッケージをデプロイするには、-ApplicationPackageReference オプションを指定してプールを作成します。まず、PSApplicationPackageReference オブジェクトを作成し、プールのコンピューティングノードにデプロイするアプリケーション ID とパッケージのバージョンでオブジェクトを構成します。

$appPackageReference = New-Object Microsoft.Azure.Commands.Batch.Models.PSApplicationPackageReference

$appPackageReference.ApplicationId = "MyBatchApplication"

$appPackageReference.Version = "1.0"

次に、プールを作成し、ApplicationPackageReferences オプションの引数としてパッケージ参照オブジェクトを指定します。

New-AzBatchPool -Id "PoolWithAppPackage" -VirtualMachineSize "Small" -VirtualMachineConfiguration $configuration -BatchContext $context -ApplicationPackageReferences $appPackageReference

アプリケーションパッケージについて詳しくは、「Batch アプリケーションパッケージを使用したコンピューティングノードへのアプリケーションのデプロイ」をご覧ください。

プールに含まれるアプリケーションパッケージの更新

既存のプールに割り当てられているアプリケーションを更新するには、まず、必要なプロパティ (アプリケーション ID とパッケージのバージョン) を指定して PSApplicationPackageReference オブジェクトを作成します。

$appPackageReference = New-Object Microsoft.Azure.Commands.Batch.Models.PSApplicationPackageReference

$appPackageReference.ApplicationId = "MyBatchApplication"

$appPackageReference.Version = "2.0"

次に、Batch からプールを取得し、既存のパッケージをすべてクリアし、新しいパッケージ参照を追加し、新しいプール設定で Batch サービスを更新します。

$pool = Get-AzBatchPool -BatchContext $context -Id "PoolWithAppPackage"

$pool.ApplicationPackageReferences.Clear()

$pool.ApplicationPackageReferences.Add($appPackageReference)

Set-AzBatchPool -BatchContext $context -Pool $pool

これで、Batch サービスでプールのプロパティが更新されました。ただし、プールのコンピューティングノードに新しいアプリケーションパッケージを実際にデプロイするには、それらのノードを再起動するか、再イメージ化する必要があります。次のコマンドを使用して、プール内のすべてのノードを再起動できます。

Get-AzBatchComputeNode -PoolId "PoolWithAppPackage" -BatchContext $context | Restart-AzBatchComputeNode -BatchContext $context

ヒント

プール内のコンピューティングノードに複数のアプリケーションパッケージをデプロイできます。現在デプロイされているパッケージを置き換えるのではなく、アプリケーションパッケージを "追加" する場合は、上記の $pool.ApplicationPackageReferences.Clear() 行を省略します。

次のステップ

コマンドレットの詳細な構文と例については、Azure Batch コマンドレットのリファレンスに関するページを参照してください。
Batch アプリケーションパッケージを使用したコンピューティングノードへのアプリケーションのデプロイ方法について説明します。