RestoreRequest Class

Reference

Description of a restore request.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance: azure.mgmt.web.v2020_12_01.models._models_py3.ProxyOnlyResource

RestoreRequest

Constructor

RestoreRequest(*, kind: str | None = None, storage_account_url: str | None = None, blob_name: str | None = None, overwrite: bool | None = None, site_name: str | None = None, databases: List[_models.DatabaseBackupSetting] | None = None, ignore_conflicting_host_names: bool = False, ignore_databases: bool = False, app_service_plan: str | None = None, operation_type: str | _models.BackupRestoreOperationType = 'Default', adjust_connection_strings: bool | None = None, hosting_environment: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
kind	str Kind of resource.
storage_account_url	str SAS URL to the container.
blob_name	str Name of a blob which contains the backup.
overwrite	bool `<code>true</code>` if the restore operation can overwrite target app; otherwise, `<code>false</code>`. `<code>true</code>` is needed if trying to restore over an existing app.
site_name	str Name of an app.
databases	list[DatabaseBackupSetting] Collection of databases which should be restored. This list has to match the list of databases included in the backup.
ignore_conflicting_host_names	bool Changes a logic when restoring an app with custom domains. `<code>true</code>` to remove custom domains automatically. If `<code>false</code>`, custom domains are added to the app's object when it is being restored, but that might fail due to conflicts during the operation.
ignore_databases	bool Ignore the databases and only restore the site content.
app_service_plan	str Specify app service plan that will own restored site.
operation_type	str or BackupRestoreOperationType Operation type. Known values are: "Default", "Clone", "Relocation", "Snapshot", and "CloudFS". Default value: Default
adjust_connection_strings	bool `<code>true</code>` if SiteConfig.ConnectionStrings should be set in new app; otherwise, `<code>false</code>`.
hosting_environment	str App Service Environment name, if needed (only when restoring an app to an App Service Environment).

Variables

Name	Description
id	str Resource Id.
name	str Resource Name.
kind	str Kind of resource.
type	str Resource type.
storage_account_url	str SAS URL to the container.
blob_name	str Name of a blob which contains the backup.
overwrite	bool `<code>true</code>` if the restore operation can overwrite target app; otherwise, `<code>false</code>`. `<code>true</code>` is needed if trying to restore over an existing app.
site_name	str Name of an app.
databases	list[DatabaseBackupSetting] Collection of databases which should be restored. This list has to match the list of databases included in the backup.
ignore_conflicting_host_names	bool Changes a logic when restoring an app with custom domains. `<code>true</code>` to remove custom domains automatically. If `<code>false</code>`, custom domains are added to the app's object when it is being restored, but that might fail due to conflicts during the operation.
ignore_databases	bool Ignore the databases and only restore the site content.
app_service_plan	str Specify app service plan that will own restored site.
operation_type	str or BackupRestoreOperationType Operation type. Known values are: "Default", "Clone", "Relocation", "Snapshot", and "CloudFS".
adjust_connection_strings	bool `<code>true</code>` if SiteConfig.ConnectionStrings should be set in new app; otherwise, `<code>false</code>`.
hosting_environment	str App Service Environment name, if needed (only when restoring an app to an App Service Environment).

Share via

RestoreRequest Class

Constructor

Keyword-Only Parameters

Variables

Additional resources