diff --git a/CHANGELOG.md b/CHANGELOG.md index f11faa591..b2b084fbd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -48,6 +48,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - SqlWindowsFirewall - Now support to authenticate using both NetBIOS domain and Fully Qualified Domain Name (FQDN) ([issue #1223](https://github.com/dsccommunity/SqlServerDsc/issues/1223)). +- SqlDatabaseObjectPermission + - Since the task that publish Wiki content was updated to correctly handle + embedded instances the duplicate documentation was removed from the + resource README.md, and some was added to the schema MOF parameter + descriptions ([issue #1580](https://github.com/dsccommunity/SqlServerDsc/issues/1580)). ## [14.0.0] - 2020-06-12 diff --git a/source/DSCResources/DSC_SqlDatabaseObjectPermission/DSC_SqlDatabaseObjectPermission.schema.mof b/source/DSCResources/DSC_SqlDatabaseObjectPermission/DSC_SqlDatabaseObjectPermission.schema.mof index 435e59024..afeeb507e 100644 --- a/source/DSCResources/DSC_SqlDatabaseObjectPermission/DSC_SqlDatabaseObjectPermission.schema.mof +++ b/source/DSCResources/DSC_SqlDatabaseObjectPermission/DSC_SqlDatabaseObjectPermission.schema.mof @@ -14,7 +14,7 @@ class DSC_SqlDatabaseObjectPermission : OMI_BaseResource [ClassVersion("1.0.0")] class DSC_DatabaseObjectPermission { - [Key, Description("Specifies the state of the permission. Valid values are 'Grant', 'Deny' and 'GrantWithGrant'."), ValueMap{"Grant","Deny","GrantWithGrant"}, Values{"Grant","Deny","GrantWithGrant"}] String State; - [Required, Description("Specifies the set of permissions for the database object for the principal assigned to 'Name'.")] String Permission[]; + [Key, Description("Specifies the state of the permission."), ValueMap{"Grant","Deny","GrantWithGrant"}, Values{"Grant","Deny","GrantWithGrant"}] String State; + [Required, Description("Specifies the set of permissions for the database object for the principal assigned to 'Name'. Valid permission names can be found in the article [ObjectPermissionSet Class properties](https://docs.microsoft.com/en-us/dotnet/api/microsoft.sqlserver.management.smo.objectpermissionset#properties).")] String Permission[]; [Write, Description("Specifies the desired state of the permission. When set to 'Present', the permissions will be added. When set to 'Absent', the permissions will be removed. Default value is 'Present'."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure; }; diff --git a/source/DSCResources/DSC_SqlDatabaseObjectPermission/README.md b/source/DSCResources/DSC_SqlDatabaseObjectPermission/README.md index e4470664d..156e32747 100644 --- a/source/DSCResources/DSC_SqlDatabaseObjectPermission/README.md +++ b/source/DSCResources/DSC_SqlDatabaseObjectPermission/README.md @@ -17,17 +17,6 @@ property names of the [ObjectPermissionSet](https://docs.microsoft.com/en-us/dot * Target machine must have access to the SQLPS PowerShell module or the SqlServer PowerShell module. -## Embedded instance DSC_DatabaseObjectPermission - -* **`[String]` State** _(Key)_: Specifies the state of the permission. - Valid values are 'Grant', 'Deny' and 'GrantWithGrant'. -* **`[String[]]` Permission** _(Required)_: Specifies the set of permissions - for the database object for the principal assigned to 'Name'. Valid - permission names can be found in the article [ObjectPermissionSet Class properties](https://docs.microsoft.com/en-us/dotnet/api/microsoft.sqlserver.management.smo.objectpermissionset#properties). -* **`[String]` Ensure** _(Key)_: Specifies the desired state of the permission. - When set to 'Present', the permissions will be added. When set to 'Absent', - the permissions will be removed. Default value is 'Present'. - ## Known issues All issues are not listed here, see [here for all open issues](https://github.com/dsccommunity/SqlServerDsc/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+SqlDatabaseObjectPermission).