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_SPServiceAppProxyGroup

Spserviceappproxygroup

SharePointDSC
 

SHORT DESCRIPTION

 

.NAME

    SPServiceAppProxyGroup 
 
# Description 
     
    This resource is used to manage SharePoint Service Application Proxy Groups. 
    The "Ensure" parameter controls whether or not the Proxy Group should exist. A 
    proxy group cannot be removed if a web application is using it. The 
    "ServiceAppProxies" property will set a specific list of Service App Proxies 
    to be members of this Proxy Group. It will add and remove proxies to ensure 
    the group matches this list exactly. The "ServiceAppProxiesToInclude" and 
    "ServiceAppProxiesToExclude" properties will allow you to add and remove 
    proxies from the group, leaving other proxies that are in the group but not in 
    either list intact. 
     
    Use the proxy group name "Default" to manipulate the default proxy group. 
     
    Requirements: 
    At least one of the ServiceAppProxies, ServiceAppProxiesToInclude or 
    ServiceAppProxiesToExclude properties needs to be specified. Do not combine 
    the ServiceAppProxies property with the ServiceAppProxiesToInclude and 
     
.PARAMETER Name 
    Key - String 
    Name of the Proxy Group to create 
 
.PARAMETER Ensure 
    Write - string 
    Allowed values: Present, Absent 
    Present creates the proxy group if it does not already exist, Absent will delete the proxy group if it exists 
 
.PARAMETER ServiceAppProxies 
    Write - String 
    List of service application proxies that belong in this proxy group, all others will be removed 
 
.PARAMETER ServiceAppProxiesToInclude 
    Write - String 
    List of service application proxies to add to this proxy group, existing proxies will remain 
 
.PARAMETER ServiceAppProxiesToExclude 
    Write - String 
    List of service application proxies to remove from this proxy grop, all others will remain 
 
.PARAMETER InstallAccount 
    Write - String 
    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 
 
 

.EXAMPLE

    This example creates two seperate proxy groups of service apps that can be  
    assigned to web apps in the farm 
 
 
    Configuration Example  
    { 
        param( 
            [Parameter(Mandatory = $true)] 
            [PSCredential] 
            $SetupAccount 
        ) 
        Import-DscResource -ModuleName SharePointDsc 
 
        node localhost { 
            SPServiceAppProxyGroup ProxyGroup1 
            { 
                Name                = "Proxy Group 1" 
                Ensure              = "Present" 
                ServiceAppProxies   = "Web 1 User Profile Service Application","Web 1 MMS Service Application","State Service Application" 
            } 
 
            SPServiceAppProxyGroup ProxyGroup2 
            { 
                Name                = "Proxy Group 2" 
                Ensure              = "Present" 
                ServiceAppProxiesToInclude = "Web 2 User Profile Service Application" 
            } 
        } 
    }