IonFar.SharePoint.PowerShell

0.2.2

IonFar.SharePoint.PowerShell.dll-Help.xml

<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh">
  <!-- Cmdlet: Invoke-IonFarFileSync -->
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
    <command:details>
      <command:name>Invoke-IonFarFileSync</command:name>
      <command:verb>Invoke</command:verb>
      <command:noun>IonFarFileSync</command:noun>
      <maml:description>
        <maml:para>Runs IonFar file synchronisation</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Synchronizes files from given source directory to target SharePoint folder.</maml:para>
      <maml:para>Transfers only if the local file has changed, by comparing the hashes.</maml:para>
    </maml:description>
    <command:syntax>
      <!-- Parameter set: __AllParameterSets -->
      <command:syntaxItem>
        <maml:name>Invoke-IonFarFileSync</maml:name>
        <!-- Parameter: DestinationPath -->
        <command:parameter required="true" globbing="false" pipelineInput="false" position="named">
          <maml:name>DestinationPath</maml:name>
          <maml:description>
            <maml:para>Server relative destination SharePoint folder path. May use '~sitecollection/' or '~site/' prefix; the folder must already exist</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: SiteUrl -->
        <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named">
          <maml:name>SiteUrl</maml:name>
          <maml:description>
            <maml:para>The url of the target SharePoint site</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: SourcePath -->
        <command:parameter required="true" globbing="false" pipelineInput="false" position="named">
          <maml:name>SourcePath</maml:name>
          <maml:description>
            <maml:para>Source folder path relative to working directory</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: BaseDirectory -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>BaseDirectory</maml:name>
          <maml:description>
            <maml:para>Full path to base working directory. Defaults to current directory if not specified</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: ClientId -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>ClientId</maml:name>
          <maml:description>
            <maml:para>App Principal Client ID</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: ClientSecret -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>ClientSecret</maml:name>
          <maml:description>
            <maml:para>App Principal Client Secret</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: Password -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>Password</maml:name>
          <maml:description>
            <maml:para>Password of the user account to run the migrations</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: UserName -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>UserName</maml:name>
          <maml:description>
            <maml:para>User account to run the migrations</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <!-- Parameter: SiteUrl -->
      <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named">
        <maml:name>SiteUrl</maml:name>
        <maml:description>
          <maml:para>The url of the target SharePoint site</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: UserName -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>UserName</maml:name>
        <maml:description>
          <maml:para>User account to run the migrations</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: Password -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>Password</maml:name>
        <maml:description>
          <maml:para>Password of the user account to run the migrations</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: ClientId -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>ClientId</maml:name>
        <maml:description>
          <maml:para>App Principal Client ID</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: ClientSecret -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>ClientSecret</maml:name>
        <maml:description>
          <maml:para>App Principal Client Secret</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: BaseDirectory -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>BaseDirectory</maml:name>
        <maml:description>
          <maml:para>Full path to base working directory. Defaults to current directory if not specified</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: SourcePath -->
      <command:parameter required="true" globbing="false" pipelineInput="false" position="named">
        <maml:name>SourcePath</maml:name>
        <maml:description>
          <maml:para>Source folder path relative to working directory</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: DestinationPath -->
      <command:parameter required="true" globbing="false" pipelineInput="false" position="named">
        <maml:name>DestinationPath</maml:name>
        <maml:description>
          <maml:para>Server relative destination SharePoint folder path. May use '~sitecollection/' or '~site/' prefix; the folder must already exist</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
        <maml:description>
          <maml:para>The url of the target SharePoint site</maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <!-- OutputType: SynchronizationResult -->
      <command:returnValue>
        <dev:type>
          <maml:name>IonFar.SharePoint.Synchronization.SynchronizationResult</maml:name>
          <maml:uri />
        </dev:type>
      </command:returnValue>
    </command:returnValues>
  </command:command>
  <!-- Cmdlet: Invoke-IonFarScriptMigration -->
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
    <command:details>
      <command:name>Invoke-IonFarScriptMigration</command:name>
      <command:verb>Invoke</command:verb>
      <command:noun>IonFarScriptMigration</command:noun>
      <maml:description>
        <maml:para>Runs IonFar migration scripts</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Runs a series of deployment scripts against a provided SharePoint Online site.</maml:para>
      <maml:para>By default, runs only the new scripts that weren't executed before.</maml:para>
      <maml:para>This behaviour can be overriden by using -Force parameter.</maml:para>
    </maml:description>
    <command:syntax>
      <!-- Parameter set: __AllParameterSets -->
      <command:syntaxItem>
        <maml:name>Invoke-IonFarScriptMigration</maml:name>
        <!-- Parameter: ScriptDirectory -->
        <command:parameter required="true" globbing="false" pipelineInput="false" position="named">
          <maml:name>ScriptDirectory</maml:name>
          <maml:description>
            <maml:para>Full path to scripts directory</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: SiteUrl -->
        <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named">
          <maml:name>SiteUrl</maml:name>
          <maml:description>
            <maml:para>The url of the target SharePoint site</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: ClientId -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>ClientId</maml:name>
          <maml:description>
            <maml:para>App Principal Client ID</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: ClientSecret -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>ClientSecret</maml:name>
          <maml:description>
            <maml:para>App Principal Client Secret</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: Force -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>Force</maml:name>
          <maml:description>
            <maml:para>Runs all scripts even if they were executed before</maml:para>
          </maml:description>
          <command:parameterValue required="true">SwitchParameter</command:parameterValue>
          <dev:type>
            <maml:name>System.Management.Automation.SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>False</dev:defaultValue>
        </command:parameter>
        <!-- Parameter: JournalPrefix -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>JournalPrefix</maml:name>
          <maml:description>
            <maml:para>Specify a custom property bag prefix</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: Password -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>Password</maml:name>
          <maml:description>
            <maml:para>Password of the user account to run the migrations</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: UserName -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>UserName</maml:name>
          <maml:description>
            <maml:para>User account to run the migrations</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <!-- Parameter: SiteUrl -->
      <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named">
        <maml:name>SiteUrl</maml:name>
        <maml:description>
          <maml:para>The url of the target SharePoint site</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: UserName -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>UserName</maml:name>
        <maml:description>
          <maml:para>User account to run the migrations</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: Password -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>Password</maml:name>
        <maml:description>
          <maml:para>Password of the user account to run the migrations</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: ClientId -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>ClientId</maml:name>
        <maml:description>
          <maml:para>App Principal Client ID</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: ClientSecret -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>ClientSecret</maml:name>
        <maml:description>
          <maml:para>App Principal Client Secret</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: ScriptDirectory -->
      <command:parameter required="true" globbing="false" pipelineInput="false" position="named">
        <maml:name>ScriptDirectory</maml:name>
        <maml:description>
          <maml:para>Full path to scripts directory</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: Force -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>Force</maml:name>
        <maml:description>
          <maml:para>Runs all scripts even if they were executed before</maml:para>
        </maml:description>
        <command:parameterValue required="true">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>System.Management.Automation.SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>False</dev:defaultValue>
      </command:parameter>
      <!-- Parameter: JournalPrefix -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>JournalPrefix</maml:name>
        <maml:description>
          <maml:para>Specify a custom property bag prefix</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
        <maml:description>
          <maml:para>The url of the target SharePoint site</maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <!-- OutputType: MigrationResult -->
      <command:returnValue>
        <dev:type>
          <maml:name>IonFar.SharePoint.Migration.MigrationResult</maml:name>
          <maml:uri />
        </dev:type>
      </command:returnValue>
    </command:returnValues>
  </command:command>
</helpItems>