Skip to content

Commit

Permalink
fix: virtual-machine-images/image-template, resource-graph/query
Browse files Browse the repository at this point in the history
…and `synapse/workspace` patch update to enforce publish with source (Azure#1260)

## Description

Minor parameter description update to enforce new patch version to be
published with source

## Pipeline Reference

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

| Pipeline |
| -------- |
|
[![avm.res.virtual-machine-images.image-template](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.virtual-machine-images.image-template.yml/badge.svg?branch=fix%2Feriqua%2Fenforce-pub-src)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.virtual-machine-images.image-template.yml)
|
|
[![avm.res.resource-graph.query](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.resource-graph.query.yml/badge.svg?branch=fix%2Feriqua%2Fenforce-pub-src)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.resource-graph.query.yml)
|
|
[![avm.res.synapse.workspace](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.synapse.workspace.yml/badge.svg?branch=fix%2Feriqua%2Fenforce-pub-src)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.synapse.workspace.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
eriqua authored Mar 12, 2024
1 parent 6d60ff2 commit 514157f
Show file tree
Hide file tree
Showing 10 changed files with 22 additions and 22 deletions.
4 changes: 2 additions & 2 deletions avm/res/resource-graph/query/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ module query 'br/public:avm/res/resource-graph/query:<version>' = {

| Parameter | Type | Description |
| :-- | :-- | :-- |
| [`name`](#parameter-name) | string | Name of the Resource Graph Query. |
| [`name`](#parameter-name) | string | The name of the Resource Graph Query. |
| [`query`](#parameter-query) | string | KQL query that will be graph. |

**Optional parameters**
Expand All @@ -294,7 +294,7 @@ module query 'br/public:avm/res/resource-graph/query:<version>' = {

### Parameter: `name`

Name of the Resource Graph Query.
The name of the Resource Graph Query.

- Required: Yes
- Type: string
Expand Down
2 changes: 1 addition & 1 deletion avm/res/resource-graph/query/main.bicep
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ metadata owner = 'Azure/module-maintainers'
// Parameters //
// ================ //

@description('Required. Name of the Resource Graph Query.')
@description('Required. The name of the Resource Graph Query.')
param name string

@description('Optional. Location for all resources.')
Expand Down
4 changes: 2 additions & 2 deletions avm/res/resource-graph/query/main.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"_generator": {
"name": "bicep",
"version": "0.25.53.49325",
"templateHash": "8072514070285903960"
"templateHash": "923009628819731946"
},
"name": "Resource Graph Queries",
"description": "This module deploys a Resource Graph Query.",
Expand Down Expand Up @@ -109,7 +109,7 @@
"name": {
"type": "string",
"metadata": {
"description": "Required. Name of the Resource Graph Query."
"description": "Required. The name of the Resource Graph Query."
}
},
"location": {
Expand Down
4 changes: 2 additions & 2 deletions avm/res/synapse/workspace/key/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ This module deploys a Synapse Workspaces Key.
| :-- | :-- | :-- |
| [`isActiveCMK`](#parameter-isactivecmk) | bool | Used to activate the workspace after a customer managed key is provided. |
| [`keyVaultResourceId`](#parameter-keyvaultresourceid) | string | The resource ID of a key vault to reference a customer managed key for encryption from. |
| [`name`](#parameter-name) | string | Encryption key name. |
| [`name`](#parameter-name) | string | The name of the Synapse Workspaces Key. |

**Conditional parameters**

Expand All @@ -48,7 +48,7 @@ The resource ID of a key vault to reference a customer managed key for encryptio

### Parameter: `name`

Encryption key name.
The name of the Synapse Workspaces Key.

- Required: Yes
- Type: string
Expand Down
2 changes: 1 addition & 1 deletion avm/res/synapse/workspace/key/main.bicep
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ metadata name = 'Synapse Workspaces Keys'
metadata description = 'This module deploys a Synapse Workspaces Key.'
metadata owner = 'Azure/module-maintainers'

@description('Required. Encryption key name.')
@description('Required. The name of the Synapse Workspaces Key.')
param name string

@description('Conditional. The name of the parent Synapse Workspace. Required if the template is used in a standalone deployment.')
Expand Down
4 changes: 2 additions & 2 deletions avm/res/synapse/workspace/key/main.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"_generator": {
"name": "bicep",
"version": "0.25.53.49325",
"templateHash": "2498604793784722860"
"templateHash": "29131182338463302"
},
"name": "Synapse Workspaces Keys",
"description": "This module deploys a Synapse Workspaces Key.",
Expand All @@ -15,7 +15,7 @@
"name": {
"type": "string",
"metadata": {
"description": "Required. Encryption key name."
"description": "Required. The name of the Synapse Workspaces Key."
}
},
"workspaceName": {
Expand Down
6 changes: 3 additions & 3 deletions avm/res/synapse/workspace/main.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"_generator": {
"name": "bicep",
"version": "0.25.53.49325",
"templateHash": "13895345816421777976"
"templateHash": "2846633042311760037"
},
"name": "Synapse Workspaces",
"description": "This module deploys a Synapse Workspace.",
Expand Down Expand Up @@ -976,7 +976,7 @@
"_generator": {
"name": "bicep",
"version": "0.25.53.49325",
"templateHash": "2498604793784722860"
"templateHash": "29131182338463302"
},
"name": "Synapse Workspaces Keys",
"description": "This module deploys a Synapse Workspaces Key.",
Expand All @@ -986,7 +986,7 @@
"name": {
"type": "string",
"metadata": {
"description": "Required. Encryption key name."
"description": "Required. The name of the Synapse Workspaces Key."
}
},
"workspaceName": {
Expand Down
8 changes: 4 additions & 4 deletions avm/res/virtual-machine-images/image-template/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -509,13 +509,13 @@ module imageTemplate 'br/public:avm/res/virtual-machine-images/image-template:<v
| [`distributions`](#parameter-distributions) | array | The distribution targets where the image output needs to go to. |
| [`imageSource`](#parameter-imagesource) | object | Image source definition in object format. |
| [`managedIdentities`](#parameter-managedidentities) | object | The managed identity definition for this resource. |
| [`name`](#parameter-name) | string | Name prefix of the Image Template to be built by the Azure Image Builder service. |
| [`name`](#parameter-name) | string | The name prefix of the Image Template to be built by the Azure Image Builder service. |

**Optional parameters**

| Parameter | Type | Description |
| :-- | :-- | :-- |
| [`buildTimeoutInMinutes`](#parameter-buildtimeoutinminutes) | int | Image build timeout in minutes. 0 means the default 240 minutes. |
| [`buildTimeoutInMinutes`](#parameter-buildtimeoutinminutes) | int | The image build timeout in minutes. 0 means the default 240 minutes. |
| [`enableTelemetry`](#parameter-enabletelemetry) | bool | Enable/Disable usage telemetry for module. |
| [`location`](#parameter-location) | string | Location for all resources. |
| [`lock`](#parameter-lock) | object | The lock settings of the service. |
Expand Down Expand Up @@ -576,14 +576,14 @@ The resource ID(s) to assign to the resource. Required if a user assigned identi

### Parameter: `name`

Name prefix of the Image Template to be built by the Azure Image Builder service.
The name prefix of the Image Template to be built by the Azure Image Builder service.

- Required: Yes
- Type: string

### Parameter: `buildTimeoutInMinutes`

Image build timeout in minutes. 0 means the default 240 minutes.
The image build timeout in minutes. 0 means the default 240 minutes.

- Required: No
- Type: int
Expand Down
4 changes: 2 additions & 2 deletions avm/res/virtual-machine-images/image-template/main.bicep
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@ metadata name = 'Virtual Machine Image Templates'
metadata description = 'This module deploys a Virtual Machine Image Template that can be consumed by Azure Image Builder (AIB).'
metadata owner = 'Azure/module-maintainers'

@description('Required. Name prefix of the Image Template to be built by the Azure Image Builder service.')
@description('Required. The name prefix of the Image Template to be built by the Azure Image Builder service.')
param name string

@description('Optional. Location for all resources.')
param location string = resourceGroup().location

@description('Optional. Image build timeout in minutes. 0 means the default 240 minutes.')
@description('Optional. The image build timeout in minutes. 0 means the default 240 minutes.')
@minValue(0)
@maxValue(960)
param buildTimeoutInMinutes int = 0
Expand Down
6 changes: 3 additions & 3 deletions avm/res/virtual-machine-images/image-template/main.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"_generator": {
"name": "bicep",
"version": "0.25.53.49325",
"templateHash": "17204586034528334587"
"templateHash": "13080829112167347263"
},
"name": "Virtual Machine Image Templates",
"description": "This module deploys a Virtual Machine Image Template that can be consumed by Azure Image Builder (AIB).",
Expand Down Expand Up @@ -291,7 +291,7 @@
"name": {
"type": "string",
"metadata": {
"description": "Required. Name prefix of the Image Template to be built by the Azure Image Builder service."
"description": "Required. The name prefix of the Image Template to be built by the Azure Image Builder service."
}
},
"location": {
Expand All @@ -307,7 +307,7 @@
"minValue": 0,
"maxValue": 960,
"metadata": {
"description": "Optional. Image build timeout in minutes. 0 means the default 240 minutes."
"description": "Optional. The image build timeout in minutes. 0 means the default 240 minutes."
}
},
"vmSize": {
Expand Down

0 comments on commit 514157f

Please sign in to comment.