Skip to content

Commit

Permalink
SqlAudit: Fix documentation (#1782)
Browse files Browse the repository at this point in the history
  • Loading branch information
johlju authored Aug 20, 2022
1 parent 87816b8 commit f61dd00
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Renamed the hidden property that derived classes can specify which properties
to not enforce when comparing desired state against current state. New name
of the hidden property is `ExcludeDscProperties`.
- SqlAudit
- Fix documentation that contain minor style errors.

### Fixed

Expand Down
17 changes: 9 additions & 8 deletions source/Classes/020.SqlAudit.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -25,22 +25,23 @@
### Property **Reasons** does not work with **PSDscRunAsCredential**
When using the built-in parameter `**PSDscRunAsCredential** the read-only
property `Reasons` will return empty values for Code and Phrase. The
built-in property **PSDscRunAsCredential** does not work with class-based
resources that using advanced type like the parameter `Reasons` have.
When using the built-in parameter **PSDscRunAsCredential** the read-only
property **Reasons** will return empty values for the properties **Code**
and **Phrase. The built-in property **PSDscRunAsCredential** does not work
together with class-based resources that using advanced type like the parameter
**Reasons** have.
### Using **Credential** property.
### Using **Credential** property
SQL Authentication and Group Managed Service Accounts is not supported as
impersonation credentials. Currently only Windows Integrated Security is
supported to use as credentials.
For Windows Authentication the username must either be provided with the User
Principal Name (UPN), e.g. 'username@domain.local' or if using non-domain
Principal Name (UPN), e.g. `username@domain.local` or if using non-domain
(for example a local Windows Server account) account the username must be
provided without the NetBIOS name, e.g. 'username'. The format 'DOMAIN\username'
will not work.
provided without the NetBIOS name, e.g. `username`. Using the NetBIOS name, e.g
using the format `DOMAIN\username` will not work.
See more information in [Credential Overview](https://github.com/dsccommunity/SqlServerDsc/wiki/CredentialOverview).
Expand Down

0 comments on commit f61dd00

Please sign in to comment.