AzureRM.StorageSync

0.1.1-preview

Microsoft.Azure.Commands.StorageSync.dll-Help.xml

                                <?xml version="1.0" encoding="utf-8"?>

<helpItems schema="maml" xmlns="http://msh">

  <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Invoke-AzureRmStorageSyncCompatibilityCheck</command:name>

      <command:verb>Invoke</command:verb>

      <command:noun>AzureRmStorageSyncCompatibilityCheck</command:noun>

      <maml:description>

        <maml:para>Checks for potential compatibility issues between your system and Azure File Sync.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>The Invoke-AzureRmStorageSyncCompatibilityCheck cmdlet checks for potential compatibility issues between your system and Azure File Sync. Given a local or remote path, it performs a set of validations on the system and file namespace, and then returns any compatibility issues it finds. System checks: - OS compatibility File namespace checks: - Unsupported characters</maml:para>

      <maml:para>- Maximum file size</maml:para>

      <maml:para>- Maximum path length</maml:para>

      <maml:para>- Maximum file length</maml:para>

      <maml:para>- Maximum dataset size</maml:para>

      <maml:para>- Maximum directory depth</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Invoke-AzureRmStorageSyncCompatibilityCheck</maml:name>

        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">

          <maml:name>ComputerName</maml:name>

          <maml:Description>

            <maml:para>The computer you are performing this check on.</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

          <dev:type>

            <maml:name>System.String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>Credential</maml:name>

          <maml:Description>

            <maml:para>Your credentials for the share you are validating.</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</command:parameterValue>

          <dev:type>

            <maml:name>System.Management.Automation.PSCredential</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>Quiet</maml:name>

          <maml:Description>

            <maml:para>Suppresses writing output report to console.</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>

          <dev:type>

            <maml:name>System.Management.Automation.SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>SkipSystemChecks</maml:name>

          <maml:Description>

            <maml:para>Set this flag to skip system validations and only perform file namespace validations.</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>

          <dev:type>

            <maml:name>System.Management.Automation.SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

      <command:syntaxItem>

        <maml:name>Invoke-AzureRmStorageSyncCompatibilityCheck</maml:name>

        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">

          <maml:name>Path</maml:name>

          <maml:Description>

            <maml:para>The UNC path of the share you are validating.</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

          <dev:type>

            <maml:name>System.String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>Credential</maml:name>

          <maml:Description>

            <maml:para>Your credentials for the share you are validating.</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</command:parameterValue>

          <dev:type>

            <maml:name>System.Management.Automation.PSCredential</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>Quiet</maml:name>

          <maml:Description>

            <maml:para>Suppresses writing output report to console.</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>

          <dev:type>

            <maml:name>System.Management.Automation.SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>SkipNamespaceChecks</maml:name>

          <maml:Description>

            <maml:para>Set this flag to skip file namespace validations and only perform system validations.</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>

          <dev:type>

            <maml:name>System.Management.Automation.SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>SkipSystemChecks</maml:name>

          <maml:Description>

            <maml:para>Set this flag to skip system validations and only perform file namespace validations.</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>

          <dev:type>

            <maml:name>System.Management.Automation.SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">

        <maml:name>ComputerName</maml:name>

        <maml:Description>

          <maml:para>The computer you are performing this check on.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>Credential</maml:name>

        <maml:Description>

          <maml:para>Your credentials for the share you are validating.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</command:parameterValue>

        <dev:type>

          <maml:name>System.Management.Automation.PSCredential</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">

        <maml:name>Path</maml:name>

        <maml:Description>

          <maml:para>The UNC path of the share you are validating.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>Quiet</maml:name>

        <maml:Description>

          <maml:para>Suppresses writing output report to console.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>

        <dev:type>

          <maml:name>System.Management.Automation.SwitchParameter</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>SkipNamespaceChecks</maml:name>

        <maml:Description>

          <maml:para>Set this flag to skip file namespace validations and only perform system validations.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>

        <dev:type>

          <maml:name>System.Management.Automation.SwitchParameter</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>SkipSystemChecks</maml:name>

        <maml:Description>

          <maml:para>Set this flag to skip system validations and only perform file namespace validations.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>

        <dev:type>

          <maml:name>System.Management.Automation.SwitchParameter</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>None</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>Microsoft.Azure.Commands.StorageSync.Evaluation.Models.PSValidationResult</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para>* Keywords: azure, azurerm, arm, resource, management, storagesync, filesync</maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>Example 1</maml:title>

        <dev:code>PS C:\&gt; Invoke-AzureRmStorageSyncCompatibilityCheck C:\DATA</dev:code>

        <dev:remarks>

          <maml:para>This command checks the compatibility of the system and also of files and folders in C:\DATA.</maml:para>

<maml:para></maml:para>

<maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>Example 2</maml:title>

        <dev:code>PS C:\&gt; Invoke-AzureRmStorageSyncCompatibilityCheck C:\DATA -SkipSystemChecks</dev:code>

        <dev:remarks>

          <maml:para>This command checks the compatibility of files and folders in C:\DATA, but does not perform a system compatibility check.</maml:para>

<maml:para></maml:para>

<maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>Example 3</maml:title>

        <dev:code>PS C:\&gt; $errors = Invoke-AzureRmStorageSyncCompatibilityCheck C:\DATA

PS C:\&gt; $errors | Select-Object -Property Type, Path, Level, Description, Result | Export-Csv -Path C:\results</dev:code>

        <dev:remarks>

          <maml:para>This command checks the compatibility of the system and also of files and folders in C:\DATA, and then exports the results as a CSV file to C:\results.</maml:para>

<maml:para></maml:para>

<maml:para></maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks>

      <maml:navigationLink>

        <maml:linkText>Online Version:</maml:linkText>

        <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.storagesync/invoke-azurermstoragesynccompatibilitycheck</maml:uri>

      </maml:navigationLink>

    </command:relatedLinks>

  </command:command>

</helpItems>