Add reference documentation for DSC.Packagemanagement/Brw

Author: Gijsreyn

docs/reference/resources/DSC/PackageManagement/Brew/examples/install-a-package-with-brew.md

@@ -0,0 +1,208 @@
+---
+description: DSC.PackageManagement/Brew resource reference documentation
+ms.date:     07/03/2025
+ms.topic:    reference
+title:       DSC.PackageManagement/Brew
+---
+
+# DSC.PackageManagement/Brew
+
+## Synopsis
+
+Manage packages using Homebrew on macOS systems.
+
+> [!IMPORTANT]
+> The `DSC.PackageManagement/Brew` resource is a proof-of-concept example
+> for use with DSC. Don't use it in production.
+
+## Metadata
+
+```yaml
+Version    : 0.1.0
+Kind       : resource
+Tags       : [macOS, brew, PackageManagement]
+Author     : Microsoft
+```
+
+## Instance definition syntax
+
+```yaml
+resources:
+  - name: <instance name>
+    type: DSC.PackageManagement/Brew
+    properties:
+      # Required properties
+      packageName: string
+      # Instance properties
+      _exist: boolean
+      version: string
+```
+
+## Description
+
+The `DSC.PackageManagement/Brew` resource enables you to idempotently manage packages using Homebrew on
+macOS systems. The resource can:
+
+- Install packages
+- Uninstall packages
+- Check if a package is installed
+- Verify the version of an installed package
+
+> [!NOTE]
+> This resource only works on macOS systems with Homebrew installed.
+
+## Requirements
+
+- A macOS system with Homebrew installed
+- Administrative privileges may be required for certain package operations
+
+## Capabilities
+
+The resource has the following capabilities:
+
+- `get` - You can use the resource to retrieve the actual state of an instance.
+- `set` - You can use the resource to enforce the desired state for an instance.
+- `export` - You can use the resource to export the current state of the system.
+
+This resource uses the synthetic test functionality of DSC to determine whether an instance is in
+the desired state. For more information about resource capabilities, see
+[DSC resource capabilities][00].
+
+## Examples
+
+1. [Install a package with Brew][04] - Shows how to install a package using
+    `DSC.PackageManagement/Brew` resource.
+2. [Remove a package][05] - Shows how to uninstall a package.
+
+## Properties
+
+The following list describes the properties for the resource.
+
+- **Required properties:** <a id="required-properties"></a> The following properties are always
+  required when defining an instance of the resource. An instance that doesn't define each of these
+  properties is invalid. For more information, see the "Required resource properties" section in
+  [DSC resource properties][01]
+
+  - [packageName](#packagename) - The name of the package to query or install.
+
+- **Key properties:** <a id="key-properties"></a> The following properties uniquely identify an
+  instance. If two instances of a resource have the same values for their key properties, the
+  instances are conflicting. For more information about key properties, see the "Key resource
+  properties" section in [DSC resource properties][02].
+
+  - [packageName](#packagename) (required) - The name of the package to query or install.
+
+- **Instance properties:** <a id="instance-properties"></a> The following properties are optional.
+  They define the desired state for an instance of the resource.
+
+  - [_exist](#_exist) - Defines whether the package should exist.
+  - [version](#version) - The version of the package to install.
+
+### packageName
+
+<details><summary>Expand for <code>packageName</code> property metadata</summary>
+
+```yaml
+Type             : string
+IsRequired       : true
+IsKey            : true
+IsReadOnly       : false
+IsWriteOnly      : false
+```
+
+</details>
+
+Defines the name of the package to query or install. This property is required and serves as the key for uniquely
+identifying the package in the Homebrew package repository.
+
+### _exist
+
+<details><summary>Expand for <code>_exist</code> property metadata</summary>
+
+```yaml
+Type             : boolean
+IsRequired       : false
+IsKey            : false
+IsReadOnly       : false
+IsWriteOnly      : false
+DefaultValue     : true
+```
+
+</details>
+
+The `_exist` canonical resource property determines whether a package should exist. When the
+value for `_exist` is `true`, the resource installs the package if it doesn't exist. When
+the value for `_exist` is `false`, the resource removes or uninstalls the package if it does exist.
+The default value for this property when not specified for an instance is `true`.
+
+### version
+
+<details><summary>Expand for <code>version</code> property metadata</summary>
+
+```yaml
+Type             : string
+IsRequired       : false
+IsKey            : false
+IsReadOnly       : false
+IsWriteOnly      : false
+```
+
+</details>
+
+Defines the version of the package to install. If not specified, the latest available version will be installed.
+
+## Instance validating schema
+
+The following snippet contains the JSON Schema that validates an instance of the resource. The
+validating schema only includes schema keywords that affect how the instance is validated. All
+non validating keywords are omitted.
+
+```json
+{
+  "type": "object",
+  "required": ["packageName"],
+  "additionalProperties": false,
+  "properties": {
+    "packageName": {
+      "type": "string"
+    },
+    "version": {
+      "type": "string"
+    },
+    "_exist": {
+      "type": "boolean"
+    }
+  }
+}
+```
+
+## Exit codes
+
+The resource returns the following exit codes from operations:
+
+- [0](#exit-code-0) - Success
+- [1](#exit-code-1) - Invalid parameter
+
+### Exit code 0
+
+Indicates the resource operation completed without errors.
+
+### Exit code 1
+
+Indicates the resource operation failed due to an invalid parameter. When the resource returns this
+exit code, it also emits an error message with details about the invalid parameter.
+
+## See also
+
+- [DSC.PackageManagement/Apt resource][03]
+- [For more information about Homebrew][07]
+
+<!-- Link definitions -->
+[00]: ../../../../../concepts/resources/capabilities.md
+[01]: ../../../../../concepts/resources/properties.md#required-resource-properties
+[02]: ../../../../../concepts/resources/properties.md#key-resource-properties
+[03]: ../APT/index.md
+[04]: ./examples/install-package-with-brew.md
+[05]: ./examples/install-specific-version.md
+[06]: ./examples/remove-package.md
+[07]: https://brew.sh/