Skip to content

SPWebAppProxyGroup

dscbot edited this page Mar 17, 2023 · 18 revisions

SPWebAppProxyGroup

Parameters

Parameter Attribute DataType Description Allowed Values
WebAppUrl Key String URL of the web application
ServiceAppProxyGroup Required String Name of the Service Application Proxy Group

Description

Type: Distributed Requires CredSSP: No

This resource is used to associate a web application to a service application proxy group. Use the proxy group name "Default" to associate the web application to the default proxy group. A web applicaiton can only connect to a single service application proxy group. This resource will overright the existing service application proxy group association.

This resource is used in conjunction with the SPServiceAppProxyGroup resource, which creates the proxy groups and associates the desired service application proxies with it. Within your configuration, that resource should be a

Examples

Example 1

This example shows how to assign a specific proxy group to the specified web app

Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $SetupAccount
    )

    Import-DscResource -ModuleName SharePointDsc

    node localhost
    {
        SPWebAppProxyGroup ContosoWeb
        {
            WebAppUrl            = "https://web.contoso.com"
            ServiceAppProxyGroup = "Proxy Group 1"
            PsDscRunAsCredential = $SetupAccount
        }
    }
}
Clone this wiki locally