ServiceFabricDeploy@1 - Service Fabric アプリケーションのデプロイ v1 タスク

このタスクを使用して、Service Fabric アプリケーションをクラスターにデプロイします。 このタスクでは、発行プロファイルで定義されている設定に従って、Azure Service Fabric アプリケーションをクラスターにデプロイします。

注意

このタスクでは、ワークフロー ID フェデレーションを使用した Azure Resource Manager認証はサポートされていません。

構文

# Service Fabric application deployment v1
# Deploy an Azure Service Fabric application to a cluster.
- task: ServiceFabricDeploy@1
  inputs:
    applicationPackagePath: # string. Required. Application Package. 
    serviceConnectionName: # string. Required. Cluster Service Connection. 
    #publishProfilePath: # string. Publish Profile. 
    #applicationParameterPath: # string. Application Parameters. 
    #overrideApplicationParameter: false # boolean. Override Application Parameters. Default: false.
  # Advanced Settings
    #compressPackage: false # boolean. Compress Package. Default: false.
    #copyPackageTimeoutSec: # string. CopyPackageTimeoutSec. 
    #registerPackageTimeoutSec: # string. RegisterPackageTimeoutSec. 
    overwriteBehavior: 'SameAppTypeAndVersion' # 'Always' | 'Never' | 'SameAppTypeAndVersion'. Required. Overwrite Behavior. Default: SameAppTypeAndVersion.
    #skipUpgradeSameTypeAndVersion: false # boolean. Skip upgrade for same Type and Version. Default: false.
    #skipPackageValidation: false # boolean. Skip package validation. Default: false.
  # Upgrade Settings
    #useDiffPackage: false # boolean. Use Diff Package. Default: false.
    #overridePublishProfileSettings: false # boolean. Override All Publish Profile Upgrade Settings. Default: false.
    #isUpgrade: true # boolean. Optional. Use when overridePublishProfileSettings = true. Upgrade the Application. Default: true.
    #unregisterUnusedVersions: true # boolean. Unregister Unused Versions. Default: true.
    #upgradeMode: 'Monitored' # 'Monitored' | 'UnmonitoredAuto' | 'UnmonitoredManual'. Required when overridePublishProfileSettings = true && isUpgrade = true. Upgrade Mode. Default: Monitored.
    #FailureAction: 'Rollback' # 'Rollback' | 'Manual'. Required when overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitored. FailureAction. Default: Rollback.
    #UpgradeReplicaSetCheckTimeoutSec: # string. Optional. Use when overridePublishProfileSettings = true && isUpgrade = true. UpgradeReplicaSetCheckTimeoutSec. 
    #TimeoutSec: # string. Optional. Use when overridePublishProfileSettings = true && isUpgrade = true. TimeoutSec. 
    #ForceRestart: false # boolean. Optional. Use when overridePublishProfileSettings = true && isUpgrade = true. ForceRestart. Default: false.
    #HealthCheckRetryTimeoutSec: # string. Optional. Use when overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitored. HealthCheckRetryTimeoutSec. 
    #HealthCheckWaitDurationSec: # string. Optional. Use when overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitored. HealthCheckWaitDurationSec. 
    #HealthCheckStableDurationSec: # string. Optional. Use when overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitored. HealthCheckStableDurationSec. 
    #UpgradeDomainTimeoutSec: # string. Optional. Use when overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitored. UpgradeDomainTimeoutSec. 
    #ConsiderWarningAsError: false # boolean. Optional. Use when overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitored. ConsiderWarningAsError. Default: false.
    #DefaultServiceTypeHealthPolicy: # string. Optional. Use when overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitored. DefaultServiceTypeHealthPolicy. 
    #MaxPercentUnhealthyDeployedApplications: # string. Optional. Use when overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitored. MaxPercentUnhealthyDeployedApplications. 
    #UpgradeTimeoutSec: # string. Optional. Use when overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitored. UpgradeTimeoutSec. 
    #ServiceTypeHealthPolicyMap: # string. Optional. Use when overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitored. ServiceTypeHealthPolicyMap. 
  # Docker Settings
    #configureDockerSettings: false # boolean. Configure Docker settings. Default: false.
    #registryCredentials: 'AzureResourceManagerEndpoint' # 'AzureResourceManagerEndpoint' | 'ContainerRegistryEndpoint' | 'UsernamePassword'. Required when configureDockerSettings = true. Registry Credentials Source. Default: AzureResourceManagerEndpoint.
    #dockerRegistryConnection: # string. Alias: dockerRegistryEndpoint. Required when configureDockerSettings = true && registryCredentials = ContainerRegistryEndpoint. Docker Registry Service Connection. 
    #azureSubscription: # string. Alias: azureSubscriptionEndpoint. Required when configureDockerSettings = true && registryCredentials = AzureResourceManagerEndpoint. Azure subscription. 
    #registryUserName: # string. Optional. Use when configureDockerSettings = true && registryCredentials = UsernamePassword. Registry User Name. 
    #registryPassword: # string. Optional. Use when configureDockerSettings = true && registryCredentials = UsernamePassword. Registry Password. 
    #passwordEncrypted: true # boolean. Optional. Use when configureDockerSettings = true && registryCredentials = UsernamePassword. Password Encrypted. Default: true.

入力

applicationPackagePath - アプリケーション パッケージ
string. 必須です。

展開するアプリケーション パッケージへのパスを指定します。 パス では、変数とワイルドカードを使用できます。

serviceConnectionName - クラスター サービス接続
string. 必須です。

クラスターへの接続に使用する Azure Service Fabric サービス接続を指定します。 この参照されるサービス接続で定義されている設定は、発行プロファイルで定義されている設定よりも優先されます。 新しいサービス接続を登録することを選択 Manage します。

クラスターに接続するために、Service Fabric タスクはマシン証明書ストアを使用して証明書に関する情報を格納します。 2 つのリリースが同じ証明書を使用して 1 台のコンピューター上で一緒に実行される場合は、適切に起動します。 ただし、いずれかのタスクが完了すると、マシン証明書ストアの証明書がクリーンアップされ、2 番目のリリースに影響します。

publishProfilePath - プロファイルの発行
string.

省略可能。 使用する設定を定義する発行プロファイル ファイルへのパスを指定します。 パス では、変数とワイルドカードを使用できます。 Visual Studio で発行プロファイルを作成する方法の詳細を確認してください。

applicationParameterPath - アプリケーション パラメーター
string.

省略可能。 アプリケーション パラメーター ファイルへのパスを指定します。 パス では、変数とワイルドカードを使用できます。 指定すると、発行プロファイルの値がオーバーライドされます。 Visual Studio でアプリケーション パラメーター ファイルを作成する方法の詳細を確認してください。

overrideApplicationParameter - アプリケーション パラメーターをオーバーライドする
boolean. 既定値: false。

省略可能。 ビルドまたはリリース パイプラインで定義されている変数を、アプリケーション マニフェスト ファイル内の Parameter Name エントリと照合するように指定します。 Visual Studio でアプリケーション パラメーター ファイルを作成する方法の詳細を確認してください。 例:

 <Parameters> 
 <Parameter Name="SampleApp_PartitionCount" Value="1" /> 
 <Parameter Name="SampleApp_InstanceCount" DefaultValue="-1" /> 
 </Parameters>

アプリケーションに上記の例のように定義されているパラメーターがあり、パーティション数を に 2変更する場合は、リリース パイプラインまたは環境変数 SampleApp_PartitionCount とその値を として 2定義できます。

注意

リリース パイプラインと環境で同じ変数が定義されている場合、環境変数はリリース パイプライン変数よりも優先されます。

compressPackage - パッケージの圧縮
boolean. 既定値: false。

省略可能。 イメージ ストアにコピーする前に、アプリケーション パッケージを圧縮するかどうかを指定します。 有効にすると、発行プロファイルの値がオーバーライドされます。 パッケージの圧縮の詳細については、こちらを参照してください。

copyPackageTimeoutSec - CopyPackageTimeoutSec
string.

省略可能。 アプリケーション パッケージをイメージ ストアにコピーするためのタイムアウトを秒単位で指定します。 指定すると、発行プロファイルの値がオーバーライドされます。

registerPackageTimeoutSec - RegisterPackageTimeoutSec
string.

省略可能。 アプリケーション パッケージの登録または登録解除のタイムアウトを秒単位で指定します。

overwriteBehavior - 上書き動作
string. 必須です。 許可値: Always、Never、SameAppTypeAndVersion。 既定値: SameAppTypeAndVersion。

同じ名前のアプリケーションがクラスター内に存在し、アップグレードが構成されていない場合に動作を上書きします。

Never では、既存のアプリケーションは削除されません。 これが既定の動作です。

Always では、アプリケーションの種類とバージョンが作成されるアプリケーションと異なる場合でも、既存のアプリケーションが削除されます。

SameAppTypeAndVersion は、アプリケーションの種類とバージョンが作成されるアプリケーションと同じ場合にのみ、既存のアプリケーションを削除します。

skipUpgradeSameTypeAndVersion - 同じ種類とバージョンのアップグレードをスキップする
boolean. 既定値: false。

省略可能。 同じアプリケーションの種類とバージョンがクラスターに既に存在する場合にアップグレードをスキップするかどうかを指定します。そうしないと、検証中にアップグレードが失敗します。 有効な場合、再デプロイはべき等になります。

skipPackageValidation - パッケージの検証をスキップする
boolean. 既定値: false。

省略可能。 展開前にパッケージを検証するかどうかを指定します。 パッケージの検証の詳細については、こちらを参照してください。

useDiffPackage - Diff パッケージを使用する
boolean. 既定値: false。

省略可能。 更新されたアプリケーション ファイル、更新されたアプリケーション マニフェスト、サービス マニフェスト ファイルのみを含むdiff パッケージを使用してアップグレードします。

diff パッケージは、アプリケーション パッケージ入力で指定されたパッケージと、ターゲット クラスターに現在登録されているパッケージを比較することによって作成されます。 クラスターの現在のパッケージ内のサービス バージョンが新しいパッケージと同じ場合、このサービス パッケージは新しいアプリケーション パッケージから削除されます。 diff パッケージの詳細については、こちらを参照してください。

overridePublishProfileSettings - すべての発行プロファイルのアップグレード設定をオーバーライドする
boolean. 既定値: false。

省略可能。 指定した値または既定値 (指定されていない場合) を使用して、すべてのアップグレード設定をオーバーライドします。 アップグレード設定の詳細については、こちらを参照してください。

isUpgrade - アプリケーションをアップグレードする
boolean. 省略可能。 の場合は overridePublishProfileSettings = trueを使用します。 既定値: true。

値が に設定されている場合は、アプリケーションを上書きします false。

unregisterUnusedVersions - 未使用バージョンの登録解除
boolean. 既定値: true。

省略可能。 アップグレード後に、使用されていないアプリケーションの種類のすべてのバージョンを削除するかどうかを示します。

upgradeMode - アップグレード モード
string. overridePublishProfileSettings = true && isUpgrade = true の場合に必要です。 許可値: Monitored、UnmonitoredAuto、UnmonitoredManual。 既定値: Monitored。

FailureAction - FailureAction
string. overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitored の場合に必要です。 使用できる値: Rollback、Manual。 既定値: Rollback。

UpgradeReplicaSetCheckTimeoutSec - UpgradeReplicaSetCheckTimeoutSec
string. 省略可能。 の場合は overridePublishProfileSettings = true && isUpgrade = trueを使用します。

TimeoutSec - TimeoutSec
string. 省略可能。 の場合は overridePublishProfileSettings = true && isUpgrade = trueを使用します。

ForceRestart - ForceRestart
boolean. 省略可能。 の場合は overridePublishProfileSettings = true && isUpgrade = trueを使用します。 既定値: false。

HealthCheckRetryTimeoutSec - HealthCheckRetryTimeoutSec
string. 省略可能。 の場合は overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitoredを使用します。

HealthCheckWaitDurationSec - HealthCheckWaitDurationSec
string. 省略可能。 の場合は overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitoredを使用します。

HealthCheckStableDurationSec - HealthCheckStableDurationSec
string. 省略可能。 の場合は overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitoredを使用します。

UpgradeDomainTimeoutSec - UpgradeDomainTimeoutSec
string. 省略可能。 の場合は overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitoredを使用します。

ConsiderWarningAsError - ConsiderWarningAsError
boolean. 省略可能。 の場合は overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitoredを使用します。 既定値: false。

DefaultServiceTypeHealthPolicy - DefaultServiceTypeHealthPolicy
string. 省略可能。 の場合は overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitoredを使用します。

MaxPercentUnhealthyDeployedApplications - MaxPercentUnhealthyDeployedApplications
string. 省略可能。 の場合は overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitoredを使用します。

UpgradeTimeoutSec - UpgradeTimeoutSec
string. 省略可能。 の場合は overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitoredを使用します。

ServiceTypeHealthPolicyMap - ServiceTypeHealthPolicyMap
string. 省略可能。 の場合は overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitoredを使用します。

configureDockerSettings - Docker 設定を構成する
boolean. 既定値: false。

指定した Docker 設定を使用してアプリケーションを構成します。

registryCredentials - レジストリ資格情報ソース
string. configureDockerSettings = true の場合に必要です。 使用できる値: AzureResourceManagerEndpoint (Azure Resource Manager サービス接続) ContainerRegistryEndpoint 、(Container Registry Service Connection) UsernamePassword 、(ユーザー名とパスワード)。 既定値: AzureResourceManagerEndpoint。

Docker レジストリの資格情報を指定する方法を指定します。

dockerRegistryConnection - Docker レジストリ サービス接続
入力エイリアス: dockerRegistryEndpoint。 string. configureDockerSettings = true && registryCredentials = ContainerRegistryEndpoint の場合に必要です。

Docker レジストリ サービス接続を指定します。 レジストリで認証する必要があるコマンドでは必須です。

注意

タスクは、サービス ファブリック クラスターに送信する前に、レジストリ シークレットの暗号化を試みます。 ただし、タスクでは、クラスターのサーバー証明書をエージェント コンピューターにインストールする必要があります。 証明書が存在しない場合、レジストリ シークレットは暗号化されません。

azureSubscription - Azure サブスクリプション
入力エイリアス: azureSubscriptionEndpoint。 string. configureDockerSettings = true && registryCredentials = AzureResourceManagerEndpoint の場合に必要です。

Azure サブスクリプションを指定します。

注意

タスクは、レジストリ シークレットを Service Fabric クラスターに送信する前に暗号化しようとします。 ただし、タスクでは、クラスターのサーバー証明書をエージェント コンピューターにインストールする必要があります。 証明書が存在しない場合、レジストリ シークレットは暗号化されません。

registryUserName - レジストリ ユーザー名
string. 省略可能。 の場合は configureDockerSettings = true && registryCredentials = UsernamePasswordを使用します。

Docker レジストリのユーザー名を指定します。

registryPassword - レジストリ パスワード
string. 省略可能。 の場合は configureDockerSettings = true && registryCredentials = UsernamePasswordを使用します。

Docker レジストリのパスワードを指定します。 パスワードが暗号化されていない場合は、カスタム リリース パイプライン シークレット変数を使用してパスワードを格納する必要があります。

passwordEncrypted - Password Encrypted
boolean. 省略可能。 の場合は configureDockerSettings = true && registryCredentials = UsernamePasswordを使用します。 既定値: true。

Invoke-ServiceFabricEncryptText を使用してパスワードを暗号化する必要があります。 そうでない場合、クラスター サービス接続のサーバー証明書拇印に一致する証明書がビルド エージェントにインストールされている場合、その証明書はパスワードの暗号化に使用されます。それ以外の場合は、エラーが発生します。

タスク制御オプション

すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「 コントロール オプションと一般的なタスク プロパティ」を参照してください。

出力変数

[なし] :

解説

このタスクを使用して、Service Fabric アプリケーションをクラスターにデプロイします。 このタスクでは、発行プロファイルで定義されている設定に従って、Azure Service Fabric アプリケーションをクラスターにデプロイします。

Service Fabric

このタスクでは、Service Fabric インストールを使用し、Service Fabric クラスターに接続してデプロイします。 ビルド エージェントに Service Fabric をダウンロードしてインストールします。

要件

要件	説明
パイプラインの種類	YAML、クラシック ビルド、クラシック リリース
実行日	エージェント、DeploymentGroup
確認要求	セルフホステッド エージェントには、このタスクを使用するジョブを実行するための次の要求に一致する機能が必要です。 Cmd
Capabilities	このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。
コマンドの制限	Any
設定可能な変数	Any
エージェントのバージョン	1.95.0 以上
タスクのカテゴリ	配置