FabricClient.ClusterManagementClient.ProvisionFabricAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
ProvisionFabricAsync(String, String) |
Provisions the Service Fabric. |
ProvisionFabricAsync(String, String, TimeSpan, CancellationToken) |
Provisions the Service Fabric by using the specified timeout and cancellation token. |
ProvisionFabricAsync(String, String)
Provisions the Service Fabric.
public System.Threading.Tasks.Task ProvisionFabricAsync (string patchFilePath, string clusterManifestFilePath);
member this.ProvisionFabricAsync : string * string -> System.Threading.Tasks.Task
Public Function ProvisionFabricAsync (patchFilePath As String, clusterManifestFilePath As String) As Task
Parameters
- patchFilePath
- String
The path to the update patch file.
- clusterManifestFilePath
- String
The path to the cluster manifest.
Returns
The provisioned Service Fabric.
Exceptions
The FabricClient object is in a closed state. Dispose of the FabricClient object you are using and instantiate a new FabricClient object.
Remarks
A null
value is permitted for either the patchFilePath
parameter or the clusterManifestFilePath
parameter. A null
value cannot be used for both parameters.
This will upload the patch file and/or cluster manifest file to the image store location. The image store location is specified as a configuration setting in the cluster manifest that was provided when the cluster was created.
Cluster manifest validation will occur within the context of this call.
Applies to
ProvisionFabricAsync(String, String, TimeSpan, CancellationToken)
Provisions the Service Fabric by using the specified timeout and cancellation token.
public System.Threading.Tasks.Task ProvisionFabricAsync (string patchFilePath, string clusterManifestFilePath, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);
member this.ProvisionFabricAsync : string * string * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function ProvisionFabricAsync (patchFilePath As String, clusterManifestFilePath As String, timeout As TimeSpan, cancellationToken As CancellationToken) As Task
Parameters
- patchFilePath
- String
The path to the update patch file.
- clusterManifestFilePath
- String
The path to the cluster manifest.
- timeout
- TimeSpan
The maximum amount of time Service Fabric will allow this operation to continue before returning a TimeoutException.
- cancellationToken
- CancellationToken
The cancellation token that the operation is observing. It can be used to send a notification that the operation should be canceled. Note that cancellation is advisory and that the operation may still be completed even if it is cancelled.
Returns
The provisioned Service Fabric.
Exceptions
The FabricClient object is in a closed state. Dispose of the FabricClient object you are using and instantiate a new FabricClient object.
Remarks
A null
value is permitted for either the patchFilePath
parameter or the clusterManifestFilePath
parameter. A null
value cannot be used for both parameters.
This will upload the patch file and/or cluster manifest file to the image store location. The image store location is specified as a configuration setting in the cluster manifest that was provided when the cluster was created.
Cluster manifest validation will occur within the context of this call.