Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OPS Build config changes and minor article edits #2051

Merged
merged 4 commits into from
Jan 12, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .openpublishing.redirection.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,21 @@
"redirect_url": "/powershell/wmf/readme",
"redirect_document_id": "False"
},
{
"source_path": "reference/docs-conceptual/core-powershell/console-guide.md",
"redirect_url": "/powershell/scripting/core-powershell/console/powershell.exe-command-line-help",
"redirect_document_id": "False"
},
{
"source_path": "reference/docs-conceptual/core-powershell/ise-guide.md",
"redirect_url": "/powershell/scripting/core-powershell/ise/introducing-the-windows-powershell-ise",
"redirect_document_id": "False"
},
{
"source_path": "reference/docs-conceptual/getting-started/understanding-concepts-reference.md",
"redirect_url": "/powershell/scripting/getting-started/fundamental/about-windows-powershell",
"redirect_document_id": "False"
},
{
"source_path": "reference/virtual-directory/index.md",
"redirect_url": "/powershell/scripting/powershell-scripting",
Expand Down
7 changes: 3 additions & 4 deletions dsc/DscForEngineers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
ms.date: 2017-10-13
author: eslesar;mgreenegit
ms.topic: conceptual
keywords: dsc,powershell,configuration,setup
title: Desired State Configuration Overview for Decision Makers
Expand Down Expand Up @@ -112,15 +111,15 @@ Configuration Sample_Share
# implement the logic of "how" to execute a task
xSmbShare MySMBShare
{
Ensure = "Present"
Ensure = "Present"
Name = "MyShare"
Path = "C:\Demo\Temp"
Path = "C:\Demo\Temp"
ReadAccess = "Alice"
FullAccess = "Bob"
Description = "This is an updated description for this share"
}
}
}
}
#Run the function to compile the configuration
Sample_Share
#Pass the configuration to the nodes we defined and configure them
Expand Down
22 changes: 13 additions & 9 deletions dsc/configDataCredentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,10 @@ To suppress these error and warning messages use the DSC configuration data keyw
* **PsDscAllowPlainTextPassword**
* **PsDscAllowDomainUser**

>**Notes:** <p>Storing/transmitting plaintext passwords unencrypted is generally not secure. Securing credentials by using the techniques covered later in this topic is recommended.</p> <p>The Azure Automation DSC service allows you to centrally manage credentials to be compiled in configurations and stored securely. For information, see: [Compiling DSC Configurations / Credential Assets](https://docs.microsoft.com/en-in/azure/automation/automation-dsc-compile#credential-assets)</p>
> [!NOTE]
> Storing/transmitting plaintext passwords unencrypted is generally not secure. Securing credentials by using the techniques covered later in this topic is recommended.
> The Azure Automation DSC service allows you to centrally manage credentials to be compiled in configurations and stored securely.
> For information, see: [Compiling DSC Configurations / Credential Assets](/azure/automation/automation-dsc-compile#credential-assets)

The following is an example of passing plain text credentials:

Expand Down Expand Up @@ -133,7 +136,8 @@ see [Running DSC with user credentials](runAsUser.md).
Newer resources and custom resources can use this automatic property
instead of creating their own property for credentials.

>**Note:** the design of some resources are to use multiple credentials for a specific reason, and they will have their own credential properties.
> [!NOTE]
> The design of some resources are to use multiple credentials for a specific reason, and they will have their own credential properties.

To find the available credential properties on a resource
use either `Get-DscResource -Name ResourceName -Syntax`
Expand Down Expand Up @@ -228,8 +232,8 @@ for node 'localhost'.
```

This example has two issues:
1. An error explains that plain text passwords are not recommended
2. A warning advises against using a domain credential
1. An error explains that plain text passwords are not recommended
2. A warning advises against using a domain credential

## PsDscAllowPlainTextPassword

Expand Down Expand Up @@ -276,10 +280,11 @@ $cred = Get-Credential -UserName contoso\genericuser -Message "Password please"
DomainCredentialExample -DomainCredential $cred -ConfigurationData $cd
```

>**Note:** `NodeName` cannot equal asterisk, a specific node name is mandatory.
> [!NOTE]
> `NodeName` cannot equal asterisk, a specific node name is mandatory.

**Microsoft advises to avoid plain text passwords due to the significant security risk.**

**Microsoft advises to avoid plain text passwords
due to the significant security risk.**
An exception would be when using the Azure Automation DSC service,
only because the data is always stored encrypted
(in transit, at rest in the service, and at rest on the node).
Expand All @@ -291,8 +296,7 @@ still generates the warning that using a domain account for a credential is not
Using a local account eliminates potential exposure of domain credentials
that could be used on other servers.

**When using credentials with DSC resources,
prefer a local account over a domain account when possible.**
**When using credentials with DSC resources, prefer a local account over a domain account when possible.**

If there is a '\' or '@' in the `Username` property of the credential,
then DSC will treat it as a domain account.
Expand Down
1 change: 0 additions & 1 deletion dsc/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
"breadcrumb_path":"bread/toc.json",
"uhfHeaderId": "MSDocsHeader-Powershell",
"layout": "conceptual",
"ms.locale": "en-us",
"ROBOTS": "INDEX, FOLLOW",
"ms.prod": "powershell",
"ms.technology": "dsc",
Expand Down
3 changes: 1 addition & 2 deletions dsc/enactingConfigurations.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
ms.date: 2017-10-16
author: eslesar;mgreenegit
ms.topic: conceptual
keywords: dsc,powershell,configuration,setup
title: Enacting configurations
Expand All @@ -27,7 +26,7 @@ For example, if the configuration MOF is located at `C:\DSC\Configurations\local
you would apply it to the local machine with the following command:
`Start-DscConfiguration -Path 'C:\DSC\Configurations'`

> __Note__: By default, DSC runs a configuration as a background job. To run the configuration interactively, call the
> __Note__: By default, DSC runs a configuration as a background job. To run the configuration interactively, call the
>[Start-DscConfiguration](https://technet.microsoft.com/library/dn521623.aspx) with the __-Wait__ parameter.

## Pull mode
Expand Down
11 changes: 5 additions & 6 deletions dsc/metaConfig.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
ms.date: 2017-10-11
author: eslesar;mgreenegit
ms.topic: conceptual
keywords: dsc,powershell,configuration,setup
title: Configuring the Local Configuration Manager
Expand Down Expand Up @@ -46,7 +45,7 @@ configuration LCMConfig
RefreshMode = 'Push'
}
}
}
}
```

The process of applying settings to LCM is similar to applying a DSC configuration.
Expand Down Expand Up @@ -144,7 +143,7 @@ you create a **ConfigurationRepositoryWeb** block.
A **ConfigurationRepositoryWeb** defines the following properties.

|Property|Type|Description|
|---|---|---|
|---|---|---|
|AllowUnsecureConnection|bool|Set to **$TRUE** to allow connections from the node to the server without authentication. Set to **$FALSE** to require authentication.|
|CertificateID|string|The thumbprint of a certificate used to authenticate to the server.|
|ConfigurationNames|String[]|An array of names of configurations to be pulled by the target node. These are used only if the node is registered with the pull service by using a **RegistrationKey**. For more information, see [Setting up a pull client with configuration names](pullClientConfigNames.md).|
Expand Down Expand Up @@ -211,7 +210,7 @@ see [DSC Partial configurations](partialConfigs.md).
**PartialConfiguration** defines the following properties.

|Property|Type|Description|
|---|---|---|
|---|---|---|
|ConfigurationSource|string[]|An array of names of configuration servers, previously defined in **ConfigurationRepositoryWeb** and **ConfigurationRepositoryShare** blocks, where the partial configuration is pulled from.|
|DependsOn|string{}|A list of names of other configurations that must be completed before this partial configuration is applied.|
|Description|string|Text used to describe the partial configuration.|
Expand All @@ -221,11 +220,11 @@ see [DSC Partial configurations](partialConfigs.md).

__Note:__ partial configurations are supported with Azure Automation DSC, but only one configuration can be pulled from each automation account per node.

## See Also
## See Also

### Concepts
[Desired State Configuration Overview](overview.md)

[Getting started with Azure Automation DSC](https://docs.microsoft.com/en-us/azure/automation/automation-dsc-getting-started)

### Other Resources
Expand Down
1 change: 0 additions & 1 deletion dsc/metaConfig4.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
ms.date: 2017-10-12
author: eslesar;mgreenegit
ms.topic: conceptual
keywords: dsc,powershell,configuration,setup
title: Windows PowerShell 4.0 Desired State Configuration Local Configuration Manager (LCM)
Expand Down
3 changes: 0 additions & 3 deletions gallery/index.md

This file was deleted.

3 changes: 0 additions & 3 deletions jea/index.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -185,8 +185,6 @@ http://go.microsoft.com/fwlink/?LinkId=142329

[Set-WSManQuickConfig](../../Microsoft.WSMan.Management/Set-WSManQuickConfig.md)

[Set-WSManSessionOption](../../Microsoft.WSMan.Management/Set-WSManSessionOption.md)

[Test-WSMan](../../Microsoft.WSMan.Management/Test-WSMan.md)

# KEYWORDS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -185,8 +185,6 @@ http://go.microsoft.com/fwlink/?LinkId=142329

[Set-WSManQuickConfig](../../Microsoft.WSMan.Management/Set-WSManQuickConfig.md)

[Set-WSManSessionOption](../../Microsoft.WSMan.Management/Set-WSManSessionOption.md)

[Test-WSMan](../../Microsoft.WSMan.Management/Test-WSMan.md)

# KEYWORDS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,6 @@ For detailed information about DSC, see
[PowerShell Desired State Configuration Overview](http://go.microsoft.com/fwlink/?LinkId=311940)
in the TechNet Library.

## DEVELOPING DSC RESOURCES WITH CLASSES

Starting in PowerShell 5.0, you can develop DSC resources by using classes.
For more information, see [about_Classes](about_Classes.md), and
[Writing a custom DSC resource with PowerShell classes](http://technet.microsoft.com/library/dn948461.aspx)
on Microsoft TechNet.

## USING DSC

To use DSC to configure your environment, first define a PowerShell
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -185,8 +185,6 @@ http://go.microsoft.com/fwlink/?LinkId=142329

[Set-WSManQuickConfig](../../Microsoft.WSMan.Management/Set-WSManQuickConfig.md)

[Set-WSManSessionOption](../../Microsoft.WSMan.Management/Set-WSManSessionOption.md)

[Test-WSMan](../../Microsoft.WSMan.Management/Test-WSMan.md)

# KEYWORDS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -185,8 +185,6 @@ http://go.microsoft.com/fwlink/?LinkId=142329

[Set-WSManQuickConfig](../../Microsoft.WSMan.Management/Set-WSManQuickConfig.md)

[Set-WSManSessionOption](../../Microsoft.WSMan.Management/Set-WSManSessionOption.md)

[Test-WSMan](../../Microsoft.WSMan.Management/Test-WSMan.md)

# KEYWORDS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -251,4 +251,3 @@ NoLanguage session, PowerShell returns the ScriptsNotAllowed error message.

- [about_Session_Configuration_Files](about_Session_Configuration_Files.md)
- [about_Session_Configurations](about_Session_Configurations.md)
- [about_Windows_RT](about_Windows_RT.md)
Loading