New-ServiceFabricComposeDeployment

Reference

Module:: ServiceFabric

PREVIEW. Creates a Service Fabric compose deployment.

Syntax

New-ServiceFabricComposeDeployment
   [-DeploymentName] <String>
   [-Compose] <String>
   [-RegistryUserName <String>]
   [-RegistryPassword <String>]
   [-PasswordEncrypted]
   [-TimeoutSec <Int32>]
   [<CommonParameters>]

Description

This cmdlet is in PREVIEW and is subject to change in the next release(s). There is no compatibility guarantee.

The New-ServiceFabricComposeDeployment cmdlet creates a Service Fabric compose deployment from a compose file.

Before you perform any operation on a Service Fabric cluster, establish a connection to the cluster by using the Connect-ServiceFabricCluster cmdlet.

For guidance of Service Fabric compose deployment, please refer to: Compose deployment in Service Fabric.

Examples

Example 1: Create a compose deployment

PS C:\> New-ServiceFabricComposeDeployment -DeploymentName mydeployment -Compose docker-compose.yaml

This command creates a compose deployment named mydeployment from compose file docker-compose.yaml. There is no need to register application type beforehand.

Example 2: Create a compose deployment with registry credential

PS C:\> New-ServiceFabricComposeDeployment -DeploymentName mydeployment -Compose docker-compose.yaml -RegistryUserName "username" -RegistryPassword "password""

This command creates a compose deployment named mydeployment from compose file docker-compose.yaml. It also provides credential to container registry. There is no need to register application type beforehand.

Parameters

-Compose

Specifies the file path to a compose file which describes the Service Fabric compose deployment.

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-DeploymentName

Specifies the name of compose deployment. The cmdlet creates a Service Fabric compose deployment with this name.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PasswordEncrypted

Indicates if RegistryPassword is encrypted by Invoke-ServiceFabricEncryptText .

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RegistryPassword

Indicates the password of container registry. If this parmameter is provided, RegistryUserName needs to be provided together.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RegistryUserName

Indicates the username of container registry. If this parmameter is provided, RegistryPassword needs to be provided together.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TimeoutSec

Specifies the time-out period, in seconds, for the operation.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

None

Outputs

System.Object