Update-AzServiceFabricApplication

リファレンス

モジュール:: Az.ServiceFabric

Service Fabric アプリケーションを更新します。これにより、アプリケーションのパラメーターを更新したり、アプリケーションのアップグレードをトリガーするアプリケーションの種類のバージョンをアップグレードしたりできます。 ARM でデプロイされたアプリケーションのみをサポートします。

構文

Update-AzServiceFabricApplication
      [-ResourceGroupName] <String>
      [-ClusterName] <String>
      [-Name] <String>
      [[-ApplicationTypeVersion] <String>]
      [-ApplicationParameter <Hashtable>]
      [-MinimumNodeCount <Int64>]
      [-MaximumNodeCount <Int64>]
      [-ForceRestart]
      [-UpgradeReplicaSetCheckTimeoutSec <Int32>]
      [-FailureAction <FailureAction>]
      [-HealthCheckRetryTimeoutSec <Int32>]
      [-HealthCheckWaitDurationSec <Int32>]
      [-HealthCheckStableDurationSec <Int32>]
      [-UpgradeDomainTimeoutSec <Int32>]
      [-UpgradeTimeoutSec <Int32>]
      [-ConsiderWarningAsError]
      [-DefaultServiceTypeMaxPercentUnhealthyPartitionsPerService <Int32>]
      [-DefaultServiceTypeMaxPercentUnhealthyReplicasPerPartition <Int32>]
      [-DefaultServiceTypeUnhealthyServicesMaxPercent <Int32>]
      [-UnhealthyDeployedApplicationsMaxPercent <Int32>]
      [-ServiceTypeHealthPolicyMap <Hashtable>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzServiceFabricApplication
      [[-ApplicationTypeVersion] <String>]
      [-ApplicationParameter <Hashtable>]
      [-MinimumNodeCount <Int64>]
      [-MaximumNodeCount <Int64>]
      [-ForceRestart]
      [-UpgradeReplicaSetCheckTimeoutSec <Int32>]
      [-FailureAction <FailureAction>]
      [-HealthCheckRetryTimeoutSec <Int32>]
      [-HealthCheckWaitDurationSec <Int32>]
      [-HealthCheckStableDurationSec <Int32>]
      [-UpgradeDomainTimeoutSec <Int32>]
      [-UpgradeTimeoutSec <Int32>]
      [-ConsiderWarningAsError]
      [-DefaultServiceTypeMaxPercentUnhealthyPartitionsPerService <Int32>]
      [-DefaultServiceTypeMaxPercentUnhealthyReplicasPerPartition <Int32>]
      [-DefaultServiceTypeUnhealthyServicesMaxPercent <Int32>]
      [-UnhealthyDeployedApplicationsMaxPercent <Int32>]
      [-ServiceTypeHealthPolicyMap <Hashtable>]
      [-ResourceId] <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzServiceFabricApplication
      -InputObject <PSApplication>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

このコマンドレットを使用して、アプリケーションパラメーターを更新し、アプリケーションの種類のバージョンをアップグレードできます。パラメーターを更新すると、ARM 側でのみモデルが変更され、新しい型バージョンが使用されている場合にのみ、コマンドによってアプリケーションのアップグレードがトリガーされます。指定された型のバージョンは、New-AzServiceFabricApplicationTypeVersionを使用してクラスター内に既に作成されている必要があります。

例

例 1

$resourceGroupName = "testRG"
$clusterName = "testCluster"
$appName = "testApp"
$version = "v2"
$packageUrl = "https://sftestapp.blob.core.windows.net/sftestapp/testAppType_v2.sfpkg"
New-AzServiceFabricApplicationTypeVersion -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appName -Version $version -PackageUrl $packageUrl -Verbose
Update-AzServiceFabricApplication -ResourceGroupName $resourceGroupName -ClusterName $clusterName -ApplicationTypeVersion $version -Name $appName -ApplicationParameter @{key0="value0";key1=$null;key2="value2"}

この例では、New-AzServiceFabricApplicationTypeVersion で作成された型バージョンを "v2" に更新するアプリケーションのアップグレード開始します。使用するアプリケーションパラメーターは、アプリケーションマニフェストで定義する必要があります。

例 2

$resourceGroupName = "testRG"
$clusterName = "testCluster"
$appName = "testApp"
Update-AzServiceFabricApplication -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appName -MinimumNodeCount 1 -MaximumNodeCount 4 -Verbose

この例では、アプリケーションのノードの最小数と最大数の制限を更新します。

例 3

$resourceGroupName = "testRG"
$clusterName = "testCluster"
$appName = "testApp"
$version = "v2"
$packageUrl = "https://sftestapp.blob.core.windows.net/sftestapp/testAppType_v2.sfpkg"
New-AzServiceFabricApplicationTypeVersion -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appName -Version $version -PackageUrl $packageUrl -Verbose
Update-AzServiceFabricApplication -ResourceGroupName $resourceGroupName -ClusterName $clusterName -ApplicationTypeVersion $version -Name $appName -ApplicationParameter @{key0="value0";key1=$null;key2="value2"} -HealthCheckStableDurationSec 0 -HealthCheckWaitDurationSec 0 -HealthCheckRetryTimeoutSec 0 -UpgradeDomainTimeoutSec 5000 -UpgradeTimeoutSec 7000 -FailureAction Rollback -UpgradeReplicaSetCheckTimeoutSec 300 -ForceRestart

この例では、アプリケーションのアップグレードを開始して、種類のバージョンを "v2" に更新します。また、現在のアップグレードから有効になるアップグレードポリシーパラメーターも設定します。

例 4

Update-AzServiceFabricApplication -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appName -ApplicationParameter @{key0="value0";key1=$null;key2="value2"}

この例では、アプリケーションパラメーターを更新しますが、これらの変更は、次のバージョンがアプリケーションにアップグレードされるまで有効になります。

パラメーター

-ApplicationParameter

アプリケーションパラメーターをキーと値のペアとして指定します。これらのパラメーターは、アプリケーションマニフェストに存在する必要があります。

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

-ApplicationTypeVersion

アプリケーションの種類のバージョンを指定する

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

-ClusterName

クラスターの名前を指定します。

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

-Confirm

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

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

-ConsiderWarningAsError

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

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

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。

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

-DefaultServiceTypeMaxPercentUnhealthyPartitionsPerService

監視対象のアップグレードに使用する既定のサービスの種類について、正常性ポリシーによって許可されるサービスごとの不十分なパーティションの最大割合を指定します。

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

-DefaultServiceTypeMaxPercentUnhealthyReplicasPerPartition

監視対象のアップグレードに使用する既定のサービスの種類について、正常性ポリシーによって許可されるサービスあたりの不十分なレプリカの最大割合を指定します。

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

-DefaultServiceTypeUnhealthyServicesMaxPercent

監視対象のアップグレードに使用する既定のサービスの種類に対して正常性ポリシーによって許可される不十分なサービスの最大割合を指定します。

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

-FailureAction

監視対象のアップグレードが失敗した場合に実行するアクションを指定します。このパラメーターに使用できる値は、Rollback または Manual です。

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

-ForceRestart

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

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

-HealthCheckRetryTimeoutSec

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

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

-HealthCheckStableDurationSec

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

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

-HealthCheckWaitDurationSec

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

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

-InputObject

アプリケーションリソース。

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

-MaximumNodeCount

アプリケーションを配置するノードの最大数を指定します

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

-MinimumNodeCount

Service Fabric がこのアプリケーションの容量を予約するノードの最小数を指定します

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

-Name

アプリケーションの名前を指定する

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

-ResourceGroupName

リソースグループの名前を指定します。

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

-ResourceId

アプリケーションの Arm ResourceId。

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

-ServiceTypeHealthPolicyMap

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

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

-UnhealthyDeployedApplicationsMaxPercent

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

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

-UpgradeDomainTimeoutSec

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

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

-UpgradeReplicaSetCheckTimeoutSec

Service Fabric がまだ安全な状態でない場合は、Service Fabric がサービスを安全な状態に再構成するまでの最大時間を指定します。その後、Service Fabric はアップグレードを続行します。

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

-UpgradeTimeoutSec

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

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

-WhatIf

コマンドレットを実行した場合の動作を示します。コマンドレットは実行されません。

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

入力

String

PSApplication

出力