IonFar.SharePoint.PowerShell

0.2.2

IonFar.SharePoint.PowerShell.xml

                                <?xml version="1.0"?>

<doc>

    <assembly>

        <name>IonFar.SharePoint.PowerShell</name>

    </assembly>

    <members>

        <member name="T:IonFar.SharePoint.PowerShell.InvokeFileSyncCmdlet">

            <summary>

            <para type="synopsis">Runs IonFar file synchronisation</para>

            <para type="description">Synchronizes files from given source directory to target SharePoint folder.</para>

            <para type="description">Transfers only if the local file has changed, by comparing the hashes.</para>

            <code>Invoke-IonFarFileSync -SiteUrl $SiteUrl -UserName $UserName -Password $Password -BaseDirectory "$($PSScriptRoot)" -SourcePath "Files\Style Library" -DestinationPath "~site/Style Library"</code>

            </summary>

        </member>

        <member name="P:IonFar.SharePoint.PowerShell.InvokeFileSyncCmdlet.SiteUrl">

            <summary>

            <para type="description">The url of the target SharePoint site</para>

            </summary>

        </member>

        <member name="P:IonFar.SharePoint.PowerShell.InvokeFileSyncCmdlet.UserName">

            <summary>

            <para type="description">User account to run the migrations</para>

            </summary>

        </member>

        <member name="P:IonFar.SharePoint.PowerShell.InvokeFileSyncCmdlet.Password">

            <summary>

            <para type="description">Password of the user account to run the migrations</para>

            </summary>

        </member>

        <member name="P:IonFar.SharePoint.PowerShell.InvokeFileSyncCmdlet.ClientId">

            <summary>

            <para type="description">App Principal Client ID</para>

            </summary>

        </member>

        <member name="P:IonFar.SharePoint.PowerShell.InvokeFileSyncCmdlet.ClientSecret">

            <summary>

            <para type="description">App Principal Client Secret</para>

            </summary>

        </member>

        <member name="P:IonFar.SharePoint.PowerShell.InvokeFileSyncCmdlet.BaseDirectory">

            <summary>

            <para type="description">Full path to base working directory. Defaults to current directory if not specified</para>

            </summary>

        </member>

        <member name="P:IonFar.SharePoint.PowerShell.InvokeFileSyncCmdlet.SourcePath">

            <summary>

            <para type="description">Source folder path relative to working directory</para>

            </summary>

        </member>

        <member name="P:IonFar.SharePoint.PowerShell.InvokeFileSyncCmdlet.DestinationPath">

            <summary>

            <para type="description">Server relative destination SharePoint folder path. May use '~sitecollection/' or '~site/' prefix; the folder must already exist</para>

            </summary>

        </member>

        <member name="T:IonFar.SharePoint.PowerShell.InvokeScriptMigrationCmdlet">

            <summary>

            <para type="synopsis">Runs IonFar migration scripts</para>

            <para type="description">Runs a series of deployment scripts against a provided SharePoint Online site.</para>

            <para type="description">By default, runs only the new scripts that weren't executed before.</para>

            <para type="description">This behaviour can be overriden by using -Force parameter.</para>

            <code>Invoke-IonFarScriptMigration -SiteUrl $SiteUrl -UserName $UserName -Password $Password -ScriptDirectory "$($PSScriptRoot)\Migrations"</code>

            </summary>

        </member>

        <member name="P:IonFar.SharePoint.PowerShell.InvokeScriptMigrationCmdlet.SiteUrl">

            <summary>

            <para type="description">The url of the target SharePoint site</para>

            </summary>

        </member>

        <member name="P:IonFar.SharePoint.PowerShell.InvokeScriptMigrationCmdlet.UserName">

            <summary>

            <para type="description">User account to run the migrations</para>

            </summary>

        </member>

        <member name="P:IonFar.SharePoint.PowerShell.InvokeScriptMigrationCmdlet.Password">

            <summary>

            <para type="description">Password of the user account to run the migrations</para>

            </summary>

        </member>

        <member name="P:IonFar.SharePoint.PowerShell.InvokeScriptMigrationCmdlet.ClientId">

            <summary>

            <para type="description">App Principal Client ID</para>

            </summary>

        </member>

        <member name="P:IonFar.SharePoint.PowerShell.InvokeScriptMigrationCmdlet.ClientSecret">

            <summary>

            <para type="description">App Principal Client Secret</para>

            </summary>

        </member>

        <member name="P:IonFar.SharePoint.PowerShell.InvokeScriptMigrationCmdlet.ScriptDirectory">

            <summary>

            <para type="description">Full path to scripts directory</para>

            </summary>

        </member>

        <member name="P:IonFar.SharePoint.PowerShell.InvokeScriptMigrationCmdlet.Force">

            <summary>

            <para type="description">Runs all scripts even if they were executed before</para>

            </summary>

        </member>

        <member name="P:IonFar.SharePoint.PowerShell.InvokeScriptMigrationCmdlet.JournalPrefix">

            <summary>

            <para type="description">Specify a custom property bag prefix</para>

            </summary>

        </member>

    </members>

</doc>