en-US/about_SPOfficeOnlineServerBinding.help.txt

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
.NAME
    SPOfficeOnlineServerBinding

# Description
    
    This resource will create a binding to an Office Online Server (formerly known
    as Office Web Apps). The DnsName property can be a single server name, or a
    FQDN of a load balanced end point that will direct traffic to a farm.
    
    NOTE: This resource is designed to be used where all WOPI bindings will be
    targeted to the same Office Online Server farm. If used on a clean
    environment, the new bindings will all point to the one DNS Name. If used on
    an existing configuration that does not follow this rule, it will match only
    
    The default value for the Ensure parameter is Present. When not specifying this
    parameter, the zone is configured.
    
.PARAMETER Zone
    Key - string
    Allowed values: Internal-HTTP, Internal-HTTPS, External-HTTP, External-HTTPS
    The zone for this binding

.PARAMETER DnsName
    Required - string
    The DNS name of the server/s that are running Office Web Apps

.PARAMETER Ensure
    Write - string
    Allowed values: Present, Absent
    Present ensures the binding for this zone exists, absent ensures it doesn't .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 create bindings to the internal-https zone for the local SharePoint farm. Configuration Example { param( [Parameter(Mandatory = $true)] [PSCredential] $SetupAccount ) Import-DscResource -ModuleName SharePointDsc node localhost { SPOfficeOnlineServerBinding OosBinding { Zone = "internal-https" DnsName = "webapps.contoso.com" PsDscRunAsCredential = $SetupAccount } } } .EXAMPLE This example shows how to remove bindings from the internal-http zone for the local SharePoint farm. Configuration Example { param( [Parameter(Mandatory = $true)] [PSCredential] $SetupAccount ) Import-DscResource -ModuleName SharePointDsc node localhost { SPOfficeOnlineServerBinding OosBinding { Zone = "Internal-HTTP" DnsName = "webapps.contoso.com" PsDscRunAsCredential = $SetupAccount Ensure = "Absent" } } }