1. Packages
  2. Azure Native
  3. API Docs
  4. web
  5. listWebAppBackupStatusSecrets
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.web.listWebAppBackupStatusSecrets

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Description for Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.

Uses Azure REST API version 2024-04-01.

Other available API versions: 2016-08-01, 2018-02-01, 2018-11-01, 2019-08-01, 2020-06-01, 2020-09-01, 2020-10-01, 2020-12-01, 2021-01-01, 2021-01-15, 2021-02-01, 2021-03-01, 2022-03-01, 2022-09-01, 2023-01-01, 2023-12-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native web [ApiVersion]. See the version guide for details.

Using listWebAppBackupStatusSecrets

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function listWebAppBackupStatusSecrets(args: ListWebAppBackupStatusSecretsArgs, opts?: InvokeOptions): Promise<ListWebAppBackupStatusSecretsResult>
function listWebAppBackupStatusSecretsOutput(args: ListWebAppBackupStatusSecretsOutputArgs, opts?: InvokeOptions): Output<ListWebAppBackupStatusSecretsResult>
Copy
def list_web_app_backup_status_secrets(backup_id: Optional[str] = None,
                                       backup_name: Optional[str] = None,
                                       backup_schedule: Optional[BackupSchedule] = None,
                                       databases: Optional[Sequence[DatabaseBackupSetting]] = None,
                                       enabled: Optional[bool] = None,
                                       kind: Optional[str] = None,
                                       name: Optional[str] = None,
                                       resource_group_name: Optional[str] = None,
                                       storage_account_url: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> ListWebAppBackupStatusSecretsResult
def list_web_app_backup_status_secrets_output(backup_id: Optional[pulumi.Input[str]] = None,
                                       backup_name: Optional[pulumi.Input[str]] = None,
                                       backup_schedule: Optional[pulumi.Input[BackupScheduleArgs]] = None,
                                       databases: Optional[pulumi.Input[Sequence[pulumi.Input[DatabaseBackupSettingArgs]]]] = None,
                                       enabled: Optional[pulumi.Input[bool]] = None,
                                       kind: Optional[pulumi.Input[str]] = None,
                                       name: Optional[pulumi.Input[str]] = None,
                                       resource_group_name: Optional[pulumi.Input[str]] = None,
                                       storage_account_url: Optional[pulumi.Input[str]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[ListWebAppBackupStatusSecretsResult]
Copy
func ListWebAppBackupStatusSecrets(ctx *Context, args *ListWebAppBackupStatusSecretsArgs, opts ...InvokeOption) (*ListWebAppBackupStatusSecretsResult, error)
func ListWebAppBackupStatusSecretsOutput(ctx *Context, args *ListWebAppBackupStatusSecretsOutputArgs, opts ...InvokeOption) ListWebAppBackupStatusSecretsResultOutput
Copy

> Note: This function is named ListWebAppBackupStatusSecrets in the Go SDK.

public static class ListWebAppBackupStatusSecrets 
{
    public static Task<ListWebAppBackupStatusSecretsResult> InvokeAsync(ListWebAppBackupStatusSecretsArgs args, InvokeOptions? opts = null)
    public static Output<ListWebAppBackupStatusSecretsResult> Invoke(ListWebAppBackupStatusSecretsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<ListWebAppBackupStatusSecretsResult> listWebAppBackupStatusSecrets(ListWebAppBackupStatusSecretsArgs args, InvokeOptions options)
public static Output<ListWebAppBackupStatusSecretsResult> listWebAppBackupStatusSecrets(ListWebAppBackupStatusSecretsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:web:listWebAppBackupStatusSecrets
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

BackupId
This property is required.
Changes to this property will trigger replacement.
string
ID of backup.
Name
This property is required.
Changes to this property will trigger replacement.
string
Name of web app.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
StorageAccountUrl This property is required. string
SAS URL to the container.
BackupName string
Name of the backup.
BackupSchedule Pulumi.AzureNative.Web.Inputs.BackupSchedule
Schedule for the backup if it is executed periodically.
Databases List<Pulumi.AzureNative.Web.Inputs.DatabaseBackupSetting>
Databases included in the backup.
Enabled bool
True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.
Kind string
Kind of resource.
BackupId
This property is required.
Changes to this property will trigger replacement.
string
ID of backup.
Name
This property is required.
Changes to this property will trigger replacement.
string
Name of web app.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
StorageAccountUrl This property is required. string
SAS URL to the container.
BackupName string
Name of the backup.
BackupSchedule BackupSchedule
Schedule for the backup if it is executed periodically.
Databases []DatabaseBackupSetting
Databases included in the backup.
Enabled bool
True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.
Kind string
Kind of resource.
backupId
This property is required.
Changes to this property will trigger replacement.
String
ID of backup.
name
This property is required.
Changes to this property will trigger replacement.
String
Name of web app.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group to which the resource belongs.
storageAccountUrl This property is required. String
SAS URL to the container.
backupName String
Name of the backup.
backupSchedule BackupSchedule
Schedule for the backup if it is executed periodically.
databases List<DatabaseBackupSetting>
Databases included in the backup.
enabled Boolean
True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.
kind String
Kind of resource.
backupId
This property is required.
Changes to this property will trigger replacement.
string
ID of backup.
name
This property is required.
Changes to this property will trigger replacement.
string
Name of web app.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
storageAccountUrl This property is required. string
SAS URL to the container.
backupName string
Name of the backup.
backupSchedule BackupSchedule
Schedule for the backup if it is executed periodically.
databases DatabaseBackupSetting[]
Databases included in the backup.
enabled boolean
True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.
kind string
Kind of resource.
backup_id
This property is required.
Changes to this property will trigger replacement.
str
ID of backup.
name
This property is required.
Changes to this property will trigger replacement.
str
Name of web app.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the resource group to which the resource belongs.
storage_account_url This property is required. str
SAS URL to the container.
backup_name str
Name of the backup.
backup_schedule BackupSchedule
Schedule for the backup if it is executed periodically.
databases Sequence[DatabaseBackupSetting]
Databases included in the backup.
enabled bool
True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.
kind str
Kind of resource.
backupId
This property is required.
Changes to this property will trigger replacement.
String
ID of backup.
name
This property is required.
Changes to this property will trigger replacement.
String
Name of web app.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group to which the resource belongs.
storageAccountUrl This property is required. String
SAS URL to the container.
backupName String
Name of the backup.
backupSchedule Property Map
Schedule for the backup if it is executed periodically.
databases List<Property Map>
Databases included in the backup.
enabled Boolean
True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.
kind String
Kind of resource.

listWebAppBackupStatusSecrets Result

The following output properties are available:

BackupId int
Id of the backup.
BlobName string
Name of the blob which contains data for this backup.
CorrelationId string
Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support.
Created string
Timestamp of the backup creation.
Databases List<Pulumi.AzureNative.Web.Outputs.DatabaseBackupSettingResponse>
List of databases included in the backup.
FinishedTimeStamp string
Timestamp when this backup finished.
Id string
Resource Id.
LastRestoreTimeStamp string
Timestamp of a last restore operation which used this backup.
Log string
Details regarding this backup. Might contain an error message.
Name string
Resource Name.
Scheduled bool
True if this backup has been created due to a schedule being triggered.
SizeInBytes double
Size of the backup in bytes.
Status string
Backup status.
StorageAccountUrl string
SAS URL for the storage account container which contains this backup.
Type string
Resource type.
WebsiteSizeInBytes double
Size of the original web app which has been backed up.
Kind string
Kind of resource.
BackupId int
Id of the backup.
BlobName string
Name of the blob which contains data for this backup.
CorrelationId string
Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support.
Created string
Timestamp of the backup creation.
Databases []DatabaseBackupSettingResponse
List of databases included in the backup.
FinishedTimeStamp string
Timestamp when this backup finished.
Id string
Resource Id.
LastRestoreTimeStamp string
Timestamp of a last restore operation which used this backup.
Log string
Details regarding this backup. Might contain an error message.
Name string
Resource Name.
Scheduled bool
True if this backup has been created due to a schedule being triggered.
SizeInBytes float64
Size of the backup in bytes.
Status string
Backup status.
StorageAccountUrl string
SAS URL for the storage account container which contains this backup.
Type string
Resource type.
WebsiteSizeInBytes float64
Size of the original web app which has been backed up.
Kind string
Kind of resource.
backupId Integer
Id of the backup.
blobName String
Name of the blob which contains data for this backup.
correlationId String
Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support.
created String
Timestamp of the backup creation.
databases List<DatabaseBackupSettingResponse>
List of databases included in the backup.
finishedTimeStamp String
Timestamp when this backup finished.
id String
Resource Id.
lastRestoreTimeStamp String
Timestamp of a last restore operation which used this backup.
log String
Details regarding this backup. Might contain an error message.
name String
Resource Name.
scheduled Boolean
True if this backup has been created due to a schedule being triggered.
sizeInBytes Double
Size of the backup in bytes.
status String
Backup status.
storageAccountUrl String
SAS URL for the storage account container which contains this backup.
type String
Resource type.
websiteSizeInBytes Double
Size of the original web app which has been backed up.
kind String
Kind of resource.
backupId number
Id of the backup.
blobName string
Name of the blob which contains data for this backup.
correlationId string
Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support.
created string
Timestamp of the backup creation.
databases DatabaseBackupSettingResponse[]
List of databases included in the backup.
finishedTimeStamp string
Timestamp when this backup finished.
id string
Resource Id.
lastRestoreTimeStamp string
Timestamp of a last restore operation which used this backup.
log string
Details regarding this backup. Might contain an error message.
name string
Resource Name.
scheduled boolean
True if this backup has been created due to a schedule being triggered.
sizeInBytes number
Size of the backup in bytes.
status string
Backup status.
storageAccountUrl string
SAS URL for the storage account container which contains this backup.
type string
Resource type.
websiteSizeInBytes number
Size of the original web app which has been backed up.
kind string
Kind of resource.
backup_id int
Id of the backup.
blob_name str
Name of the blob which contains data for this backup.
correlation_id str
Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support.
created str
Timestamp of the backup creation.
databases Sequence[DatabaseBackupSettingResponse]
List of databases included in the backup.
finished_time_stamp str
Timestamp when this backup finished.
id str
Resource Id.
last_restore_time_stamp str
Timestamp of a last restore operation which used this backup.
log str
Details regarding this backup. Might contain an error message.
name str
Resource Name.
scheduled bool
True if this backup has been created due to a schedule being triggered.
size_in_bytes float
Size of the backup in bytes.
status str
Backup status.
storage_account_url str
SAS URL for the storage account container which contains this backup.
type str
Resource type.
website_size_in_bytes float
Size of the original web app which has been backed up.
kind str
Kind of resource.
backupId Number
Id of the backup.
blobName String
Name of the blob which contains data for this backup.
correlationId String
Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support.
created String
Timestamp of the backup creation.
databases List<Property Map>
List of databases included in the backup.
finishedTimeStamp String
Timestamp when this backup finished.
id String
Resource Id.
lastRestoreTimeStamp String
Timestamp of a last restore operation which used this backup.
log String
Details regarding this backup. Might contain an error message.
name String
Resource Name.
scheduled Boolean
True if this backup has been created due to a schedule being triggered.
sizeInBytes Number
Size of the backup in bytes.
status String
Backup status.
storageAccountUrl String
SAS URL for the storage account container which contains this backup.
type String
Resource type.
websiteSizeInBytes Number
Size of the original web app which has been backed up.
kind String
Kind of resource.

Supporting Types

BackupSchedule

FrequencyInterval This property is required. int
How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day)
FrequencyUnit This property is required. Pulumi.AzureNative.Web.FrequencyUnit
The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7)
KeepAtLeastOneBackup This property is required. bool
True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
RetentionPeriodInDays This property is required. int
After how many days backups should be deleted.
StartTime string
When the schedule should start working.
FrequencyInterval This property is required. int
How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day)
FrequencyUnit This property is required. FrequencyUnit
The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7)
KeepAtLeastOneBackup This property is required. bool
True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
RetentionPeriodInDays This property is required. int
After how many days backups should be deleted.
StartTime string
When the schedule should start working.
frequencyInterval This property is required. Integer
How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day)
frequencyUnit This property is required. FrequencyUnit
The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7)
keepAtLeastOneBackup This property is required. Boolean
True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
retentionPeriodInDays This property is required. Integer
After how many days backups should be deleted.
startTime String
When the schedule should start working.
frequencyInterval This property is required. number
How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day)
frequencyUnit This property is required. FrequencyUnit
The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7)
keepAtLeastOneBackup This property is required. boolean
True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
retentionPeriodInDays This property is required. number
After how many days backups should be deleted.
startTime string
When the schedule should start working.
frequency_interval This property is required. int
How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day)
frequency_unit This property is required. FrequencyUnit
The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7)
keep_at_least_one_backup This property is required. bool
True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
retention_period_in_days This property is required. int
After how many days backups should be deleted.
start_time str
When the schedule should start working.
frequencyInterval This property is required. Number
How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day)
frequencyUnit This property is required. "Day" | "Hour"
The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7)
keepAtLeastOneBackup This property is required. Boolean
True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
retentionPeriodInDays This property is required. Number
After how many days backups should be deleted.
startTime String
When the schedule should start working.

DatabaseBackupSetting

DatabaseType This property is required. string | Pulumi.AzureNative.Web.DatabaseType
Database type (e.g. SqlAzure / MySql).
ConnectionString string
Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.
ConnectionStringName string
Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.
Name string
DatabaseType This property is required. string | DatabaseType
Database type (e.g. SqlAzure / MySql).
ConnectionString string
Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.
ConnectionStringName string
Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.
Name string
databaseType This property is required. String | DatabaseType
Database type (e.g. SqlAzure / MySql).
connectionString String
Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.
connectionStringName String
Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.
name String
databaseType This property is required. string | DatabaseType
Database type (e.g. SqlAzure / MySql).
connectionString string
Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.
connectionStringName string
Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.
name string
database_type This property is required. str | DatabaseType
Database type (e.g. SqlAzure / MySql).
connection_string str
Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.
connection_string_name str
Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.
name str
databaseType This property is required. String | "SqlAzure" | "MySql" | "LocalMySql" | "PostgreSql"
Database type (e.g. SqlAzure / MySql).
connectionString String
Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.
connectionStringName String
Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.
name String

DatabaseBackupSettingResponse

DatabaseType This property is required. string
Database type (e.g. SqlAzure / MySql).
ConnectionString string
Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.
ConnectionStringName string
Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.
Name string
DatabaseType This property is required. string
Database type (e.g. SqlAzure / MySql).
ConnectionString string
Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.
ConnectionStringName string
Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.
Name string
databaseType This property is required. String
Database type (e.g. SqlAzure / MySql).
connectionString String
Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.
connectionStringName String
Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.
name String
databaseType This property is required. string
Database type (e.g. SqlAzure / MySql).
connectionString string
Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.
connectionStringName string
Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.
name string
database_type This property is required. str
Database type (e.g. SqlAzure / MySql).
connection_string str
Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.
connection_string_name str
Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.
name str
databaseType This property is required. String
Database type (e.g. SqlAzure / MySql).
connectionString String
Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.
connectionStringName String
Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.
name String

DatabaseType

FrequencyUnit

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi