Invoke-AzStorageSyncCompatibilityCheck
Checks for potential compatibility issues between your system and Azure File Sync.
Syntax
PathBased (Default)
Invoke-AzStorageSyncCompatibilityCheck
[-Path] <String>
[-Credential <PSCredential>]
[-SkipSystemChecks]
[-SkipNamespaceChecks]
[<CommonParameters>]
ComputerNameBased
Invoke-AzStorageSyncCompatibilityCheck
[-ComputerName] <String>
[-Credential <PSCredential>]
[-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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ComputerNameBased
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Credential
Your credentials for the share you are validating.
Parameter properties
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Path
The UNC path of the share you are validating.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
PathBased
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SkipNamespaceChecks
Set this flag to skip file namespace validations and only perform system validations.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
PathBased
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SkipSystemChecks
Set this flag to skip system validations and only perform file namespace validations.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None
Outputs
PSValidationResult
Notes
- Keywords: azure, Az, arm, resource, management, storagesync, filesync
