Edit

Share via

Get-AzRecoveryServicesBackupStatus

Module:
Az.RecoveryServices Module

Checks whether your ARM resource is backed up or not.

Syntax

Name (Default) 

Get-AzRecoveryServicesBackupStatus
    -Name <String>
    -ResourceGroupName <String>
    -Type <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

IdWorkload 

Get-AzRecoveryServicesBackupStatus
    -Type <String>
    -ResourceId <String>
    -ProtectableObjectName <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Id 

Get-AzRecoveryServicesBackupStatus
    -ResourceId <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The command returns null/empty if the specified resource is not protected under any Recovery Services vault in the subscription. When configuring backup fails, it may return vault details. If Azure Backup is failing, then look for the corresponding error code in the common issues section. If it is protected, the relevant vault details will be returned.

Examples

Example 1

Checks whether your ARM resource is backed up or not. (autogenerated)

Get-AzRecoveryServicesBackupStatus -Name 'myAzureVM' -ResourceGroupName 'myAzureVMRG' -Type AzureVM

Parameters

-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

-Name

Name of the Azure Resource whose representative item needs to be checked if it is already protected by some Recovery Services Vault in the subscription.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Name
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProtectableObjectName

Name of the Azure Resource whose representative item needs to be checked if it is already protected by some Recovery Services Vault in the subscription.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

IdWorkload
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ResourceGroupName

Name of the resource group of the Azure Resource whose representative item needs to be checked if it is already protected by some RecoveryServices Vault in the subscription.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Name
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceId

ID of the Azure Resource whose representative item needs to be checked if it is already protected by some RecoveryServices Vault in the subscription.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

IdWorkload
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
Id
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Type

Type of the Azure Resource whose representative item needs to be checked if it is already protected by some Recovery Services Vault in the subscription.

Parameter properties

Type:String
Default value:None
Accepted values:AzureVM, AzureFiles
Supports wildcards:False
DontShow:False

Parameter sets

Name
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
IdWorkload
Position:Named
Mandatory:True
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.

Inputs

String

Outputs

ResourceBackupStatus