< Back

Remove-ArchivialProvider

Fri Jan 10, 2020 8:45 pm

NAME Remove-ArchivialProvider



SYNOPSIS

Removes the configured storage or messaging provider.





SYNTAX

Remove-ArchivialProvider -ProviderName <string> [<CommonParameters>]



Remove-ArchivialProvider -Provider <Provider> [<CommonParameters>]





DESCRIPTION

Providers are used to connect to external services for cloud storage backup or message notifications.



Removing a cloud storage provider means that new or updated files will not be backed up to that provider anymore,

but existing files stored at that provider will remain.



To view existing configured providers, run Get-ArchivialProviders. This command supports piping from

Get-ArchivialProviders or manual invoke from the provider name.





PARAMETERS

-ProviderName <string>

Specify the name of the provider to remove.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Provider <Provider>

Specify the object (from pipeline) to remove.



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

ArchivialLibrary.Providers.Provider

Specify the object (from pipeline) to remove.





OUTPUTS



---------- EXAMPLE 1 ----------



C:\\> Remove-ArchivialProvider -ProviderName "Azure"



Removes the configured Azure provider.



---------- EXAMPLE 2 ----------



C:\\> Get-ArchivialProvider | Where Name -eq "Azure" | Remove-ArchivialProvider



Removes the configured Azure provider, but using the pipeline scenario.





RELATED LINKS