start_node_transitions
Creates, updates, deletes, gets or lists a start_node_transitions resource.
Overview​
| Name | start_node_transitions |
| Type | Resource |
| Id | azure.service_fabric_dataplane.start_node_transitions |
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:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
start_node_transition | exec | StopDurationInSeconds, NodeTransitionType, node_name, OperationId, NodeInstanceId, endpoint | timeout | Starts or stops a cluster node. Starts or stops a cluster node. A cluster node is a process, not the OS instance itself. To start a node, pass in "Start" for the NodeTransitionType parameter. To stop a node, pass in "Stop" for the NodeTransitionType parameter. This API starts the operation - when the API returns the node may not have finished transitioning yet. Call GetNodeTransitionProgress with the same OperationId to get the progress of the operation. |
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.
| Name | Datatype | Description |
|---|---|---|
NodeInstanceId | string | The node instance ID of the target node. This can be determined through GetNodeInfo API. |
NodeTransitionType | string | Indicates the type of transition to perform. NodeTransitionType.Start will start a stopped node. NodeTransitionType.Stop will stop a node that is up. Possible values include: 'Invalid', 'Start', 'Stop' |
OperationId | string | A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API |
StopDurationInSeconds | integer | The duration, in seconds, to keep the node stopped. The minimum value is 600, the maximum is 14400. After this time expires, the node will automatically come back up. |
endpoint | string | The service endpoint host (no scheme). (default: ) |
node_name | string | The name of the node. |
timeout | integer (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​
- start_node_transition
Starts or stops a cluster node. Starts or stops a cluster node. A cluster node is a process, not the OS instance itself. To start a node, pass in "Start" for the NodeTransitionType parameter. To stop a node, pass in "Stop" for the NodeTransitionType parameter. This API starts the operation - when the API returns the node may not have finished transitioning yet. Call GetNodeTransitionProgress with the same OperationId to get the progress of the operation.
EXEC azure.service_fabric_dataplane.start_node_transitions.start_node_transition
@StopDurationInSeconds='{{ StopDurationInSeconds }}' --required,
@NodeTransitionType='{{ NodeTransitionType }}' --required,
@node_name='{{ node_name }}' --required,
@OperationId='{{ OperationId }}' --required,
@NodeInstanceId='{{ NodeInstanceId }}' --required,
@endpoint='{{ endpoint }}' --required,
@timeout='{{ timeout }}'
;