-
Notifications
You must be signed in to change notification settings - Fork 7
Add AppControl/Policy doc #24
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
hongshu-w
wants to merge
3
commits into
main
Choose a base branch
from
user/hongshuw/add-appcontrol-doc
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,157 @@ | ||
| # Microsoft.Windows/AppControl/Policy | ||
|
|
||
| Specifies an [App Control for Business](https://learn.microsoft.com/windows/security/application-security/application-control/app-control-for-business/appcontrol) policy on the device. This resource allows you to deploy, query, and remove application control policies. | ||
|
|
||
| Requires Windows **build 22621** or later. | ||
|
|
||
| ## Properties | ||
|
|
||
| ### `id` | ||
|
|
||
| The GUID that identifies the policy. | ||
|
|
||
| - `BF61FE40-8929-4FDF-9EC2-F7A767717F0B` | ||
|
|
||
| ### `content` | ||
|
|
||
| The policy content to deploy. Can be either: | ||
|
|
||
| - A **base64-encoded** compiled binary policy (`.cip` file content) | ||
| - A **raw XML** policy string | ||
|
|
||
| Not returned by `get` or `list`. | ||
|
|
||
| ### `baseId` | ||
|
|
||
| The base policy ID. For a base policy this equals `id`; for a supplemental policy it points to the parent. | ||
|
|
||
| ### `friendlyName` | ||
|
|
||
| The display name of the policy as set in the policy metadata. | ||
|
|
||
| ### `version` | ||
|
|
||
| The version of the policy. | ||
|
|
||
| ### `isBasePolicy` | ||
|
|
||
| Whether this is a base policy (as opposed to a supplemental policy). Derived from `id == baseId`. | ||
|
|
||
| ### `isDeployed` | ||
|
|
||
| Whether the policy file is currently present on disk. | ||
|
|
||
| ### `isEffective` | ||
|
|
||
| Whether the policy is currently active and loaded by the kernel. | ||
|
|
||
| ### `isEnforced` | ||
|
|
||
| Whether the policy is in enforcement mode (i.e. it does **not** have the `Enabled:Audit Mode` option). | ||
|
|
||
| ### `isAuthorized` | ||
|
|
||
| Whether the policy is authorized. If the policy requires a token, this reflects the token authorization state; otherwise it matches `isEffective`. | ||
|
|
||
| ### `isSigned` | ||
|
|
||
| Whether the policy has a valid signature. | ||
|
|
||
| ### `isSystemPolicy` | ||
|
|
||
| Whether this is a Microsoft-provided system policy (e.g. the vulnerable driver blocklist). | ||
|
|
||
| ### `options` | ||
|
|
||
| An array of policy option strings (e.g. `["Enabled:Audit Mode", "Enabled:UMCI"]`). | ||
|
|
||
| ### `status` | ||
|
|
||
| The policy status code (integer). `0` indicates OK. | ||
|
|
||
| ## Operations | ||
|
|
||
| ### `get` | ||
|
|
||
| Queries the system for a policy matching `id`. Returns the full policy metadata if found, or `null` if the policy is not present. | ||
|
|
||
| - `id` *(required)* | ||
|
|
||
| ### `set` | ||
|
|
||
| Deploys a policy to the system. | ||
|
|
||
| - `id` *(required)* | ||
| - `content` *(required)* | ||
|
|
||
| ### `remove` | ||
|
|
||
| Removes a policy from the system by its `id`. Idempotent — if the policy is already absent, this is a no-op. | ||
|
|
||
| - `id` *(required)* | ||
|
|
||
| ### `list` | ||
|
|
||
| Returns all App Control policies on the system with their full metadata. | ||
|
|
||
| *(No input properties required.)* | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Deploy a compiled binary policy (base64) | ||
|
|
||
| ```yaml | ||
| type: Microsoft.Windows/AppControl/Policy | ||
| properties: | ||
| id: "BF61FE40-8929-4FDF-9EC2-F7A767717F0B" | ||
| content: "AQAAAA..." | ||
| ``` | ||
|
|
||
| ### Deploy a policy from XML | ||
|
|
||
| ```yaml | ||
| type: Microsoft.Windows/AppControl/Policy | ||
| properties: | ||
| id: "BF61FE40-8929-4FDF-9EC2-F7A767717F0B" | ||
| content: | | ||
| <SiPolicy xmlns="urn:schemas-microsoft-com:sipolicy"> | ||
| <PolicyID>{BF61FE40-8929-4FDF-9EC2-F7A767717F0B}</PolicyID> | ||
| <!-- ... policy rules ... --> | ||
| </SiPolicy> | ||
| ``` | ||
|
|
||
| ### Query a specific policy | ||
|
|
||
| ```yaml | ||
| type: Microsoft.Windows/AppControl/Policy | ||
| properties: | ||
| id: "BF61FE40-8929-4FDF-9EC2-F7A767717F0B" | ||
| ``` | ||
|
|
||
| Returns (example): | ||
|
|
||
| ```json | ||
| { | ||
| "id": "{BF61FE40-8929-4FDF-9EC2-F7A767717F0B}", | ||
| "baseId": "{BF61FE40-8929-4FDF-9EC2-F7A767717F0B}", | ||
| "friendlyName": "AllowMicrosoft_WS2025_Audit", | ||
| "version": "10.0.0.0", | ||
| "isBasePolicy": true, | ||
| "isDeployed": true, | ||
| "isEffective": true, | ||
| "isEnforced": false, | ||
| "isAuthorized": true, | ||
| "isSigned": false, | ||
| "isSystemPolicy": false, | ||
| "options": ["Enabled:Audit Mode", "Enabled:UMCI", "Enabled:Managed Installer"], | ||
| "status": 0 | ||
| } | ||
| ``` | ||
|
|
||
| ### Remove a policy | ||
|
|
||
| ```yaml | ||
| type: Microsoft.Windows/AppControl/Policy | ||
| properties: | ||
| id: "{BF61FE40-8929-4FDF-9EC2-F7A767717F0B}" | ||
| ``` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a support link that we can just reuse from the AppControl docs?