-
Notifications
You must be signed in to change notification settings - Fork 107
SPTrustedRootAuthority
Yorick Kuijs edited this page Jul 10, 2020
·
9 revisions
Parameter | Attribute | DataType | Description | Allowed Values |
---|---|---|---|---|
Name | Key | String | Specifies the name of the trusted root authority to create. | |
CertificateThumbprint | Write | String | Specifies the X.509 certificate of the trusted root authority, as a certificate thumbprint. | |
CertificateFilePath | Write | String | Specify the file path to the certificate if it is not stored in the local certificate store already. Private key should not be present. | |
Ensure | Write | String | Present ensures the trusted root authority exists, absent ensures it is removed | Present, Absent |
InstallAccount | Write | PSCredential | POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 |
Type: Distributed Requires CredSSP: No
This resource is used to create or remove SPTrustedRootAuthority in a SharePoint farm. It imports the certificate into SharePoint in order for high trust apps or consuming service applications from other farms will work.
This example deploys a SP Trusted Root Authority to the local farm.
Configuration Example
{
param(
[Parameter(Mandatory = $true)]
[PSCredential]
$SetupAccount
)
Import-DscResource -ModuleName SharePointDsc
node localhost {
SPTrustedRootAuthority SampleRootAuthority
{
Name = "Contoso"
CertificateThumbprint = "770515261D1AB169057E246E0EE6431D557C3AFB"
Ensure = "Present"
PsDscRunAsCredential = $SetupAccount
}
}
}
This example deploys a SP Trusted Root Authority to the local farm.
Configuration Example
{
param(
[Parameter(Mandatory = $true)]
[PSCredential]
$SetupAccount
)
Import-DscResource -ModuleName SharePointDsc
node localhost {
SPTrustedRootAuthority SampleRootAuthority
{
Name = "Contoso"
CertificateFilePath = "C:\Certificates\RootAuthority.cer"
Ensure = "Present"
PsDscRunAsCredential = $SetupAccount
}
}
}
This example removes a SP Trusted Root Authority from the local farm.
Configuration Example
{
param(
[Parameter(Mandatory = $true)]
[PSCredential]
$SetupAccount
)
Import-DscResource -ModuleName SharePointDsc
node localhost {
SPTrustedRootAuthority SampleRootAuthority
{
Name = "Contoso"
CertificateThumbprint = "770515261D1AB169057E246E0EE6431D557C3AFB"
Ensure = "Absent"
PsDscRunAsCredential = $SetupAccount
}
}
}
- Home
- Getting Started
- Pre-requisites
- Installing the module
- Exporting SharePoint Configuration
- Creating Configuration Files
- Pre-created Examples
- Creating an Azure development environment
- Understanding Resources & Syntax
- Remote PowerShell Authentication
- Contributing to SharePointDsc
- Other useful modules for SharePoint DSC configurations