Remove-CloudStorage Cmdlet

Parameters   Output Objects   Configuration Settings  

The Remove-CloudStorage cmdlet is used to delete files and directories from Cloud Storage providers.

Syntax

Remove-CloudStorage [parameters]

Remarks

The RemoteFile parameter determines which file to remove from the remote host. Wildcards (*) can be used to remove multiple files, and empty directories can also be deleted.

The following cloud storage providers require OAuth authentication:

• Box
• DropBox
• GoogleDrive
• OneDrive

For each of these providers, OAuthClientId and OAuthClientSecret are required to generate the OAuth token. The cmdlet will automatically fetch and cache OAuth tokens, which requires user-interaction the first time. Once the token has been cached the cmdlet will automatically use and refresh this token without additional interaction. The OAuthCacheDir parameter governs the location of the OAuth cache files, and passing the empty string to this parameter will disable OAuth caching entirely.

Service providers that do not require OAuth authentication have dedicated parameters for the necessary account credentials:

• Amazon S3: AmazonS3AccessKey and AmazonS3SecretKey
• Wasabi: WasabiAccessKey and WasabiSecretKey
• Azure Blob: AzureAccount and AzureBlobAccessKey
• SharePoint: SharePointUser, SharePointPassword, and SharePointURL

The cmdlets support pipeline input for some of their parameters. Prebuilding an object and piping it to the cmdlet is very useful, but should be used with caution to prevent security conflicts. Steps have been taken to decrease the risk of a possibly accidental pipe to the cmdlet, for instance, the Credential parameter cannot be piped to the cmdlet and must be specified manually.

#remove a single file from Amazon S3
Remove-CloudStorage -ServiceProvider Amazons3 -AmazonS3AccessKey $accesskey -AmazonS3SecretKey $secretkey -RemoteFile "test/delete_me.txt"

#remove all text files from a subfolder in Box
Remove-CloudStorage -ServiceProvider Box -OAuthClientId $boxid -OAuthClientSecret $boxsecret -RemoteFile "test/*.txt"

#remove a Wasabi directory/bucket (must be empty to suceed)
Remove-CloudStorage -ServiceProvider Wasabi -WasabiAccessKey $accesskey -WasabiSecretKey $secretkey -RemoteFile "myBucket"

Connection Handling

This cmdlet supports persistent connections through the Connection parameter. To establish a new CloudStorage connection, use the Connect-CloudStorage cmdlet. To close the connection, use the Disconnect-CloudStorage cmdlet.