en-US/about_SPBlobCacheSettings.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
.NAME
    SPBlobCacheSettings

# Description
    
    **Type:** Specific
    
    This resource is used to configure the Blob Cache settings for a web
    application.
    
    Important:
    This resource only configures the local server. It changes the web.config
    file directly and is NOT using the SPWebConfigModifications class. In order
    to configure all WFE servers in the farm, you have to apply this resource
    to all servers.
    
    NOTE:
    In order to prevent inconsistancy between different web front end servers,
    make sure you configure this setting on all servers equally.
    If the specified folder does not exist, the resource will create the folder.
    
    Best practice:
    Specify a directory that is not on the same drive as where either the server
    operating system swap files or server log files are stored.
    
.PARAMETER WebAppUrl
    Key - string
    The URL of the web application

.PARAMETER Zone
    Key - string
    Allowed values: Default, Intranet, Internet, Custom, Extranet
    The zone of the web application for which blob cache has to be configured

.PARAMETER EnableCache
    Required - Boolean
    Specify if the blob cache has to be enabled

.PARAMETER Location
    Write - string
    The location where the blob cache has to store its files

.PARAMETER MaxSizeInGB
    Write - Uint16
    The maximum size (in GB) of disk space the blob cache is allowed to use

.PARAMETER MaxAgeInSeconds
    Write - Uint32
    The maximum age (in seconds) that a browser caches a blob

.PARAMETER FileTypes
    Write - string
    Specify the file types that must be stored by the blob cache

.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 to configure the blob cache settings on the local server for the
    specified web application and zone 


    Configuration Example 
    {
        param(
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPBlobCacheSettings BlobCacheSettings 
            {
                WebAppUrl = "http://intranet.contoso.com"
                Zone = "Default"
                EnableCache = $true
                Location = "F:\BlobCache"
                MaxSizeInGB = 10
                FileTypes = "\.(gif|jpg|png|css|js)$"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }