Skip to content

Commit cf7b0eb

Browse files
Merge pull request #234860 from mumian/0418-publish-module
Document documnetationUri switch
2 parents 3c992ea + db12eab commit cf7b0eb

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Bicep CLI commands and overview
33
description: Describes the commands that you can use in the Bicep CLI. These commands include building Azure Resource Manager templates from Bicep.
44
ms.topic: conceptual
55
ms.custom: devx-track-azurecli, devx-track-bicep, devx-track-arm-template
6-
ms.date: 01/10/2023
6+
ms.date: 04/18/2023
77
---
88

99
# Bicep CLI commands
@@ -135,18 +135,18 @@ The `publish` command adds a module to a registry. The Azure container registry
135135

136136
After publishing the file to the registry, you can [reference it in a module](modules.md#file-in-registry).
137137

138-
To use the publish command, you must have Bicep CLI version **0.4.1008 or later**.
138+
To use the publish command, you must have Bicep CLI version **0.4.1008 or later**. To use the `--documentationUri`/`-d` parameter, you must have Bicep CLI version **0.14.46 or later**.
139139

140140
To publish a module to a registry, use:
141141

142142
```azurecli
143-
az bicep publish --file <bicep-file> --target br:<registry-name>.azurecr.io/<module-path>:<tag>
143+
az bicep publish --file <bicep-file> --target br:<registry-name>.azurecr.io/<module-path>:<tag> --documentationUri <documentation-uri>
144144
```
145145

146146
For example:
147147

148148
```azurecli
149-
az bicep publish --file storage.bicep --target br:exampleregistry.azurecr.io/bicep/modules/storage:v1
149+
az bicep publish --file storage.bicep --target br:exampleregistry.azurecr.io/bicep/modules/storage:v1 --documentationUri https://www.contoso.com/exampleregistry.html
150150
```
151151

152152
The `publish` command doesn't recognize aliases that you've defined in a [bicepconfig.json](bicep-config-modules.md) file. Provide the full module path.

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Create private registry for Bicep module
33
description: Learn how to set up an Azure container registry for private Bicep modules
44
ms.topic: conceptual
55
ms.custom: devx-track-bicep
6-
ms.date: 01/10/2023
6+
ms.date: 04/18/2023
77
---
88

99
# Create private registry for Bicep modules
@@ -58,15 +58,15 @@ After setting up the container registry, you can publish files to it. Use the [p
5858
# [PowerShell](#tab/azure-powershell)
5959
6060
```azurepowershell
61-
Publish-AzBicepModule -FilePath ./storage.bicep -Target br:exampleregistry.azurecr.io/bicep/modules/storage:v1
61+
Publish-AzBicepModule -FilePath ./storage.bicep -Target br:exampleregistry.azurecr.io/bicep/modules/storage:v1 -DocumentationUri https://www.contoso.com/exampleregistry.html
6262
```
6363

6464
# [Azure CLI](#tab/azure-cli)
6565

6666
To run this deployment command, you must have the [latest version](/cli/azure/install-azure-cli) of Azure CLI.
6767

6868
```azurecli
69-
az bicep publish --file storage.bicep --target br:exampleregistry.azurecr.io/bicep/modules/storage:v1
69+
az bicep publish --file storage.bicep --target br:exampleregistry.azurecr.io/bicep/modules/storage:v1 --documentationUri https://www.contoso.com/exampleregistry.html
7070
```
7171

7272
---

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Publish modules to private module registry
33
description: Publish Bicep modules to private module registry and use the modules.
4-
ms.date: 04/01/2022
4+
ms.date: 04/18/2023
55
ms.topic: quickstart
66
ms.custom: mode-api, devx-track-bicep
77
#Customer intent: As a developer new to Azure deployment, I want to learn how to publish Bicep modules to private module registry.
@@ -85,13 +85,13 @@ Use the following syntax to publish a Bicep file as a module to a private module
8585
# [Azure CLI](#tab/azure-cli)
8686

8787
```azurecli
88-
az bicep publish --file storage.bicep --target br:exampleregistry.azurecr.io/bicep/modules/storage:v1
88+
az bicep publish --file storage.bicep --target br:exampleregistry.azurecr.io/bicep/modules/storage:v1 --documentationUri https://www.contoso.com/exampleregistry.html
8989
```
9090

9191
# [Azure PowerShell](#tab/azure-powershell)
9292

9393
```azurepowershell
94-
Publish-AzBicepModule -FilePath ./storage.bicep -Target br:exampleregistry.azurecr.io/bicep/modules/storage:v1
94+
Publish-AzBicepModule -FilePath ./storage.bicep -Target br:exampleregistry.azurecr.io/bicep/modules/storage:v1 -DocumentationUri https://www.contoso.com/exampleregistry.html
9595
```
9696

9797
---

articles/container-registry/container-registry-get-started-bicep.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ param location string = resourceGroup().location
3636
@description('Provide a tier of your Azure Container Registry.')
3737
param acrSku string = 'Basic'
3838
39-
resource acrResource 'Microsoft.ContainerRegistry/registries@2021-06-01-preview' = {
39+
resource acrResource 'Microsoft.ContainerRegistry/registries@2023-01-01-preview' = {
4040
name: acrName
4141
location: location
4242
sku: {

0 commit comments

Comments
 (0)