Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Complete YAML documentation #193

Merged
merged 1 commit into from
Dec 25, 2022
Merged

Complete YAML documentation #193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- `AddsTrusts` Composite for establishing Forest trusts with more configuration options than using AddsDomain-property DomainTrusts.
- `FilesAndFolder` Add property to embed binary files into MOF.
- `SmbShares` Add check and remove of duplicates from access properties in MOF.
- Update documentation
- Complete YAML documentation
- `FileContents` Composite for managing file content.
- `RemoteDesktopDeployment` Composite to configure a remote desktop deployment
- `RemoteDesktopCollections` Composite to configure RD session collections, including their settings
Expand Down
105 changes: 105 additions & 0 deletions doc/ConfigurationManagerDistributionGroups.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
// CommonTasks YAML Reference: ConfigurationManagerDistributionGroups
// ==================================================================

:YmlCategory: ConfigurationManagerDistributionGroups

:abstract: {YmlCategory} is used to ###TBD###

[#dscyml_configurationmanagerdistributiongroups]
= DSC Resource '{YmlCategory}'

[[dscyml_configurationmanagerdistributiongroups_abstract, {abstract}]]
{abstract}


[cols="1,3a" options="autowidth" caption=]
|===
| Source | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/ConfigurationManagerDistributionGroups
| DSC Resource | https://github.com/dsccommunity/ConfigMgrCBDsc[ConfigMgrCBDsc]
| Documentation | https://github.com/dsccommunity/ConfigMgrCBDsc#resources[CMDistributionGroup]
|===


.Attributes of category '{YmlCategory}'
[cols="1,1,1,2a,1a" options="header"]
|===
| Parameter
| Attribute
| DataType
| Description
| Allowed Values

| SiteCode
| Mandatory
| String
|
|

| [[dscyml_configurationmanagerdistributiongroups_distributiongroups, {YmlCategory}/DistributionGroups]]<<dscyml_configurationmanagerdistributiongroups_distributiongroups_details, DistributionGroups>>
|
| Hashtable[]
| set of distribution groups
|

|===


[[dscyml_configurationmanagerdistributiongroups_distributiongroups_details]]
.Attributes of category '<<dscyml_configurationmanagerdistributiongroups_distributiongroups>>'
[cols="1,1,1,2a,1a" options="header"]
|===
| Parameter
| Attribute
| DataType
| Description
| Allowed Values

|
|
|
|
|

|===


.Example
[source, yaml]
----
ConfigurationManagerDistributionGroups:
SiteCode: AL1
DistributionGroups:
- DistributionGroup: DG1
#Collections: # 1:1 match, supported in future release of ConfigMgrCBDsc
# - Collection 1
# - Collection 2
DistributionPointsToExclude:
- DP2
DistributionPointsToInclude:
- DP1
SecurityScopesToExclude:
- Scope1
SecurityScopesToInclude:
- Scope2
- DistributionGroup: DG2
#CollectionsToExclude: # supported in future release of ConfigMgrCBDsc
# - Collection 1
#CollectionsToInclude: # supported in future release of ConfigMgrCBDsc
# - Collection 2
DistributionPoints: # 1:1 match
- DP1
- DP2
SecurityScopes: # 1:1 match
- Scope1
- Scope2
- DistributionGroup: DG3
SiteCode: AL2 # Override SiteCode for individual groups
DistributionPointsToExclude:
- DP2
DistributionPointsToInclude:
- DP1
SecurityScopesToExclude:
- Scope1
SecurityScopesToInclude:
- Scope2
----
19 changes: 9 additions & 10 deletions doc/DscPullServerSql.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,18 @@
:ref_xDscWebService: https://github.com/dsccommunity/xPSDesiredStateConfiguration#xdscwebservice[xDscWebService]



[cols="1,3a" options="autowidth" caption=]
|===
| Source | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/DscPullServerSql
| DSC Resource | https://github.com/dsccommunity/xPSDesiredStateConfiguration[xPSDesiredStateConfiguration],
https://docs.microsoft.com/en-us/powershell/module/psdesiredstateconfiguration/[PSDesiredStateConfiguration],
https://github.com/dsccommunity/xWebAdministration[xWebAdministration],
https://docs.microsoft.com/de-de/powershell/scripting/dsc/reference/resources/windows/fileresource[File],
https://github.com/dsccommunity/NetworkingDsc[NetworkingDsc]
| Documentation | {ref_xDscWebService},
https://github.com/dsccommunity/xWebAdministration#xwebconfigkeyvalue-deprecated[xWebConfigKeyValue],
https://github.com/dsccommunity/xWebAdministration#xwebapppool[xWebAppPool],
https://github.com/dsccommunity/NetworkingDsc/wiki/Firewall[Firewall]
| DSC Resource | - https://github.com/dsccommunity/xPSDesiredStateConfiguration[xPSDesiredStateConfiguration]
- https://docs.microsoft.com/en-us/powershell/module/psdesiredstateconfiguration/[PSDesiredStateConfiguration]
- https://github.com/dsccommunity/xWebAdministration[xWebAdministration]
- https://docs.microsoft.com/de-de/powershell/scripting/dsc/reference/resources/windows/fileresource[File]
- https://github.com/dsccommunity/NetworkingDsc[NetworkingDsc]
| Documentation | - {ref_xDscWebService}
- https://github.com/dsccommunity/xWebAdministration#xwebconfigkeyvalue-deprecated[xWebConfigKeyValue]
- https://github.com/dsccommunity/xWebAdministration#xwebapppool[xWebAppPool]
- https://github.com/dsccommunity/NetworkingDsc/wiki/Firewall[Firewall]
|===


Expand Down