SPOAppPrincipalMgmtServiceAppProxy

SPOAppPrincipalMgmtServiceAppProxy

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
Name	Key	String	The name of the SPO application principal management service application proxy
Ensure	Write	String	Present ensures service app proxy exists, absent ensures it is removed	Present, Absent
OnlineTenantUri	Required	String	URL to SharePoint Online Tenant
InstallAccount	Write	PSCredential	POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5

Description

Type: Distributed Requires CredSSP: No

This resource is used to create a SharePoint Online management Application Proxy. This is used by for example hybrid search. It will identify an instance of the SPO management apllication proxy through the display name. Currently the resource will provision the app proxy if it does not yet exist, and will recreate the proxy if the Online Tenant URI associated to the proxy does not match the configuration.

The default value for the Ensure parameter is Present. When not specifying this parameter, the service application is provisioned.

Examples

Example 1

This example shows how to create a new SharePoint Online management Application Proxy in the farm connecting to the contoso tenant.

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

    Import-DscResource -ModuleName SharePointDsc

    node localhost
    {
        SPOAppPrincipalMgmtServiceAppProxy SPOAddInManagementProxy
        {
            Name                 = "SPO Add-in Management Proxy"
            OnlineTenantUri      = "https://contoso.sharepoint.com"
            PsDscRunAsCredential = $SetupAccount
        }
    }
}