Skip to content

Commit cea4a8c

Browse files
authored
Merge pull request #287414 from mumian/0926-bicep-freshness
Refresh Bicep content - 2024/01/01
2 parents 2608df1 + 2a1089a commit cea4a8c

24 files changed

+62
-62
lines changed

articles/azure-resource-manager/bicep/add-template-to-azure-pipelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: CI/CD with Azure Pipelines, Bicep, and bicepparam files
33
description: In this quickstart, you learn how to configure continuous integration in Azure Pipelines by using Bicep and bicepparam files. It shows how to use an Azure CLI task to deploy a bicepparam file.
44
ms.topic: quickstart
55
ms.custom: devx-track-bicep, devx-track-azurecli
6-
ms.date: 02/29/2024
6+
ms.date: 09/26/2024
77
---
88

99
# Quickstart: Integrate Bicep with Azure Pipelines

articles/azure-resource-manager/bicep/child-resource-name-type.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Child resources in Bicep
33
description: Describes how to set the name and type for child resources in Bicep.
44
ms.topic: conceptual
55
ms.custom: devx-track-bicep
6-
ms.date: 06/23/2023
6+
ms.date: 09/26/2024
77
---
88

99
# Set name and type for child resources in Bicep

articles/azure-resource-manager/bicep/create-resource-group.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Use Bicep to create a new resource group
33
description: Describes how to use Bicep to create a new resource group in your Azure subscription.
44
ms.topic: how-to
55
ms.custom: devx-track-bicep
6-
ms.date: 09/26/2023
6+
ms.date: 09/26/2024
77
---
88

99
# Create resource groups by using Bicep

articles/azure-resource-manager/bicep/deploy-cloud-shell.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Deploy Bicep files with Cloud Shell
33
description: Use Azure Resource Manager and Azure Cloud Shell to deploy resources to Azure. The resources are defined in a Bicep file.
44
ms.topic: how-to
55
ms.custom: devx-track-bicep, devx-track-arm-template
6-
ms.date: 06/23/2023
6+
ms.date: 09/26/2024
77
---
88

99
# Deploy Bicep files from Azure Cloud Shell

articles/azure-resource-manager/bicep/deploy-github-actions.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Deploy Bicep files by using GitHub Actions
33
description: In this quickstart, you learn how to deploy Bicep files by using GitHub Actions.
44
ms.topic: how-to
5-
ms.date: 01/19/2024
5+
ms.date: 09/26/2024
66
ms.custom: github-actions-azure, devx-track-bicep
77
---
88

@@ -20,7 +20,7 @@ It provides a short introduction to GitHub actions and Bicep files. If you want
2020

2121
## Create resource group
2222

23-
Create a resource group. Later in this quickstart, you'll deploy your Bicep file to this resource group.
23+
Create a resource group. Later in this quickstart, you deploy your Bicep file to this resource group.
2424

2525
# [CLI](#tab/CLI)
2626

@@ -40,15 +40,15 @@ New-AzResourceGroup -Name exampleRG -Location westus
4040

4141
# [Service principal](#tab/userlevel)
4242

43-
Your GitHub Actions run under an identity. Use the [az ad sp create-for-rbac](/cli/azure/ad/sp#az-ad-sp-create-for-rbac) command to create a [service principal](../../active-directory/develop/app-objects-and-service-principals.md#service-principal-object) for the identity. Grant the service principal the contributor role for the resource group created in the previous session so that the GitHub action with the identity can create resources in this resource group. It is recommended that you grant minimum required access.
43+
Your GitHub Actions run under an identity. Use the [az ad sp create-for-rbac](/cli/azure/ad/sp#az-ad-sp-create-for-rbac) command to create a [service principal](../../active-directory/develop/app-objects-and-service-principals.md#service-principal-object) for the identity. Grant the service principal the contributor role for the resource group created in the previous session so that the GitHub action with the identity can create resources in this resource group. It's recommended that you grant minimum required access.
4444

4545
```azurecli-interactive
4646
az ad sp create-for-rbac --name {app-name} --role contributor --scopes /subscriptions/{subscription-id}/resourceGroups/exampleRG --json-auth
4747
```
4848

4949
Replace the placeholder `{app-name}` with the name of your application. Replace `{subscription-id}` with your subscription ID.
5050

51-
The output is a JSON object with the role assignment credentials that provide access to your App Service app similar to below.
51+
The output is a JSON object with the role assignment credentials that provide access to your App Service app similar to the following output.
5252

5353
```output
5454
{
@@ -60,21 +60,21 @@ The output is a JSON object with the role assignment credentials that provide ac
6060
}
6161
```
6262

63-
Copy this JSON object for later. You'll only need the sections with the `clientId`, `clientSecret`, `subscriptionId`, and `tenantId` values. Make sure you don't have an extra comma at the end of the last line, for example, the `tenantId` line in the preceding example, or else it will result in an invalid JSON file. You will get an error during the deployment saying "Login failed with Error: Content is not a valid JSON object. Double check if the 'auth-type' is correct."
63+
Copy this JSON object for later. You'll only need the sections with the `clientId`, `clientSecret`, `subscriptionId`, and `tenantId` values. Make sure you don't have an extra comma at the end of the last line, for example, the `tenantId` line in the preceding example, or else it results in an invalid JSON file. You get an error during the deployment saying "Login failed with Error: Content isn't a valid JSON object. Double check if the 'auth-type' is correct."
6464

6565
# [Open ID Connect](#tab/openid)
6666

6767
Open ID Connect is an authentication method that uses short-lived tokens. Setting up [OpenID Connect with GitHub Actions](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect) is more complex process that offers hardened security.
6868

69-
1. If you do not have an existing application, register a [new Active Directory application and service principal that can access resources](../../active-directory/develop/howto-create-service-principal-portal.md). Create the Active Directory application.
69+
1. If you don't have an existing application, register a [new Active Directory application and service principal that can access resources](../../active-directory/develop/howto-create-service-principal-portal.md). Create the Active Directory application.
7070

7171
```azurecli-interactive
7272
az ad app create --display-name myApp
7373
```
7474
75-
This command will output JSON with an `appId` that is your `client-id`. Save the value to use as the `AZURE_CLIENT_ID` GitHub secret later.
75+
This command outputs JSON with an `appId` that is your `client-id`. Save the value to use as the `AZURE_CLIENT_ID` GitHub secret later.
7676
77-
You'll use the `objectId` value when creating federated credentials with Graph API and reference it as the `APPLICATION-OBJECT-ID`.
77+
You use the `objectId` value when creating federated credentials with Graph API and reference it as the `APPLICATION-OBJECT-ID`.
7878
7979
1. Create a service principal. Replace the `$appID` with the appId from your JSON output.
8080
@@ -86,7 +86,7 @@ Open ID Connect is an authentication method that uses short-lived tokens. Settin
8686
az ad sp create --id $appId
8787
```
8888
89-
1. Create a new role assignment by subscription and object. By default, the role assignment will be tied to your default subscription. Replace `$subscriptionId` with your subscription ID, `$resourceGroupName` with your resource group name, and `$assigneeObjectId` with the generated `assignee-object-id`. Learn [how to manage Azure subscriptions with the Azure CLI](/cli/azure/manage-azure-subscriptions-azure-cli).
89+
1. Create a new role assignment by subscription and object. By default, the role assignment is tied to your default subscription. Replace `$subscriptionId` with your subscription ID, `$resourceGroupName` with your resource group name, and `$assigneeObjectId` with the generated `assignee-object-id`. Learn [how to manage Azure subscriptions with the Azure CLI](/cli/azure/manage-azure-subscriptions-azure-cli).
9090
9191
```azurecli-interactive
9292
az role assignment create --role contributor --subscription $subscriptionId --assignee-object-id $assigneeObjectId --assignee-principal-type ServicePrincipal --scopes /subscriptions/$subscriptionId/resourceGroups/$resourceGroupName/providers/Microsoft.Web/sites/
@@ -112,7 +112,7 @@ Open ID Connect is an authentication method that uses short-lived tokens. Settin
112112
113113
# [Service principal](#tab/userlevel)
114114
115-
Create secrets for your Azure credentials, resource group, and subscriptions. You will use these secrets in the [Create workflow](#create-workflow) section.
115+
Create secrets for your Azure credentials, resource group, and subscriptions. You use these secrets in the [Create workflow](#create-workflow) section.
116116
117117
1. In [GitHub](https://github.com/), navigate to your repository.
118118
@@ -284,7 +284,7 @@ Updating either the workflow file or Bicep file triggers the workflow. The workf
284284

285285
## Check workflow status
286286

287-
1. Select the **Actions** tab. You'll see a **Create deployBicepFile.yml** workflow listed. It takes 1-2 minutes to run the workflow.
287+
1. Select the **Actions** tab. You see a **Create deployBicepFile.yml** workflow listed. It takes 1-2 minutes to run the workflow.
288288
1. Select the workflow to open it, and verify the `Status` is `Success`.
289289

290290
## Clean up resources

articles/azure-resource-manager/bicep/deploy-to-management-group.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Use Bicep to deploy resources to management group
33
description: Describes how to create a Bicep file that deploys resources at the management group scope.
44
ms.topic: how-to
55
ms.custom: devx-track-bicep
6-
ms.date: 06/23/2023
6+
ms.date: 09/26/2024
77
---
88

99
# Management group deployments with Bicep files
@@ -256,7 +256,7 @@ To deploy a template that moves an existing Azure subscription to a new manageme
256256

257257
Custom policy definitions that are deployed to the management group are extensions of the management group. To get the ID of a custom policy definition, use the [extensionResourceId()](./bicep-functions-resource.md#extensionresourceid) function. Built-in policy definitions are tenant level resources. To get the ID of a built-in policy definition, use the [tenantResourceId()](./bicep-functions-resource.md#tenantresourceid) function.
258258

259-
The following example shows how to [define](../../governance/policy/concepts/definition-structure.md) a policy at the management group level, and assign it.
259+
The following example shows how to [define](../../governance/policy/concepts/definition-structure.md) a policy at the management group level, and how to assign it.
260260

261261
```bicep
262262
targetScope = 'managementGroup'

articles/azure-resource-manager/bicep/deploy-to-resource-group.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Use Bicep to deploy resources to resource groups
33
description: Describes how to deploy resources in a Bicep file. It shows how to target more than one resource group.
44
ms.topic: how-to
55
ms.custom: devx-track-bicep
6-
ms.date: 07/11/2024
6+
ms.date: 09/26/2024
77
---
88

99
# Resource group deployments with Bicep files

articles/azure-resource-manager/bicep/deploy-to-subscription.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Use Bicep to deploy resources to subscription
33
description: Describes how to create a Bicep file that deploys resources to the Azure subscription scope.
44
ms.topic: how-to
55
ms.custom: devx-track-bicep
6-
ms.date: 09/26/2023
6+
ms.date: 09/26/2024
77
---
88

99
# Subscription deployments with Bicep files

articles/azure-resource-manager/bicep/deploy-to-tenant.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Use Bicep to deploy resources to tenant
33
description: Describes how to deploy resources at the tenant scope in a Bicep file.
44
ms.topic: how-to
55
ms.custom: devx-track-bicep
6-
ms.date: 07/11/2024
6+
ms.date: 09/26/2024
77
---
88

99
# Tenant deployments with Bicep file

articles/azure-resource-manager/bicep/deploy-what-if.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Bicep deployment what-if
33
description: Determine what changes will happen to your resources before deploying a Bicep file.
44
ms.topic: conceptual
55
ms.custom: devx-track-bicep, devx-track-azurecli, devx-track-azurepowershell
6-
ms.date: 09/06/2023
6+
ms.date: 09/26/2024
77
---
88

99
# Bicep deployment what-if operation
@@ -12,7 +12,7 @@ Before deploying a Bicep file, you can preview the changes that will happen. Azu
1212

1313
You can use the what-if operation with Azure PowerShell, Azure CLI, or REST API operations. What-if is supported for resource group, subscription, management group, and tenant level deployments.
1414

15-
During What-If operations, the evaluation and expansion of `templateLink` are not supported. As a result, any resources deployed using template links within nested deployments, including template spec references, will not be visible in the What-If operation results.
15+
During What-If operations, the evaluation and expansion of `templateLink` aren't supported. As a result, any resources deployed using template links within nested deployments, including template spec references, won't be visible in the What-If operation results.
1616

1717
### Training resources
1818

@@ -140,7 +140,7 @@ The what-if operation lists seven different types of changes:
140140

141141
- **Create**: The resource doesn't currently exist but is defined in the Bicep file. The resource will be created.
142142
- **Delete**: This change type only applies when using [complete mode](../templates/deployment-modes.md) for JSON template deployment. The resource exists, but isn't defined in the Bicep file. With complete mode, the resource will be deleted. Only resources that [support complete mode deletion](../templates/deployment-complete-mode-deletion.md) are included in this change type.
143-
- **Ignore**: The resource exists, but isn't defined in the Bicep file. The resource won't be deployed or modified. When you reach the limits for expanding nested templates, you will encounter this change type. See [What-if limits](#what-if-limits).
143+
- **Ignore**: The resource exists, but isn't defined in the Bicep file. The resource won't be deployed or modified. When you reach the limits for expanding nested templates, you'll encounter this change type. See [What-if limits](#what-if-limits).
144144
- **NoChange**: The resource exists, and is defined in the Bicep file. The resource will be redeployed, but the properties of the resource won't change. This change type is returned when [ResultFormat](#result-format) is set to `FullResourcePayloads`, which is the default value.
145145
- **NoEffect**: The property is ready-only and will be ignored by the service. For example, the `sku.tier` property is always set to match `sku.name` in the [`Microsoft.ServiceBus`](/azure/templates/microsoft.servicebus/namespaces) namespace.
146146
- **Modify**: The resource exists, and is defined in the Bicep file. The resource will be redeployed, and the properties of the resource will change. This change type is returned when [ResultFormat](#result-format) is set to `FullResourcePayloads`, which is the default value.
@@ -484,5 +484,5 @@ You can use the what-if operation through the Azure SDKs.
484484
## Next steps
485485

486486
- To use the what-if operation in a pipeline, see [Test ARM templates with What-If in a pipeline](https://4bes.nl/2021/03/06/test-arm-templates-with-what-if/).
487-
- If you notice incorrect results from the what-if operation, please report the issues at [https://aka.ms/whatifissues](https://aka.ms/whatifissues).
487+
- If you notice incorrect results from the what-if operation, report the issues at [https://aka.ms/whatifissues](https://aka.ms/whatifissues).
488488
- For a Learn module that demonstrates using what-if, see [Preview changes and validate Azure resources by using what-if and the ARM template test toolkit](/training/modules/arm-template-test/).

0 commit comments

Comments
 (0)