Merge pull request #193717 from mumian/0401-public-registry

Bicep public module registry

Author: v-shils

articles/azure-resource-manager/bicep/bicep-config-modules.md

@@ -2,7 +2,7 @@
 title: Module setting for Bicep config
 description: Describes how to customize configuration values for modules in Bicep deployments.
 ms.topic: conceptual
-ms.date: 01/03/2022
+ms.date: 04/08/2022
 ---
 
 # Add module settings in the Bicep config file
@@ -99,6 +99,27 @@ For a template spec, use:
 module stgModule  'ts/CoreSpecs:storage:v1' = {
 ```
 
+An alias has been predefined for the [public module registry](./modules.md#path-to-module). To reference a public module, you can use the format:
+
+```bicep
+br/public:<file>:<tag>
+```
+
+You can override the public module registry alias definition in the bicepconfig.json file:
+
+```json
+{
+  "moduleAliases": {
+    "br": {
+      "public": {
+        "registry": "<your_module_registry>",
+        "modulePath": "<optional_module_path>"
+      }
+    }
+  }
+}
+```
+
 ## Credentials for publishing/restoring modules
 
 To [publish](bicep-cli.md#publish) modules to a private module registry or to [restore](bicep-cli.md#restore) external modules to the local cache, the account must have the correct permissions to access the registry. You can configure the credential precedence for authenticating to the registry. By default, Bicep uses the credentials from the user authenticated in Azure CLI or Azure PowerShell. To customize the credential precedence, see [Add credential precedence to Bicep config](bicep-config.md#credential-precedence).

articles/azure-resource-manager/bicep/media/modules/bicep-public-module-registry-modules.png

@@ -2,14 +2,14 @@
 title: Bicep modules
 description: Describes how to define a module in a Bicep file, and how to use module scopes.
 ms.topic: conceptual
-ms.date: 02/01/2022
+ms.date: 04/08/2022
 ---
 
 # Bicep modules
 
 Bicep enables you to organize deployments into modules. A module is just a Bicep file that is deployed from another Bicep file. With modules, you improve the readability of your Bicep files by encapsulating complex details of your deployment. You can also easily reuse modules for different deployments.
 
-To share modules with other people in your organization, create a [template spec](../templates/template-specs.md) or [private registry](private-module-registry.md). Template specs and modules in the registry are only available to users with the correct permissions.
+To share modules with other people in your organization, create a [template spec](../templates/template-specs.md), [public registry](https://github.com/Azure/bicep-registry-modules), or [private registry](private-module-registry.md). Template specs and modules in the registry are only available to users with the correct permissions.
 
 > [!TIP]
 > The choice between module registry and template specs is mostly a matter of preference. There are a few things to consider when you choose between the two:
@@ -77,6 +77,41 @@ For example, to deploy a file that is up one level in the directory from your ma
 
 ### File in registry
 
+#### Public module registry
+
+The public module registry is hosted in a Microsoft container registry (MCR). The source code and the modules are stored in [GitHub](https://github.com/azure/bicep-registry-modules). The [README file](https://github.com/azure/bicep-registry-modules#readme) in the GitHub repo lists the available modules and their latest versions:
+
+![Bicep public module registry modules](./media/modules/bicep-public-module-registry-modules.png)
+
+Select the versions to see the available versions. You can also select **Code** to see the module source code, and open the Readme files.
+
+There are only a few published modules currently. More modules are coming. If you like to contribute to the registry, see the [contribution guide](https://github.com/Azure/bicep-registry-modules/blob/main/CONTRIBUTING.md).
+
+To link to a public registry module, specify the module path with the following syntax:
+
+```bicep
+module <symbolic-name> 'br/public:<file-path>:<tag>' = {}
+```
+
+- **br/public** is the alias for the public module registry.
+- **file path** can contain segments that can be separated by the `/` character.
+- **tag** is used for specifying a version for the module.
+
+For example:
+
+::: code language="bicep" source="~/azure-docs-bicep-samples/syntax-samples/modules/registry-definition-public.bicep" highlight="1" :::
+
+> [!NOTE]
+> **br/public** is the alias for the public registry. It can also be written as
+>
+> ```bicep
+> module <symbolic-name> 'br:mcr.microsoft.com/bicep/<file-path>:<tag>' = {}
+> ```
+>
+> For more information see aliases and configuring aliases later in this section.
+
+#### Private module registry
+
 If you've [published a module to a registry](bicep-cli.md#publish), you can link to that module. Provide the name for the Azure container registry and a path to the module. Specify the module path with the following syntax:
 
 ```bicep
@@ -97,6 +132,12 @@ The full path for a module in a registry can be long. Instead of providing the f
 
 ::: code language="bicep" source="~/azure-docs-bicep-samples/syntax-samples/modules/alias-definition.bicep" highlight="1" :::
 
+An alias for the public module registry has been predefined:
+
+::: code language="bicep" source="~/azure-docs-bicep-samples/syntax-samples/modules/alias-definition-public.bicep" highlight="1" :::
+
+You can override the public alias in the bicepconfig.json file.
+
 ### File in template spec
 
 After creating a [template spec](../bicep/template-specs.md), you can link to that template spec in a module. Specify the template spec in the following format:

articles/azure-resource-manager/bicep/modules.md

@@ -2,12 +2,12 @@
 title: Create private registry for Bicep module
 description: Learn how to set up an Azure container registry for private Bicep modules
 ms.topic: conceptual
-ms.date: 02/21/2022
+ms.date: 04/01/2022
 ---
 
 # Create private registry for Bicep modules
 
-To share [modules](modules.md) within your organization, you can create a private module registry. You publish modules to that registry and give read access to users who need to deploy the modules. After the modules are shared in the registries, you can reference them from your Bicep files.
+To share [modules](modules.md) within your organization, you can create a private module registry. You publish modules to that registry and give read access to users who need to deploy the modules. After the modules are shared in the registries, you can reference them from your Bicep files. To contribute to the public module registry, see the [contribution guide](https://github.com/Azure/bicep-registry-modules/blob/main/CONTRIBUTING.md).
 
 To work with module registries, you must have [Bicep CLI](./install.md) version **0.4.1008 or later**. To use with Azure CLI, you must also have version **2.31.0 or later**; to use with Azure PowerShell, you must also have version **7.0.0** or later.
 

articles/azure-resource-manager/bicep/private-module-registry.md

@@ -1,15 +1,15 @@
 ---
 title: Publish modules to private module registry
 description: Publish Bicep modules to private module registry and use the modules.
-ms.date: 01/04/2022
+ms.date: 04/01/2022
 ms.topic: quickstart
 ms.custom: mode-api
 #Customer intent: As a developer new to Azure deployment, I want to learn how to publish Bicep modules to private module registry.
 ---
 
 # Quickstart: Publish Bicep modules to private module registry
 
-Learn how to publish Bicep modules to private modules registry, and how to call the modules from your Bicep files. Private module registry allows you to share Bicep modules within your organization.  To learn more, see [Create private registry for Bicep modules](./private-module-registry.md).
+Learn how to publish Bicep modules to private modules registry, and how to call the modules from your Bicep files. Private module registry allows you to share Bicep modules within your organization.  To learn more, see [Create private registry for Bicep modules](./private-module-registry.md). To contribute to the public module registry, see the [contribution guide](https://github.com/Azure/bicep-registry-modules/blob/main/CONTRIBUTING.md).
 
 ## Prerequisites