Skip to content

Commit 9283fb5

Browse files
authored
Merge pull request #111061 from DCtheGeek/dmc-bp-images
Full review, reflow, and platform adjustments
2 parents aa01d91 + 19e6159 commit 9283fb5

File tree

9 files changed

+73
-61
lines changed

9 files changed

+73
-61
lines changed

articles/governance/blueprints/concepts/parameters.md

Lines changed: 40 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
title: Use parameters to creating dynamic blueprints
33
description: Learn about static and dynamic parameters and how to use them to create secure and dynamic blueprints.
4-
ms.date: 03/12/2019
4+
ms.date: 04/15/2020
55
ms.topic: conceptual
66
---
77
# Creating dynamic blueprints through parameters
88

99
A fully defined blueprint with various artifacts (such as resource groups, Resource Manager
1010
templates, policies, or role assignments) offers the rapid creation and consistent creation of
11-
objects within Azure. To enable flexible use of these reusable design patterns and containers,
12-
Azure Blueprints supports parameters. The parameter creates flexibility, both during definition and
11+
objects within Azure. To enable flexible use of these reusable design patterns and containers, Azure
12+
Blueprints supports parameters. The parameter creates flexibility, both during definition and
1313
assignment, to change properties on the artifacts deployed by the blueprint.
1414

1515
A simple example is the resource group artifact. When a resource group is created, it has two
@@ -32,22 +32,21 @@ without having conflict.
3232
## Blueprint parameters
3333

3434
Through the REST API, parameters can be created on the blueprint itself. These parameters are
35-
different than the parameters on each of the supported artifacts. When a parameter is created on
36-
the blueprint, it can be used by the artifacts in that blueprint. An example might be the prefix
37-
for naming of the resource group. The artifact can use the blueprint parameter to create a "mostly
38-
dynamic" parameter. As the parameter can also be defined during assignment, this pattern allows
39-
for a consistency that may adhere to naming rules. For steps, see [setting static parameters -
40-
blueprint level parameter](#blueprint-level-parameter).
35+
different than the parameters on each of the supported artifacts. When a parameter is created on the
36+
blueprint, it can be used by the artifacts in that blueprint. An example might be the prefix for
37+
naming of the resource group. The artifact can use the blueprint parameter to create a "mostly
38+
dynamic" parameter. As the parameter can also be defined during assignment, this pattern allows for
39+
a consistency that may adhere to naming rules. For steps, see [setting static parameters - blueprint
40+
level parameter](#blueprint-level-parameter).
4141

4242
### Using secureString and secureObject parameters
4343

4444
While a Resource Manager template _artifact_ supports parameters of the **secureString** and
45-
**secureObject** types, Azure Blueprints requires each to be connected with an Azure Key Vault.
46-
This security measure prevents the unsafe practice of storing secrets along with the Blueprint and
47-
encourages employment of secure patterns. Azure Blueprints supports this security measure,
48-
detecting the inclusion of either secure parameter in a Resource Manager template _artifact_. The
49-
service then prompts during assignment for the following Key Vault properties per detected secure
50-
parameter:
45+
**secureObject** types, Azure Blueprints requires each to be connected with an Azure Key Vault. This
46+
security measure prevents the unsafe practice of storing secrets along with the Blueprint and
47+
encourages employment of secure patterns. Azure Blueprints supports this security measure, detecting
48+
the inclusion of either secure parameter in a Resource Manager template _artifact_. The service then
49+
prompts during assignment for the following Key Vault properties per detected secure parameter:
5150

5251
- Key Vault resource ID
5352
- Key Vault secret name
@@ -73,30 +72,36 @@ Overview](../../../key-vault/key-vault-overview.md).
7372

7473
### Static parameters
7574

76-
A parameter value defined in the definition of a blueprint is called a **static parameter**,
77-
because every use of the blueprint will deploy the artifact using that static value. In the
78-
resource group example, while it doesn't make sense for the name of the resource group, it might
79-
make sense for the location. Then, every assignment of the blueprint would create the resource
80-
group, whatever it's called during assignment, in the same location. This flexibility allows you to
81-
be selective in what you define as required vs what can be changed during assignment.
75+
A parameter value defined in the definition of a blueprint is called a **static parameter**, because
76+
every use of the blueprint will deploy the artifact using that static value. In the resource group
77+
example, while it doesn't make sense for the name of the resource group, it might make sense for the
78+
location. Then, every assignment of the blueprint would create the resource group, whatever it's
79+
called during assignment, in the same location. This flexibility allows you to be selective in what
80+
you define as required vs what can be changed during assignment.
8281

8382
#### Setting static parameters in the portal
8483

8584
1. Select **All services** in the left pane. Search for and select **Blueprints**.
8685

8786
1. Select **Blueprint definitions** from the page on the left.
8887

89-
1. Click on an existing blueprint and then click **Edit blueprint** OR click **+ Create blueprint** and fill out the information on the **Basics** tab.
88+
1. Click on an existing blueprint and then click **Edit blueprint** OR click **+ Create blueprint**
89+
and fill out the information on the **Basics** tab.
9090

9191
1. Click **Next: Artifacts** OR click on the **Artifacts** tab.
9292

93-
1. Artifacts added to the blueprint that have parameter options display **X of Y parameters populated** in the **Parameters** column. Click on the artifact row to edit the artifact parameters.
93+
1. Artifacts added to the blueprint that have parameter options display **X of Y parameters
94+
populated** in the **Parameters** column. Click on the artifact row to edit the artifact
95+
parameters.
9496

95-
![Blueprint parameters on a blueprint definition](../media/parameters/parameter-column.png)
97+
:::image type="content" source="../media/parameters/parameter-column.png" alt-text="Blueprint parameters on a blueprint definition" border="false":::
9698

97-
1. The **Edit Artifact** page displays value options appropriate to the artifact clicked on. Each parameter on the artifact has a title, a value box, and a checkbox. Set the box to unchecked to make it a **static parameter**. In the example below, only _Location_ is a **static parameter** as it's unchecked and _Resource Group Name_ is checked.
99+
1. The **Edit Artifact** page displays value options appropriate to the artifact clicked on. Each
100+
parameter on the artifact has a title, a value box, and a checkbox. Set the box to unchecked to
101+
make it a **static parameter**. In the example below, only _Location_ is a **static parameter**
102+
as it's unchecked and _Resource Group Name_ is checked.
98103

99-
![Blueprint static parameters on a blueprint artifact](../media/parameters/static-parameter.png)
104+
:::image type="content" source="../media/parameters/static-parameter.png" alt-text="Blueprint static parameters on a blueprint artifact" border="false":::
100105

101106
#### Setting static parameters from REST API
102107

@@ -205,20 +210,24 @@ and **tagValue**. The value on each is directly provided and doesn't use a funct
205210
The opposite of a static parameter is a **dynamic parameter**. This parameter isn't defined on the
206211
blueprint, but instead is defined during each assignment of the blueprint. In the resource group
207212
example, use of a **dynamic parameter** makes sense for the resource group name. It provides a
208-
different name for every assignment of the blueprint. For a list of blueprint functions, see the [blueprint functions](../reference/blueprint-functions.md)
209-
reference.
213+
different name for every assignment of the blueprint. For a list of blueprint functions, see the
214+
[blueprint functions](../reference/blueprint-functions.md) reference.
210215

211216
#### Setting dynamic parameters in the portal
212217

213218
1. Select **All services** in the left pane. Search for and select **Blueprints**.
214219

215220
1. Select **Blueprint definitions** from the page on the left.
216221

217-
1. Right-click on the blueprint that you want to assign. Select **Assign blueprint** OR click on the blueprint you want to assign, then click the **Assign blueprint** button.
222+
1. Right-click on the blueprint that you want to assign. Select **Assign blueprint** OR click on the
223+
blueprint you want to assign, then click the **Assign blueprint** button.
218224

219-
1. On the **Assign blueprint** page, find the **Artifact parameters** section. Each artifact with at least one **dynamic parameter** displays the artifact and the configuration options. Provide required values to the parameters before assigning the blueprint. In the example below, _Name_ is a **dynamic parameter** that must be defined to complete blueprint assignment.
225+
1. On the **Assign blueprint** page, find the **Artifact parameters** section. Each artifact with at
226+
least one **dynamic parameter** displays the artifact and the configuration options. Provide
227+
required values to the parameters before assigning the blueprint. In the example below, _Name_ is
228+
a **dynamic parameter** that must be defined to complete blueprint assignment.
220229

221-
![Blueprint dynamic parameter during blueprint assignment](../media/parameters/dynamic-parameter.png)
230+
:::image type="content" source="../media/parameters/dynamic-parameter.png" alt-text="Blueprint dynamic parameter during blueprint assignment" border="false":::
222231

223232
#### Setting dynamic parameters from REST API
224233

articles/governance/blueprints/concepts/resource-locking.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ blueprint assignment and can only be removed from the artifact resources by the
128128
identity. This security measure enforces the locking mechanism and prevents removing the blueprint
129129
lock outside Azure Blueprints.
130130

131-
![Blueprint deny assignment on resource group](../media/resource-locking/blueprint-deny-assignment.png)
131+
:::image type="content" source="../media/resource-locking/blueprint-deny-assignment.png" alt-text="Blueprint deny assignment on resource group" border="false":::
132132

133133
The
134134
[deny assignment properties](../../../role-based-access-control/deny-assignments.md#deny-assignment-properties)

articles/governance/blueprints/create-blueprint-portal.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Manager template and role assignment on the new resource group.
3131

3232
Or, select **Create** from the **Getting started** page to go straight to creating a blueprint.
3333

34-
![Create a blueprint from the Blueprint definitions page](./media/create-blueprint-portal/create-blueprint-button.png)
34+
:::image type="content" source="./media/create-blueprint-portal/create-blueprint-button.png" alt-text="Create a blueprint from the Blueprint definitions page" border="false":::
3535

3636
1. Select **Start with blank blueprint** from the card at the top of the built-in blueprints list.
3737

@@ -59,12 +59,13 @@ Manager template and role assignment on the new resource group.
5959

6060
1. Select **Add** to add this artifact to the blueprint.
6161

62-
![Role assignment for a blueprint artifact](./media/create-blueprint-portal/add-role-assignment.png)
62+
:::image type="content" source="./media/create-blueprint-portal/add-role-assignment.png" alt-text="Role assignment for a blueprint artifact" border="false":::
6363

6464
> [!NOTE]
6565
> Most artifacts support parameters. A parameter that's assigned a value during blueprint
66-
> creation is a *static parameter*. If the parameter is assigned during blueprint assignment,
67-
> it's a *dynamic parameter*. For more information, see [Blueprint parameters](./concepts/parameters.md).
66+
> creation is a _static parameter_. If the parameter is assigned during blueprint assignment,
67+
> it's a _dynamic parameter_. For more information, see
68+
> [Blueprint parameters](./concepts/parameters.md).
6869
6970
1. Add a policy assignment at the subscription level:
7071

@@ -171,13 +172,13 @@ Manager template and role assignment on the new resource group.
171172

172173
1. Select **Add** to add this artifact to the blueprint.
173174

174-
![Resource Manager template for the blueprint artifact](./media/create-blueprint-portal/add-resource-manager-template.png)
175+
:::image type="content" source="./media/create-blueprint-portal/add-resource-manager-template.png" alt-text="Resource Manager template for the blueprint artifact" border="false":::
175176

176177
1. Your completed blueprint should look similar to the following. Notice that each artifact has
177178
**_x_ out of _y_ parameters populated** in the **Parameters** column. The dynamic parameters are
178179
set during each assignment of the blueprint.
179180

180-
![Completed blueprint definition](./media/create-blueprint-portal/completed-blueprint.png)
181+
:::image type="content" source="./media/create-blueprint-portal/completed-blueprint.png" alt-text="Completed blueprint definition" border="false":::
181182

182183
1. Now that all planned artifacts have been added, select **Save Draft** at the bottom of the page.
183184

@@ -211,14 +212,14 @@ assignment to the new resource group. You can fix both by following these steps:
211212
1. Search for and select a user, app, or group to add. This artifact uses a static parameter set
212213
the same in every assignment of this blueprint.
213214

214-
e. Select **Add** to add this artifact to the blueprint.
215+
1. Select **Add** to add this artifact to the blueprint.
215216

216-
![Second role assignment for the blueprint artifact](./media/create-blueprint-portal/add-role-assignment-2.png)
217+
:::image type="content" source="./media/create-blueprint-portal/add-role-assignment-2.png" alt-text="Second role assignment for the blueprint artifact" border="false":::
217218

218219
1. Your completed blueprint should look similar to the following. Notice that the newly added role
219220
assignment shows **1 out of 1 parameters populated**. That means it's a static parameter.
220221

221-
![Second definition for the completed blueprint](./media/create-blueprint-portal/completed-blueprint-2.png)
222+
:::image type="content" source="./media/create-blueprint-portal/completed-blueprint-2.png" alt-text="Second definition for the completed blueprint" border="false":::
222223

223224
1. Select **Save Draft** now that it has been updated.
224225

@@ -252,8 +253,9 @@ is saved to a subscription, it can only be assigned to that subscription.
252253
1. On the **Assign blueprint** page, in the **Subscription** drop-down list, select the
253254
subscriptions that you want to deploy this blueprint to.
254255

255-
If there are supported Enterprise offerings available from [Azure Billing](../../billing/index.md),
256-
a **Create new** link is activated under the **Subscription** box. Follow these steps:
256+
If there are supported Enterprise offerings available from
257+
[Azure Billing](../../billing/index.md), a **Create new** link is activated under the
258+
**Subscription** box. Follow these steps:
257259

258260
1. Select the **Create new** link to create a new subscription instead of selecting existing
259261
ones.
@@ -267,10 +269,10 @@ is saved to a subscription, it can only be assigned to that subscription.
267269

268270
1. Select **Create** at the bottom of the page.
269271

270-
![Create a subscription for a blueprint assignment subscription](./media/create-blueprint-portal/assignment-create-subscription.png)
272+
:::image type="content" source="./media/create-blueprint-portal/assignment-create-subscription.png" alt-text="Create a subscription for a blueprint assignment subscription" border="false":::
271273

272-
> [!IMPORTANT]
273-
> The new subscription is created immediately after you select **Create**.
274+
> [!IMPORTANT]
275+
> The new subscription is created immediately after you select **Create**.
274276

275277
> [!NOTE]
276278
> An assignment is created for each subscription that you select. You can make changes to a
@@ -287,9 +289,10 @@ is saved to a subscription, it can only be assigned to that subscription.
287289
1. Leave the **Blueprint definition version** drop-down selection of **Published** versions on the
288290
**v1** entry. (The default is the most recently published version.)
289291

290-
1. For **Lock Assignment**, leave the default of **Don't Lock**. For more information, see [Blueprints resource locking](./concepts/resource-locking.md).
292+
1. For **Lock Assignment**, leave the default of **Don't Lock**. For more information, see
293+
[Blueprints resource locking](./concepts/resource-locking.md).
291294

292-
![Locking and managed identities for the assignment](./media/create-blueprint-portal/assignment-locking-mi.png)
295+
:::image type="content" source="./media/create-blueprint-portal/assignment-locking-mi.png" alt-text="Locking and managed identities for the assignment" border="false":::
293296

294297
1. Under **Managed Identity**, leave the default of **System assigned**.
295298

@@ -327,7 +330,7 @@ Now that the blueprint has been assigned to a subscription, verify the progress
327330
1. In the list of blueprints, right-click the one that you previously assigned and select **View
328331
assignment details**.
329332

330-
![View assignment details from the Assigned blueprints page](./media/create-blueprint-portal/view-assignment-details.png)
333+
:::image type="content" source="./media/create-blueprint-portal/view-assignment-details.png" alt-text="View assignment details from the Assigned blueprints page" border="false":::
331334

332335
1. On the **Blueprint assignment** page, validate that all artifacts were successfully deployed and
333336
that there were no errors during the deployment. If errors occurred, see [Troubleshooting blueprints](./troubleshoot/general.md)

articles/governance/blueprints/how-to/update-existing-assignments.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Update an existing assignment from the portal
33
description: Learn about the mechanism for updating an existing blueprint assignment from the portal in Azure Blueprints.
4-
ms.date: 11/21/2019
4+
ms.date: 04/15/2020
55
ms.topic: how-to
66
---
77
# How to update an existing blueprint assignment
@@ -22,7 +22,7 @@ an existing assignment, including:
2222
1. In the list of blueprints, left-click the blueprint assignment. Then click the **Update
2323
assignment** button OR right-click the blueprint assignment and select **Update assignment**.
2424

25-
![Update an existing blueprint assignment](../media/update-existing-assignments/update-assignment.png)
25+
:::image type="content" source="../media/update-existing-assignments/update-assignment.png" alt-text="Update an existing blueprint assignment" border="false":::
2626

2727
1. The **Assign blueprint** page will load pre-filled with all values from the original assignment.
2828
You can change the **blueprint definition version**, the **Lock Assignment** state, and any of
@@ -32,12 +32,12 @@ an existing assignment, including:
3232
1. On the updated assignment details page, see the new status. In this example, we added **Locking**
3333
to the assignment.
3434

35-
![Updated an existing blueprint assignment - lock mode changed](../media/update-existing-assignments/updated-assignment.png)
35+
:::image type="content" source="../media/update-existing-assignments/updated-assignment.png" alt-text="Updated an existing blueprint assignment - lock mode changed" border="false":::
3636

3737
1. Explore details about other **Assignment operations** using the drop-down. The table of **Managed
3838
resources** updates by selected assignment operation.
3939

40-
![Assignment operations of a blueprint assignment](../media/update-existing-assignments/assignment-operations.png)
40+
:::image type="content" source="../media/update-existing-assignments/assignment-operations.png" alt-text="Assignment operations of a blueprint assignment" border="false":::
4141

4242
## Rules for updating assignments
4343

articles/governance/blueprints/samples/caf-foundation/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: CAF Foundation blueprint sample overview
33
description: Overview and architecture of the Cloud Adoption Framework (CAF) for Azure Foundation blueprint sample.
4-
ms.date: 08/20/2019
4+
ms.date: 04/15/2020
55
ms.topic: sample
66
---
77
# Overview of the Microsoft Cloud Adoption Framework for Azure Foundation blueprint sample
@@ -17,7 +17,7 @@ be used by organizations to put in place the foundation controls necessary to ma
1717
estate. This sample will deploy and enforce resources, policies, and templates that will allow an
1818
organization to confidently get started with Azure.
1919

20-
![CAF Foundation, image describes what gets installed as part of CAF guidance for creating a foundation to get started with Azure](../../media/caf-blueprints/caf-foundation-architecture.png)
20+
:::image type="content" source="../../media/caf-blueprints/caf-foundation-architecture.png" alt-text="CAF Foundation, image describes what gets installed as part of CAF guidance for creating a foundation to get started with Azure" border="false":::
2121

2222
This implementation incorporates several Azure services used to provide a secure, fully monitored,
2323
enterprise-ready foundation. This environment is composed of:

0 commit comments

Comments
 (0)