SPAlternateUrl

SPAlternateUrl

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
WebAppName	Key	String	The name of the web application to apply the alternate URL to
Zone	Key	String	The Zone to use for the alternate URL	Default, Intranet, Extranet, Custom, Internet
Url	Key	String	The new alternate URL
Internal	Write	Boolean	Specifies if the URL has to be configured as internal
Ensure	Write	string	Present ensures the URL is set for this zone on this web app, Absent ensures it is removed	Present, Absent
InstallAccount	Write	PSCredential	POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5

Description

This resource is used to define an alternate access mapping URL for a specified web application. These can be assigned to specific zones for each web application. Alternatively a URL can be removed from a zone to ensure that it will remain empty and have no alternate URL.

To select the Central Administration site, use the following command to retrieve the correct web application name: (Get-SPWebApplication -IncludeCentralAdministration | Where-Object { $_.IsAdministrationWebApplication }).DisplayName

The default value for the Ensure parameter is Present. When not specifying this parameter, the setting is configured.

Examples

Example 1

This example shows how to add a new alternate URL to a specific web application

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

        node localhost {
            SPAlternateUrl CentralAdminAAM
            {
                WebAppName           = "SharePoint - www.domain.com80"
                Zone                 = "Intranet"
                Url                  = "https://admin.sharepoint.contoso.com"
                Internal             = $false
                Ensure               = "Present"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }

Example 2

This example shows how to remove an alternate URL from a specified zone for a specific web application.

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

        node localhost {
            SPAlternateUrl CentralAdminAAM
            {
                WebAppName           = "SharePoint - www.domain.com80"
                Zone                 = "Intranet"
                Url                  = "http://www.externaldomain.com"
                Internal             = $false
                Ensure               = "Absent"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }