register-secret¶

Description¶

Registers a reference to a secret stored in the vault of the cloud provider and stores its metadata in the database. The secret is used to connect to an external data source.

Synopsis¶

  register-secret
[--secret-name <value>]
[--cluster-id <value>]
[--secret-provider-key <value>]
[--azure-vault-name <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--secret-name (string)

Name of the secret.

--cluster-id (string)

The ID of the cluster.

--secret-provider-key (string)

Key of the Secret Provider.

--azure-vault-name (string)

Name of the Azure vault.

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

result -> (object)

Details of a single DWX secret.

secretName -> (string)

The user-facing name of the secret.

secretProviderKey -> (string)

The provider key name associated with the secret.

createdBy -> (string)

The CRN of the user who created the secret.

properties -> (object)

The properties of the secret.

cloudProvider -> (string)

The cloud provider associated with the secret.

version -> (string)

The version of the secret.

azureVaultName -> (string)

The name of the Azure Key Vault.

Form Factors¶

public