update-parameter-group¶

Description¶

Updates an existing parameter group with new configuration. A parameter with only its name set indicates deletion. A parameter matching an existing name indicates an update. A parameter with a new name indicates an addition.

Synopsis¶

  update-parameter-group
--environment-crn <value>
--parameter-group-crn <value>
[--description <value>]
[--parameters <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--environment-crn (string)

The CRN of an environment to execute the command.

--parameter-group-crn (string)

The CRN of the Parameter Group.

--description (string)

The description of the parameter group.

--parameters (array)

The parameters in this group.

Shorthand Syntax:

name=string,sensitive=boolean,description=string,value=string,assetReferences=[{id=string,name=string,path=string,version=string,environmentProvided=boolean},{id=string,name=string,path=string,version=string,environmentProvided=boolean}] ... (separate items with spaces)

JSON Syntax:

[
  {
    "name": "string",
    "sensitive": true|false,
    "description": "string",
    "value": "string",
    "assetReferences": [
      {
        "id": "string",
        "name": "string",
        "path": "string",
        "version": "string",
        "environmentProvided": true|false
      }
      ...
    ]
  }
  ...
]

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

parameterGroup -> (object)

A parameter group represents a collection of parameters that can be used across multiple workloads.

name -> (string)

The name of the parameter group.

id -> (string)

The parameter group ID.

source -> (string)

The source of parameter group creation.

projectId -> (string)

Optional project ID that parameter group is assigned to.

projectSummary -> (object)

Provides a summary of the project.

id -> (string)

The ID of the project.

crn -> (string)

The CRN of the project.

name -> (string)

The name of the group.

description -> (string)

The description of the group.

workloadAdministrationGroup -> (string)

The name of the workload administration group for this project.

deleting -> (boolean)

Indicates the project is in the process of being deleted.

usages -> (array)

The list of usages where this parameter group is used.

item -> (object)

Represents a resource that uses a parameter group.

resourceId -> (string)

The ID of the resource that uses the parameter group.

resourceType -> (string)

The type of the resource that uses the parameter group.

parentResourceId -> (string)

The parent-resource ID (e.g., deploymentId when resourceType is DEPLOYED_FLOW).

resourceName -> (string)

The name of the resource that uses the parameter group.

status -> (string)

The synchronization status between the parameter group and the resource.

created -> (integer)

Creation timestamp of the parameter group.

updated -> (integer)

Timestamp of the last time the parameter group was modified.

description -> (string)

The description of the parameter group.

crn -> (string)

The CRN of the Parameter Group.

createdBy -> (string)

The username of the creator of the parameter group.

version -> (integer)

The version of the parameter group.

parameters -> (array)

The parameters in this group.

item -> (object)

Represents a parameter which can be used in a parameter context or a deployed flow.

name -> (string)

The name of the parameter.

sensitive -> (boolean)

Whether or not the parameter value is sensitive.

description -> (string)

A brief explanation of how the parameter is used.

value -> (string)

The value of the parameter in this context.

valueSet -> (boolean)

Indicates if the value of this parameter is set (i.e. not null).

assetReferences -> (array)

The list of asset references, if this parameter is a FILE or FILES type.

item -> (object)

A reference to an asset used in a flow parameter

id -> (string)

The ID of the asset

name -> (string)

The name of the asset

path -> (string)

The path of the asset

version -> (string)

The version of the asset

environmentProvided -> (boolean)

Whether or not the asset is provided automatically by the environment. If true, the asset cannot removed or replaced.

Form Factors¶

public