Skip to content

Latest commit

 

History

History
154 lines (118 loc) · 3.91 KB

Invoke-AzStorageSyncCompatibilityCheck.md

File metadata and controls

154 lines (118 loc) · 3.91 KB
Raw
external help file Module Name online version schema
Microsoft.Azure.PowerShell.Cmdlets.StorageSync.dll-Help.xml
Az.StorageSync
2.0.0

Invoke-AzStorageSyncCompatibilityCheck

SYNOPSIS

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 [-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: System.String
Parameter Sets: ComputerNameBased
Aliases:

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

-Credential

Your credentials for the share you are validating.

Type: System.Management.Automation.PSCredential
Parameter Sets: (All)
Aliases:

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

-Path

The UNC path of the share you are validating.

Type: System.String
Parameter Sets: PathBased
Aliases:

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

-SkipNamespaceChecks

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

Type: System.Management.Automation.SwitchParameter
Parameter Sets: PathBased
Aliases:

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

-SkipSystemChecks

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

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

None

OUTPUTS

Microsoft.Azure.Commands.StorageSync.Evaluation.Models.PSValidationResult

NOTES

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

RELATED LINKS