Skip to content

Commit 33ed8a6

Browse files
Merge pull request #279260 from shanhix1/shannon/versioning
Documenting portal limitation WRT custom initiatives referencing built-in policy versions
2 parents b77dedd + e3a9539 commit 33ed8a6

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

articles/governance/policy/concepts/initiative-definition-structure.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Details of the initiative definition structure
33
description: Describes how policy initiative definitions are used to group policy definitions for deployment to Azure resources in your organization.
4-
ms.date: 08/17/2021
4+
ms.date: 07/02/2024
55
ms.topic: conceptual
66
---
77
# Azure Policy initiative definition structure
@@ -128,23 +128,21 @@ there are some _common_ properties used by Azure Policy and in built-ins.
128128
## Version (preview)
129129
Built-in policy initiatives can host multiple versions with the same `definitionID`. If no version number is specified, all experiences will show the latest version of the definition. To see a specific version of a built-in, it must be specified in API, SDK or UI. To reference a specific version of a definition within an assignment, see [definition version within assignment](../concepts/assignment-structure.md#policy-definition-id-and-version-preview)
130130

131-
The Azure Policy service uses `version`, `preview`, and `deprecated` properties to convey level of
132-
> change to a built-in policy definition or initiative and state. The format of `version` is:
133-
> `{Major}.{Minor}.{Patch}`. Specific states, such as _deprecated_ or _preview_, are appended to the
134-
> `version` property or in another property as a **boolean**.
131+
The Azure Policy service uses `version`, `preview`, and `deprecated` properties to convey the level of change to a built-in policy definition or initiative and state. The format of `version` is: `{Major}.{Minor}.{Patch}`. Specific states, such as _deprecated_ or _preview_, are appended to the `version` property or in another property as a **boolean** as shown in the common metadata properties.
135132

136133
- Major Version (example: 2.0.0): introduce breaking changes such as major rule logic changes, removing parameters, adding an enforcement effect by default.
137134
- Minor Version (example: 2.1.0): introduce changes such as minor rule logic changes, adding new parameter allowed values, change to role definitionIds, adding or removing definitions within an initiative.
138135
- Patch Version (example: 2.1.4): introduce string or metadata changes and break glass security scenarios (rare).
139136

137+
Built-in initiatives are versioned, and specific versions of built-in policy definitions can be referenced within built-in or custom initiatives as well. For more information, see [reference definition and versions](#policy-definition-properties).
138+
139+
> While in preview, when creating an initiative through the portal, you will not be able to specify versions for built-in policy definition references. All built-in policy references in custom initiatives created through the portal will instead default to the latest version of the policy definition.
140+
>
140141
> For more information about
141142
> Azure Policy versions built-ins, see
142143
> [Built-in versioning](https://github.com/Azure/azure-policy/blob/master/built-in-policies/README.md).
143144
> To learn more about what it means for a policy to be _deprecated_ or in _preview_, see [Preview and deprecated policies](https://github.com/Azure/azure-policy/blob/master/built-in-policies/README.md#preview-and-deprecated-policies).
144145
145-
Built-in initiatives themselves are versioned, but it's possible to reference a specific version of a built-in definition within a builtin or custom initiative. For more information, see [reference definition and versions.](#policy-definition-properties)
146-
147-
148146
## Parameters
149147

150148
Parameters help simplify your policy management by reducing the number of policy definitions. Think

0 commit comments

Comments
 (0)