ActionState interface

Package:

@azure/arm-networkcloud

ActionState represents the state of an action taken against a resource. This can be used to represent both explicitly and implicitly defined action types.

Properties

actionType	The representation of the action for which this is a status. Matches ARM resource action format when the action is an ARM-based action. NOTE: This property will not be serialized. It can only be populated by the server.
correlationId	The correlation ID for the original action request. Omitted if there is no related correlation ID. NOTE: This property will not be serialized. It can only be populated by the server.
endTime	The timestamp of when the action reached its final, terminal state. Uses ISO 8601 format. NOTE: This property will not be serialized. It can only be populated by the server.
message	The description providing additional context for the status value. May be empty or contain guidance in the case of a failure. NOTE: This property will not be serialized. It can only be populated by the server.
startTime	The timestamp of when the action began, in ISO 8601 format. NOTE: This property will not be serialized. It can only be populated by the server.
status	The status of the action. NOTE: This property will not be serialized. It can only be populated by the server.
stepStates	The ordered list of the individual steps which make up the action. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

actionType

The representation of the action for which this is a status. Matches ARM resource action format when the action is an ARM-based action. NOTE: This property will not be serialized. It can only be populated by the server.

actionType?: string

Property Value

string

correlationId

The correlation ID for the original action request. Omitted if there is no related correlation ID. NOTE: This property will not be serialized. It can only be populated by the server.

correlationId?: string

Property Value

string

endTime

The timestamp of when the action reached its final, terminal state. Uses ISO 8601 format. NOTE: This property will not be serialized. It can only be populated by the server.

endTime?: string

Property Value

string

message

The description providing additional context for the status value. May be empty or contain guidance in the case of a failure. NOTE: This property will not be serialized. It can only be populated by the server.

message?: string

Property Value

string

startTime

The timestamp of when the action began, in ISO 8601 format. NOTE: This property will not be serialized. It can only be populated by the server.

startTime?: string

Property Value

string

status

The status of the action. NOTE: This property will not be serialized. It can only be populated by the server.

status?: string

Property Value

string

stepStates

The ordered list of the individual steps which make up the action. NOTE: This property will not be serialized. It can only be populated by the server.

stepStates?: StepState[]

Property Value

StepState[]