Invoke-AzStorageSyncCompatibilityCheck

Reference

Module:: Az.StorageSync

Checks for potential compatibility issues between your system and Azure File Sync.

Syntax

Invoke-AzStorageSyncCompatibilityCheck
      [-Path] <String>
      [-Credential <PSCredential>]
      [-SkipSystemChecks]
      [-SkipNamespaceChecks]
      [<CommonParameters>]

Invoke-AzStorageSyncCompatibilityCheck
      [-Credential <PSCredential>]
      [-ComputerName] <String>
      [-SkipSystemChecks]
      [<CommonParameters>]

Description

The Invoke-AzStorageSyncCompatibilityCheck 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
Maximum file size
Maximum path length
Maximum file length
Maximum dataset size
Maximum directory depth

Examples

Example 1

Invoke-AzStorageSyncCompatibilityCheck C:\DATA

This command checks the compatibility of the system and also of files and folders in C:\DATA.

Example 2

Invoke-AzStorageSyncCompatibilityCheck C:\DATA -SkipSystemChecks

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

Example 3

$validation = Invoke-AzStorageSyncCompatibilityCheck C:\DATA
$validation.Results | Select-Object -Property Type, Path, Level, Description, Result | Export-Csv -Path C:\results.csv -Encoding utf8

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.

Parameters

-ComputerName

The computer you are performing this check on.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Credential

Your credentials for the share you are validating.

Type:	PSCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Path

The UNC path of the share you are validating.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SkipNamespaceChecks

Set this flag to skip file namespace validations and only perform system validations.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SkipSystemChecks

Set this flag to skip system validations and only perform file namespace validations.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

None

Outputs

PSValidationResult

Notes

Keywords: azure, Az, arm, resource, management, storagesync, filesync