en-US/about_SPTrustedRootAuthority.help.txt

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
.NAME
    SPTrustedRootAuthority

# Description
    
    **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.
    
.PARAMETER Name
    Key - String
    Specifies the name of the trusted root authority to create.

.PARAMETER CertificateThumbprint
    Write - String
    Specifies the X.509 certificate of the trusted root authority, as a certificate thumbprint.

.PARAMETER 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.

.PARAMETER Ensure
    Write - String
    Allowed values: Present, Absent
    Present ensures the trusted root authority exists, absent ensures it is removed

.PARAMETER InstallAccount
    Write - String
    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5


.EXAMPLE
    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
            }
        }
    }


.EXAMPLE
    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
            }
        }
    }


.EXAMPLE
    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
            }
        }
    }