Update-AzServiceFabricApplication

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

構文

ByResourceGroup (既定)

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>]

ByResourceId

Update-AzServiceFabricApplication
    [[-ApplicationTypeVersion] <String>]
    [-ResourceId] <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>]

ByInputObject

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
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ByResourceGroup
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ByResourceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ApplicationTypeVersion

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

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ByResourceGroup
配置:3
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ByResourceId
配置:3
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ClusterName

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

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ByResourceGroup
配置:1
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-Confirm

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

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False
エイリアス:Cf

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ConsiderWarningAsError

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

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ByResourceGroup
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ByResourceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-DefaultProfile

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

パラメーターのプロパティ

型:IAzureContextContainer
規定値:None
ワイルドカードのサポート:False
DontShow:False
エイリアス:AzContext, AzureRmContext, AzureCredential

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-DefaultServiceTypeMaxPercentUnhealthyPartitionsPerService

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

パラメーターのプロパティ

型:Int32
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ByResourceGroup
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ByResourceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-DefaultServiceTypeMaxPercentUnhealthyReplicasPerPartition

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

パラメーターのプロパティ

型:Int32
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ByResourceGroup
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ByResourceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-DefaultServiceTypeUnhealthyServicesMaxPercent

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

パラメーターのプロパティ

型:Int32
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ByResourceGroup
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ByResourceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-FailureAction

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

パラメーターのプロパティ

型:FailureAction
規定値:None
指定可能な値:Rollback, Manual
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ByResourceGroup
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ByResourceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ForceRestart

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

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ByResourceGroup
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ByResourceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-HealthCheckRetryTimeoutSec

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

パラメーターのプロパティ

型:Int32
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ByResourceGroup
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ByResourceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-HealthCheckStableDurationSec

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

パラメーターのプロパティ

型:Int32
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ByResourceGroup
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ByResourceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-HealthCheckWaitDurationSec

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

パラメーターのプロパティ

型:Int32
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ByResourceGroup
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ByResourceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-InputObject

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

パラメーターのプロパティ

型:PSApplication
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ByInputObject
配置:Named
必須:True
パイプラインからの値:True
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-MaximumNodeCount

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

パラメーターのプロパティ

型:Int64
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ByResourceGroup
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ByResourceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-MinimumNodeCount

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

パラメーターのプロパティ

型:Int64
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ByResourceGroup
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ByResourceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Name

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

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False
エイリアス:ApplicationName

パラメーター セット

ByResourceGroup
配置:2
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ResourceGroupName

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

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ByResourceGroup
配置:0
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-ResourceId

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

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ByResourceId
配置:0
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-ServiceTypeHealthPolicyMap

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

パラメーターのプロパティ

型:Hashtable
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ByResourceGroup
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ByResourceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-UnhealthyDeployedApplicationsMaxPercent

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

パラメーターのプロパティ

型:Int32
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ByResourceGroup
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ByResourceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-UpgradeDomainTimeoutSec

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

パラメーターのプロパティ

型:Int32
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ByResourceGroup
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ByResourceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-UpgradeReplicaSetCheckTimeoutSec

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

パラメーターのプロパティ

型:Int32
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ByResourceGroup
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ByResourceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-UpgradeTimeoutSec

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

パラメーターのプロパティ

型:Int32
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ByResourceGroup
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ByResourceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-WhatIf

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

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False
エイリアス:wi

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

CommonParameters

このコマンドレットは、共通パラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable をサポートします。 詳細については、about_CommonParametersを参照してください。

入力

String

PSApplication

出力

PSApplication