en-us/about_SPAlternateUrl.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
.NAME
    SPAlternateUrl
 
.SYNOPSIS
 
This resource is used to define an alternate access mapping URL for a specified web application.
 
 
.EXAMPLE
 
    SPAlternateUrl CentralAdminAAM
    {
        WebAppUrl = "http://sharepoint1:9999"
        Zone = "Intranet"
        Url = "https://admin.sharepoint.contoso.com"
        PsDscRunAsCredential = $SPSetupAccount
    }
 
.PARAMETER WebAppUrl
    Key - String
    The URL of the web application to apply the alternate URL to
 
.PARAMETER Zone
    Key - String
    Allowed values: Default, Intranet, Extranet, Custom, Internet
    The Zone to use for the alternate URL
 
.PARAMETER Url
    Write - String
    The new alternate URL
 
.PARAMETER Ensure
    Write - string
    Allowed values: Present, Absent
    Present ensures the URL is set for this zone on this web app, Absent ensures it is removed
 
.PARAMETER InstallAccount
    Write - String
    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5