Share via

RestoreRequest interface

Package:
@azure/arm-appservice

Description of a restore request.

Extends
ProxyOnlyResource

Properties

adjustConnectionStrings

true if SiteConfig.ConnectionStrings should be set in new app; otherwise, false.
appServicePlan

Specify app service plan that will own restored site.
blobName

Name of a blob which contains the backup.
databases

Collection of databases which should be restored. This list has to match the list of databases included in the backup.
hostingEnvironment

App Service Environment name, if needed (only when restoring an app to an App Service Environment).
ignoreConflictingHostNames

Changes a logic when restoring an app with custom domains. true to remove custom domains automatically. If false, custom domains are added to the app's object when it is being restored, but that might fail due to conflicts during the operation.
ignoreDatabases

Ignore the databases and only restore the site content
operationType

Operation type.
overwrite

true if the restore operation can overwrite target app; otherwise, false. true is needed if trying to restore over an existing app.
siteName

Name of an app.
storageAccountUrl

SAS URL to the container.

Inherited Properties

id

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.
kind

Kind of resource.
name

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.
type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

adjustConnectionStrings

true if SiteConfig.ConnectionStrings should be set in new app; otherwise, false.

adjustConnectionStrings?: boolean

Property Value

boolean

appServicePlan

Specify app service plan that will own restored site.

appServicePlan?: string

Property Value

string

blobName

Name of a blob which contains the backup.

blobName?: string

Property Value

string

databases

Collection of databases which should be restored. This list has to match the list of databases included in the backup.

databases?: DatabaseBackupSetting[]

Property Value

DatabaseBackupSetting[]

hostingEnvironment

App Service Environment name, if needed (only when restoring an app to an App Service Environment).

hostingEnvironment?: string

Property Value

string

ignoreConflictingHostNames

Changes a logic when restoring an app with custom domains. true to remove custom domains automatically. If false, custom domains are added to the app's object when it is being restored, but that might fail due to conflicts during the operation.

ignoreConflictingHostNames?: boolean

Property Value

boolean

ignoreDatabases

Ignore the databases and only restore the site content

ignoreDatabases?: boolean

Property Value

boolean

operationType

Operation type.

operationType?: BackupRestoreOperationType

Property Value

BackupRestoreOperationType

overwrite

true if the restore operation can overwrite target app; otherwise, false. true is needed if trying to restore over an existing app.

overwrite?: boolean

Property Value

boolean

siteName

Name of an app.

siteName?: string

Property Value

string

storageAccountUrl

SAS URL to the container.

storageAccountUrl?: string

Property Value

string

Inherited Property Details

id

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyOnlyResource.id

kind

Kind of resource.

kind?: string

Property Value

string

Inherited From ProxyOnlyResource.kind

name

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyOnlyResource.name

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyOnlyResource.type