en-US/about_SPSiteUrl.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
.NAME
    SPSiteUrl

# Description
    
    **Type:** Distributed
    **Requires CredSSP:** No
    
    This resource will configure the site url for a host named site collection.
    There are four available zones to configure: Intranet, Internet, Extranet
    and Custom.
    
    It is not possible to change the site url for the Default zone, since this
    means changing the url that is used as identity. A site collection rename
    is required for that:
    $site = Get-SPSite "http://old.contoso.com"
    $new = "http://new.contoso.com"
    $site.Rename($new)
    ((Get-SPSite $new).contentdatabase).RefreshSitesInConfigurationDatabase
    
.PARAMETER Url
    Key - string
    The URL of the site collection

.PARAMETER Intranet
    Write - string
    The URL of the Intranet zone

.PARAMETER Internet
    Write - string
    The URL of the Internet zone

.PARAMETER Extranet
    Write - string
    The URL of the Extranet zone

.PARAMETER Custom
    Write - string
    The URL of the Custom zone

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


.EXAMPLE
    This example configures the site collection urls for the specified
    Host Named Site Collection


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

        node localhost {
            SPSiteUrl TeamSite
            {
                Url                  = "http://sharepoint.contoso.intra"
                Intranet             = "http://sharepoint.contoso.com"
                Internet             = "https://sharepoint.contoso.com"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }