Skip to content

remove loc metadata in links #2146

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

Merged
merged 1 commit into from
Feb 23, 2018
Merged
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
2 changes: 1 addition & 1 deletion dsc/authoringResourceClass.md
Original file line number Diff line number Diff line change
@@ -65,7 +65,7 @@ Notice that the properties are modified by attributes. The meaning of the attrib
- **DscProperty(NotConfigurable)**: The property is read-only. Properties marked with this attribute cannot be set by a configuration, but are populated by the **Get()** method when present.
- **DscProperty()**: The property is configurable, but it is not required.

The **$Path** and **$SourcePath** properties are both strings. The **$CreationTime** is a [DateTime](https://technet.microsoft.com/en-us/library/system.datetime.aspx) property. The **$Ensure** property is an enumeration type, defined as follows.
The **$Path** and **$SourcePath** properties are both strings. The **$CreationTime** is a [DateTime](https://technet.microsoft.com/library/system.datetime.aspx) property. The **$Ensure** property is an enumeration type, defined as follows.

```powershell
enum Ensure
4 changes: 2 additions & 2 deletions dsc/authoringResourceMofCS.md
Original file line number Diff line number Diff line change
@@ -9,7 +9,7 @@ title: Authoring a DSC resource in C#

> Applies To: Windows PowerShell 4.0, Windows PowerShell 5.0

Typically, a Windows PowerShell Desired State Configuration (DSC) custom resource is implemented in a PowerShell script. However, you can also implement the functionality of a DSC custom resource by writing cmdlets in C#. For an introduction on writing cmdlets in C#, see [Writing a Windows PowerShell Cmdlet](https://technet.microsoft.com/en-us/library/dd878294.aspx).
Typically, a Windows PowerShell Desired State Configuration (DSC) custom resource is implemented in a PowerShell script. However, you can also implement the functionality of a DSC custom resource by writing cmdlets in C#. For an introduction on writing cmdlets in C#, see [Writing a Windows PowerShell Cmdlet](https://technet.microsoft.com/library/dd878294.aspx).

Aside from implementing the resource in C# as cmdlets, the process of creating the MOF schema, creating the folder structure, importing and using your custom DSC resource are the same as described in [Writing a custom DSC resource with MOF](authoringResourceMOF.md).

@@ -277,5 +277,5 @@ $env: psmodulepath (folder)
#### Concepts
[Writing a custom DSC resource with MOF](authoringResourceMOF.md)
#### Other Resources
[Writing a Windows PowerShell Cmdlet](https://msdn.microsoft.com/en-us/library/dd878294.aspx)
[Writing a Windows PowerShell Cmdlet](https://msdn.microsoft.com/library/dd878294.aspx)

2 changes: 1 addition & 1 deletion dsc/authoringResourceMofDesigner.md
Original file line number Diff line number Diff line change
@@ -11,7 +11,7 @@ title: Using the Resource Designer tool

The Resource Designer tool is a set of cmdlets exposed by the **xDscResourceDesigner** module that make creating Windows PowerShell Desired State Configuration (DSC) resources easier. The cmdlets in this resource help create the MOF schema, the script module, and the directory structure for your new resource. For more information about DSC resources, see [Build Custom Windows PowerShell Desired State Configuration Resources](authoringResource.md).
In this topic, we will create a DSC resource that manages Active Directory users.
Use the [Install-Module](https://technet.microsoft.com/en-us/library/dn807162.aspx) cmdlet to install the **xDscResourceDesigner** module.
Use the [Install-Module](https://technet.microsoft.com/library/dn807162.aspx) cmdlet to install the **xDscResourceDesigner** module.

>**Note**: **Install-Module** is included in the **PowerShellGet** module, which is included in PowerShell 5.0. You can download the **PowerShellGet** module for PowerShell 3.0 and 4.0 at [PackageManagement PowerShell Modules Preview](https://www.microsoft.com/en-us/download/details.aspx?id=49186).

4 changes: 2 additions & 2 deletions dsc/bootstrapDsc.md
Original file line number Diff line number Diff line change
@@ -18,8 +18,8 @@ For information on how to configure new virtual machines at initial boot-up in P
To run these examples, you will need:

- A bootable VHD to work with. You can download an ISO with an evaluation copy of Windows Server 2016 at
[TechNet Evaluation Center](https://www.microsoft.com/en-us/evalcenter/evaluate-windows-server-2016). You can find instructions on how to create a VHD
from an ISO image at [Creating Bootable Virtual Hard Disks](https://technet.microsoft.com/en-us/library/gg318049.aspx).
[TechNet Evaluation Center](https://www.microsoft.com/evalcenter/evaluate-windows-server-2016). You can find instructions on how to create a VHD
from an ISO image at [Creating Bootable Virtual Hard Disks](https://technet.microsoft.com/library/gg318049.aspx).
- A host computer that has Hyper-V enabled. For information, see [Hyper-V overview](https://technet.microsoft.com/library/hh831531.aspx).

By using DSC, you can automate software installation and configuration for a computer at initial boot-up.
4 changes: 2 additions & 2 deletions dsc/configDataCredentials.md
Original file line number Diff line number Diff line change
@@ -158,7 +158,7 @@ Group [String] #ResourceName
}
```

This example uses a [Group](https://msdn.microsoft.com/en-us/powershell/dsc/groupresource) resource
This example uses a [Group](https://msdn.microsoft.com/powershell/dsc/groupresource) resource
from the `PSDesiredStateConfiguration` built-in DSC resource module.
It can create local groups and add or remove members.
It accepts both the `Credential` property and the automatic `PsDscRunAsCredential` property.
@@ -238,7 +238,7 @@ This example has two issues:

The first error message has a URL with documentation.
This link explains how to encrypt passwords
using a [ConfigurationData](https://msdn.microsoft.com/en-us/powershell/dsc/configdata)
using a [ConfigurationData](https://msdn.microsoft.com/powershell/dsc/configdata)
structure and a certificate.
For more information on certificates and DSC [read this post](http://aka.ms/certs4dsc).

4 changes: 2 additions & 2 deletions dsc/configHelp.md
Original file line number Diff line number Diff line change
@@ -10,8 +10,8 @@ title: Writing help for DSC configurations
>Applies To: Windows Windows PowerShell 5.0

You can use comment-based help in DSC configurations. Users can access the help by calling the configuration function with `-?`, or by using the
[Get-Help](https://technet.microsoft.com/en-us/library/hh849696.aspx) cmdlet. For more information about PowerShell comment-based help, see
[about_Comment_Based_Help](https://technet.microsoft.com/en-us/library/hh847834.aspx).
[Get-Help](https://technet.microsoft.com/library/hh849696.aspx) cmdlet. For more information about PowerShell comment-based help, see
[about_Comment_Based_Help](https://technet.microsoft.com/library/hh847834.aspx).

The following example shows a script that contains a configuration and comment-based help for it:

6 changes: 3 additions & 3 deletions dsc/configurations.md
Original file line number Diff line number Diff line change
@@ -146,14 +146,14 @@ Configuration DependsOnExample {
If you ran the previous examples, you might have noticed that you were warned that you were using a resource without explicitly importing it.
Today, DSC ships with 12 resources as part of the PSDesiredStateConfiguration module.
Other resources in external modules must be placed in `$env:PSModulePath` in order to be recognized by the LCM.
A new cmdlet, [Get-DscResource](https://technet.microsoft.com/en-us/library/dn521625.aspx),
A new cmdlet, [Get-DscResource](https://technet.microsoft.com/library/dn521625.aspx),
can be used to determine what resources are installed on the system and available for use by the LCM.
Once these modules have been placed in `$env:PSModulePath` and are properly recognized by [Get-DscResource](https://technet.microsoft.com/en-us/library/dn521625.aspx),
Once these modules have been placed in `$env:PSModulePath` and are properly recognized by [Get-DscResource](https://technet.microsoft.com/library/dn521625.aspx),
they still need to be loaded within your configuration.
**Import-DscResource** is a dynamic keyword that can only be recognized within a **Configuration** block (i.e. it is not a cmdlet).
**Import-DscResource** supports two parameters:
- **ModuleName** is the recommended way of using **Import-DscResource**. It accepts the name of the module that contains the resources to be imported (as well as a string array of module names).
- **Name** is the name of the resource to import. This is not the friendly name returned as "Name" by [Get-DscResource](https://technet.microsoft.com/en-us/library/dn521625.aspx), but the class name used when defining the resource schema (returned as **ResourceType** by [Get-DscResource](https://technet.microsoft.com/en-us/library/dn521625.aspx)).
- **Name** is the name of the resource to import. This is not the friendly name returned as "Name" by [Get-DscResource](https://technet.microsoft.com/library/dn521625.aspx), but the class name used when defining the resource schema (returned as **ResourceType** by [Get-DscResource](https://technet.microsoft.com/library/dn521625.aspx)).

## See Also
* [Windows PowerShell Desired State Configuration Overview](overview.md)
8 changes: 4 additions & 4 deletions dsc/debugResource.md
Original file line number Diff line number Diff line change
@@ -12,10 +12,10 @@ title: Debugging DSC resources
In PowerShell 5.0, a new feature was introduced in Desired State Configuraiton (DSC) that allows you to debug a DSC resource as a configuration is being applied.

## Enabling DSC debugging
Before you can debug a resource, you have to enable debugging by calling the [Enable-DscDebug](https://technet.microsoft.com/en-us/library/mt517870.aspx) cmdlet.
Before you can debug a resource, you have to enable debugging by calling the [Enable-DscDebug](https://technet.microsoft.com/library/mt517870.aspx) cmdlet.
This cmdlet takes a mandatory parameter, **BreakAll**.

You can verify that debugging has been enabled by looking at the result of a call to [Get-DscLocalConfigurationManager](https://technet.microsoft.com/en-us/library/dn407378.aspx).
You can verify that debugging has been enabled by looking at the result of a call to [Get-DscLocalConfigurationManager](https://technet.microsoft.com/library/dn407378.aspx).

The following PowerShell output shows the result of enabling debugging:

@@ -57,7 +57,7 @@ Configuration PSWebAccess
}
PSWebAccess
```
After compiling the configuration, start it by calling [Start-DscConfiguration](https://technet.microsoft.com/en-us/library/dn521623.aspx).
After compiling the configuration, start it by calling [Start-DscConfiguration](https://technet.microsoft.com/library/dn521623.aspx).
The configuration will stop when the Local Configuration Manager (LCM) calls into the first resource in the configuration.
If you use the `-Verbose` and `-Wait` parameters, the output displays the lines you need to enter to start debugging.

@@ -101,7 +101,7 @@ Remember that every line in the resource script (or class) is set as a break poi

## Disabling DSC debugging

After calling [Enable-DscDebug](https://technet.microsoft.com/en-us/library/mt517870.aspx), all calls to [Start-DscConfiguration](https://technet.microsoft.com/en-us/library/dn521623.aspx)
After calling [Enable-DscDebug](https://technet.microsoft.com/library/mt517870.aspx), all calls to [Start-DscConfiguration](https://technet.microsoft.com/library/dn521623.aspx)
will result in the configuration breaking into the debugger. To allow configurations to run normally, you must disable debugging by calling the
[Disable-DscDebug](https://technet.microsoft.com/en-us/library/mt517872.aspx) cmdlet.

6 changes: 3 additions & 3 deletions dsc/decisionMaker.md
Original file line number Diff line number Diff line change
@@ -13,7 +13,7 @@ This document describes the business benefits of using PowerShell Desired State

Windows PowerShell Desired State Configuration (DSC) is a configuration management platform built into Windows that is based on open standards. DSC is flexible enough to function reliably and consistently in each stage of the deployment lifecycle (development, test, pre-production, production), as well as during scale-out.

DSC centers around "[configurations](https://msdn.microsoft.com/en-us/powershell/dsc/configurations)".
DSC centers around "[configurations](https://msdn.microsoft.com/powershell/dsc/configurations)".
A configuration is an easy-to-read document that describes an environment made up of computers ("nodes") with specific characteristics.
These characteristics can be as simple as ensuring a specific Windows feature is enabled or as complex as deploying SharePoint.

@@ -41,13 +41,13 @@ DSC was designed with DevOps in mind.
Having a single configuration define an environment means that developers can encode their requirements into a configuration,
check that configuration into source control, and operations teams can easily deploy code without having to go through error-prone manual processes.

Configurations are also [data-driven](https://msdn.microsoft.com/en-us/powershell/dsc/configdata),
Configurations are also [data-driven](https://msdn.microsoft.com/powershell/dsc/configdata),
which makes it easier for ops teams to identify and change environments without developer intervention.

## Desired State Configuration On- and Off-Premises

DSC can be used to manage both on-premises and off-premises deployments.
For on-premises solutions, DSC has a [pull server](https://msdn.microsoft.com/en-us/powershell/dsc/pullserver)
For on-premises solutions, DSC has a [pull server](https://msdn.microsoft.com/powershell/dsc/pullserver)
that can be used to centralize management of machines and report on their status.
For cloud solutions, DSC is usable wherever Windows is usable.
There are also specific offerings from Azure built on Desired State Configuration,
2 changes: 1 addition & 1 deletion dsc/directCallResource.md
Original file line number Diff line number Diff line change
@@ -9,7 +9,7 @@ title: Calling DSC resource methods directly

>Applies To: Windows PowerShell 5.0

You can use the [Invoke-DscResource](https://technet.microsoft.com/en-us/library/mt517869.aspx) cmdlet to directly call the functions or methods of a DSC resource (The **Get-TargetResource**,
You can use the [Invoke-DscResource](https://technet.microsoft.com/library/mt517869.aspx) cmdlet to directly call the functions or methods of a DSC resource (The **Get-TargetResource**,
**Set-TargetResource**, and **Test-TargetResource** functions of a MOF-based resource, or the **Get**, **Set**, and **Test** methods of a class-based resource).
This can be used by third-parties that want to use DSC resources, or as a helpful tool while developing resources.

6 changes: 3 additions & 3 deletions dsc/enactingConfigurations.md
Original file line number Diff line number Diff line change
@@ -17,10 +17,10 @@ push mode and pull mode.
![Push mode](images/pushModel.png "How push mode works")

Push mode refers to a user actively applying a configuration to a target node
by calling the [Start-DscConfiguration](https://technet.microsoft.com/en-us/library/dn521623.aspx) cmdlet.
by calling the [Start-DscConfiguration](https://technet.microsoft.com/library/dn521623.aspx) cmdlet.

After creating and compiling a configuration, you can enact it in push mode
by calling the [Start-DscConfiguration](https://technet.microsoft.com/en-us/library/dn521623.aspx) cmdlet,
by calling the [Start-DscConfiguration](https://technet.microsoft.com/library/dn521623.aspx) cmdlet,
setting the -Path parameter of the cmdlet to the path where the configuration MOF is located.
For example, if the configuration MOF is located at `C:\DSC\Configurations\localhost.mof`,
you would apply it to the local machine with the following command:
@@ -53,7 +53,7 @@ For information about configuring the LCM, see
[Configuring the Local Configuration Manager](metaConfig.md).

The recommended solution for hosting a Pull Service, is the DSC cloud service,
[Azure Automation](https://azure.microsoft.com/en-us/services/automation/).
[Azure Automation](https://azure.microsoft.com/services/automation/).
This is hosted solution provides graphical management, reporting,
and centralized administration.

6 changes: 3 additions & 3 deletions dsc/gettingStarted.md
Original file line number Diff line number Diff line change
@@ -12,7 +12,7 @@ This guide describes how to begin creating PowerShell Desired State Configuratio

## Create a Configuration ##

[**Configurations**](https://msdn.microsoft.com/en-us/powershell/dsc/configurations) are documents that describe an environment. Environments consist of "**nodes**", which are commonly virtual or physical machines.
[**Configurations**](https://msdn.microsoft.com/powershell/dsc/configurations) are documents that describe an environment. Environments consist of "**nodes**", which are commonly virtual or physical machines.

Configurations can come in a variety of forms. The easiest way to create a new configuration is to create a .ps1 (PowerShell script) file. To do this, open your editor of choice. The PowerShell ISE is a good choice, since it understands DSC natively. Save the following as a PS1:

@@ -40,9 +40,9 @@ The next line is an import statement, similar to importing a module. It will be

"Node" defines the machine name this configuration will act on. Although this configuration is edited locally, configurations can reach out to remote nodes and configure them.

Nodes can be machine names or IP addresses. You can have multiple nodes in a single configuration document. Using [configuration data](https://msdn.microsoft.com/en-us/powershell/dsc/configdata), you can also have the same configuration apply to multiple nodes. In this case, the node is "localhost" - which means the local computer.
Nodes can be machine names or IP addresses. You can have multiple nodes in a single configuration document. Using [configuration data](https://msdn.microsoft.com/powershell/dsc/configdata), you can also have the same configuration apply to multiple nodes. In this case, the node is "localhost" - which means the local computer.

The next item is a [**resource**](https://msdn.microsoft.com/en-us/powershell/dsc/resources). Resources are building blocks of configurations. Each resource is a module that defines the implementation logic of a single aspect of a machine. You can view every resource on your machine by running **Get-DscResource** in PowerShell. Resources must be present on the local machine and imported before they can be used in a configuration with **Import-DscResource** which is on the second line of this configuration.
The next item is a [**resource**](https://msdn.microsoft.com/powershell/dsc/resources). Resources are building blocks of configurations. Each resource is a module that defines the implementation logic of a single aspect of a machine. You can view every resource on your machine by running **Get-DscResource** in PowerShell. Resources must be present on the local machine and imported before they can be used in a configuration with **Import-DscResource** which is on the second line of this configuration.

**Enacting a Configuration**

2 changes: 1 addition & 1 deletion dsc/lnxFileResource.md
Original file line number Diff line number Diff line change
@@ -72,7 +72,7 @@ nxFile resolvConf
```


Step 2: Read the file contents in the PowerShell script with [Get-Content](https://technet.microsoft.com/en-us/library/hh849787.aspx) after setting the __$OFS__ property to use the Linux line-break character.
Step 2: Read the file contents in the PowerShell script with [Get-Content](https://technet.microsoft.com/library/hh849787.aspx) after setting the __$OFS__ property to use the Linux line-break character.


```
2 changes: 1 addition & 1 deletion dsc/msft-dsclocalconfigurationmanager-resourceget.md
Original file line number Diff line number Diff line change
@@ -32,7 +32,7 @@ The name of the module that contains the resource to call.

*resourceProperty* \[in\]
Specifies the resource property name and its value in a hash table as key and value, respectively. Use the
[Get-DscResource](https://technet.microsoft.com/en-us/library/dn521625.aspx) cmdlet to discover resource properties and their types.
[Get-DscResource](https://technet.microsoft.com/library/dn521625.aspx) cmdlet to discover resource properties and their types.

*configurations* \[out\]
On return, contains an embedded instance of the configurations.
2 changes: 1 addition & 1 deletion dsc/msft-dsclocalconfigurationmanager-resourceset.md
Original file line number Diff line number Diff line change
@@ -32,7 +32,7 @@ The name of the module that contains the resource to call.

*resourceProperty* \[in\]
Specifies the resource property name and its value in a hash table as key and value, respectively. Use the
[Get-DscResource](https://technet.microsoft.com/en-us/library/dn521625.aspx) cmdlet to discover resource properties and their types.
[Get-DscResource](https://technet.microsoft.com/library/dn521625.aspx) cmdlet to discover resource properties and their types.

*RebootRequired* \[out\]
On return, this property is set to **true** if the target node needs to be rebooted.
2 changes: 1 addition & 1 deletion dsc/msft-dsclocalconfigurationmanager-resourcetest.md
Original file line number Diff line number Diff line change
@@ -32,7 +32,7 @@ The name of the module that contains the resource to call.

*resourceProperty* \[in\]
Specifies the resource property name and its value in a hash table as key and value, respectively. Use the
[Get-DscResource](https://technet.microsoft.com/en-us/library/dn521625.aspx) cmdlet to discover resource properties and their types.
[Get-DscResource](https://technet.microsoft.com/library/dn521625.aspx) cmdlet to discover resource properties and their types.

*InDesiredState* \[out\]
On return, this property is set to **true** if the target node is in the desired state.
Loading