Skip to content

SPVisioServiceApp

Yorick Kuijs edited this page Apr 1, 2021 · 19 revisions

SPVisioServiceApp

Parameters

Parameter Attribute DataType Description Allowed Values
Name Key String The name of the service application
ApplicationPool Required String The name of the application pool to run the service app in
ProxyName Write String The name of the Visio Service Application Proxy
Ensure Write String Present if the service app should exist, absent if it should not Present, Absent
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 responsible for creating Visio Graphics Service Application instances within the local SharePoint farm. The resource will provision and configure the Visio Graphics Service Application.

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 visio services service app in the local farm

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

    Import-DscResource -ModuleName SharePointDsc

    node localhost
    {
        SPVisioServiceApp VisioServices
        {
            Name                 = "Visio Graphics Service Application"
            ApplicationPool      = "SharePoint Web Services"
            PsDscRunAsCredential = $SetupAccount
        }
    }
}

Example 2

This example shows how to remove a visio services service app in the local farm. The ApplicationPool property is still requried but is not used when removing, so the value used here doesn't matter.

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

    Import-DscResource -ModuleName SharePointDsc

    node localhost
    {
        SPVisioServiceApp VisioServices
        {
            Name                 = "Visio Graphics Service Application"
            ApplicationPool      = "n/a"
            Ensure               = "Absent"
            PsDscRunAsCredential = $SetupAccount
        }
    }
}
Clone this wiki locally