BitwardenSecretManagerResource
Handle
interface BitwardenSecretManagerResource extends IResource, IResourceWithWaitSupport { addSecret(name: string): BitwardenSecretResource; addSecretWithRemoteName( name: string, remoteName: string): BitwardenSecretResource; getSecret(name: string): BitwardenSecretResource; getSecretById( name: string, secretId: guid): BitwardenSecretResource; getSecretWithRemoteName( name: string, remoteName: string): BitwardenSecretResource; withApiUrl(apiUrl: string): BitwardenSecretManagerResource; withApiUrlFromExternalService(server: ExternalServiceResource): BitwardenSecretManagerResource; withApiUrlFromParameter(apiUrl: ParameterResource): BitwardenSecretManagerResource; withAuthCacheDirectory(authCacheDirectory: string): BitwardenSecretManagerResource; withCacheFile(cacheFile: string): BitwardenSecretManagerResource; withIdentityUrl(identityUrl: string): BitwardenSecretManagerResource; withIdentityUrlFromExternalService(server: ExternalServiceResource): BitwardenSecretManagerResource; withIdentityUrlFromParameter(identityUrl: ParameterResource): BitwardenSecretManagerResource;}13 members
Methods
Adds a managed Bitwarden secret whose local and remote names are the same. The secret value is resolved from configuration key `Parameters:{parentName}-{name}`.
addSecret(name: string): BitwardenSecretResourceParameters
namestringThe Aspire resource name and Bitwarden secret name.Returns
BitwardenSecretResource Adds a managed Bitwarden secret with distinct Aspire and remote names. The secret value is resolved from configuration key `Parameters:{parentName}-{name}`.
addSecretWithRemoteName( name: string, remoteName: string): BitwardenSecretResourceParameters
namestringThe Aspire resource name.remoteName stringThe Bitwarden secret name.Returns
BitwardenSecretResource Gets or creates a Bitwarden secret reference whose Aspire and remote names are the same. The secret must already exist in Bitwarden; use `AddSecret` if Aspire should own and write the secret value.
getSecret(name: string): BitwardenSecretResourceParameters
namestringThe Aspire resource name and Bitwarden secret name.Returns
BitwardenSecretResource Gets or creates a Bitwarden secret reference by secret identifier. Use this when multiple secrets share the same name and the identifier is the only unambiguous key. The secret must already exist in Bitwarden; use `AddSecret` if Aspire should own and write the secret value.
getSecretById( name: string, secretId: guid): BitwardenSecretResourceParameters
namestringThe Aspire resource name.secretId guidThe Bitwarden secret identifier.Returns
BitwardenSecretResource Gets or creates a Bitwarden secret reference with distinct Aspire and remote names. The secret must already exist in Bitwarden; use `AddSecret` if Aspire should own and write the secret value.
getSecretWithRemoteName( name: string, remoteName: string): BitwardenSecretResourceParameters
namestringThe Aspire resource name.remoteName stringThe Bitwarden secret name.Returns
BitwardenSecretResource Overrides the Bitwarden API URL.
withApiUrl(apiUrl: string): BitwardenSecretManagerResourceParameters
apiUrl stringThe absolute Bitwarden API URL.Returns
BitwardenSecretManagerResource Overrides the Bitwarden API URL using an external service resource. The Bitwarden resource will wait for the external service before authenticating.
withApiUrlFromExternalService(server: ExternalServiceResource): BitwardenSecretManagerResourceParameters
serverExternalServiceResource The external service whose URL is used as the Bitwarden API URL.Returns
BitwardenSecretManagerResource Overrides the Bitwarden API URL using a parameter.
withApiUrlFromParameter(apiUrl: ParameterResource): BitwardenSecretManagerResourceParameters
apiUrl ParameterResource The parameter that resolves to the absolute Bitwarden API URL.Returns
BitwardenSecretManagerResource Overrides the AppHost auth cache directory (Bitwarden SDK auth session used by the AppHost reconciler). Defaults to the Aspire store when not set. Override to reuse a cached auth session across CI runs. To configure the auth cache directory inside the deployed app, use `WithBitwardenAuthCacheDirectory``1`.
withAuthCacheDirectory(authCacheDirectory: string): BitwardenSecretManagerResourceParameters
authCacheDirectory stringThe auth cache directory on the AppHost, relative to the Aspire store when not rooted.Returns
BitwardenSecretManagerResource Overrides the AppHost cache file path (integration bookkeeping: Bitwarden project ID, secret ID mappings). Defaults to `.bitwarden/{resourceName}.{environment}.json` relative to the AppHost directory. Override to share the cache across multiple AppHost projects, or to store it in a CI cache directory.
withCacheFile(cacheFile: string): BitwardenSecretManagerResourceParameters
cacheFile stringThe cache file path, relative to the AppHost directory when not rooted.Returns
BitwardenSecretManagerResource Overrides the Bitwarden identity URL.
withIdentityUrl(identityUrl: string): BitwardenSecretManagerResourceParameters
identityUrl stringThe absolute Bitwarden identity URL.Returns
BitwardenSecretManagerResource Overrides the Bitwarden identity URL using an external service resource. The Bitwarden resource will wait for the external service before authenticating.
withIdentityUrlFromExternalService(server: ExternalServiceResource): BitwardenSecretManagerResourceParameters
serverExternalServiceResource The external service whose URL is used as the Bitwarden identity URL.Returns
BitwardenSecretManagerResource Overrides the Bitwarden identity URL using a parameter.
withIdentityUrlFromParameter(identityUrl: ParameterResource): BitwardenSecretManagerResourceParameters
identityUrl ParameterResource The parameter that resolves to the absolute Bitwarden identity URL.Returns
BitwardenSecretManagerResource