[app/job]: change secure parameter to a custom type
#2071
Assignees
Labels
Class: Resource Module 📦
This is a resource module
Type: AVM 🅰️ ✌️ Ⓜ️
This is an AVM related issue
Type: Feature Request ➕
New feature or request
Comments
ReneHezser
added
Needs: Triage 🔍
|
Important The "Needs: Triage 🔍" label must be removed once the triage process is complete! Tip For additional guidance on how to triage this issue/PR, see the BRM Issue Triage documentation. Note This label was added as per ITA06. |
microsoft-github-policy-service
bot
added
the
Type: Feature Request ➕
|
Note The "Type: Feature Request ➕" label was added as per ITA20. |
|
@ReneHezser, thanks for submitting this issue for the Important A member of the @Azure/avm-res-app-job-module-owners-bicep or @Azure/avm-res-app-job-module-contributors-bicep team will review it soon! |
ReneHezser
changed the title
secureList property with custom typessecureList property with custom types
ReneHezser
changed the title
secureList property with custom typessecure parameter to a custom type
11 tasks
|
Warning Tagging the AVM Core Team (@Azure/avm-core-team-technical-bicep) due to a module owner or contributor having not responded to this issue within 3 business days. The AVM Core Team will attempt to contact the module owners/contributors directly. Tip
Note This message was posted as per ITA01BCP. |
microsoft-github-policy-service
bot
added
the
Status: Response Overdue 🚩
|
Waiting for merge of #2074 |
|
Removing the |
AlexanderSehr
removed
Needs: Triage 🔍
eriqua
pushed a commit
that referenced
this issue
Jun 5, 2024
## Description
- changed secure parameter from an as secure decorated object to a
custom type.
- improved documentation with examples and tests
Unfortunately, there is a breaking change in this change. The secrets
parameter required a `secureList` property, which is not required
anymore
```
// this is the old usage
secrets: {
secureList: [
{
name: 'connection-string'
value: '<secretValue>'
}
]
}
// which has now changed to a custom type and must be used like this:
secrets: [
{
name: 'connection-string'
value: '<secretValue>'
}
]
```
#2070
Fixes #2071
## Pipeline Reference
<!-- Insert your Pipeline Status Badge below -->
| Pipeline |
| -------- |
|
[](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.app.job.yml)
|
## Type of Change
<!-- Use the check-boxes [x] on the options that are relevant. -->
- [ ] Update to CI Environment or utlities (Non-module effecting
changes)
- [x] Azure Verified Module updates:
- [ ] Bugfix containing backwards compatible bug fixes, and I have NOT
bumped the MAJOR or MINOR version in `version.json`:
- [ ] Someone has opened a bug report issue, and I have included "Closes
#{bug_report_issue_number}" in the PR description.
- [ ] The bug was found by the module author, and no one has opened an
issue to report it yet.
- [ ] Feature update backwards compatible feature updates, and I have
bumped the MINOR version in `version.json`.
- [x] Breaking changes and I have bumped the MAJOR version in
`version.json`.
- [x] Update to documentation
## Checklist
- [x] I'm sure there are no other open Pull Requests for the same
update/change
- [x] I have run `Set-AVMModule` locally to generate the supporting
module files.
- [x] My corresponding pipelines / checks run clean and green without
any errors or warnings
---------
Co-authored-by: Alexander Sehr <[email protected]>
github-project-automation
bot
moved this from Needs: Triage
to Done
in AVM - Module Issues
hundredacres
pushed a commit
to hundredacres/bicep-registry-modules
that referenced
this issue
Jun 19, 2024
](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.app.job.yml){kind=link}
## Description
- changed secure parameter from an as secure decorated object to a
custom type.
- improved documentation with examples and tests
Unfortunately, there is a breaking change in this change. The secrets
parameter required a `secureList` property, which is not required
anymore
```
// this is the old usage
secrets: {
secureList: [
{
name: 'connection-string'
value: '<secretValue>'
}
]
}
// which has now changed to a custom type and must be used like this:
secrets: [
{
name: 'connection-string'
value: '<secretValue>'
}
]
```
Azure#2070
Fixes Azure#2071
## Pipeline Reference
<!-- Insert your Pipeline Status Badge below -->
| Pipeline |
| -------- |
|
[](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.app.job.yml)
|
## Type of Change
<!-- Use the check-boxes [x] on the options that are relevant. -->
- [ ] Update to CI Environment or utlities (Non-module effecting
changes)
- [x] Azure Verified Module updates:
- [ ] Bugfix containing backwards compatible bug fixes, and I have NOT
bumped the MAJOR or MINOR version in `version.json`:
- [ ] Someone has opened a bug report issue, and I have included "Closes
#{bug_report_issue_number}" in the PR description.
- [ ] The bug was found by the module author, and no one has opened an
issue to report it yet.
- [ ] Feature update backwards compatible feature updates, and I have
bumped the MINOR version in `version.json`.
- [x] Breaking changes and I have bumped the MAJOR version in
`version.json`.
- [x] Update to documentation
## Checklist
- [x] I'm sure there are no other open Pull Requests for the same
update/change
- [x] I have run `Set-AVMModule` locally to generate the supporting
module files.
- [x] My corresponding pipelines / checks run clean and green without
any errors or warnings
---------
Co-authored-by: Alexander Sehr <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Check for previous/existing GitHub issues
Issue Type?
Feature Request
Module Name
avm/res/app/job
(Optional) Module Version
No response
Description
The
secretsparameter is defined as an object and contains asecureListproperty. This should be changed to a custom type to improve syntax highlighting and get rid of the workaround introduced earlier.#2070
(Optional) Correlation Id
No response
The text was updated successfully, but these errors were encountered: