Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The keyword expires does not work in keyvault secret library #26431

Closed
4 of 7 tasks
comorekf opened this issue Jul 7, 2023 · 2 comments · Fixed by #26507
Closed
4 of 7 tasks

The keyword expires does not work in keyvault secret library #26431

comorekf opened this issue Jul 7, 2023 · 2 comments · Fixed by #26507
Assignees
Labels
bug This issue requires a change to an existing behavior in the product in order to be resolved. Client This issue points to a problem in the data-plane of the library. customer-reported Issues that are reported by GitHub users external to the Azure organization. Docs KeyVault

Comments

@comorekf
Copy link

comorekf commented Jul 7, 2023

Describe the bug
A clear and concise description of what the bug is.
When setting a KV secret with expiry date the attribute is wrongly named in the documentation. expires does have no effect while expiresOn works.
To Reproduce
Steps to reproduce the behavior:

client.setSecret(secretName, "automated", {
                expires: expire,
            });

vs

client.setSecret(secretName, "automated", {
                expiresOn: expire,
            });

Expected behavior
Either expires work as described in the documentation or the documentation is updated.

Screenshots
Not applicable.

Additional context
TS library

@github-actions github-actions bot added customer-reported Issues that are reported by GitHub users external to the Azure organization. needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. question The issue doesn't require a change to the product in order to be resolved. Most issues start as that labels Jul 7, 2023
@xirzec
Copy link
Member

xirzec commented Jul 7, 2023

Thanks @comorekf for reporting!

It looks like the detailed API docs have expiresOn: https://learn.microsoft.com/en-us/javascript/api/%40azure/keyvault-secrets/secretproperties?view=azure-node-latest

But the README is not updated:

- `expires`: A given date after which the secret value cannot be retrieved.

@xirzec xirzec added bug This issue requires a change to an existing behavior in the product in order to be resolved. Client This issue points to a problem in the data-plane of the library. KeyVault Docs and removed question The issue doesn't require a change to the product in order to be resolved. Most issues start as that labels Jul 7, 2023
@github-actions github-actions bot removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Jul 7, 2023
@timovv
Copy link
Member

timovv commented Jul 17, 2023

Thanks for reporting! I have made a PR with the fix. I'm surprised this wasn't caught earlier!

timovv added a commit that referenced this issue Aug 3, 2023
…piresOn` in README (#26507)

### Packages impacted by this PR

- `@azure/keyvault-secrets`

### Issues associated with this PR

- Fixes #26431

### Describe the problem that is addressed by this PR

Documentation fix as reported in #26431.
dgetu pushed a commit that referenced this issue Sep 6, 2023
…piresOn` in README (#26507)

### Packages impacted by this PR

- `@azure/keyvault-secrets`

### Issues associated with this PR

- Fixes #26431

### Describe the problem that is addressed by this PR

Documentation fix as reported in #26431.
@github-actions github-actions bot locked and limited conversation to collaborators Nov 1, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug This issue requires a change to an existing behavior in the product in order to be resolved. Client This issue points to a problem in the data-plane of the library. customer-reported Issues that are reported by GitHub users external to the Azure organization. Docs KeyVault
Projects
Archived in project
3 participants