en-US/about_SPWebApplicationAppDomain.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
.NAME
    SPWebApplicationAppDomain

# Description
    
    **Type:** Distributed
    
    This resource will configure the App Domain at a specific zone for the given
    Web Application. The configuration is done per zone on the specified web
    application, allowing for the setting of unique app domains for each extension
    of a web application. The app prefix should still be set using the SPAppDomain
    resource before this is applied to customise a specific zone.
    
.PARAMETER WebApplication
    Key - string
    The URL of the web application to set the app domain for

.PARAMETER Zone
    Key - string
    Allowed values: Default, Internet, Intranet, Extranet, Custom
    The zone that this app domain applies to

.PARAMETER AppDomain
    Required - string
    The domain for apps in this web app zone

.PARAMETER Port
    Write - string
    The port to run apps on

.PARAMETER SSL
    Write - boolean
    Should apps run under SSL

.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 set the app domain for a specified web application


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

        node localhost {
            SPWebApplicationAppDomain Domain
            {
                AppDomain = "contosointranetapps.com"
                WebApplication ="http://portal.contoso.com";
                Zone = "Default";
                Port = 80;
                SSL = $false;
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }