add-flow-to-deployment¶

Description¶

Add a flow to an existing deployment on workload. This operation is supported for the CLI only.

Synopsis¶

  add-flow-to-deployment
--deployment-crn <value>
--flow-version-crn <value>
--name <value>
[--from-archive <value>]
[--import-archive-flow-name <value>]
[--auto-start-flow | --no-auto-start-flow]
[--parameter-groups <value>]
[--kpis <value>]
[--ignore-deployment-inbound-configuration-checks | --no-ignore-deployment-inbound-configuration-checks]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--deployment-crn (string)

CRN for the deployment.

--flow-version-crn (string)

CRN for the flow definition version.

--name (string)

Unique name for the deployed flow within the deployment.

--from-archive (string)

The name of the deployment configuration archive to import deployment configurations from.

--import-archive-flow-name (string)

The name of the flow within the configuration archive to import. This parameter is required when using –from-archive.

--auto-start-flow | --no-auto-start-flow (boolean)

Automatically start the flow.

--parameter-groups (array)

Parameter groups with each requiring a value or assets. If –from-archive is used, then parameters defined here will override what is defined in the archive. Sensitive parameters must always be specified here.

JSON Syntax:

[
  {
    "name": "string",
    "parameters": [
      {
        "name": "string",
        "value": "string",
        "assetReferences": ["string", ...],
        "sourceParameterGroupId": "string"
      }
      ...
    ],
    "inheritedParameterGroups": [
      {
        "groupId": "string"
      }
      ...
    ]
  }
  ...
]

--kpis (array)

Key Performance Indicators with associated alerts. This argument will be ignored if –from-archive is used.

JSON Syntax:

[
  {
    "metricId": "string",
    "componentId": "string",
    "alert": {
      "thresholdMoreThan": {
        "unitId": "string",
        "value": double
      },
      "thresholdLessThan": {
        "unitId": "string",
        "value": double
      },
      "frequencyTolerance": {
        "value": double,
        "unit": {
          "id": "SECONDS"|"MINUTES"|"HOURS"|"DAYS"
        }
      }
    }
  }
  ...
]

--ignore-deployment-inbound-configuration-checks | --no-ignore-deployment-inbound-configuration-checks (boolean)

When specified, ignore the check to validate if deployment has inbound connection configured for all listen components.

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

crn -> (string)

CRN for the created deployed flow.

Form Factors¶

public