AzureFileshareProtectedItem Class

Azure File Share workload-specific backup item.

Constructor

AzureFileshareProtectedItem()

Variables

Name	Description
backupManagementType	Union[str, <xref:"BackupManagementType">] Type of backup management for the backed up item. Known values are: "Invalid", "AzureIaasVM", "MAB", "DPM", "AzureBackupServer", "AzureSql", "AzureStorage", "AzureWorkload", and "DefaultBackup".
workloadType	Union[str, <xref:"DataSourceType">] Type of workload this item represents. Known values are: "Invalid", "VM", "FileFolder", "AzureSqlDb", "SQLDB", "Exchange", "Sharepoint", "VMwareVM", "SystemState", "Client", "GenericDataSource", "SQLDataBase", "AzureFileShare", "SAPHanaDatabase", "SAPAseDatabase", and "SAPHanaDBInstance".
containerName	str Unique name of container.
sourceResourceId	str ARM ID of the resource to be backed up.
policyId	str ID of the backup policy with which this item is backed up.
lastRecoveryPoint	str Timestamp when the last (latest) backup copy was created for this backup item.
backupSetName	str Name of the backup set the backup item belongs to.
createMode	Union[str, <xref:"CreateMode">] Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Known values are: "Invalid", "Default", and "Recover".
deferredDeleteTimeInUTC	str Time for deferred deletion in UTC.
isScheduledForDeferredDelete	bool Flag to identify whether the DS is scheduled for deferred delete.
deferredDeleteTimeRemaining	str Time remaining before the DS marked for deferred delete is permanently deleted.
isDeferredDeleteScheduleUpcoming	bool Flag to identify whether the deferred deleted DS is to be purged soon.
isRehydrate	bool Flag to identify that deferred deleted DS is to be moved into Pause state.
resourceGuardOperationRequests	list[str] ResourceGuardOperationRequests on which LAC check will be performed.
isArchiveEnabled	bool Flag to identify whether datasource is protected in archive.
policyName	str Name of the policy used for protection.
softDeleteRetentionPeriodInDays	int Soft delete retention period in days.
sourceLocation	str Source location of the protected item datasource.
vaultId	str ID of the vault which protects this item.
sourceSideScanInfo	<xref:<xref:"SourceSideScanInfo">> Source side threat information.
friendlyName	str Friendly name of the fileshare represented by this backup item.
protectionStatus	str Backup status of this backup item.
protectionState	Union[str, <xref:"ProtectionState">] Backup state of this backup item. Known values are: "Invalid", "IRPending", "Protected", "ProtectionError", "ProtectionStopped", "ProtectionPaused", and "BackupsSuspended".
lastBackupStatus	str Last backup operation status. Possible values: Healthy, Unhealthy.
lastBackupTime	str Timestamp of the last backup operation on this backup item.
kpisHealths	dict[str, <xref:"KPIResourceHealthDetails">] Health details of different KPIs.
extendedInfo	<xref:<xref:"AzureFileshareProtectedItemExtendedInfo">> Additional information with this backup item.
protectedItemType	Literal["AzureFileShareProtectedItem"] backup item type. Required. Default value is "AzureFileShareProtectedItem".

Attributes

backupManagementType

"Invalid", "AzureIaasVM", "MAB", "DPM", "AzureBackupServer", "AzureSql", "AzureStorage", "AzureWorkload", and "DefaultBackup".

backupManagementType: str | BackupManagementType

backupSetName

Name of the backup set the backup item belongs to.

backupSetName: str

containerName

Unique name of container.

containerName: str

createMode

Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Known values are: "Invalid", "Default", and "Recover".

createMode: str | CreateMode

deferredDeleteTimeInUTC

Time for deferred deletion in UTC.

deferredDeleteTimeInUTC: str

deferredDeleteTimeRemaining

Time remaining before the DS marked for deferred delete is permanently deleted.

deferredDeleteTimeRemaining: str

extendedInfo

Additional information with this backup item.

extendedInfo: AzureFileshareProtectedItemExtendedInfo

friendlyName

Friendly name of the fileshare represented by this backup item.

friendlyName: str

isArchiveEnabled

Flag to identify whether datasource is protected in archive.

isArchiveEnabled: bool

isDeferredDeleteScheduleUpcoming

Flag to identify whether the deferred deleted DS is to be purged soon.

isDeferredDeleteScheduleUpcoming: bool

isRehydrate

Flag to identify that deferred deleted DS is to be moved into Pause state.

isRehydrate: bool

isScheduledForDeferredDelete

Flag to identify whether the DS is scheduled for deferred delete.

isScheduledForDeferredDelete: bool

kpisHealths

Health details of different KPIs.

kpisHealths: dict[str, 'KPIResourceHealthDetails']

lastBackupStatus

Healthy, Unhealthy.

lastBackupStatus: str

lastBackupTime

Timestamp of the last backup operation on this backup item.

lastBackupTime: str

lastRecoveryPoint

Timestamp when the last (latest) backup copy was created for this backup item.

lastRecoveryPoint: str

policyId

ID of the backup policy with which this item is backed up.

policyId: str

policyName

Name of the policy used for protection.

policyName: str

protectedItemType

backup item type. Required. Default value is "AzureFileShareProtectedItem".

protectedItemType: Required[Literal['AzureFileShareProtectedItem']]

protectionState

"Invalid", "IRPending", "Protected", "ProtectionError", "ProtectionStopped", "ProtectionPaused", and "BackupsSuspended".

protectionState: str | ProtectionState

protectionStatus

Backup status of this backup item.

protectionStatus: str

resourceGuardOperationRequests

ResourceGuardOperationRequests on which LAC check will be performed.

resourceGuardOperationRequests: list[str]

softDeleteRetentionPeriodInDays

Soft delete retention period in days.

softDeleteRetentionPeriodInDays: int

sourceLocation

Source location of the protected item datasource.

sourceLocation: str

sourceResourceId

ARM ID of the resource to be backed up.

sourceResourceId: str

sourceSideScanInfo

Source side threat information.

sourceSideScanInfo: SourceSideScanInfo

vaultId

ID of the vault which protects this item.

vaultId: str

workloadType

"Invalid", "VM", "FileFolder", "AzureSqlDb", "SQLDB", "Exchange", "Sharepoint", "VMwareVM", "SystemState", "Client", "GenericDataSource", "SQLDataBase", "AzureFileShare", "SAPHanaDatabase", "SAPAseDatabase", and "SAPHanaDBInstance".

workloadType: str | DataSourceType