Share via

RestartDeployedCodePackageRequest interface

Package:
@azure/arm-servicefabricmanagedclusters

Parameters for restarting a deployed code package.

Properties

codePackageInstanceId

The instance ID for currently running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started. Each time entry point executable is run, its instance ID will change. If 0 is passed in as the code package instance ID, the API will restart the code package with whatever instance ID it is currently running. If an instance ID other than 0 is passed in, the API will restart the code package only if the current Instance ID matches the passed in instance ID. Note, passing in the exact instance ID (not 0) in the API is safer, because if ensures at most one restart of the code package.
codePackageName

The name of the code package as specified in the service manifest.
nodeName

The name of the node where the code package needs to be restarted. Use '*' to restart on all nodes where the code package is running.
serviceManifestName

The name of the service manifest as specified in the code package.
servicePackageActivationId

The activation id of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId is always an empty string.

Property Details

codePackageInstanceId

The instance ID for currently running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started. Each time entry point executable is run, its instance ID will change. If 0 is passed in as the code package instance ID, the API will restart the code package with whatever instance ID it is currently running. If an instance ID other than 0 is passed in, the API will restart the code package only if the current Instance ID matches the passed in instance ID. Note, passing in the exact instance ID (not 0) in the API is safer, because if ensures at most one restart of the code package.

codePackageInstanceId: string

Property Value

string

codePackageName

The name of the code package as specified in the service manifest.

codePackageName: string

Property Value

string

nodeName

The name of the node where the code package needs to be restarted. Use '*' to restart on all nodes where the code package is running.

nodeName: string

Property Value

string

serviceManifestName

The name of the service manifest as specified in the code package.

serviceManifestName: string

Property Value

string

servicePackageActivationId

The activation id of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId is always an empty string.

servicePackageActivationId?: string

Property Value

string