CommandProperties Class

  • Reference

Base class for all types of DMS command properties. If command is not supported by current client, this object is returned.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: MigrateMISyncCompleteCommandProperties, MigrateSyncCompleteCommandProperties, MongoDbCancelCommand, MongoDbFinishCommand, MongoDbRestartCommand.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance
msrest.serialization.Model
CommandProperties

Constructor

CommandProperties(**kwargs)

Parameters

Name Description
command_type
Required
str

Required. Command type.Constant filled by server.

Variables

Name Description
errors
list[ODataError]

Array of errors. This is ignored if submitted.
state
str or CommandState

The state of the command. This is ignored if submitted. Possible values include: "Unknown", "Accepted", "Running", "Succeeded", "Failed".