Skip to main content

start_partition_restarts

Creates, updates, deletes, gets or lists a start_partition_restarts resource.

Overview

Namestart_partition_restarts
TypeResource
Idazure.service_fabric_dataplane.start_partition_restarts

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
start_partition_restartexecRestartPartitionMode, service_id, partition_id, OperationId, endpointtimeoutThis API will restart some or all replicas or instances of the specified partition. This API is useful for testing failover. If used to target a stateless service partition, RestartPartitionMode must be AllReplicasOrInstances. Call the GetPartitionRestartProgress API using the same OperationId to get the progress.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
OperationIdstringA GUID that identifies a call of this API. This is passed into the corresponding GetProgress API
RestartPartitionModestringDescribe which partitions to restart. Possible values include: 'Invalid', 'AllReplicasOrInstances', 'OnlyActiveSecondaries'
endpointstringThe service endpoint host (no scheme). (default: )
partition_idstringThe identity of the partition.
service_idstringThe identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myappapp1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.
timeoutinteger (int64)The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.

Lifecycle Methods

This API will restart some or all replicas or instances of the specified partition. This API is useful for testing failover. If used to target a stateless service partition, RestartPartitionMode must be AllReplicasOrInstances. Call the GetPartitionRestartProgress API using the same OperationId to get the progress.

EXEC azure.service_fabric_dataplane.start_partition_restarts.start_partition_restart 
@RestartPartitionMode='{{ RestartPartitionMode }}' --required,
@service_id='{{ service_id }}' --required,
@partition_id='{{ partition_id }}' --required,
@OperationId='{{ OperationId }}' --required,
@endpoint='{{ endpoint }}' --required,
@timeout='{{ timeout }}'
;