store

Documentation

Index

• type KeyVaultClient
• type MsiKeyVaultStore
  • func NewMsiKeyVaultStore(kvClient KeyVaultClient) *MsiKeyVaultStore
  • func (s *MsiKeyVaultStore) DeleteCredentialsObject(ctx context.Context, secretName string) error
  • func (s *MsiKeyVaultStore) GetCredentialsObject(ctx context.Context, secretName string) (*SecretResponse, error)
  • func (s *MsiKeyVaultStore) GetCredentialsObjectPager() *runtime.Pager[azsecrets.ListSecretPropertiesResponse]
  • func (s *MsiKeyVaultStore) GetDeletedCredentialsObjectPager() *runtime.Pager[azsecrets.ListDeletedSecretPropertiesResponse]
  • func (s *MsiKeyVaultStore) PurgeDeletedCredentialsObject(ctx context.Context, secretName string) error
  • func (s *MsiKeyVaultStore) SetCredentialsObject(ctx context.Context, properties SecretProperties, ...) error
• type SecretProperties
• type SecretResponse

Types

type KeyVaultClient

type KeyVaultClient interface {
	DeleteSecret(ctx context.Context, name string, options *azsecrets.DeleteSecretOptions) (azsecrets.DeleteSecretResponse, error)
	GetSecret(ctx context.Context, name string, version string, options *azsecrets.GetSecretOptions) (azsecrets.GetSecretResponse, error)
	NewListDeletedSecretPropertiesPager(options *azsecrets.ListDeletedSecretPropertiesOptions) *runtime.Pager[azsecrets.ListDeletedSecretPropertiesResponse]
	NewListSecretPropertiesPager(options *azsecrets.ListSecretPropertiesOptions) *runtime.Pager[azsecrets.ListSecretPropertiesResponse]
	PurgeDeletedSecret(ctx context.Context, name string, options *azsecrets.PurgeDeletedSecretOptions) (azsecrets.PurgeDeletedSecretResponse, error)
	SetSecret(ctx context.Context, name string, parameters azsecrets.SetSecretParameters, options *azsecrets.SetSecretOptions) (azsecrets.SetSecretResponse, error)
}

type MsiKeyVaultStore

type MsiKeyVaultStore struct {
	// contains filtered or unexported fields
}

func NewMsiKeyVaultStore

func NewMsiKeyVaultStore(kvClient KeyVaultClient) *MsiKeyVaultStore

func (*MsiKeyVaultStore) DeleteCredentialsObject

func (s *MsiKeyVaultStore) DeleteCredentialsObject(ctx context.Context, secretName string) error

Delete a credentials object from key vault using the specified secret name. Delete applies to all versions of the secret.

func (*MsiKeyVaultStore) GetCredentialsObject

func (s *MsiKeyVaultStore) GetCredentialsObject(ctx context.Context, secretName string) (*SecretResponse, error)

Get a credentials object from the key vault using the specified secret name. The latest version of the secret will always be returned.

func (*MsiKeyVaultStore) GetCredentialsObjectPager

func (s *MsiKeyVaultStore) GetCredentialsObjectPager() *runtime.Pager[azsecrets.ListSecretPropertiesResponse]

Get a pager for listing credentials objects from the key vault.

func (*MsiKeyVaultStore) GetDeletedCredentialsObjectPager

func (s *MsiKeyVaultStore) GetDeletedCredentialsObjectPager() *runtime.Pager[azsecrets.ListDeletedSecretPropertiesResponse]

Get a pager for listing deleted credentials objects from the key vault.

func (*MsiKeyVaultStore) PurgeDeletedCredentialsObject

func (s *MsiKeyVaultStore) PurgeDeletedCredentialsObject(ctx context.Context, secretName string) error

Purge a deleted credentials object from the key vault using the specified secret name. This operation is only applicable in vaults enabled for soft-delete.

func (*MsiKeyVaultStore) SetCredentialsObject

func (s *MsiKeyVaultStore) SetCredentialsObject(ctx context.Context, properties SecretProperties, credentialsObject dataplane.CredentialsObject) error

Set a credentials object in the key vault using the specified secret name. If the secret already exists, key vault will create a new version of the secret.

type SecretProperties

type SecretProperties struct {
	Enabled   bool
	Expires   time.Time
	Name      string
	NotBefore time.Time
}

type SecretResponse

type SecretResponse struct {
	CredentialsObject dataplane.CredentialsObject
	Properties        SecretProperties
}