Set-AzSqlInstanceDatabaseLongTermRetentionBackupLegalHold
Sets legal hold immutability on a Managed Instance LTR backup. (Public Preview)
Syntax
Default (Default)
Set-AzSqlInstanceDatabaseLongTermRetentionBackupLegalHold
[-Location] <String>
[-InstanceName] <String>
[-DatabaseName] <String>
[-BackupName] <String>
[-ResourceGroupName <String>]
[-Force]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzSqlInstanceDatabaseLongTermRetentionBackupLegalHold
[-InputObject] <AzureSqlManagedDatabaseLongTermRetentionBackupModel>
[-Force]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ResourceId
Set-AzSqlInstanceDatabaseLongTermRetentionBackupLegalHold
[-ResourceId] <String>
[-Force]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Sets a legal hold on a Managed Instance long-term retention backup.
The backup cannot be deleted and does not expire until the legal hold is removed.
Examples
Example 1: Set a legal hold
Set-AzSqlInstanceDatabaseLongTermRetentionBackupLegalHold -Location southeastasia -ResourceGroupName testResourceGroup -InstanceName testInstance -DatabaseName testDatabase -BackupName "15be823c-7e2c-49d8-819f-a3fdcad92215;132268250550000000" -PassThru
Sets a legal hold on the specified backup and returns the updated backup.
Parameters
-BackupName
The name of the backup.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
Default
Position: 3 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DatabaseName
The name of the Managed Database the backup is from.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
Default
Position: 2 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Force
Skips the confirmation prompt.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
The Managed Instance long-term retention backup to update.
InputObject
Position: 0 Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-InstanceName
The name of the Managed Instance the backup is under.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
Default
Position: 1 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Location
The location of the backup's source Managed Instance.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
Default
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PassThru
Returns the updated backup.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group that contains the Managed Instance.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
Default
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceId
The resource ID of the Managed Instance long-term retention backup to update.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ResourceId
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
