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

fix: res/web/connections static test fix #2559

Merged
merged 20 commits into from
Jun 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 47 additions & 2 deletions avm/res/web/connection/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ module connection 'br/public:avm/res/web/connection:<version>' = {
| [`lock`](#parameter-lock) | object | The lock settings of the service. |
| [`nonSecretParameterValues`](#parameter-nonsecretparametervalues) | object | Dictionary of nonsecret parameter values. |
| [`parameterValues`](#parameter-parametervalues) | secureObject | Connection strings or access keys for connection. Example: `accountName` and `accessKey` when using blobs. It can change depending on the resource. |
| [`parameterValueSet`](#parameter-parametervalueset) | object | Additional parameter Value Set used for authentication settings. |
| [`parameterValueSet`](#parameter-parametervalueset) | object | Additional parameter value set used for authentication settings. |
| [`roleAssignments`](#parameter-roleassignments) | array | Array of role assignments to create. |
| [`statuses`](#parameter-statuses) | array | The status of the connection. |
| [`tags`](#parameter-tags) | object | Tags of the resource. |
Expand All @@ -333,6 +333,14 @@ Specific values for some API connections.

- Required: No
- Type: object
- Example:
```Bicep
// for a Service Bus connection
{
type: 'Microsoft.Web/locations/managedApis'
id: subscriptionResourceId('Microsoft.Web/locations/managedApis', '${resourceLocation}', 'servicebus')
}
```

### Parameter: `customParameterValues`

Expand Down Expand Up @@ -406,13 +414,43 @@ Connection strings or access keys for connection. Example: `accountName` and `ac

- Required: No
- Type: secureObject
- Example:
```Bicep
{
connectionString: 'listKeys('/subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/Microsoft.ServiceBus/namespaces/AuthorizationRules/<serviceBusName>/RootManagedSharedAccessKey', '2023-01-01').primaryConnectionString'
}
{
rootfolder: fileshareConnection.rootfolder
authType: fileshareConnection.authType
// to add an object, use the any() function
gateway: any({
name: fileshareConnection.odgw.name
id: resourceId(fileshareConnection.odgw.resourceGroup, 'Microsoft.Web/connectionGateways', fileshareConnection.odgw.name)
type: 'Microsoft.Web/connectionGateways'
})
username: username
password: password
}
```

### Parameter: `parameterValueSet`

Additional parameter Value Set used for authentication settings.
Additional parameter value set used for authentication settings.

- Required: No
- Type: object
- Example:
```Bicep
// for a Service Bus connection
{
name: 'managedIdentityAuth'
values: {
namespaceEndpoint: {
value: 'sb://${dependency.outputs.serviceBusEndpoint}'
}
}
}
```

### Parameter: `roleAssignments`

Expand Down Expand Up @@ -516,6 +554,13 @@ Tags of the resource.

- Required: No
- Type: object
- Example:
```Bicep
{
key1: 'value1'
key2: 'value2'
}
```

### Parameter: `testLinks`

Expand Down
2 changes: 1 addition & 1 deletion avm/res/web/connection/main.bicep
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ param nonSecretParameterValues object?
})
param parameterValues object?

@description('Optional. Additional parameter Value Set used for authentication settings.')
@description('Optional. Additional parameter value set used for authentication settings.')
@metadata({
example: '''
// for a Service Bus connection
Expand Down
2 changes: 1 addition & 1 deletion avm/res/web/connection/main.json
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@
"nullable": true,
"metadata": {
"example": " // for a Service Bus connection\n {\n name: 'managedIdentityAuth'\n values: {\n namespaceEndpoint: {\n value: 'sb://${dependency.outputs.serviceBusEndpoint}'\n }\n }\n }\n",
"description": "Optional. Additional parameter Value Set used for authentication settings."
"description": "Optional. Additional parameter value set used for authentication settings."
}
},
"roleAssignments": {
Expand Down