azure-service-fabric-target.mdx

layout	pubDate	modDate	title	description	navOrder
src/layouts/Default.astro	2023-01-01	2024-04-30	Create Azure Service Fabric target command	Cmdlet for creating an Azure Service Fabric target	30

import CreateDeploymentTargetsHint from 'src/shared-content/infrastructure/create-deployment-targets-hint.include.md';

Azure Service Fabric

Command: New-OctopusAzureServiceFabricTarget

Parameter	Value
-name	Name for the Octopus deployment target
-azureConnectionEndpoint	Connection endpoint for the Service Fabric Cluster
-azureSecurityMode	Security mode, use one of the aliases in the table below
-azureCertificateThumbprint	Certificate thumbprint of the Azure Certificate
-azureActiveDirectoryUsername	Username for accessing the Service Fabric Cluster
-azureActiveDirectoryPassword	Password for accessing the Service Fabric Cluster
-certificateStoreLocation	(Optional) Override the default certificate store location
-certificateStoreName	(Optional) Override the default certificate store name
-octopusCertificateIdOrName	Name or Id of the Certificate Resource in Octopus
-octopusRoles	Comma separated list of target tags to assign
-updateIfExisting	Will update an existing Service Fabric target with the same name, create if it doesn't exist
-octopusDefaultWorkerPoolIdOrName	Name or Id of the Worker Pool for the deployment target to use. (Optional). Added in 2020.6.0.

Security Mode Options

Mode	Aliases
Unsecure	unsecure
Secure Client Certificate	certificate clientcertificate secureclientcertificate
Secure Azure Active Directory	aad azureactivedirectory

Examples:

# Unsecure
New-OctopusAzureServiceFabricTarget -name "My Service Fabric Target 1" `
                                    -azureConnectionEndpoint "connectionEndpoint" `
                                    -azureSecurityMode "unsecure" `
                                    -octopusRoles "ServiceFabricTargetTag" `
                                    -updateIfExisting

# Client Certificate
New-OctopusAzureServiceFabricTarget -name "My Service Fabric Target 2" `
                                    -azureConnectionEndpoint "connectionEndpoint" `
                                    -azureSecurityMode "certificate" `
                                    -azureCertificateThumbprint "1234567890" `
                                    -octopusCertificateIdOrName "My Service Fabric Certificate" `
                                    -octopusRoles "ServiceFabricTargetTag"

# Client Certificate overriding certificate store
New-OctopusAzureServiceFabricTarget -name "My Service Fabric Target 3" `
                                    -azureConnectionEndpoint "https://localhost" `
                                    -azureSecurityMode "certificate" `
                                    -azureCertificateThumbprint "1234" `
                                    -certificateStoreLocation "Custom Store Location" `
                                    -certificateStoreName "My Store Name" `
                                    -octopusCertificateIdOrName "cert" `
                                    -octopusRoles "ServiceFabricTargetTag"

# Azure Active Directory
New-OctopusAzureServiceFabricTarget -name "My Service Fabric Target 4" `
                                   -azureConnectionEndpoint "connectionEndpoint" `
                                   -azureSecurityMode  "azureactivedirectory" `
                                   -azureCertificateThumbprint "1234567890" `
                                   -octopusCertificateIdOrName "cert" `
                                   -octopusRoles "ServiceFabricTargetTag"