FabricClient.ClusterManagementClient.CopyClusterPackage Method

Definition

Namespace:

System.Fabric

Assembly:

System.Fabric.dll

Package:

Microsoft.ServiceFabric v9.1.1833

Overloads

CopyClusterPackage(String, String, String, String, String)	Copies the cluster manifest file and/or Service Fabric code package to the image store.
CopyClusterPackage(String, String, String, String, String, TimeSpan)	Copies the cluster manifest file and/or Service Fabric code package to the image store.

CopyClusterPackage(String, String, String, String, String)

Copies the cluster manifest file and/or Service Fabric code package to the image store.

public void CopyClusterPackage (string imageStoreConnectionString, string clusterManifestPath, string clusterManifestPathInImageStore, string codePackagePath, string codePackagePathInImageStore);

member this.CopyClusterPackage : string * string * string * string * string -> unit

Public Sub CopyClusterPackage (imageStoreConnectionString As String, clusterManifestPath As String, clusterManifestPathInImageStore As String, codePackagePath As String, codePackagePathInImageStore As String)

Parameters

imageStoreConnectionString

String

The connection string for the image store, which should match the "ImageStoreConnectionString" setting value found in the cluster manifest of the target cluster. In an on-premise cluster, the value is chosen during initial deployment by the cluster administrator. In an Azure cluster created through the Azure Resource Manager, this value is "fabric:ImageStore". The image store connection string value can be checked by looking at the cluster manifest contents returned by GetClusterManifestAsync().

clusterManifestPath

String

The full path to the cluster manifest file to be copied.

clusterManifestPathInImageStore

String

The relative path along with the file name of the destination in the image store. This parameter is required when clusterManifestPath is specified. This path is created relative to the root directory in the image store and used as the destination for the cluster manifest copy.

codePackagePath

String

The full path to the Service Fabric code package to be copied.

codePackagePathInImageStore

String

The relative path along with the file name of the destination in the image store. This parameter is required when codePackagePathInImageStore is specified. This path is created relative to the root directory in the image store and used as the destination for the code package copy.

Exceptions

UnauthorizedAccessException

There was an error accessing a file on the image store.

FileNotFoundException

A required file was not found on the image store.

DirectoryNotFoundException

A required directory was not found on the image store.

PathTooLongException

A path to an image store file/directory was too long.

FabricException

ImageStoreIOException: There was an IO error communicating with the image store.

TimeoutException

The request timed out but may have already been accepted for processing by the system.

Remarks

Both source cluster manifest path and source code path cannot be null.

CopyClusterPackage(String, String, String, String, String, TimeSpan)

Copies the cluster manifest file and/or Service Fabric code package to the image store.

public void CopyClusterPackage (string imageStoreConnectionString, string clusterManifestPath, string clusterManifestPathInImageStore, string codePackagePath, string codePackagePathInImageStore, TimeSpan timeout);

member this.CopyClusterPackage : string * string * string * string * string * TimeSpan -> unit

Public Sub CopyClusterPackage (imageStoreConnectionString As String, clusterManifestPath As String, clusterManifestPathInImageStore As String, codePackagePath As String, codePackagePathInImageStore As String, timeout As TimeSpan)

Parameters

imageStoreConnectionString

String

The connection string for the image store, which should match the "ImageStoreConnectionString" setting value found in the cluster manifest of the target cluster. In an on-premise cluster, the value is chosen during initial deployment by the cluster administrator. In an Azure cluster created through the Azure Resource Manager, this value is "fabric:ImageStore". The image store connection string value can be checked by looking at the cluster manifest contents returned by GetClusterManifestAsync().

clusterManifestPath

String

The full path to the cluster manifest file to be copied.

clusterManifestPathInImageStore

String

The relative path along with the file name of the destination in the image store. This parameter is required when clusterManifestPath is specified. This path is created relative to the root directory in the image store and used as the destination for the cluster manifest copy.

codePackagePath

String

The full path to the Service Fabric code package to be copied.

codePackagePathInImageStore

String

The relative path along with the file name of the destination in the image store. This parameter is required when codePackagePathInImageStore is specified. This path is created relative to the root directory in the image store and used as the destination for the code package copy.

timeout

TimeSpan

The timespan that defines the maximum amount of time Service Fabric will allow this operation to continue before returning a TimeoutException.

Exceptions

UnauthorizedAccessException

There was an error accessing a file on the image store.

FileNotFoundException

A required file was not found on the image store.

DirectoryNotFoundException

A required directory was not found on the image store.

PathTooLongException

A path to an image store file/directory was too long.

FabricException

ImageStoreIOException: There was an IO error communicating with the image store.

TimeoutException

The request timed out but may have already been accepted for processing by the system.

Remarks

Both source cluster manifest path and source code path cannot be null.