Restore-AzureRmWebAppBackup
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Restore-AzureRmWebAppBackup
[-AppServicePlan <String>]
[-Databases <DatabaseBackupSetting[]>]
[-IgnoreConflictingHostNames]
[-ResourceGroupName] <String>
[-Name] <String>
[[-Slot] <String>]
[-DefaultProfile <IAzureContextContainer>]
[-StorageAccountUrl] <String>
[-BlobName] <String>
[-Overwrite]
[<CommonParameters>] Restore-AzureRmWebAppBackup
[-AppServicePlan <String>]
[-Databases <DatabaseBackupSetting[]>]
[-IgnoreConflictingHostNames]
[-WebApp] <PSSite>
[-DefaultProfile <IAzureContextContainer>]
[-StorageAccountUrl] <String>
[-BlobName] <String>
[-Overwrite]
[<CommonParameters>] Description
The Restore-AzureRmWebAppBackup cmdlet restores an Azure Web App Backup.
Examples
1:
PS C:\> Restore-AzureRmWebAppBackup -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -StorageAccountUrl "https://storageaccount.file.core.windows.net" -BlobName "myBlob"Restores a backup of the specified app ContosoWebApp that is within resource group Default-Web-WestUS in blob "myBlob" located at https://storageaccount.file.core.windows.net
Parameters
-AppServicePlan
The name of the App Service Plan for the restored app. If left empty, the app's current App Service Plan is used.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-BlobName
Blob Name
| Type: | String |
| Position: | 4 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Databases
Databases of type DatabaseBackupSetting[]
| Type: | DatabaseBackupSetting[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
| Type: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IgnoreConflictingHostNames
Ignore Conflicting HostNames Option
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
WebApp Name
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Overwrite
Overwrite Option
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceGroupName
Resource Group Name
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Slot
WebApp Slot Name
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-StorageAccountUrl
Storage Account Url
| Type: | String |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WebApp
WebApp Object
| Type: | PSSite |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Inputs
Parameters: WebApp (ByValue)