{"id":15192217,"url":"https://github.com/powershell/dscresource.template","last_synced_at":"2025-10-02T06:32:42.772Z","repository":{"id":65985516,"uuid":"173153842","full_name":"PowerShell/DscResource.Template","owner":"PowerShell","description":null,"archived":true,"fork":false,"pushed_at":"2019-05-12T05:32:29.000Z","size":146,"stargazers_count":10,"open_issues_count":17,"forks_count":15,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-01-21T12:35:56.967Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PowerShell.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-02-28T17:11:08.000Z","updated_at":"2023-07-13T23:14:10.000Z","dependencies_parsed_at":"2023-02-19T18:46:10.241Z","dependency_job_id":null,"html_url":"https://github.com/PowerShell/DscResource.Template","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/PowerShell/DscResource.Template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PowerShell%2FDscResource.Template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PowerShell%2FDscResource.Template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PowerShell%2FDscResource.Template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PowerShell%2FDscResource.Template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PowerShell","download_url":"https://codeload.github.com/PowerShell/DscResource.Template/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PowerShell%2FDscResource.Template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":277968828,"owners_count":25907418,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-02T02:00:08.890Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-27T21:20:13.508Z","updated_at":"2025-10-02T06:32:42.517Z","avatar_url":"https://github.com/PowerShell.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DscResource.Template\r\n\r\nThe **DscResource.Template** module contains a template with example code and\r\nbest practices for DSC resource modules in\r\n[DSC Resource Kit](https://github.com/PowerShell/DscResources).\r\n\r\n\u003e**NOTE!** This is not meant to be a fully functioning resource module.\r\n\u003eThe resource in this repository is just to make sure common code works,\r\n\u003eand used as a practical example.\r\n\r\nThis project has adopted [this code of conduct](CODE_OF_CONDUCT.md).\r\n\r\n## Branches\r\n\r\n### master\r\n\r\n[![Build status](https://ci.appveyor.com/api/projects/status/vqviwd2mmclxeopb/branch/master?svg=true)](https://ci.appveyor.com/project/PowerShell/DscResource-Template/branch/master)\r\n[![codecov](https://codecov.io/gh/PowerShell/DscResource.Template/branch/master/graph/badge.svg)](https://codecov.io/gh/PowerShell/DscResource.Template/branch/master)\r\n\r\nThis is the branch containing the latest release -\r\nno contributions should be made directly to this branch.\r\n\r\n### dev\r\n\r\n[![Build status](https://ci.appveyor.com/api/projects/status/vqviwd2mmclxeopb/branch/dev?svg=true)](https://ci.appveyor.com/project/PowerShell/DscResource-Template/branch/dev)\r\n[![codecov](https://codecov.io/gh/PowerShell/DscResource.Template/branch/dev/graph/badge.svg)](https://codecov.io/gh/PowerShell/DscResource.Template/branch/dev)\r\n\r\nThis is the development branch to which contributions should be proposed\r\nby contributors as pull requests.\r\nThis development branch will periodically be merged to the master branch,\r\nand be released to [PowerShell Gallery](https://www.powershellgallery.com/).\r\n\r\n## Contributing\r\n\r\nPlease see our [contributing guidelines](/CONTRIBUTING.md).\r\n\r\n## Installation\r\n\r\n### GitHub\r\n\r\nTo manually install the module,\r\ndownload the source code and unzip the contents to the directory\r\n'$env:ProgramFiles\\WindowsPowerShell\\Modules' folder.\r\n\r\n### PowerShell Gallery\r\n\r\nTo install from the PowerShell gallery using PowerShellGet (in PowerShell 5.0)\r\nrun the following command:\r\n\r\n```powershell\r\nFind-Module -Name DscResource.Template -Repository PSGallery | Install-Module\r\n```\r\n\r\nTo confirm installation, run the below command and ensure you see the\r\nDSC resources available:\r\n\r\n```powershell\r\nGet-DscResource -Module DscResource.Template\r\n```\r\n\r\n## Requirements\r\n\r\nThe minimum Windows Management Framework (PowerShell) version required is 4.0\r\nor higher.\r\n\r\n## Examples\r\n\r\nYou can review the [Examples](/Examples) directory for some general use\r\nscenarios for all of the resources that are in the module.\r\n\r\n## Change log\r\n\r\nA full list of changes in each version can be found in the [change log](CHANGELOG.md).\r\n\r\n## Resources\r\n\r\n* [**Folder**](#folder) example resource\r\n  to manage a folder on Windows.\r\n* {**Resource2** One line description of resource 1}\r\n\r\n### Folder\r\n\r\nExample resource to manage a folder on Windows.\r\n\r\n#### Requirements\r\n\r\n* Target machine must be running Windows Server 2008 R2 or later.\r\n\r\n#### Parameters\r\n\r\n* **`[String]` Path** _(Key)_: The path to the folder to create.\r\n* **`[Boolean]` ReadOnly** _(Required)_: If the files in the folder should be\r\n  read only.\r\n* **`[Boolean]` Hidden** _(Write)_: If the folder should be hidden.\r\n  Default value is `$false`.\r\n* **`[String]` Ensure** _(Write)_: Specifies the desired state of the folder.\r\n     When set to `'Present'`, the folder will be created. When set to `'Absent'`,\r\n    the folder will be removed. Default value is `'Present'`.\r\n\r\n#### Read-Only Properties from Get-TargetResource\r\n\r\n* **`[Boolean]` Shared** _(Write)_: If sharing is be enabled or disabled.\r\n* **`[String]` ShareName** _(Read)_: The name of the shared resource.\r\n\r\n#### Examples\r\n\r\n* [Create folder as SYSTEM](/Examples/Resources/Folder/1-DscResourceTemplate_CreateFolderAsSystemConfig.ps1)\r\n* [Create folder as user](/Examples/Resources/Folder/2-DscResourceTemplate_CreateFolderAsUserConfig.ps1)\r\n* [Remove folder](/Examples/Resources/Folder/3-DscResourceTemplate_RemoveFolderConfig.ps1)\r\n\r\n#### Known issues\r\n\r\nAll issues are not listed here, see [here for all open issues](https://github.com/PowerShell/DscResource.Template/issues?utf8=%E2%9C%93\u0026q=is%3Aissue+is%3Aopen+Folder).\r\n\r\n### {ResourceName}\r\n\r\n{ Detailed description of ResourceName. }\r\n\r\n#### Requirements\r\n\r\n{ Please include any requirements for running this resource (e.g. Must\r\nrun on Windows Server OS, must have Exchange already installed). }\r\n\r\n* Target machine must be running Windows Server 2008 R2 or later.\r\n\r\n#### Parameters\r\n\r\n* {**`[String]` Property1** _(Key)_: Description of ResourceName property 1}\r\n* {**`[Boolean]` Property2** _(Required)_: Description of ResourceName property 2}\r\n\r\n#### Read-Only Properties from Get-TargetResource\r\n\r\n* {**`[Boolean]` Property3** _(Write)_: Description of ResourceName property 2}\r\n\r\n#### Examples\r\n\r\n* { Add links to the examples for the resource ResourceName }\r\n\r\n#### Known issues\r\n\r\nAll issues are not listed here, see [here for all open issues](https://github.com/PowerShell/DscResource.Template/issues?utf8=%E2%9C%93\u0026q=is%3Aissue+is%3Aopen+ResourceName).\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpowershell%2Fdscresource.template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpowershell%2Fdscresource.template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpowershell%2Fdscresource.template/lists"}