IUserSecretsManager

Interface

📦 Aspire.Hosting v13.4.0

interface IUserSecretsManager {
  readonly filePath: string;
  readonly isAvailable: boolean;
  getOrSetSecret(
      resourceBuilder: IResource,
      name: string,
      value: string): void;
  saveStateJson(
      json: string,
      cancellationToken?: cancellationToken): void;
  tryDeleteSecret(name: string): boolean;
  trySetSecret(
      name: string,
      value: string): boolean;
}

6 members

Properties

propertyfilePathstringget

Gets the path to the user secrets file.

propertyisAvailablebooleanget

Gets a value indicating whether user secrets are available.

Methods

methodgetOrSetSecret

Gets a secret value if it exists in configuration, or sets it to the provided value if it does not.

getOrSetSecret(
    resourceBuilder: IResource,
    name: string,
    value: string): void

Parameters

resourceBuilderIResource

namestring

valuestring

methodsaveStateJson

Saves state to user secrets from a JSON string.

saveStateJson(
    json: string,
    cancellationToken?: cancellationToken): void

Parameters

jsonstring

cancellationTokencancellationTokenoptional

methodtryDeleteSecret

Attempts to delete a user secret value synchronously.

tryDeleteSecret(name: string): boolean

Parameters

namestring

Returns

boolean

methodtrySetSecret

Attempts to set a user secret value synchronously.

trySetSecret(
    name: string,
    value: string): boolean

Parameters

namestring

valuestring

Returns

boolean