New-ServiceFabricApplication

  • Reference
Module:
ServiceFabric

Creates a Service Fabric application.

Syntax

New-ServiceFabricApplication
   [-ApplicationName] <Uri>
   [-ApplicationTypeName] <String>
   [-ApplicationTypeVersion] <String>
   [-ApplicationParameter <Hashtable>]
   [-MaximumNodes <Int64>]
   [-MinimumNodes <Int64>]
   [-Metrics <String[]>]
   [-TimeoutSec <Int32>]
   [<CommonParameters>]

Description

The New-ServiceFabricApplication cmdlet creates a Service Fabric application of a registered application type. Use the Register-ServiceFabricApplicationType cmdlet to register an application type.

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

Examples

Example 1: Create an application

PS C:\> New-ServiceFabricApplication -ApplicationName fabric:/myapp/persistenttodolist -ApplicationTypeName "PersistentToDoListApp" -ApplicationTypeVersion "1.0"

This command creates an application of the type PersistentToDoListApp. The application is version 1.0. Application type and version come from application manifest in the application package that was used when registering the application using Register-ServiceFabricApplicationType cmdlet.

Example 2: Create an application by overriding default parameter values in the application manifest

PS C:\> New-ServiceFabricApplication -ApplicationName fabric:/myapp/persistenttodolist -ApplicationTypeName "PersistentToDoListApp" -ApplicationTypeVersion "1.0" -ApplicationParameter @{CustomParameter1='MyValue'; CustomParameter2='MyValue'}

This command creates an application of the type PersistentToDoListApp and version 1.0 with overridden values for parameters CustomParameter1 and CustomParameter2. These parameter names must exist in the application manifest of the application package that was used when registering the application using Register-ServiceFabricApplicationType cmdlet.

Parameters

-ApplicationName

Specifies the Uniform Resource Identifier (URI) of a Service Fabric application. The cmdlet creates a Service Fabric application with the name that you specify.

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

-ApplicationParameter

Specifies the overrides for application parameters defined in application manifest as key/value pairs. The cmdlet creates a Service Fabric application of the application type and uses the overridden values for these parameters. The parameters that are being overridden here must exist in the application manifest.

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

-ApplicationTypeName

Specifies the name of a Service Fabric application type. The cmdlet creates a Service Fabric application of the application type that you specify.

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

-ApplicationTypeVersion

Specifies the version of a Service Fabric application type. The cmdlet creates an application that has the version that you specify.

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

-MaximumNodes

Specifies the maximum number of nodes on which to place an application. The value of this parameter must be a non-negative integer. The default value is 0, which indicates the application can be placed on any number of nodes in the cluster.

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

-Metrics

Specifies an array of metrics. These metrics are used by Service Fabric Cluster Resource Manager to manage resources in the cluster. For more information about metrics and resource management in Service Fabric, see Service Fabric Cluster Resource Manager Introduction. Each metric can follow the pattern MetricName, NodeReservationCapacity, MaximumNodeCapacity, TotalApplicationCapacity, or can specify MetricName and use parameter names NodeReservationCapacity, MaximumNodeCapacity, or TotalApplicationCapacity followed by a parameter value, and separated with a colon. Each parameter name:value pair can appear at most once.

  • MetricName. Specifies the name of the metric.
  • NodeReservationCapacity. Specifies the amount of metric load that is reserved on nodes that have instances of this application. If MinimumNodes is specified, the product of these values is the capacity reserved in the cluster for the application.
  • MaximumNodeCapacity. Specifies the maximum load for an instance of this application on a single node. Even if the capacity of the node is greater than this value, Service Fabric limits the total load of the application's child replicas to this value.
  • TotalApplicationCapacity. Specifies the total capacity for the application in the cluster. Service Fabric attempts to limit the sum of loads of the application's child replicas to this value.

While creating the application, Service Fabric performs the following validations and will fail the command if they do not pass:

  • NodeReservationCapacity must not be more than MaximumNodeCapacity.

  • If both the MinimumNodes parameter and NodeReservationCapacity metric are specified, then the product of MinimumNodes and NodeReservationCapacity must not be more than TotalApplicationCapacity. For more information, see Application Metrics, Load and Capacity

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

-MinimumNodes

Specifies the minimum number of nodes where Service Fabric will reserve capacity for this application, this does not mean that the application is guaranteed to have replicas on all those nodes. The value of this parameter must be a non-negative integer. Default value for this is zero, which means no capacity is reserved for the application.

Type:Int64
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