Skip to content

Commit d212d8b

Browse files
author
Travis Fields
committed
(docs) MODULES-2325 update readme to reflect permissions
- Define types ::login::permissions and :;role::permissions as well as ::user:;permissions were in the singular form in the README and needed to be updated to reflect correct name
1 parent cc63029 commit d212d8b

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
* [Create a new database](#create-a-new-database-on-an-instance-of-sql-server)
1313
* [Set up a new login](#set-up-a-new-login)
1414
* [Create a new login and a user](#create-a-new-login-and-a-user-for-a-given-database)
15-
* [Manage the user's permission](#manage-the-above-users-permission)
15+
* [Manage the user's permissions](#manage-the-above-users-permissions)
1616
* [Run custom TSQL statements](#run-custom-tsql-statements)
1717
5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
1818
6. [Limitations - OS compatibility, etc.](#limitations)
@@ -110,20 +110,20 @@ sqlserver::user{'rp_logging-loggingUser':
110110
}
111111
~~~
112112

113-
###Manage the above user's permission
113+
###Manage the above user's permissions
114114

115115
~~~puppet
116-
sqlserver::user::permission{'INSERT-loggingUser-On-rp_logging':
116+
sqlserver::user::permissions{'INSERT-loggingUser-On-rp_logging':
117117
user => 'loggingUser',
118118
database => 'rp_logging',
119-
permission => 'INSERT',
119+
permissions => 'INSERT',
120120
require => Sqlserver::User['rp_logging-loggingUser'],
121121
}
122122
123-
sqlserver::user::permission{'Deny the Update as we should only insert':
123+
sqlserver::user::permissions{'Deny the Update as we should only insert':
124124
user => 'loggingUser',
125125
database => 'rp_logging',
126-
permission => 'UPDATE',
126+
permissions => 'UPDATE',
127127
state => 'DENY',
128128
require => Sqlserver::User['rp_logging-loggingUser'],
129129
}
@@ -363,15 +363,15 @@ Requires the `sqlserver::config` define.
363363
* [Create Login](http://technet.microsoft.com/en-us/library/ms189751.aspx)
364364
* [Alter Login](http://technet.microsoft.com/en-us/library/ms189828.aspx)
365365

366-
#### `sqlserver::login::permission`
366+
#### `sqlserver::login::permissions`
367367

368368
Configures the permissions associated with a given login account.
369369

370370
* `instance`: *Optional.* Specifies a SQL Server instance on which to manage the permissions. Valid options: a string containing the name of an existing instance. Default: 'MSSQLSERVER'.
371371

372372
* `login`: *Required.* Specifies a SQL or Windows login to manage. Valid options: a string containing an existing login.
373373

374-
* `permission`: *Required.* Specifies one or more permissions to manage. Valid options: a string or an array of strings, where each string contains a [SQL Server permission](https://technet.microsoft.com/en-us/library/ms191291%28v=sql.105%29.aspx) (e.g., 'SELECT', 'INSERT', 'UPDATE', or 'DELETE').
374+
* `permissions`: *Required.* Specifies one or more permissions to manage. Valid options: a string or an array of strings, where each string contains a [SQL Server permissions](https://technet.microsoft.com/en-us/library/ms191291%28v=sql.105%29.aspx) (e.g., 'SELECT', 'INSERT', 'UPDATE', or 'DELETE').
375375

376376
* `state`: *Optional.* Determines the state of the specified permissions. Valid options: 'GRANT', 'DENY', and 'REVOKE'. If set to 'REVOKE', Puppet removes any explicit statements of these permissions and falls back on inherited levels. Default: 'GRANT'.
377377

@@ -397,7 +397,7 @@ Requires the `sqlserver::config` define for access to the parent instance.
397397

398398
* `user`: *Required.* Specifies a user to manage. Valid options: a string containing a username. Default: the title of your declared resource.
399399

400-
#### `sqlserver::user::permission`
400+
#### `sqlserver::user::permissions`
401401

402402
Configures the permissions associated with a user account within a given database.
403403

@@ -517,4 +517,4 @@ This module was built by Puppet Labs specifically for use with Puppet Enterprise
517517

518518
If you run into an issue with this module, or if you would like to request a feature, please [file a ticket](https://tickets.puppetlabs.com/browse/MODULES/).
519519

520-
If you are having problems getting this module up and running, please [contact Support](http://puppetlabs.com/services/customer-support).
520+
If you are having problems getting this module up and running, please [contact Support](http://puppetlabs.com/services/customer-support).

0 commit comments

Comments
 (0)