Integrations
Start for free

Deploy a Service Fabric App

Octopus.AzureServiceFabricApp exported 2026-07-22 by Octopus Deploy belongs to ‘Azure’ category.

Deploy a Service Fabric application package to an Azure Service Fabric cluster.

Parameters

When this step is included in a project’s deployment process, the parameters below can be set.

Connection Endpoint

Octopus.Action.ServiceFabric.ConnectionEndpoint

The connection endpoint of the Service Fabric cluster. Used in legacy mode only.

Example: tcp://mycluster.eastus.cloudapp.azure.com:19000

Security Mode

Octopus.Action.ServiceFabric.SecurityMode

The security mode used to connect to the Service Fabric cluster. Used in legacy mode only.

Allowed values: Unsecure, SecureClientCertificate, SecureAzureAD

Default: Unsecure

Server Certificate Thumbprint

Octopus.Action.ServiceFabric.ServerCertThumbprint

The server certificate thumbprint used to communicate with the secure cluster.

Client Certificate

Octopus.Action.ServiceFabric.ClientCertVariable

The client certificate variable used to communicate with the secure cluster when using client certificate security mode.

AAD Credential Type

Octopus.Action.ServiceFabric.AadCredentialType

The Azure Active Directory credential type when using AAD security mode.

Allowed values: UserCredential, ClientCredential

Default: UserCredential

Client Application Secret

Octopus.Action.ServiceFabric.AadClientCredentialSecret

The client application secret used to communicate with the secure cluster via AAD client credentials.

AAD Username

Octopus.Action.ServiceFabric.AadUserCredentialUsername

The Azure AD user’s username used to communicate with the secure cluster.

AAD Password

Octopus.Action.ServiceFabric.AadUserCredentialPassword

The Azure AD user’s password used to communicate with the secure cluster.

Publish Profile File

Octopus.Action.ServiceFabric.PublishProfileFile

The path to the publish profile file. Octopus will use the ApplicationParameters file referenced in this publish profile.

Example: PublishProfiles\Cloud.xml

Deploy Only

Octopus.Action.ServiceFabric.DeployOnly

If selected, the Service Fabric application will not be created or upgraded after registering the application type.

Allowed values: True, False

Default: False

Unregister Unused Versions

Octopus.Action.ServiceFabric.UnregisterUnusedApplicationVersionsAfterUpgrade

Select to unregister any unused application versions that exist after an upgrade is finished.

Allowed values: True, False

Default: False

Override Upgrade Behavior

Octopus.Action.ServiceFabric.OverrideUpgradeBehavior

Indicates the behavior used to override the upgrade settings specified by the publish profile.

Allowed values: None, ForceUpgrade, VetoUpgrade

Default: None

Overwrite Behavior

Octopus.Action.ServiceFabric.OverwriteBehavior

Overwrite behavior if an application exists in the cluster with the same name. This setting is not applicable when upgrading an application.

Allowed values: Never, Always, SameAppTypeAndVersion

Default: SameAppTypeAndVersion

Skip Package Validation

Octopus.Action.ServiceFabric.SkipPackageValidation

Select to tell Service Fabric not to validate the package before deployment.

Allowed values: True, False

Default: False

Copy Package Timeout

Octopus.Action.ServiceFabric.CopyPackageTimeoutSec

A value in seconds to override the timeout for copying an application package to the image store.

Example: 600

Register Application Type Timeout

Octopus.Action.ServiceFabric.RegisterApplicationTypeTimeoutSec

A value in seconds to override the timeout for registering application type.

Example: 600

Enable Legacy Mode

Octopus.Action.ServiceFabric.IsLegacyMode

Select legacy mode if you wish to configure connection-related properties on the step and not through Azure Targets.

Allowed values: True, False

Default: False

Optional features

Enable features by adding their IDs to Octopus.Action.EnabledFeatures (a comma-separated list).

.NET Configuration Transforms Octopus.Features.ConfigurationTransforms

Runs configuration file transforms. Enabled by default for package deployments.

Octopus.Action.Package.AutomaticallyRunConfigurationTransformationFiles

Octopus.Action.Package.AutomaticallyRunConfigurationTransformationFiles

Run default XML transforms (True/False).

Octopus.Action.Package.AdditionalXmlConfigurationTransforms

Octopus.Action.Package.AdditionalXmlConfigurationTransforms

Comma- or newline-separated list of additional transform rules (e.g. Web.Release.config => Web.config).

.NET Configuration Variables Octopus.Features.ConfigurationVariables

Replace appSettings and connectionStrings in .config files. Enabled by default for package deployments.

Octopus.Action.Package.AutomaticallyUpdateAppSettingsAndConnectionStrings

Octopus.Action.Package.AutomaticallyUpdateAppSettingsAndConnectionStrings

Replace appSettings and connectionStrings in .config files (True/False).

Custom Deployment Scripts Octopus.Features.CustomScripts

Execute scripts during the deployment (pre-deploy, deploy, post-deploy) without embedding them in your package.

Octopus.Action.CustomScripts.PreDeploy.

Octopus.Action.CustomScripts.PreDeploy.<ext>

Pre-deploy script body. The key’s is the script language extension: ps1 (PowerShell), sh (Bash), csx (C#), or py (Python).

Octopus.Action.CustomScripts.Deploy.

Octopus.Action.CustomScripts.Deploy.<ext>

Deploy-phase script body. The key’s is the script language extension: ps1 (PowerShell), sh (Bash), csx (C#), or py (Python).

Octopus.Action.CustomScripts.PostDeploy.

Octopus.Action.CustomScripts.PostDeploy.<ext>

Post-deploy script body. The key’s is the script language extension: ps1 (PowerShell), sh (Bash), csx (C#), or py (Python).

Structured Configuration Variables Octopus.Features.JsonConfigurationVariables

Replace settings in JSON, YAML, XML, and Java Properties files with Octopus variables. Enabled by default for package deployments.

Octopus.Action.Package.JsonConfigurationVariablesTargets

Octopus.Action.Package.JsonConfigurationVariablesTargets

Newline-separated list of target files (e.g. appsettings.json). Wildcards supported.

Substitute Variables in Templates Octopus.Features.SubstituteInFiles

Transforms files using the Octopus #{Variable} substitution syntax. Enabled by default for package deployments.

Octopus.Action.SubstituteInFiles.TargetFiles

Octopus.Action.SubstituteInFiles.TargetFiles

Newline-separated list of file names to transform (relative to package). Wildcards supported.

Octopus.Action.SubstituteInFiles.OutputEncoding

Octopus.Action.SubstituteInFiles.OutputEncoding

Encoding name for the output file (e.g. utf-8). Optional.

Step configuration using OCL

Example in Octopus Configuration Language (OCL):

step "deploy-service-fabric-app" {
    name = "Deploy Service Fabric App"
    properties = {
        Octopus.Action.TargetRoles = "service-fabric-cluster"
    }

    action {
        action_type = "Octopus.AzureServiceFabricApp"
        properties = {
            Octopus.Action.Package.DownloadOnTentacle = "False"
            Octopus.Action.Package.FeedId = "octopus-server-built-in"
            Octopus.Action.Package.PackageId = "MySfApp"
            Octopus.Action.RunOnServer = "false"
            Octopus.Action.ServiceFabric.DeployOnly = "False"
            Octopus.Action.ServiceFabric.OverrideUpgradeBehavior = "None"
            Octopus.Action.ServiceFabric.OverwriteBehavior = "SameAppTypeAndVersion"
            Octopus.Action.ServiceFabric.PublishProfileFile = "PublishProfiles\\Cloud.xml"
            Octopus.Action.ServiceFabric.SkipPackageValidation = "False"
            Octopus.Action.ServiceFabric.UnregisterUnusedApplicationVersionsAfterUpgrade = "False"
            OctopusUseBundledTooling = "False"
        }

        packages {
            acquisition_location = "Server"
            feed = "octopus-server-built-in"
            package_id = "MySfApp"
        }
    }
}

Page updated on Wednesday, July 22, 2026