set-workload-password-policy¶

Description¶

Set the workload password for the account. Changes to the workload password policy only affect passwords that are set after the policy has been updated. By default, passwords never expire.

Synopsis¶

  set-workload-password-policy
[--global-password-policy <value>]
[--machine-users-password-policy <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--global-password-policy (object)

An object representing password policy options.

maxPasswordLifetimeDays -> (integer)

The maximum lifetime of passwords, in days. If set to ‘0’ passwords never expire. The default is 0.

minPasswordLength -> (integer)

The minimum length of a password. Can be any number between 6 and 256. The default minimum password length is 8.

mustIncludeUpperCaseCharacters -> (boolean)

Whether passwords must include upper case characters. The default is ‘true’.

mustIncludeLowerCaseCharacters -> (boolean)

Whether passwords must include lower case characters. The default is ‘true’.

mustIncludeNumbers -> (boolean)

Whether passwords must include numbers. The default is ‘true’.

mustIncludeSymbols -> (boolean)

Whether passwords must include symbols. The symbols are ‘#’, ‘&’, ‘*’, ‘$’, ‘%’, ‘@’, ‘^’, ‘.’, ‘_’, and ‘!’. The default is ‘true’.

minPasswordLifetimeDays -> (integer)

The minimum lifetime of passwords, in days. The password must be used for this duration before it can be changed. If set to ‘0’ the password may be changed any time. The default is 0. The minPasswordLifetimeDays must be greater than maxPasswordLifetimeDays.

passwordHistorySize -> (integer)

The number of previous passwords that should be remembered. The user or machine user is prevented from reusing these passwords. Can be any number between 0 and 20. The default is 0, this value means all previous passwords may be reused.

Shorthand Syntax:

maxPasswordLifetimeDays=integer,minPasswordLength=integer,mustIncludeUpperCaseCharacters=boolean,mustIncludeLowerCaseCharacters=boolean,mustIncludeNumbers=boolean,mustIncludeSymbols=boolean,minPasswordLifetimeDays=integer,passwordHistorySize=integer

JSON Syntax:

{
  "maxPasswordLifetimeDays": integer,
  "minPasswordLength": integer,
  "mustIncludeUpperCaseCharacters": true|false,
  "mustIncludeLowerCaseCharacters": true|false,
  "mustIncludeNumbers": true|false,
  "mustIncludeSymbols": true|false,
  "minPasswordLifetimeDays": integer,
  "passwordHistorySize": integer
}

--machine-users-password-policy (object)

An object representing password policy options.

maxPasswordLifetimeDays -> (integer)

The maximum lifetime of passwords, in days. If set to ‘0’ passwords never expire. The default is 0.

minPasswordLength -> (integer)

The minimum length of a password. Can be any number between 6 and 256. The default minimum password length is 8.

mustIncludeUpperCaseCharacters -> (boolean)

Whether passwords must include upper case characters. The default is ‘true’.

mustIncludeLowerCaseCharacters -> (boolean)

Whether passwords must include lower case characters. The default is ‘true’.

mustIncludeNumbers -> (boolean)

Whether passwords must include numbers. The default is ‘true’.

mustIncludeSymbols -> (boolean)

Whether passwords must include symbols. The symbols are ‘#’, ‘&’, ‘*’, ‘$’, ‘%’, ‘@’, ‘^’, ‘.’, ‘_’, and ‘!’. The default is ‘true’.

minPasswordLifetimeDays -> (integer)

The minimum lifetime of passwords, in days. The password must be used for this duration before it can be changed. If set to ‘0’ the password may be changed any time. The default is 0. The minPasswordLifetimeDays must be greater than maxPasswordLifetimeDays.

passwordHistorySize -> (integer)

The number of previous passwords that should be remembered. The user or machine user is prevented from reusing these passwords. Can be any number between 0 and 20. The default is 0, this value means all previous passwords may be reused.

Shorthand Syntax:

maxPasswordLifetimeDays=integer,minPasswordLength=integer,mustIncludeUpperCaseCharacters=boolean,mustIncludeLowerCaseCharacters=boolean,mustIncludeNumbers=boolean,mustIncludeSymbols=boolean,minPasswordLifetimeDays=integer,passwordHistorySize=integer

JSON Syntax:

{
  "maxPasswordLifetimeDays": integer,
  "minPasswordLength": integer,
  "mustIncludeUpperCaseCharacters": true|false,
  "mustIncludeLowerCaseCharacters": true|false,
  "mustIncludeNumbers": true|false,
  "mustIncludeSymbols": true|false,
  "minPasswordLifetimeDays": integer,
  "passwordHistorySize": integer
}

--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¶

Form Factors¶

public, private