Skip to content

Commit 51175ed

Browse files
committed
Refine documentation for SqlAgentAlert to improve clarity on alert types and credential usage
1 parent f898566 commit 51175ed

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

source/Classes/020.SqlAgentAlert.ps1

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,14 @@
77
The `SqlAgentAlert` DSC resource is used to create, modify, or remove
88
_SQL Server Agent_ alerts.
99
10-
An alert can be switch between using system message and severity-based alerts by passing
11-
the required parameter. It will switch the alert type accordingly.
10+
An alert can be switched between a system-message–based alert and a severity-based
11+
alert by specifying the corresponding parameter. The alert type will be switched
12+
accordingly.
1213
1314
The built-in parameter **PSDscRunAsCredential** can be used to run the resource
1415
as another user. The resource will then authenticate to the _SQL Server_
15-
instance as that user. It also possible to instead use impersonation by the
16-
parameter **Credential**.
16+
instance as that user. It is also possible to use impersonation via the
17+
**Credential** parameter.
1718
1819
## Requirements
1920
@@ -31,20 +32,20 @@
3132
When using the built-in parameter **PSDscRunAsCredential** the read-only
3233
property **Reasons** will return empty values for the properties **Code**
3334
and **Phrase**. The built-in property **PSDscRunAsCredential** does not work
34-
together with class-based resources that using advanced type like the parameter
35-
**Reasons** have.
35+
together with class-based resources that use advanced types, such as the
36+
**Reasons** parameter.
3637
3738
### Using **Credential** property
3839
39-
SQL Authentication and Group Managed Service Accounts is not supported as
40-
impersonation credentials. Currently only Windows Integrated Security is
41-
supported to use as credentials.
40+
SQL Authentication and Group Managed Service Accounts are not supported as
41+
impersonation credentials. Currently, only Windows Integrated Security is
42+
supported.
4243
4344
For Windows Authentication the username must either be provided with the User
44-
Principal Name (UPN), e.g. `[email protected]` or if using non-domain
45-
(for example a local Windows Server account) account the username must be
46-
provided without the NetBIOS name, e.g. `username`. Using the NetBIOS name, e.g
47-
using the format `DOMAIN\username` will not work.
45+
Principal Name (UPN), e.g., `[email protected]`, or, if using a nondomain
46+
account (for example, a local Windows Server account), the username must be
47+
provided without the NetBIOS name, e.g., `username`. Using the NetBIOS name,
48+
for example `DOMAIN\username`, will not work.
4849
4950
See more information in [Credential Overview](https://github.com/dsccommunity/SqlServerDsc/wiki/CredentialOverview).
5051

0 commit comments

Comments
 (0)