fix: Changed the version ref in the readme to a generic <version> (#…

…608) ## Description Changed the version ref in the readme to a generic `<version>` | Pipeline | | - | | [![avm.res.network.private-endpoint](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.network.private-endpoint.yml/badge.svg?branch=users%2Falsehr%2FreadMeVersioningPlaceholder)](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.network.private-endpoint.yml) | | [![avm.res.key-vault.vault](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.key-vault.vault.yml/badge.svg?branch=users%2Falsehr%2FreadMeVersioningPlaceholder)](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.key-vault.vault.yml) | --------- Co-authored-by: Erika Gressi <[email protected]>
Azure · Nov 9, 2023 · 7cc9f7b · 7cc9f7b
1 parent c0ad6d2
commit 7cc9f7b
Show file tree

Hide file tree

Showing 16 changed files with 63 additions and 64 deletions.
diff --git a/avm/res/batch/batch-account/README.md b/avm/res/batch/batch-account/README.md
@@ -27,7 +27,7 @@ The following section provides usage examples for the module, which were used to
 
 >**Note**: Each example lists all the required parameters first, followed by the rest - each in alphabetical order.
 
->**Note**: To reference the module, please use the following syntax `br/public:avm/res/batch/batch-account:0.1.1`.
+>**Note**: To reference the module, please use the following syntax `br/public:avm/res/batch/batch-account:<version>`.
 
 - [Using only defaults](#example-1-using-only-defaults)
 - [Using Customer-Managed-Keys with User-Assigned identity](#example-2-using-customer-managed-keys-with-user-assigned-identity)
@@ -44,7 +44,7 @@ This instance deploys the module with the minimum set of required parameters.
 <summary>via Bicep module</summary>
 
 ```bicep
-module batchAccount 'br/public:avm/res/batch/batch-account:0.1.1' = {
+module batchAccount 'br/public:avm/res/batch/batch-account:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-bbamin'
   params: {
     // Required parameters
@@ -140,7 +140,7 @@ This instance deploys the module using Customer-Managed-Keys using a User-Assign
 <summary>via Bicep module</summary>
 
 ```bicep
-module batchAccount 'br/public:avm/res/batch/batch-account:0.1.1' = {
+module batchAccount 'br/public:avm/res/batch/batch-account:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-bbaencr'
   params: {
     // Required parameters
@@ -262,7 +262,7 @@ This instance deploys the module with most of its features enabled.
 <summary>via Bicep module</summary>
 
 ```bicep
-module batchAccount 'br/public:avm/res/batch/batch-account:0.1.1' = {
+module batchAccount 'br/public:avm/res/batch/batch-account:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-bbamax'
   params: {
     // Required parameters
@@ -450,7 +450,7 @@ This instance deploys the module in alignment with the best-practices of the Azu
 <summary>via Bicep module</summary>
 
 ```bicep
-module batchAccount 'br/public:avm/res/batch/batch-account:0.1.1' = {
+module batchAccount 'br/public:avm/res/batch/batch-account:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-bbawaf'
   params: {
     // Required parameters

diff --git a/avm/res/cognitive-services/account/README.md b/avm/res/cognitive-services/account/README.md
@@ -32,7 +32,7 @@ The following section provides usage examples for the module, which were used to
 
 >**Note**: Each example lists all the required parameters first, followed by the rest - each in alphabetical order.
 
->**Note**: To reference the module, please use the following syntax `br/public:avm/res/cognitive-services/account:0.1.1`.
+>**Note**: To reference the module, please use the following syntax `br/public:avm/res/cognitive-services/account:<version>`.
 
 - [Using only defaults](#example-1-using-only-defaults)
 - [Using large parameter set](#example-2-using-large-parameter-set)
@@ -51,7 +51,7 @@ This instance deploys the module with the minimum set of required parameters.
 <summary>via Bicep module</summary>
 
 ```bicep
-module account 'br/public:avm/res/cognitive-services/account:0.1.1' = {
+module account 'br/public:avm/res/cognitive-services/account:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-csamin'
   params: {
     // Required parameters
@@ -155,7 +155,7 @@ This instance deploys the module with most of its features enabled.
 <summary>via Bicep module</summary>
 
 ```bicep
-module account 'br/public:avm/res/cognitive-services/account:0.1.1' = {
+module account 'br/public:avm/res/cognitive-services/account:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-csamax'
   params: {
     // Required parameters
@@ -407,7 +407,7 @@ This instance deploys the module as a Speech Service.
 <summary>via Bicep module</summary>
 
 ```bicep
-module account 'br/public:avm/res/cognitive-services/account:0.1.1' = {
+module account 'br/public:avm/res/cognitive-services/account:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-csaspeech'
   params: {
     // Required parameters
@@ -557,7 +557,7 @@ This instance deploys the module using Customer-Managed-Keys using a System-Assi
 <summary>via Bicep module</summary>
 
 ```bicep
-module account 'br/public:avm/res/cognitive-services/account:0.1.1' = {
+module account 'br/public:avm/res/cognitive-services/account:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-csaecrs'
   params: {
     // Required parameters
@@ -683,7 +683,7 @@ This instance deploys the module using Customer-Managed-Keys using a User-Assign
 <summary>via Bicep module</summary>
 
 ```bicep
-module account 'br/public:avm/res/cognitive-services/account:0.1.1' = {
+module account 'br/public:avm/res/cognitive-services/account:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-csaencr'
   params: {
     // Required parameters
@@ -815,7 +815,7 @@ This instance deploys the module in alignment with the best-pratices of the Well
 <summary>via Bicep module</summary>
 
 ```bicep
-module account 'br/public:avm/res/cognitive-services/account:0.1.1' = {
+module account 'br/public:avm/res/cognitive-services/account:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-csawaf'
   params: {
     // Required parameters

diff --git a/avm/res/compute/ssh-public-key/README.md b/avm/res/compute/ssh-public-key/README.md
@@ -26,7 +26,7 @@ The following section provides usage examples for the module, which were used to
 
 >**Note**: Each example lists all the required parameters first, followed by the rest - each in alphabetical order.
 
->**Note**: To reference the module, please use the following syntax `br/public:avm/res/compute/ssh-public-key:0.1.1`.
+>**Note**: To reference the module, please use the following syntax `br/public:avm/res/compute/ssh-public-key:<version>`.
 
 - [Using only defaults](#example-1-using-only-defaults)
 - [Using large parameter set](#example-2-using-large-parameter-set)
@@ -44,7 +44,7 @@ This instance deploys the module with the minimum set of required parameters.
 <summary>via Bicep module</summary>
 
 ```bicep
-module sshPublicKey 'br/public:avm/res/compute/ssh-public-key:0.1.1' = {
+module sshPublicKey 'br/public:avm/res/compute/ssh-public-key:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-cspkmin'
   params: {
     // Required parameters
@@ -104,7 +104,7 @@ This instance deploys the module with most of its features enabled.
 <summary>via Bicep module</summary>
 
 ```bicep
-module sshPublicKey 'br/public:avm/res/compute/ssh-public-key:0.1.1' = {
+module sshPublicKey 'br/public:avm/res/compute/ssh-public-key:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-cspkmax'
   params: {
     // Required parameters
@@ -198,7 +198,7 @@ This instance deploys the module in alignment with the best-practices of the Azu
 <summary>via Bicep module</summary>
 
 ```bicep
-module sshPublicKey 'br/public:avm/res/compute/ssh-public-key:0.1.1' = {
+module sshPublicKey 'br/public:avm/res/compute/ssh-public-key:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-cspkwaf'
   params: {
     // Required parameters

diff --git a/avm/res/insights/action-group/README.md b/avm/res/insights/action-group/README.md
@@ -23,7 +23,7 @@ The following section provides usage examples for the module, which were used to
 
 >**Note**: Each example lists all the required parameters first, followed by the rest - each in alphabetical order.
 
->**Note**: To reference the module, please use the following syntax `br/public:avm/res/insights/action-group:0.1.2`.
+>**Note**: To reference the module, please use the following syntax `br/public:avm/res/insights/action-group:<version>`.
 
 - [Defaults](#example-1-defaults)
 - [Max](#example-2-max)
@@ -36,7 +36,7 @@ The following section provides usage examples for the module, which were used to
 <summary>via Bicep module</summary>
 
 ```bicep
-module actionGroup 'br/public:avm/res/insights/action-group:0.1.2' = {
+module actionGroup 'br/public:avm/res/insights/action-group:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-iagmin'
   params: {
     // Required parameters
@@ -133,7 +133,7 @@ module actionGroup 'br/public:avm/res/insights/action-group:0.1.2' = {
 <summary>via Bicep module</summary>
 
 ```bicep
-module actionGroup 'br/public:avm/res/insights/action-group:0.1.2' = {
+module actionGroup 'br/public:avm/res/insights/action-group:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-iagmax'
   params: {
     // Required parameters
@@ -252,7 +252,7 @@ module actionGroup 'br/public:avm/res/insights/action-group:0.1.2' = {
 <summary>via Bicep module</summary>
 
 ```bicep
-module actionGroup 'br/public:avm/res/insights/action-group:0.1.2' = {
+module actionGroup 'br/public:avm/res/insights/action-group:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-iagwaf'
   params: {
     // Required parameters

diff --git a/avm/res/key-vault/vault/README.md b/avm/res/key-vault/vault/README.md
@@ -30,7 +30,7 @@ The following section provides usage examples for the module, which were used to
 
 >**Note**: Each example lists all the required parameters first, followed by the rest - each in alphabetical order.
 
->**Note**: To reference the module, please use the following syntax `br/public:avm/res/key-vault/vault:0.1.1`.
+>**Note**: To reference the module, please use the following syntax `br/public:avm/res/key-vault/vault:<version>`.
 
 - [Using only defaults](#example-1-using-only-defaults)
 - [Using large parameter set](#example-2-using-large-parameter-set)
@@ -49,7 +49,7 @@ This instance deploys the module with the minimum set of required parameters.
 <summary>via Bicep module</summary>
 
 ```bicep
-module vault 'br/public:avm/res/key-vault/vault:0.1.1' = {
+module vault 'br/public:avm/res/key-vault/vault:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-kvvmin'
   params: {
     // Required parameters
@@ -135,7 +135,7 @@ This instance deploys the module with most of its features enabled.
 <summary>via Bicep module</summary>
 
 ```bicep
-module vault 'br/public:avm/res/key-vault/vault:0.1.1' = {
+module vault 'br/public:avm/res/key-vault/vault:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-kvvmax'
   params: {
     // Required parameters
@@ -539,7 +539,7 @@ This instance deploys the module with Private Endpoints.
 <summary>via Bicep module</summary>
 
 ```bicep
-module vault 'br/public:avm/res/key-vault/vault:0.1.1' = {
+module vault 'br/public:avm/res/key-vault/vault:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-kvvpe'
   params: {
     // Required parameters
@@ -631,7 +631,7 @@ This instance deploys the module in alignment with the best-practices of the Wel
 <summary>via Bicep module</summary>
 
 ```bicep
-module vault 'br/public:avm/res/key-vault/vault:0.1.1' = {
+module vault 'br/public:avm/res/key-vault/vault:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-kvvwaf'
   params: {
     // Required parameters

diff --git a/avm/res/kubernetes-configuration/extension/README.md b/avm/res/kubernetes-configuration/extension/README.md
@@ -24,7 +24,7 @@ The following section provides usage examples for the module, which were used to
 
 >**Note**: Each example lists all the required parameters first, followed by the rest - each in alphabetical order.
 
->**Note**: To reference the module, please use the following syntax `br/public:avm/res/kubernetes-configuration/extension:0.1.1`.
+>**Note**: To reference the module, please use the following syntax `br/public:avm/res/kubernetes-configuration/extension:<version>`.
 
 - [Using only defaults](#example-1-using-only-defaults)
 - [Using large parameter set](#example-2-using-large-parameter-set)
@@ -42,7 +42,7 @@ This instance deploys the module with the minimum set of required parameters.
 <summary>via Bicep module</summary>
 
 ```bicep
-module extension 'br/public:avm/res/kubernetes-configuration/extension:0.1.1' = {
+module extension 'br/public:avm/res/kubernetes-configuration/extension:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-kcemin'
   params: {
     // Required parameters
@@ -126,7 +126,7 @@ This instance deploys the module with most of its features enabled.
 <summary>via Bicep module</summary>
 
 ```bicep
-module extension 'br/public:avm/res/kubernetes-configuration/extension:0.1.1' = {
+module extension 'br/public:avm/res/kubernetes-configuration/extension:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-kcemax'
   params: {
     // Required parameters
@@ -250,7 +250,7 @@ This instance deploys the module in alignment with the best-practices of the Azu
 <summary>via Bicep module</summary>
 
 ```bicep
-module extension 'br/public:avm/res/kubernetes-configuration/extension:0.1.1' = {
+module extension 'br/public:avm/res/kubernetes-configuration/extension:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-kcewaf'
   params: {
     // Required parameters

diff --git a/avm/res/kubernetes-configuration/flux-configuration/README.md b/avm/res/kubernetes-configuration/flux-configuration/README.md
@@ -23,7 +23,7 @@ The following section provides usage examples for the module, which were used to
 
 >**Note**: Each example lists all the required parameters first, followed by the rest - each in alphabetical order.
 
->**Note**: To reference the module, please use the following syntax `br/public:avm/res/kubernetes-configuration/flux-configuration:0.2.0`.
+>**Note**: To reference the module, please use the following syntax `br/public:avm/res/kubernetes-configuration/flux-configuration:<version>`.
 
 - [Using only defaults](#example-1-using-only-defaults)
 - [Using large parameter set](#example-2-using-large-parameter-set)
@@ -41,7 +41,7 @@ This instance deploys the module with the minimum set of required parameters.
 <summary>via Bicep module</summary>
 
 ```bicep
-module fluxConfiguration 'br/public:avm/res/kubernetes-configuration/flux-configuration:0.2.0' = {
+module fluxConfiguration 'br/public:avm/res/kubernetes-configuration/flux-configuration:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-kcfcmin'
   params: {
     // Required parameters
@@ -133,7 +133,7 @@ This instance deploys the module with most of its features enabled.
 <summary>via Bicep module</summary>
 
 ```bicep
-module fluxConfiguration 'br/public:avm/res/kubernetes-configuration/flux-configuration:0.2.0' = {
+module fluxConfiguration 'br/public:avm/res/kubernetes-configuration/flux-configuration:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-kcfcmax'
   params: {
     // Required parameters
@@ -243,7 +243,7 @@ This instance deploys the module in alignment with the best-practices of the Azu
 <summary>via Bicep module</summary>
 
 ```bicep
-module fluxConfiguration 'br/public:avm/res/kubernetes-configuration/flux-configuration:0.2.0' = {
+module fluxConfiguration 'br/public:avm/res/kubernetes-configuration/flux-configuration:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-kcfcwaf'
   params: {
     // Required parameters

diff --git a/avm/res/network/dns-forwarding-ruleset/README.md b/avm/res/network/dns-forwarding-ruleset/README.md
@@ -26,7 +26,7 @@ The following section provides usage examples for the module, which were used to
 
 >**Note**: Each example lists all the required parameters first, followed by the rest - each in alphabetical order.
 
->**Note**: To reference the module, please use the following syntax `br/public:avm/res/network/dns-forwarding-ruleset:0.1.1`.
+>**Note**: To reference the module, please use the following syntax `br/public:avm/res/network/dns-forwarding-ruleset:<version>`.
 
 - [Using only defaults](#example-1-using-only-defaults)
 - [Using large parameter set](#example-2-using-large-parameter-set)
@@ -44,7 +44,7 @@ This instance deploys the module with the minimum set of required parameters.
 <summary>via Bicep module</summary>
 
 ```bicep
-module dnsForwardingRuleset 'br/public:avm/res/network/dns-forwarding-ruleset:0.1.1' = {
+module dnsForwardingRuleset 'br/public:avm/res/network/dns-forwarding-ruleset:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-ndfrsmin'
   params: {
     // Required parameters
@@ -120,7 +120,7 @@ This instance deploys the module with most of its features enabled.
 <summary>via Bicep module</summary>
 
 ```bicep
-module dnsForwardingRuleset 'br/public:avm/res/network/dns-forwarding-ruleset:0.1.1' = {
+module dnsForwardingRuleset 'br/public:avm/res/network/dns-forwarding-ruleset:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-ndfrsmax'
   params: {
     // Required parameters
@@ -250,7 +250,7 @@ This instance deploys the module in alignment with the best-practices of the Azu
 <summary>via Bicep module</summary>
 
 ```bicep
-module dnsForwardingRuleset 'br/public:avm/res/network/dns-forwarding-ruleset:0.1.1' = {
+module dnsForwardingRuleset 'br/public:avm/res/network/dns-forwarding-ruleset:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-ndfrswaf'
   params: {
     // Required parameters

diff --git a/avm/res/network/dns-resolver/README.md b/avm/res/network/dns-resolver/README.md
@@ -26,7 +26,7 @@ The following section provides usage examples for the module, which were used to
 
 >**Note**: Each example lists all the required parameters first, followed by the rest - each in alphabetical order.
 
->**Note**: To reference the module, please use the following syntax `br/public:avm/res/network/dns-resolver:0.1.1`.
+>**Note**: To reference the module, please use the following syntax `br/public:avm/res/network/dns-resolver:<version>`.
 
 - [Using only defaults](#example-1-using-only-defaults)
 - [Using large parameter set](#example-2-using-large-parameter-set)
@@ -44,7 +44,7 @@ This instance deploys the module with the minimum set of required parameters.
 <summary>via Bicep module</summary>
 
 ```bicep
-module dnsResolver 'br/public:avm/res/network/dns-resolver:0.1.1' = {
+module dnsResolver 'br/public:avm/res/network/dns-resolver:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-ndrmin'
   params: {
     // Required parameters
@@ -116,7 +116,7 @@ This instance deploys the module with most of its features enabled.
 <summary>via Bicep module</summary>
 
 ```bicep
-module dnsResolver 'br/public:avm/res/network/dns-resolver:0.1.1' = {
+module dnsResolver 'br/public:avm/res/network/dns-resolver:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-ndrmax'
   params: {
     // Required parameters
@@ -234,7 +234,7 @@ This instance deploys the module in alignment with the best-practices of the Azu
 <summary>via Bicep module</summary>
 
 ```bicep
-module dnsResolver 'br/public:avm/res/network/dns-resolver:0.1.1' = {
+module dnsResolver 'br/public:avm/res/network/dns-resolver:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-ndrwaf'
   params: {
     // Required parameters