Skip to content

Commit

Permalink
fix: Patch of avm/res/web/connection to enforce the publishing (#1387)
Browse files Browse the repository at this point in the history
## Description

Patch of `avm/res/web/connection` to enforce the publishing
<!--
>Thank you for your contribution !
> Please include a summary of the change and which issue is fixed.
> Please also include the context.
> List any dependencies that are required for this change.

Fixes #123
Fixes #456
Closes #123
Closes #456
-->

## Pipeline Reference

<!-- Insert your Pipeline Status Badge below -->

| Pipeline |
| -------- |
|
[![avm.res.web.connection](https://github.com/krbar/bicep-registry-modules/actions/workflows/avm.res.web.connection.yml/badge.svg?branch=users%2Fkrbar%2FwebConnFix)](https://github.com/krbar/bicep-registry-modules/actions/workflows/avm.res.web.connection.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:
- [x] 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`.
- [ ] Breaking changes and I have bumped the MAJOR version in
`version.json`.
  - [ ] 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

<!-- Please keep up to day with the contribution guide at
https://aka.ms/avm/contribute/bicep -->
  • Loading branch information
krbar authored Mar 22, 2024
1 parent a46cf8c commit 84e8045
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
14 changes: 7 additions & 7 deletions avm/res/web/connection/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ This instance deploys the module with the minimum set of required parameters.

```bicep
module connection 'br/public:avm/res/web/connection:<version>' = {
name: '${uniqueString(deployment().name, resourceLocation)}-test-wcmin'
name: 'connectionDeployment'
params: {
// Required parameters
displayName: 'azuremonitorlogs'
Expand Down Expand Up @@ -107,7 +107,7 @@ This instance deploys the module with most of its features enabled.

```bicep
module connection 'br/public:avm/res/web/connection:<version>' = {
name: '${uniqueString(deployment().name, resourceLocation)}-test-wcmax'
name: 'connectionDeployment'
params: {
// Required parameters
displayName: 'azuremonitorlogs'
Expand Down Expand Up @@ -225,7 +225,7 @@ This instance deploys the module in alignment with the best-practices of the Azu

```bicep
module connection 'br/public:avm/res/web/connection:<version>' = {
name: '${uniqueString(deployment().name, resourceLocation)}-test-wcwaf'
name: 'connectionDeployment'
params: {
// Required parameters
displayName: 'azuremonitorlogs'
Expand Down Expand Up @@ -294,14 +294,14 @@ module connection 'br/public:avm/res/web/connection:<version>' = {
| Parameter | Type | Description |
| :-- | :-- | :-- |
| [`displayName`](#parameter-displayname) | string | Display name connection. Example: 'blobconnection' when using blobs. It can change depending on the resource. |
| [`name`](#parameter-name) | string | Connection name for connection. Example: 'azureblob' when using blobs. It can change depending on the resource. |
| [`name`](#parameter-name) | string | Connection name for connection. Example: 'azureblob' when using blobs. It can change depending on the resource. |

**Optional parameters**

| Parameter | Type | Description |
| :-- | :-- | :-- |
| [`api`](#parameter-api) | object | Specific values for some API connections. |
| [`customParameterValues`](#parameter-customparametervalues) | object | Customized parameter values for specific connections. |
| [`customParameterValues`](#parameter-customparametervalues) | object | Dictionary of custom parameter values for specific connections. |
| [`enableTelemetry`](#parameter-enabletelemetry) | bool | Enable/Disable usage telemetry for module. |
| [`location`](#parameter-location) | string | Location of the deployment. |
| [`lock`](#parameter-lock) | object | The lock settings of the service. |
Expand All @@ -321,7 +321,7 @@ Display name connection. Example: 'blobconnection' when using blobs. It can chan

### Parameter: `name`

Connection name for connection. Example: 'azureblob' when using blobs. It can change depending on the resource.
Connection name for connection. Example: 'azureblob' when using blobs. It can change depending on the resource.

- Required: Yes
- Type: string
Expand All @@ -335,7 +335,7 @@ Specific values for some API connections.

### Parameter: `customParameterValues`

Customized parameter values for specific connections.
Dictionary of custom parameter values for specific connections.

- Required: No
- Type: object
Expand Down
4 changes: 2 additions & 2 deletions avm/res/web/connection/main.bicep
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ metadata owner = 'Azure/module-maintainers'
@description('Optional. Specific values for some API connections.')
param api object?

@description('Required. Connection name for connection. Example: \'azureblob\' when using blobs. It can change depending on the resource.')
@description('Required. Connection name for connection. Example: \'azureblob\' when using blobs. It can change depending on the resource.')
param name string

@description('Optional. Enable/Disable usage telemetry for module.')
param enableTelemetry bool = true

@description('Optional. Customized parameter values for specific connections.')
@description('Optional. Dictionary of custom parameter values for specific connections.')
param customParameterValues object?

@description('Required. Display name connection. Example: \'blobconnection\' when using blobs. It can change depending on the resource.')
Expand Down
6 changes: 3 additions & 3 deletions avm/res/web/connection/main.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"_generator": {
"name": "bicep",
"version": "0.26.54.24096",
"templateHash": "7023218884574427074"
"templateHash": "153462740137838298"
},
"name": "API Connections",
"description": "This module deploys an Azure API Connection.",
Expand Down Expand Up @@ -116,7 +116,7 @@
"name": {
"type": "string",
"metadata": {
"description": "Required. Connection name for connection. Example: 'azureblob' when using blobs. It can change depending on the resource."
"description": "Required. Connection name for connection. Example: 'azureblob' when using blobs. It can change depending on the resource."
}
},
"enableTelemetry": {
Expand All @@ -130,7 +130,7 @@
"type": "object",
"nullable": true,
"metadata": {
"description": "Optional. Customized parameter values for specific connections."
"description": "Optional. Dictionary of custom parameter values for specific connections."
}
},
"displayName": {
Expand Down

0 comments on commit 84e8045

Please sign in to comment.