en-US/about_SPFarmPropertyBag.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
.NAME
    SPFarmPropertyBag

# Description
    
    This resource is used to work with SharePoint Property Bags at the farm level.
    The account that runs this resource must be a farm administrator.
    
    The default value for the Ensure parameter is Present. When not specifying this
    parameter, the property bag is configured.
    
.PARAMETER Key
    Key - string
    The key of the SPFarm property bag

.PARAMETER Value
    Write - String
    Value of the SPfarm property bag

.PARAMETER Ensure
    Write - string
    Allowed values: Present, Absent
    Set to present to ensure the SPfarm property exists, or absent to ensure 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 shows how add property bag in the current farm.


Configuration Example 
{
    param
    (
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $SetupAccount
    )

    Import-DscResource -ModuleName SharePointDsc

    node localhost 
    {
        SPFarmPropertyBag APPLICATION_APPCodeProperty
        {
            PsDscRunAsCredential = $SetupAccount
            Key = "FARM_TYPE"
            Value = "SearchFarm"
            Ensure = "Present"
        }
    }
}


.EXAMPLE
    This example shows how remove property bag in the current farm.


Configuration Example 
{
    param
    (
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $SetupAccount
    )

    Import-DscResource -ModuleName SharePointDsc

    node localhost 
    {
        SPFarmPropertyBag APPLICATION_APPCodeProperty
        {
            PsDscRunAsCredential = $SetupAccount
            Key = "KeyToRemove"
            Ensure = "Absent"
        }
    }
}