get-environment-user-sync-state

subtitle

Returns the user synchronization state for an environment.

version

0.9.128

Description

Returns the user synchronization state for an environment.

Synopsis

  get-environment-user-sync-state
--environment-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options

--environment-name (string)

The name or CRN of the environment.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output

state -> (string)

The user sync state of the environment.

userSyncOperationId -> (string)

Operation Id for the latest user sync operation, if any, run for this environment.

Form Factors

public, private