Skip to content

Commit f0892db

Browse files
Merge pull request #819 from Gijsreyn/clarification-winrm-requirement
Clarify WinRM requirement for WindowsPowerShell adapter
2 parents 8fd7ef4 + f724b53 commit f0892db

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/get-started/index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ Retrieving the current state of a resource is useful, but in practice you more o
235235
whether an instance is in the desired state. The `dsc resource test` command not only tells you
236236
whether an instance is out of state, but how it's out state.
237237

238-
> {!NOTE}
238+
> [!NOTE]
239239
> Remember that the `Registry` resource doesn't have the `test` capability. Fortunately, that
240240
> doesn't mean that you can't use the **Test** operation for a resource. When a resource doesn't
241241
> have the `test` capability, it is indicating that the resource depends on DSC's synthetic test
@@ -334,6 +334,9 @@ resource instances. In this configuration, it defines two instances:
334334
- The second instance uses the `PSModule` PSDSC resource from the same module to make sure that the
335335
**Microsoft.WinGet.Client** module is installed.
336336

337+
> [!NOTE]
338+
> When invoking resources from `WindowsPowerShell` adapter, Windows Remote Management (WinRM) needs to be configured properly on the system. For more information about configuring WinRM, see [Setting Up a WinRM Endpoint](/windows/win32/winrm/installation-and-configuration-for-windows-remote-management#to-configure-winrm-with-default-settings).
339+
337340
Open a terminal with elevated permissions. PSDSC resources in Windows PowerShell need to run as
338341
administrator. In the elevated terminal, change directory to the folder where you saved the
339342
configuration document as `example.dsc.config.yaml`. Then run the following command.

0 commit comments

Comments
 (0)