Start-ServiceFabricApplicationUpgrade

リファレンス

モジュール:: ServiceFabric

Service Fabric アプリケーションを指定された ApplicationTypeVersion にアップグレードします。

構文

Start-ServiceFabricApplicationUpgrade
     [-ApplicationName] <Uri>
     [-ApplicationTypeVersion] <String>
     [[-ApplicationParameter] <Hashtable>]
     [-ForceRestart]
     [[-UpgradeReplicaSetCheckTimeoutSec] <UInt32>]
     [[-SortOrder] <UpgradeSortOrder>]
     [-ReplicaQuorumTimeoutSec <UInt32>]
     [-RestartProcess]
     [-InstanceCloseDelayDurationSec <UInt32>]
     [-UnmonitoredAuto]
     [-Force]
     [-TimeoutSec <Int32>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Start-ServiceFabricApplicationUpgrade
     [-ApplicationName] <Uri>
     [-ApplicationTypeVersion] <String>
     [[-ApplicationParameter] <Hashtable>]
     [-ForceRestart]
     [[-UpgradeReplicaSetCheckTimeoutSec] <UInt32>]
     [[-SortOrder] <UpgradeSortOrder>]
     [-ReplicaQuorumTimeoutSec <UInt32>]
     [-RestartProcess]
     [-InstanceCloseDelayDurationSec <UInt32>]
     [-UnmonitoredManual]
     [-Force]
     [-TimeoutSec <Int32>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Start-ServiceFabricApplicationUpgrade
     [-ApplicationName] <Uri>
     [-ApplicationTypeVersion] <String>
     [[-ApplicationParameter] <Hashtable>]
     [-ForceRestart]
     [[-UpgradeReplicaSetCheckTimeoutSec] <UInt32>]
     [[-SortOrder] <UpgradeSortOrder>]
     [-ReplicaQuorumTimeoutSec <UInt32>]
     [-RestartProcess]
     [-InstanceCloseDelayDurationSec <UInt32>]
     [-Monitored]
     -FailureAction <UpgradeFailureAction>
     [-HealthCheckRetryTimeoutSec <UInt32>]
     [-HealthCheckWaitDurationSec <UInt32>]
     [-HealthCheckStableDurationSec <UInt32>]
     [-UpgradeDomainTimeoutSec <UInt32>]
     [-UpgradeTimeoutSec <UInt32>]
     [-ConsiderWarningAsError <Boolean>]
     [-DefaultServiceTypeHealthPolicy <String>]
     [-MaxPercentUnhealthyDeployedApplications <Byte>]
     [-ServiceTypeHealthPolicyMap <Hashtable>]
     [-Force]
     [-TimeoutSec <Int32>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

説明

Start-ServiceFabricApplicationUpgrade コマンドレットは、Service Fabric アプリケーションをアップグレードします。このコマンドレットを使用する前に、更新されたアプリケーションパッケージをイメージストアにコピーし、更新されたアプリケーションの種類を登録する必要があります。 Copy-ServiceFabricApplicationPackage を使用して、アプリケーションパッケージをイメージストアにコピーします。 Register-ServiceFabricApplicationType コマンドレットを使用して、更新されたアプリケーションの種類を登録します。

このコマンドレットは、クラスターでアップグレードを開始します。

ApplicationParameters は、アプリケーションのアップグレード間で保持されません。現在のアプリケーションパラメーターを保持するには、次の 例 1 に示すように、最初にパラメーターを取得し、アップグレード API 呼び出しに渡す必要があります。

Service Fabric アプリケーションのアップグレードの詳細については、概念に関するドキュメントを参照してください。

Service Fabric クラスターで操作を実行する前に、 Connect-ServiceFabricCluster コマンドレットを使用してクラスターへの接続を確立します。

例

例 1: アップグレード呼び出しに渡すアプリケーションパラメーターを取得する

$myApplication = Get-ServiceFabricApplication -ApplicationName fabric:/myApplication
$appParamCollection = $myApplication.ApplicationParameters
$applicationParameterMap = @{}

foreach ($pair in $appParamCollection)
{ $applicationParameterMap.Add($pair.Name, $pair.Value); }

Start-ServiceFabricApplicationUpgrade -ApplicationName fabric:/myApplication -ApplicationTypeVersion 2.0.0 -ApplicationParameter $applicationParameterMap -Monitored -FailureAction Rollback

例 2: アプリケーションをアップグレードする

PS C:\> Copy-ServiceFabricApplicationPackage -ApplicationPackagePath "C:\PersistentToDoListServiceV2" -ImageStoreConnectionString "file:C:\ProgramData\ServiceFabric\ImageStore"
PS C:\> Register-ServiceFabricApplicationType -ApplicationPathInImageStore "PersistentToDoListServiceV2"
PS C:\> Start-ServiceFabricApplicationUpgrade -ApplicationName fabric:/myapp/persistenttodolist -ApplicationTypeVersion "2.0" -ForceRestart -UnMonitoredManual

最初のコマンドでは、Copy-ServiceFabricApplicationPackage コマンドレットを使用して、更新されたアプリケーションパッケージをイメージストアにコピーします。

2 番目のコマンドでは、 Register-ServiceFabricApplicationType コマンドレットを使用して、更新されたアプリケーションの種類を登録します。

3 番目のコマンドは、アプリケーションをアップグレードします。このコマンドは、監視されていない手動アップグレードを実行します。これには、アプリケーションをホストするサーバーの再起動が含まれます。

パラメーター

-ApplicationName

Service Fabric アプリケーションの Uniform Resource Identifier (URI) を指定します。コマンドレットは、指定した URI を持つアプリケーションをアップグレードします。

型:	Uri
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ApplicationParameter

アプリケーションパラメーターのオーバーライドを名前と値のペアとして指定します。

型:	Hashtable
配置:	2
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ApplicationTypeVersion

Service Fabric アプリケーションの種類のバージョンを指定します。コマンドレットは、指定したバージョンにアプリケーションをアップグレードします。

型:	String
配置:	1
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ConsiderWarningAsError

正常性評価中に警告の正常性イベントをエラーイベントとして扱うかどうかを示します。

型:	Boolean
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DefaultServiceTypeHealthPolicy

MaxPercentUnhealthyPartitionsPerService、MaxPercentUnhealthyReplicasPerPartition、MaxPercentUnhealthyServices の形式で、監視対象のアップグレードに使用する既定のサービスの種類に対して正常性ポリシーを指定します。たとえば、5,10,15 は、

MaxPercentUnhealthyPartitionsPerService = 5
MaxPercentUnhealthyReplicasPerPartition = 10
MaxPercentUnhealthyServices = 15

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-FailureAction

監視対象のアップグレードが失敗した場合に実行するアクションを指定します。このパラメーターの有効値は、次のとおりです。

ロールバック
マニュアル

型:	UpgradeFailureAction
指定可能な値:	Invalid, Rollback, Manual
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Force

このコマンドレットが警告メッセージをスキップし、強制的にアップグレードすることを示します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ForceRestart

アップグレードが構成のみの変更である場合でも、サービスホストが再起動することを示します。

型:	SwitchParameter
配置:	3
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-HealthCheckRetryTimeoutSec

前の正常性チェックが失敗した場合に Service Fabric が正常性チェックを再試行する期間を秒単位で指定します。

型:	UInt32
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-HealthCheckStableDurationSec

次のアップグレードドメインに移動するか、アップグレードを完了する前に、アプリケーションが安定していることを確認するために Service Fabric が待機する時間 (秒単位) を指定します。この待機時間は、正常性チェックが実行された直後に検出されない正常性の変更を防ぎます。

型:	UInt32
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-HealthCheckWaitDurationSec

アップグレードドメインでのアップグレードが完了した後、Service Fabric が初期正常性チェックを実行するまでの待機時間を秒単位で指定します。

型:	UInt32
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-InstanceCloseDelayDurationSec

アクティブな要求が正常にドレインできるように、アプリケーションのアップグレードの影響を受けるステートレスインスタンスが閉じられるまで待機する時間を秒単位で指定します。この待機時間は、InstanceCloseDelayDuration に対して 0 以外の値が構成され、構成済みの値をオーバーライドするステートレスサービスのインスタンスに対してのみ有効です。詳細については、 InstanceCloseDelayDuration (in New-ServiceFabricService) を参照してください。

型:	UInt32
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-MaxPercentUnhealthyDeployedApplications

クラスターのアプリケーションの正常性状態がエラーになるまでの正常性状態がエラーであるクラスター内のノードにデプロイされたアプリケーションインスタンスの最大割合を指定します。

型:	Byte
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Monitored

アップグレードモードが監視対象であることを示します。コマンドレットによってアップグレードドメインのアップグレードを完了した後、定義した正常性ポリシーをアップグレードドメインとクラスターの正常性が満たしている場合、Service Fabric は次のアップグレードドメインをアップグレードします。アップグレードドメインまたはクラスターが正常性ポリシーを満たしていない場合、アップグレードは失敗し、Service Fabric は指定されたポリシーに従って、アップグレードドメインのアップグレードをロールバックするか、手動モードに戻ります。これは、運用環境でのアプリケーションのアップグレードに推奨されるモードです。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ReplicaQuorumTimeoutSec

レプリカセットにクォーラムがあるかどうかを確認するタイムアウト期間を秒単位で指定します。タイムアウト期間が経過すると、アップグレードが続行されます。

このパラメーターは非推奨になりました。代わりに UpgradeReplicaSetCheckTimeoutSec パラメーターを指定します。

型:	UInt32
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-RestartProcess

アップグレードの一環としてサービスホストが再起動することを示します。

このパラメーターは非推奨になりました。代わりに ForceRestart パラメーターを指定します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ServiceTypeHealthPolicyMap

さまざまなサービスの種類に使用する正常性ポリシーのマップをハッシュテーブルとして次の形式で指定します。 @ {"ServiceTypeName" : "MaxPercentUnhealthyPartitionsPerService,MaxPercentUnhealthyReplicasPerPartition,MaxPercentUnhealthyServices"}。次に例を示します。

@{ "ServiceTypeName01" = "5,10,5";"ServiceTypeName02" = "5,5,5" }

型:	Hashtable
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SortOrder

クラスターを介してアップグレードを続行する順序を定義します。

次のいずれかの値になります。

Invalid - この並べ替え順序が無効であることを示します。すべての Service Fabric 列挙型の型が無効です。
Default - 既定の並べ替え順序 (クラスターマニフェストで指定) が使用されることを示します。
Numeric - 前方の数値の並べ替え順序 (数値として並べ替えられた UD 名) が使用されることを示します。
Lexicographical - 前方辞書式の並べ替え順序 (文字列として並べ替えられた UD 名) が使用されることを示します。
ReverseNumeric - 逆の数値並べ替え順序 (数値として並べ替えられた UD 名) が使用されることを示します。
ReverseLexicographical- 逆辞書式の並べ替え順序 (文字列として並べ替えられた UD 名) が使用されることを示します。

型:	UpgradeSortOrder
指定可能な値:	Invalid, Default, Numeric, Lexicographical, ReverseNumeric, ReverseLexicographical
配置:	5
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-TimeoutSec

操作のタイムアウト期間を秒単位で指定します。

型:	Int32
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-UnmonitoredAuto

アップグレードモードが監視対象外の自動であることを示します。 Service Fabric がアップグレードドメインをアップグレードした後、アプリケーションの正常性の状態に関係なく、Service Fabric は次のアップグレードドメインをアップグレードします。このモードは運用環境にはお勧めできません。アプリケーションの開発中にのみ役に立ちます。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-UnmonitoredManual

アップグレードモードが監視対象外の手動であることを示します。 Service Fabric は、アップグレードドメインをアップグレードした後、ユーザーが Resume-ServiceFabricApplicationUpgrade コマンドレットを使用して次のアップグレードドメインをアップグレードするまで待機します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-UpgradeDomainTimeoutSec

Service Fabric が 1 つのアップグレードドメインのアップグレードに要する最大時間を秒単位で指定します。この期間が経過すると、アップグレードは失敗します。

型:	UInt32
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-UpgradeReplicaSetCheckTimeoutSec

Service Fabric がアップグレードを続行する前に、Service Fabric がサービスが安全な状態に再構成されるまで待機する最大時間を指定します (まだ安全な状態でない場合)。

型:	UInt32
配置:	4
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-UpgradeTimeoutSec

Service Fabric がアップグレード全体に要する最大時間を秒単位で指定します。この期間が経過すると、アップグレードは失敗します。

型:	UInt32
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WhatIf

コマンドレットの実行時に発生する内容を示します。このコマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

None

出力

System.Object

次の方法で共有

Start-ServiceFabricApplicationUpgrade

構文

説明

例

例 1: アップグレード呼び出しに渡すアプリケーションパラメーターを取得する

例 2: アプリケーションをアップグレードする

パラメーター

-ApplicationName

-ApplicationParameter

-ApplicationTypeVersion

-Confirm

-ConsiderWarningAsError

-DefaultServiceTypeHealthPolicy

-FailureAction

-Force

-ForceRestart

-HealthCheckRetryTimeoutSec

-HealthCheckStableDurationSec

-HealthCheckWaitDurationSec

-InstanceCloseDelayDurationSec

-MaxPercentUnhealthyDeployedApplications

-Monitored

-ReplicaQuorumTimeoutSec

-RestartProcess

-ServiceTypeHealthPolicyMap

-SortOrder

-TimeoutSec

-UnmonitoredAuto

-UnmonitoredManual

-UpgradeDomainTimeoutSec

-UpgradeReplicaSetCheckTimeoutSec

-UpgradeTimeoutSec

-WhatIf

入力

出力

その他のリソース

次の方法で共有

Start-ServiceFabricApplicationUpgrade

構文

説明

例

例 1: アップグレード呼び出しに渡すアプリケーション パラメーターを取得する

例 2: アプリケーションをアップグレードする

パラメーター

-ApplicationName

-ApplicationParameter

-ApplicationTypeVersion

-Confirm

-ConsiderWarningAsError

-DefaultServiceTypeHealthPolicy

-FailureAction

-Force

-ForceRestart

-HealthCheckRetryTimeoutSec

-HealthCheckStableDurationSec

-HealthCheckWaitDurationSec

-InstanceCloseDelayDurationSec

-MaxPercentUnhealthyDeployedApplications

-Monitored

-ReplicaQuorumTimeoutSec

-RestartProcess

-ServiceTypeHealthPolicyMap

-SortOrder

-TimeoutSec

-UnmonitoredAuto

-UnmonitoredManual

-UpgradeDomainTimeoutSec

-UpgradeReplicaSetCheckTimeoutSec

-UpgradeTimeoutSec

-WhatIf

入力

出力

関連リンク

その他のリソース

例 1: アップグレード呼び出しに渡すアプリケーションパラメーターを取得する