FabricClient.FaultManagementClient.RestartDeployedCodePackageAsync 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
RestartDeployedCodePackageAsync(String, Uri, String, String, String, Int64, CompletionMode)
This API call restarts the code package as specified by the input parameters.
public System.Threading.Tasks.Task<System.Fabric.Result.RestartDeployedCodePackageResult> RestartDeployedCodePackageAsync (string nodeName, Uri applicationName, string serviceManifestName, string servicePackageActivationId, string codePackageName, long codePackageInstanceId, System.Fabric.CompletionMode completionMode);member this.RestartDeployedCodePackageAsync : string * Uri * string * string * string * int64 * System.Fabric.CompletionMode -> System.Threading.Tasks.Task<System.Fabric.Result.RestartDeployedCodePackageResult>Public Function RestartDeployedCodePackageAsync (nodeName As String, applicationName As Uri, serviceManifestName As String, servicePackageActivationId As String, codePackageName As String, codePackageInstanceId As Long, completionMode As CompletionMode) As Task(Of RestartDeployedCodePackageResult)Parameters
- nodeName
- String
The node on which the code package is hosted.
- applicationName
- Uri
The name of the application to which the code package belongs.
- serviceManifestName
- String
The name of the service manifest where the code package is defined.
- servicePackageActivationId
- String
The ServicePackageActivationId of deployed service package which contains the code package. You can get the ServicePackageActivationId of a deployed service package by using GetDeployedServicePackageListAsync(String, Uri) query.
If ServicePackageActivationMode specified at the time of creating the service was SharedProcess (or if it was not specified, in which case it defaults to SharedProcess), then value of ServicePackageActivationId is always an empty string. For more details please see ServicePackageActivationMode.
- codePackageName
- String
The name of the code package to be restarted
- codePackageInstanceId
- Int64
The code package instance id for the running code package which if specified and does not match then the restart is not processed If the value is 0 then the comparison is skipped.
- completionMode
- CompletionMode
The CompletionMode that specifies whether to wait until the restart of the code package completes or not.
Returns
RestartDeployedCodePackageResult which gives information about the actual code package restarted. SelectedReplica is None in this overload.
Exceptions
Action took more than its allocated time.
Any of the required arguments are null.
These are the fabric failures FabricErrorCode.CodePackageNotFound - If the selected code package was not found FabricErrorCode.InstanceIdMismatch - If the specified instance id did not match
The code package was not in a valid running state.
Remarks
The CompletionMode options are DoNotVerify - Return after triggering the restart of the code package Verify - Return after the restart completes i.e. the code package has come back up again.
Applies to
RestartDeployedCodePackageAsync(String, Uri, String, String, String, Int64, CompletionMode, TimeSpan, CancellationToken)
This API call restarts the code package as specified by the input parameters.
public System.Threading.Tasks.Task<System.Fabric.Result.RestartDeployedCodePackageResult> RestartDeployedCodePackageAsync (string nodeName, Uri applicationName, string serviceManifestName, string servicePackageActivationId, string codePackageName, long codePackageInstanceId, System.Fabric.CompletionMode completionMode, TimeSpan operationTimeout, System.Threading.CancellationToken token);member this.RestartDeployedCodePackageAsync : string * Uri * string * string * string * int64 * System.Fabric.CompletionMode * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Result.RestartDeployedCodePackageResult>Public Function RestartDeployedCodePackageAsync (nodeName As String, applicationName As Uri, serviceManifestName As String, servicePackageActivationId As String, codePackageName As String, codePackageInstanceId As Long, completionMode As CompletionMode, operationTimeout As TimeSpan, token As CancellationToken) As Task(Of RestartDeployedCodePackageResult)Parameters
- nodeName
- String
The node on which the code package is hosted.
- applicationName
- Uri
The name of the application to which the code package belongs.
- serviceManifestName
- String
The name of the service manifest where the code package is defined.
- servicePackageActivationId
- String
The ServicePackageActivationId of deployed service package which contains the code package. You can get the ServicePackageActivationId of a deployed service package by using GetDeployedServicePackageListAsync(String, Uri) query.
If ServicePackageActivationMode specified at the time of creating the service was SharedProcess (or if it was not specified, in which case it defaults to SharedProcess), then value of ServicePackageActivationId is always an empty string. For more details please see ServicePackageActivationMode.
- codePackageName
- String
The name of the code package to be restarted
- codePackageInstanceId
- Int64
The code package instance id for the running code package which if specified and does not match then the restart is not processed If the value is 0 then the comparison is skipped.
- completionMode
- CompletionMode
The CompletionMode that specifies whether to wait until the restart of the code package completes or not.
- operationTimeout
- TimeSpan
The overall timeout for the operation including the timeout to wait for code package to restart if CompletionMode is Verify
- token
- CancellationToken
Cancellation token
Returns
RestartDeployedCodePackageResult which gives information about the actual code package restarted. SelectedReplica is None in this overload.
Exceptions
Action took more than its allocated time.
Any of the required arguments are null.
These are the fabric failures FabricErrorCode.CodePackageNotFound - If the selected code package was not found FabricErrorCode.InstanceIdMismatch - If the specified instance id did not match
The code package was not in a valid running state.
Remarks
The CompletionMode options are DoNotVerify - Return after triggering the restart of the code package Verify - Return after the restart completes i.e. the code package has come back up again.
Applies to
RestartDeployedCodePackageAsync(String, Uri, String, String, Int64, CompletionMode, TimeSpan, CancellationToken)
This API call restarts the code package as specified by the input parameters.
public System.Threading.Tasks.Task<System.Fabric.Result.RestartDeployedCodePackageResult> RestartDeployedCodePackageAsync (string nodeName, Uri applicationName, string serviceManifestName, string codePackageName, long codePackageInstanceId, System.Fabric.CompletionMode completionMode, TimeSpan operationTimeout, System.Threading.CancellationToken token);member this.RestartDeployedCodePackageAsync : string * Uri * string * string * int64 * System.Fabric.CompletionMode * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Result.RestartDeployedCodePackageResult>Public Function RestartDeployedCodePackageAsync (nodeName As String, applicationName As Uri, serviceManifestName As String, codePackageName As String, codePackageInstanceId As Long, completionMode As CompletionMode, operationTimeout As TimeSpan, token As CancellationToken) As Task(Of RestartDeployedCodePackageResult)Parameters
- nodeName
- String
The node on which the code package is hosted.
- applicationName
- Uri
The name of the application to which the code package belongs.
- serviceManifestName
- String
The name of the service manifest where the code package is defined.
- codePackageName
- String
The name of the code package to be restarted
- codePackageInstanceId
- Int64
The code package instance id for the running code package which if specified and does not match then the restart is not processed If the value is 0 then the comparison is skipped.
- completionMode
- CompletionMode
The CompletionMode that specifies whether to wait until the restart of the code package completes or not.
- operationTimeout
- TimeSpan
The overall timeout for the operation including the timeout to wait for code package to restart if CompletionMode is Verify
- token
- CancellationToken
Cancellation token
Returns
RestartDeployedCodePackageResult which gives information about the actual code package restarted. SelectedReplica is None in this overload.
Exceptions
Action took more than its allocated time.
Any of the required arguments are null.
These are the fabric failures FabricErrorCode.CodePackageNotFound - If the selected code package was not found FabricErrorCode.InstanceIdMismatch - If the specified instance id did not match
The code package was not in a valid running state.
Remarks
The CompletionMode options are DoNotVerify - Return after triggering the restart of the code package Verify - Return after the restart completes i.e. the code package has come back up again.
Applies to
RestartDeployedCodePackageAsync(String, Uri, String, String, Int64, CompletionMode, CancellationToken)
This API call restarts the code package as specified by the input parameters.
public System.Threading.Tasks.Task<System.Fabric.Result.RestartDeployedCodePackageResult> RestartDeployedCodePackageAsync (string nodeName, Uri applicationName, string serviceManifestName, string codePackageName, long codePackageInstanceId, System.Fabric.CompletionMode completionMode, System.Threading.CancellationToken token);member this.RestartDeployedCodePackageAsync : string * Uri * string * string * int64 * System.Fabric.CompletionMode * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Result.RestartDeployedCodePackageResult>Public Function RestartDeployedCodePackageAsync (nodeName As String, applicationName As Uri, serviceManifestName As String, codePackageName As String, codePackageInstanceId As Long, completionMode As CompletionMode, token As CancellationToken) As Task(Of RestartDeployedCodePackageResult)Parameters
- nodeName
- String
The node on which the code package is hosted
- applicationName
- Uri
The name of the application to which the code package belongs
- serviceManifestName
- String
The name of the service manifest where the code package is defined
- codePackageName
- String
The name of the code package to be restarted
- codePackageInstanceId
- Int64
The code package instance id for the running code package which if specified and does not match then the restart is not processed If the value is 0 then the comparison is skipped
- completionMode
- CompletionMode
The CompletionMode that specifies whether to wait until the restart of the code package completes or not.
- token
- CancellationToken
Cancellation token
Returns
RestartDeployedCodePackageResult which gives information about the actual code package restarted. SelectedReplica is None in this overload.
Exceptions
Action took more than its allocated time.
Any of the required arguments are null.
These are the fabric failures FabricErrorCode.CodePackageNotFound - If the selected code package was not found FabricErrorCode.InstanceIdMismatch - If the specified instance id did not match
The code package was not in a valid running state.
Remarks
The CompletionMode options are DoNotVerify - Return after triggering the restart of the code package Verify - Return after the restart completes i.e. the code package has come back up again.
Applies to
RestartDeployedCodePackageAsync(String, Uri, String, String, String, Int64, CompletionMode, CancellationToken)
This API call restarts the code package as specified by the input parameters.
public System.Threading.Tasks.Task<System.Fabric.Result.RestartDeployedCodePackageResult> RestartDeployedCodePackageAsync (string nodeName, Uri applicationName, string serviceManifestName, string servicePackageActivationId, string codePackageName, long codePackageInstanceId, System.Fabric.CompletionMode completionMode, System.Threading.CancellationToken token);member this.RestartDeployedCodePackageAsync : string * Uri * string * string * string * int64 * System.Fabric.CompletionMode * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Result.RestartDeployedCodePackageResult>Public Function RestartDeployedCodePackageAsync (nodeName As String, applicationName As Uri, serviceManifestName As String, servicePackageActivationId As String, codePackageName As String, codePackageInstanceId As Long, completionMode As CompletionMode, token As CancellationToken) As Task(Of RestartDeployedCodePackageResult)Parameters
- nodeName
- String
The node on which the code package is hosted
- applicationName
- Uri
The name of the application to which the code package belongs
- serviceManifestName
- String
The name of the service manifest where the code package is defined
- servicePackageActivationId
- String
The ServicePackageActivationId of deployed service package which contains the code package. You can get the ServicePackageActivationId of a deployed service package by using GetDeployedServicePackageListAsync(String, Uri) query.
If ServicePackageActivationMode specified at the time of creating the service was SharedProcess (or if it was not specified, in which case it defaults to SharedProcess), then value of ServicePackageActivationId is always an empty string. For more details please see ServicePackageActivationMode.
- codePackageName
- String
The name of the code package to be restarted
- codePackageInstanceId
- Int64
The code package instance id for the running code package which if specified and does not match then the restart is not processed If the value is 0 then the comparison is skipped
- completionMode
- CompletionMode
The CompletionMode that specifies whether to wait until the restart of the code package completes or not.
- token
- CancellationToken
Cancellation token
Returns
RestartDeployedCodePackageResult which gives information about the actual code package restarted. SelectedReplica is None in this overload.
Exceptions
Action took more than its allocated time.
Any of the required arguments are null.
These are the fabric failures FabricErrorCode.CodePackageNotFound - If the selected code package was not found FabricErrorCode.InstanceIdMismatch - If the specified instance id did not match
The code package was not in a valid running state.
Remarks
The CompletionMode options are DoNotVerify - Return after triggering the restart of the code package Verify - Return after the restart completes i.e. the code package has come back up again.
Applies to
RestartDeployedCodePackageAsync(Uri, ReplicaSelector, CompletionMode, TimeSpan, CancellationToken)
This API call restarts the code package which hosts the replica specified by the ReplicaSelector and belongs to the specified application name.
public System.Threading.Tasks.Task<System.Fabric.Result.RestartDeployedCodePackageResult> RestartDeployedCodePackageAsync (Uri applicationName, System.Fabric.ReplicaSelector replicaSelector, System.Fabric.CompletionMode completionMode, TimeSpan operationTimeout, System.Threading.CancellationToken token);member this.RestartDeployedCodePackageAsync : Uri * System.Fabric.ReplicaSelector * System.Fabric.CompletionMode * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Result.RestartDeployedCodePackageResult>Public Function RestartDeployedCodePackageAsync (applicationName As Uri, replicaSelector As ReplicaSelector, completionMode As CompletionMode, operationTimeout As TimeSpan, token As CancellationToken) As Task(Of RestartDeployedCodePackageResult)Parameters
- applicationName
- Uri
The name of the application to which the code package belongs
- replicaSelector
- ReplicaSelector
The ReplicaSelector which identifies the replica whose host code package needs to be restarted.
- completionMode
- CompletionMode
The CompletionMode that specifies whether to wait until the restart of the code package completes or not.n
- operationTimeout
- TimeSpan
The overall timeout for the operation including the timeout to wait for code package to restart if CompletionMode is Verify
- token
- CancellationToken
Cancellation token.
Returns
RestartDeployedCodePackageResult which gives information about the actual code package restarted and replica selected.
Exceptions
Action took more than its allocated time.
Any of the required arguments are null.
These are the fabric failures FabricErrorCode.ReplicaDoesNotExist - If the Selected replica was not found FabricErrorCode.PartitionNotFound - if the specified partition selected does not exist FabricErrorCode.CodePackageNotFound - If the selected code package was not found
The code package was not in a valid running state.
Remarks
The CompletionMode options are DoNotVerify - Return after triggering the restart of the code package Verify - Return after the restart completes i.e. the code package has come back up again.
Applies to
RestartDeployedCodePackageAsync(Uri, ReplicaSelector, CompletionMode, CancellationToken)
This API call restarts the code package which hosts the replica specified by the ReplicaSelector and belongs to the specified application name.
public System.Threading.Tasks.Task<System.Fabric.Result.RestartDeployedCodePackageResult> RestartDeployedCodePackageAsync (Uri applicationName, System.Fabric.ReplicaSelector replicaSelector, System.Fabric.CompletionMode completionMode, System.Threading.CancellationToken token);member this.RestartDeployedCodePackageAsync : Uri * System.Fabric.ReplicaSelector * System.Fabric.CompletionMode * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Result.RestartDeployedCodePackageResult>Public Function RestartDeployedCodePackageAsync (applicationName As Uri, replicaSelector As ReplicaSelector, completionMode As CompletionMode, token As CancellationToken) As Task(Of RestartDeployedCodePackageResult)Parameters
- applicationName
- Uri
The name of the application to which the code package belong.s
- replicaSelector
- ReplicaSelector
The ReplicaSelector which identifies the replica whose host code package needs to be restarted.
- completionMode
- CompletionMode
The CompletionMode that specifies whether to wait until the restart of the code package completes or not.
- token
- CancellationToken
Cancellation token
Returns
RestartDeployedCodePackageResult which gives information about the actual code package restarted and replica selected.
Exceptions
Action took more than its allocated time.
Any of the required arguments are null.
These are the fabric failures FabricErrorCode.ReplicaDoesNotExist - If the Selected replica was not found FabricErrorCode.PartitionNotFound - if the specified partition selected does not exist FabricErrorCode.CodePackageNotFound - If the selected code package was not found.
The code package was not in a valid running state.
Remarks
The CompletionMode options are DoNotVerify - Return after triggering the restart of the code package Verify - Return after the restart completes i.e. the code package has come back up again.
Applies to
RestartDeployedCodePackageAsync(Uri, ReplicaSelector, CompletionMode)
This API call restarts the code package which hosts the replica specified by the ReplicaSelector and belongs to the specified application name.
public System.Threading.Tasks.Task<System.Fabric.Result.RestartDeployedCodePackageResult> RestartDeployedCodePackageAsync (Uri applicationName, System.Fabric.ReplicaSelector replicaSelector, System.Fabric.CompletionMode completionMode);member this.RestartDeployedCodePackageAsync : Uri * System.Fabric.ReplicaSelector * System.Fabric.CompletionMode -> System.Threading.Tasks.Task<System.Fabric.Result.RestartDeployedCodePackageResult>Public Function RestartDeployedCodePackageAsync (applicationName As Uri, replicaSelector As ReplicaSelector, completionMode As CompletionMode) As Task(Of RestartDeployedCodePackageResult)Parameters
- applicationName
- Uri
The name of the application to which the code package belongs
- replicaSelector
- ReplicaSelector
The ReplicaSelector which identifies the replica whose host code package needs to be restarted.
- completionMode
- CompletionMode
The CompletionMode that specifies whether to wait until the restart of the code package completes or not.
Returns
RestartDeployedCodePackageResult which gives information about the actual code package restarted and replica selected.
Exceptions
Action took more than its allocated time.
Any of the required arguments are null.
These are the fabric failures FabricErrorCode.ReplicaDoesNotExist - If the Selected replica was not found FabricErrorCode.PartitionNotFound - if the specified partition selected does not exist FabricErrorCode.CodePackageNotFound - If the selected code package was not found
The code package was not in a valid running state.
Remarks
The CompletionMode options are DoNotVerify - Return after triggering the restart of the code package Verify - Return after the restart completes i.e. the code package has come back up again.
Applies to
RestartDeployedCodePackageAsync(String, Uri, String, String, Int64, CompletionMode)
This API call restarts the code package as specified by the input parameters.
public System.Threading.Tasks.Task<System.Fabric.Result.RestartDeployedCodePackageResult> RestartDeployedCodePackageAsync (string nodeName, Uri applicationName, string serviceManifestName, string codePackageName, long codePackageInstanceId, System.Fabric.CompletionMode completionMode);member this.RestartDeployedCodePackageAsync : string * Uri * string * string * int64 * System.Fabric.CompletionMode -> System.Threading.Tasks.Task<System.Fabric.Result.RestartDeployedCodePackageResult>Public Function RestartDeployedCodePackageAsync (nodeName As String, applicationName As Uri, serviceManifestName As String, codePackageName As String, codePackageInstanceId As Long, completionMode As CompletionMode) As Task(Of RestartDeployedCodePackageResult)Parameters
- nodeName
- String
The node on which the code package is hosted.
- applicationName
- Uri
The name of the application to which the code package belongs.
- serviceManifestName
- String
The name of the service manifest where the code package is defined.
- codePackageName
- String
The name of the code package to be restarted
- codePackageInstanceId
- Int64
The code package instance id for the running code package which if specified and does not match then the restart is not processed If the value is 0 then the comparison is skipped.
- completionMode
- CompletionMode
The CompletionMode that specifies whether to wait until the restart of the code package completes or not.
Returns
RestartDeployedCodePackageResult which gives information about the actual code package restarted. SelectedReplica is None in this overload.
Exceptions
Action took more than its allocated time.
Any of the required arguments are null.
These are the fabric failures FabricErrorCode.CodePackageNotFound - If the selected code package was not found FabricErrorCode.InstanceIdMismatch - If the specified instance id did not match
The code package was not in a valid running state.
Remarks
The CompletionMode options are DoNotVerify - Return after triggering the restart of the code package Verify - Return after the restart completes i.e. the code package has come back up again.
Applies to
Azure SDK for .NET