About Help

Choose a topic from the list on the left or search for a specific topic. Choose a topic from the list or search for a specific topic.
Cmdlets  Providers  Aliases  Modules
 

about_SPWebAppProxyGroup

Spwebappproxygroup

SharePointDSC
 

SHORT DESCRIPTION

 

.NAME

    SPWebAppProxyGroup 
 
# Description 
     
    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 
     
.PARAMETER WebAppUrl 
    Key - String 
    URL of the web application 
 
.PARAMETER ServiceAppProxyGroup 
    Required - string 
    Name of the Service Applicaiton Proxy Group 
 
.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 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 
            } 
        } 
    }