Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Disable-AzRecoveryServicesBackupAutoProtection
- Module:
- Az.RecoveryServices Module
Disables auto backup for a protectable item.
Syntax
Default (Default)
Disable-AzRecoveryServicesBackupAutoProtection
[-InputItem] <ProtectableItemBase>
[-BackupManagementType] <BackupManagementType>
[-WorkloadType] <WorkloadType>
[-PassThru]
[-VaultId <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Disable-AzRecoveryServicesBackupAutoProtection cmdlet disables protection on a protectable item.
Examples
Example 1
$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName"
$container = Get-AzRecoveryServicesBackupContainer -ContainerType AzureVMAppContainer -Status "Registered" -FriendlyName "TestSQLServerVM" -VaultId $vault.ID
Get-AzRecoveryServicesBackupProtectableItem -Container $container -WorkloadType "MSSQL" -ItemType "SQLInstance" -Name "MSSQLInstance" | Disable-AzRecoveryServicesBackupAutoProtection -BackupManagementType "AzureWorkload" -WorkloadType "MSSQL"
The first cmdlet gets the Backup container of type AzureVMAppContainer. The second cmdlet gets the protectable BackupItem and disables auto protection.
Example 2
Disables auto backup for a protectable item. (autogenerated)
Disable-AzRecoveryServicesBackupAutoProtection -BackupManagementType AzureVM -InputItem <ProtectableItemBase> -VaultId $vault.ID -WorkloadType AzureVM
Parameters
-BackupManagementType
The class of resources being protected. Currently the value supported for this cmdlet is AzureWorkload
Parameter properties
| Type: | BackupManagementType |
| Default value: | None |
| Accepted values: | AzureWorkload |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-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
-InputItem
Item Id
Parameter properties
| Type: | ProtectableItemBase |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PassThru
Return the result for auto protection.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-VaultId
ARM ID of the Recovery Services Vault.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-WorkloadType
Workload type of the resource. The current supported value is "MSSQL"
Parameter properties
| Type: | WorkloadType |
| Default value: | None |
| Accepted values: | MSSQL |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
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.
Inputs
String
Outputs
Boolean
Azure PowerShell
Feedback
Was this page helpful?