Skip to content

SPAzureAccessControlServiceAppProxy

dscbot edited this page Mar 17, 2023 · 6 revisions

SPAzureAccessControlServiceAppProxy

Parameters

Parameter Attribute DataType Description Allowed Values
Name Key String The name of the Azure Access Control service application proxy
Ensure Write String Present ensures service app proxy exists, absent ensures it is removed Present, Absent
MetadataServiceEndpointUri Required String Specifies the URL of the Azure Access Control Service's metadata document.

Description

Type: Distributed Requires CredSSP: No

This resource is used to create a new service application proxy for the Azure Control service application. It will identify an instance of the ACS service application 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 metadata service endpoint 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 proxy is provisioned.

Examples

Example 1

This example shows how to create a new Azure Access Control Service Application Proxy in the farm connecting to the contoso tenant.

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

    Import-DscResource -ModuleName SharePointDsc

    node localhost
    {
        SPAzureAccessControlServiceAppProxy SPOACS
        {
            Name                       = "SPO ACS"
            MetadataServiceEndpointUri = "https://accounts.accesscontrol.windows.net/contoso.onmicrosoft.com/metadata/json/1"
            PsDscRunAsCredential       = $SetupAccount
        }
    }
}
Clone this wiki locally