ServiceFabricDeploy@1 - Tâche de déploiement d’applications Service Fabric v1

Utilisez cette tâche pour déployer une application Service Fabric sur un cluster. Cette tâche déploie une application Azure Service Fabric sur un cluster en fonction des paramètres définis dans le profil de publication.

Syntax

# 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.
# Service Fabric Application Deployment v1
# Deploy a 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.

Entrées

applicationPackagePath - Package d’application
string. Obligatoire.

Spécifie le chemin d’accès au package d’application à déployer. Les variables et les caractères génériques peuvent être utilisés dans le chemin d’accès.


serviceConnectionName - Connexion au service de cluster
string. Obligatoire.

Spécifie la connexion de service Azure Service Fabric à utiliser pour se connecter au cluster. Les paramètres définis dans cette connexion de service référencée remplacent ceux définis dans le profil de publication. Choisissez Manage d’inscrire une nouvelle connexion de service.

Pour se connecter au cluster, la tâche Service Fabric utilise le magasin de certificats de la machine pour stocker les informations du certificat. Si deux versions s’exécutent ensemble sur un ordinateur à l’aide du même certificat, elles démarrent correctement. Toutefois, si l’une des tâches est terminée, le certificat du magasin de certificats de l’ordinateur sera nettoyé, ce qui affecte la deuxième version.


publishProfilePath - Publier un profil
string.

facultatif. Spécifie le chemin d’accès au fichier de profil de publication qui définit les paramètres à utiliser. Les variables et les caractères génériques peuvent être utilisés dans le chemin d’accès. En savoir plus sur la création de profils de publication dans Visual Studio.


applicationParameterPath - Paramètres d’application
string.

facultatif. Spécifie le chemin d’accès au fichier de paramètres d’application. Les variables et les caractères génériques peuvent être utilisés dans le chemin d’accès. Si elle est spécifiée, la valeur dans le profil de publication est remplacée. En savoir plus sur la création d’un fichier de paramètres d’application dans Visual Studio.


overrideApplicationParameter - Remplacer les paramètres d’application
boolean. Valeur par défaut : false.

facultatif. Spécifie que les variables définies dans le pipeline de build ou de mise en production sont mises en correspondance avec les Parameter Name entrées du fichier manifeste de l’application. En savoir plus sur la création d’un fichier de paramètres d’application dans Visual Studio. Exemple :

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

Si votre application a un paramètre défini comme dans l’exemple ci-dessus, et que vous souhaitez modifier le nombre de partitions en 2, vous pouvez définir un pipeline de mise en production ou une variable SampleApp_PartitionCount d’environnement et sa valeur en tant que 2.

Notes

Si les mêmes variables sont définies dans le pipeline de mise en production et dans l’environnement, les variables d’environnement remplacent les variables de pipeline de mise en production.


compressPackage - Compresser le package
boolean. Valeur par défaut : false.

facultatif. Spécifie si le package d’application doit être compressé avant la copie dans le magasin d’images. Si cette option est activée, elle remplace la valeur dans le profil de publication. En savoir plus sur la compression des packages.


copyPackageTimeoutSec - CopyPackageTimeoutSec
string.

facultatif. Spécifie le délai d’attente en secondes pour la copie du package d’application dans le magasin d’images. Si elle est spécifiée, la valeur dans le profil de publication est remplacée.


registerPackageTimeoutSec - RegisterPackageTimeoutSec
string.

facultatif. Spécifie le délai d’attente en secondes pour l’inscription ou la désinscrire d’un package d’application.


overwriteBehavior - Comportement de remplacement
string. Obligatoire. Valeurs autorisées : Always, Never, SameAppTypeAndVersion. Valeur par défaut : SameAppTypeAndVersion.

Remplace le comportement si une application existe dans le cluster portant le même nom et que les mises à niveau n’ont pas été configurées.

Never ne supprime pas l’application existante. Il s'agit du comportement par défaut.

Always supprime l’application existante, même si son type d’application et sa version sont différents de l’application en cours de création.

SameAppTypeAndVersion supprime l’application existante uniquement si son type d’application et sa version sont identiques à l’application en cours de création.


skipUpgradeSameTypeAndVersion - Ignorer la mise à niveau pour les mêmes type et version
boolean. Valeur par défaut : false.

facultatif. Spécifie si une mise à niveau sera ignorée si le même type d’application et la même version existent déjà dans le cluster ; sinon, la mise à niveau échoue pendant la validation. Si activé, les redéploiements sont idempotents.


skipPackageValidation - Ignorer la validation de package
boolean. Valeur par défaut : false.

facultatif. Spécifie si le package doit être validé ou non avant le déploiement. En savoir plus sur la validation des packages.


useDiffPackage - Utiliser le package Diff
boolean. Valeur par défaut : false.

facultatif. Met à niveau à l’aide d’un package diff qui contient uniquement les fichiers d’application mis à jour, le manifeste d’application mis à jour et les fichiers manifeste de service.

Un package diff est créé en comparant le package spécifié dans l’entrée du package d’application au package actuellement inscrit dans le cluster cible. Si une version de service dans le package actuel du cluster est identique au nouveau package, ce package de service est supprimé du nouveau package d’application. En savoir plus sur les packages diff.


overridePublishProfileSettings - Remplacer tous les paramètres de mise à niveau de profil de publication
boolean. Valeur par défaut : false.

facultatif. Remplace tous les paramètres de mise à niveau par des valeurs spécifiées ou par la valeur par défaut (s’il n’est pas spécifié). En savoir plus sur les paramètres de mise à niveau.


isUpgrade - Mettre à niveau l’application
boolean. facultatif. Utilisez quand overridePublishProfileSettings = true. Valeur par défaut : true.

Remplace l’application si la valeur est définie sur false.


unregisterUnusedVersions - Annuler l’inscription des versions inutilisées
boolean. Valeur par défaut : true.

facultatif. Indique si toutes les versions inutilisées du type d’application seront supprimées après une mise à niveau.


upgradeMode - Mode mise à niveau
string. Nécessaire lorsque overridePublishProfileSettings = true && isUpgrade = true. Valeurs autorisées : Monitored, UnmonitoredAuto, UnmonitoredManual. Valeur par défaut : Monitored.


FailureAction - FailureAction
string. Nécessaire lorsque overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitored. Valeurs autorisées : Rollback, Manual. Valeur par défaut : Rollback.


UpgradeReplicaSetCheckTimeoutSec - UpgradeReplicaSetCheckTimeoutSec
string. facultatif. Utilisez quand overridePublishProfileSettings = true && isUpgrade = true.


TimeoutSec - TimeoutSec
string. facultatif. Utilisez quand overridePublishProfileSettings = true && isUpgrade = true.


ForceRestart - ForceRestart
boolean. facultatif. Utilisez quand overridePublishProfileSettings = true && isUpgrade = true. Valeur par défaut : false.


HealthCheckRetryTimeoutSec - HealthCheckRetryTimeoutSec
string. facultatif. Utilisez quand overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitored.


HealthCheckWaitDurationSec - HealthCheckWaitDurationSec
string. facultatif. Utilisez quand overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitored.


HealthCheckStableDurationSec - HealthCheckStableDurationSec
string. facultatif. Utilisez quand overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitored.


UpgradeDomainTimeoutSec - UpgradeDomainTimeoutSec
string. facultatif. Utilisez quand overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitored.


ConsiderWarningAsError - ConsiderWarningAsError
boolean. facultatif. Utilisez quand overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitored. Valeur par défaut : false.


DefaultServiceTypeHealthPolicy - DefaultServiceTypeHealthPolicy
string. facultatif. Utilisez quand overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitored.


MaxPercentUnhealthyDeployedApplications - MaxPercentUnhealthyDeployedApplications
string. facultatif. Utilisez quand overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitored.


UpgradeTimeoutSec - UpgradeTimeoutSec
string. facultatif. Utilisez quand overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitored.


ServiceTypeHealthPolicyMap - ServiceTypeHealthPolicyMap
string. facultatif. Utilisez quand overridePublishProfileSettings = true && isUpgrade = true && upgradeMode = Monitored.


configureDockerSettings - Configurer les paramètres Docker
boolean. Valeur par défaut : false.

Configure l’application avec les paramètres Docker spécifiés.


registryCredentials - Source des informations d’identification du Registre
string. Nécessaire lorsque configureDockerSettings = true. Valeurs autorisées : AzureResourceManagerEndpoint (Azure Resource Manager Service Connection), ContainerRegistryEndpoint (Container Registry Service Connection), UsernamePassword (Nom d’utilisateur et Mot de passe). Valeur par défaut : AzureResourceManagerEndpoint.

Spécifie la façon dont les informations d’identification pour le registre Docker sont fournies.


dockerRegistryConnection - Connexion au service Docker Registry
Alias d’entrée : dockerRegistryEndpoint. string. Nécessaire lorsque configureDockerSettings = true && registryCredentials = ContainerRegistryEndpoint.

Spécifie une connexion au service de registre Docker. Obligatoire pour les commandes qui doivent s’authentifier sur un registre.

Notes

La tâche tente de chiffrer le secret du Registre avant de le transmettre au cluster Service Fabric. Toutefois, la tâche nécessite l’installation du certificat de serveur du cluster sur l’ordinateur agent. Si le certificat n’est pas présent, le secret de Registre n’est pas chiffré.


azureSubscription - Abonnement Azure
Alias d’entrée : azureSubscriptionEndpoint. string. Nécessaire lorsque configureDockerSettings = true && registryCredentials = AzureResourceManagerEndpoint.

Spécifie un abonnement Azure.

Notes

La tâche tente de chiffrer le secret du Registre avant de le transmettre au cluster Service Fabric. Toutefois, la tâche nécessite l’installation du certificat de serveur du cluster sur l’ordinateur agent. Si le certificat n’est pas présent, le secret de Registre n’est pas chiffré.


registryUserName - Nom d’utilisateur du Registre
string. facultatif. Utilisez quand configureDockerSettings = true && registryCredentials = UsernamePassword.

Spécifie le nom d’utilisateur du registre Docker.


registryPassword - Mot de passe du Registre
string. facultatif. Utilisez quand configureDockerSettings = true && registryCredentials = UsernamePassword.

Spécifie le mot de passe du registre Docker. Si le mot de passe n’est pas chiffré, vous devez utiliser une variable secrète de pipeline de mise en production personnalisée pour le stocker.


passwordEncrypted - Mot de passe chiffré
boolean. facultatif. Utilisez quand configureDockerSettings = true && registryCredentials = UsernamePassword. Valeur par défaut : true.

Vous devez chiffrer votre mot de passe à l’aide d’Invoke-ServiceFabricEncryptText. Si ce n’est pas le cas, et qu’un certificat correspondant à l’empreinte numérique du certificat de serveur dans la connexion au service de cluster est installé sur l’agent de build, ce certificat sera utilisé pour chiffrer le mot de passe ; sinon, une erreur se produit.


Options de contrôle de la tâche

Toutes les tâches ont des options de contrôle en plus de leurs entrées de tâches. Pour plus d’informations, consultez Options de contrôle et propriétés de tâche courantes.

Variables de sortie

Aucun.

Notes

Utilisez cette tâche pour déployer une application Service Fabric sur un cluster. Cette tâche déploie une application Azure Service Fabric sur un cluster en fonction des paramètres définis dans le profil de publication.

Service Fabric

Cette tâche utilise une installation Service Fabric pour se connecter à un cluster Service Fabric et y effectuer un déploiement. Téléchargez et installez Service Fabric sur l’agent de build.

Configuration requise

Condition requise Description
Types de pipelines YAML, build classique, version classique
S’exécute sur Agent, DeploymentGroup
Demandes Les agents auto-hébergés doivent avoir des fonctionnalités qui correspondent aux exigences suivantes pour exécuter des travaux qui utilisent cette tâche : Cmd
Capabilities Cette tâche ne répond à aucune demande pour les tâches suivantes dans le travail.
Restrictions de commandes Quelconque
Variables settables Quelconque
Version de l’agent 1.95.0 ou version ultérieure
Catégorie de la tâche Déployer