Client library for RecoveryServicesBackupClient
npm install --save @datafire/azure_recoveryservicesbackup_bms
let azure_recoveryservicesbackup_bms = require('@datafire/azure_recoveryservicesbackup_bms').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
It will validate followings
azure_recoveryservicesbackup_bms.ProtectionIntent_Validate({
"api-version": "",
"azureRegion": "",
"subscriptionId": "",
"parameters": {}
}, context)
object
string
: Client Api Version.string
: Azure region to hit Apistring
: The subscription Id.Get the container backup status
azure_recoveryservicesbackup_bms.BackupStatus_Get({
"api-version": "",
"azureRegion": "",
"subscriptionId": "",
"parameters": {}
}, context)
object
string
: Client Api Version.string
: Azure region to hit Apistring
: The subscription Id.It will validate if given feature with resource properties is supported in service
azure_recoveryservicesbackup_bms.FeatureSupport_Validate({
"api-version": "",
"azureRegion": "",
"subscriptionId": "",
"parameters": {}
}, context)
object
string
: Client Api Version.string
: Azure region to hit Apistring
: The subscription Id.Used to remove intent from an item
azure_recoveryservicesbackup_bms.ProtectionIntent_Delete({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"fabricName": "",
"intentObjectName": ""
}, context)
object
string
: Client Api Version.string
: The name of the recovery services vault.string
: The name of the resource group where the recovery services vault is present.string
: The subscription Id.string
: Fabric name associated with the intent.string
: Intent to be deleted.Output schema unknown
Provides the details of the protection intent up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.
azure_recoveryservicesbackup_bms.ProtectionIntent_Get({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"fabricName": "",
"intentObjectName": ""
}, context)
object
string
: Client Api Version.string
: The name of the recovery services vault.string
: The name of the resource group where the recovery services vault is present.string
: The subscription Id.string
: Fabric name associated with the backed up item.string
: Backed up item name whose details are to be fetched.Create Intent for Enabling backup of an item. This is a synchronous operation.
azure_recoveryservicesbackup_bms.ProtectionIntent_CreateOrUpdate({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"fabricName": "",
"intentObjectName": "",
"parameters": null
}, context)
object
string
: Client Api Version.string
: The name of the recovery services vault.string
: The name of the resource group where the recovery services vault is present.string
: The subscription Id.string
: Fabric name associated with the backup item.string
: Intent object name.Provides a pageable list of all intents that are present within a vault.
azure_recoveryservicesbackup_bms.BackupProtectionIntent_List({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": ""
}, context)
object
string
: Client Api Version.string
: The name of the recovery services vault.string
: The name of the resource group where the recovery services vault is present.string
: The subscription Id.string
: OData filter options.string
: skipToken Filter.Fetches the backup management usage summaries of the vault.
azure_recoveryservicesbackup_bms.BackupUsageSummaries_List({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": ""
}, context)
object
string
: Client Api Version.string
: The name of the recovery services vault.string
: The name of the resource group where the recovery services vault is present.string
: The subscription Id.string
: OData filter options.string
: skipToken Filter.object
: Azure backup goal feature specific request.string
: backup support feature type.object
: Azure IaaS VM workload-specific error information.integer
: Error code.string
: Localized error string.string
: Title: Typically, the entity that the error pertains to.array
: List of localized recommendations for above error code.string
object
: Azure IaaS VM workload-specific job object.array
: Gets or sets the state/actions applicable on this job like cancel/retry.string
(values: Invalid, Cancellable, Retriable)string
: Time elapsed during the execution of this job.array
: Error details on execution of this job.string
: Specifies whether the backup item is a Classic or an Azure Resource Manager VM.string
: ActivityId of job.string
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql, AzureStorage, AzureWorkload, DefaultBackup): Backup management type to execute the current job.string
: The end time.string
: Friendly name of the entity on which the current job is executing.string
: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.string
: The operation name.string
: The start time.string
: Job status.object
: Azure IaaS VM workload-specific additional information for job.string
: Non localized error message on job execution.string
: Time remaining for execution of this job.object
: Job internal properties.number
: Indicates progress of the job. Null if it has not started or completed.object
: Job properties.array
: List of tasks associated with this job.object
: Azure IaaS VM workload-specific job task details.string
: Time elapsed for task.string
: The end time.string
: The instanceId.number
: Progress of the task.string
: The start time.string
: The status.string
: Details about execution of the task.string
: The task display name.object
: Azure Recovery Services Vault specific protection intent item.string
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql, AzureStorage, AzureWorkload, DefaultBackup): Type of backup management for the backed up item.string
: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemIdstring
: ID of the backup policy with which this item is backed up.string
: backup protectionIntent type.string
(values: Invalid, NotProtected, Protecting, Protected, ProtectionFailed): Backup state of this backup item.string
: ARM ID of the resource to be backed up.object
: IaaS VM specific backup protection intent item.string
: Friendly name of the VM represented by this backup item.string
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql, AzureStorage, AzureWorkload, DefaultBackup): Type of backup management for the backed up item.string
: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemIdstring
: ID of the backup policy with which this item is backed up.string
: backup protectionIntent type.string
(values: Invalid, NotProtected, Protecting, Protected, ProtectionFailed): Backup state of this backup item.string
: ARM ID of the resource to be backed up.object
: Azure storage specific error informationinteger
: Error code.string
: Localized error string.array
: List of localized recommendations for above error code.string
object
: Azure storage specific job.array
: Gets or sets the state/actions applicable on this job like cancel/retry.string
(values: Invalid, Cancellable, Retriable)string
: Time elapsed during the execution of this job.array
: Error details on execution of this job.string
: Specifies friendly name of the storage account.string
: Specifies whether the Storage account is a Classic or an Azure Resource Manager Storage account.string
: ActivityId of job.string
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql, AzureStorage, AzureWorkload, DefaultBackup): Backup management type to execute the current job.string
: The end time.string
: Friendly name of the entity on which the current job is executing.string
: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.string
: The operation name.string
: The start time.string
: Job status.object
: Azure Storage workload-specific additional information for job.string
: Non localized error message on job execution.object
: Job properties.array
: List of tasks for this jobobject
: Azure storage workload specific job task details.string
: The status.string
: The task display name.object
: AzureResource(IaaS VM) Specific feature support requeststring
: Size of the resource: VM size(A/D series etc) in case of IaasVMstring
: SKUs (Premium/Managed etc) in case of IaasVMstring
: backup support feature type.object
: Response for feature support requests for Azure IaasVmstring
(values: Invalid, Supported, DefaultOFF, DefaultON, NotSupported): Support status of featureobject
: Azure Recovery Services Vault specific protection intent item.string
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql, AzureStorage, AzureWorkload, DefaultBackup): Type of backup management for the backed up item.string
: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemIdstring
: ID of the backup policy with which this item is backed up.string
: backup protectionIntent type.string
(values: Invalid, NotProtected, Protecting, Protected, ProtectionFailed): Backup state of this backup item.string
: ARM ID of the resource to be backed up.object
: Azure storage specific error informationstring
: Additional details for above error code.integer
: Error code.string
: Localized error string.string
: Title: Typically, the entity that the error pertains to.array
: List of localized recommendations for above error code.string
object
: Azure storage specific job.array
: Gets or sets the state/actions applicable on this job like cancel/retry.string
(values: Invalid, Cancellable, Retriable)string
: Time elapsed during the execution of this job.array
: Error details on execution of this job.string
: Workload type of the jobstring
: ActivityId of job.string
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql, AzureStorage, AzureWorkload, DefaultBackup): Backup management type to execute the current job.string
: The end time.string
: Friendly name of the entity on which the current job is executing.string
: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.string
: The operation name.string
: The start time.string
: Job status.object
: Azure VM workload-specific additional information for job.string
: Non localized error message on job execution.object
: Job properties.array
: List of tasks for this jobobject
: Azure VM workload specific job task details.string
: The status.string
: The task display name.object
: Azure Workload SQL Auto Protection intent item.string
(values: Invalid, SQLInstance, SQLDataBase, SAPHanaSystem, SAPHanaDatabase, SAPAseSystem, SAPAseDatabase): Workload item type of the item for which intent is to be setstring
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql, AzureStorage, AzureWorkload, DefaultBackup): Type of backup management for the backed up item.string
: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemIdstring
: ID of the backup policy with which this item is backed up.string
: backup protectionIntent type.string
(values: Invalid, NotProtected, Protecting, Protected, ProtectionFailed): Backup state of this backup item.string
: ARM ID of the resource to be backed up.object
: Query parameters to fetch backup summaries.string
(values: Invalid, BackupProtectedItemCountSummary, BackupProtectionContainerCountSummary): Backup management type for this container.object
: Backup management usages of a vault.integer
: Current value of usage.integer
: Limit of usage.string
: Next reset time of usage.string
: Quota period of usage.string
(values: Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond): Unit of the usage.object
: Backup management usage for vault.array
: The list of backup management usages for the given vault.object
: BackupStatus request.string
: Protectable Item Logical Namestring
: Entire ARM resource id of the resourcestring
(values: Invalid, VM, FileFolder, AzureSqlDb, SQLDB, Exchange, Sharepoint, VMwareVM, SystemState, Client, GenericDataSource, SQLDataBase, AzureFileShare, SAPHanaDatabase, SAPAseDatabase): Container Type - VM, SQLPaaS, DPM, AzureFileShare...object
: BackupStatus response.string
: Specifies the product specific container name. E.g. iaasvmcontainer;iaasvmcontainer;csname;vmname.string
: ErrorCode in case of intent failedstring
: ErrorMessage in case of intent failed.string
(values: Invalid, Azure): Specifies the fabric name - Azure or ADstring
: Specifies the policy name which is used for protectionstring
: Specifies the product specific ds name. E.g. vm;iaasvmcontainer;csname;vmname.string
(values: Invalid, NotProtected, Protecting, Protected, ProtectionFailed): Specifies whether the container is registered or notstring
: Container registration statusstring
: Specifies the arm resource id of the vaultobject
: DPM workload-specific error information.string
: Localized error string.array
: List of localized recommendations for above error code.string
object
: DPM workload-specific job object.array
: The state/actions applicable on this job like cancel/retry.string
(values: Invalid, Cancellable, Retriable)string
: Name of cluster/server protecting current backup item, if any.string
: Type of container.string
: DPM server name managing the backup item or backup job.string
: Time elapsed for job.array
: The errors.string
: Type of backup item.string
: ActivityId of job.string
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql, AzureStorage, AzureWorkload, DefaultBackup): Backup management type to execute the current job.string
: The end time.string
: Friendly name of the entity on which the current job is executing.string
: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.string
: The operation name.string
: The start time.string
: Job status.object
: Additional information on the DPM workload-specific job.string
: Non localized error message on job execution.object
: The job properties.array
: List of tasks associated with this job.object
: DPM workload-specific job task details.string
: Time elapsed for task.string
: The end time.string
: The start time.string
: The status.string
: The task display name.object
: Base class for feature requeststring
: backup support feature type.object
string
string
object
: Defines workload agnostic properties for a job.string
: ActivityId of job.string
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql, AzureStorage, AzureWorkload, DefaultBackup): Backup management type to execute the current job.string
: The end time.string
: Friendly name of the entity on which the current job is executing.string
: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.string
: The operation name.string
: The start time.string
: Job status.object
: Defines workload agnostic properties for a job.string
: Optional ETag.string
: Resource Id represents the complete path to the resource.string
: Resource location.string
: Resource name associated with the resource.object
: Resource tags.string
: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...object
: MAB workload-specific error information.string
: Localized error string.array
: List of localized recommendations.string
object
: MAB workload-specific job.array
: The state/actions applicable on jobs like cancel/retry.string
(values: Invalid, Cancellable, Retriable)string
: Time taken by job to run.array
: The errors.string
: Name of server protecting the DS.string
(values: Invalid, Unknown, IaasVMContainer, IaasVMServiceContainer, DPMContainer, AzureBackupServerContainer, MABContainer, Cluster, AzureSqlContainer, Windows, VCenter, VMAppContainer, SQLAGWorkLoadContainer, StorageContainer, GenericContainer): Server type of MAB container.string
(values: Invalid, VM, FileFolder, AzureSqlDb, SQLDB, Exchange, Sharepoint, VMwareVM, SystemState, Client, GenericDataSource, SQLDataBase, AzureFileShare, SAPHanaDatabase, SAPAseDatabase): Workload type of backup item.string
: ActivityId of job.string
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql, AzureStorage, AzureWorkload, DefaultBackup): Backup management type to execute the current job.string
: The end time.string
: Friendly name of the entity on which the current job is executing.string
: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.string
: The operation name.string
: The start time.string
: Job status.object
: Additional information for the MAB workload-specific job.string
: Non localized error message specific to this job.object
: The job properties.array
: List of tasks for this job.object
: MAB workload-specific job task details.string
: Time elapsed for task.string
: The end time.string
: The start time.string
: The status.string
: The task display name.object
: The name of usage.string
: Localized value of usage.string
: Value of usage.object
: Contract to validate if backup can be enabled on the given resource in a given vault and given configuration.string
: Configuration of VM if any needs to be validated like OS type etcstring
: ARM Virtual Machine Idstring
(values: Invalid, VM, FileFolder, AzureSqlDb, SQLDB, Exchange, Sharepoint, VMwareVM, SystemState, Client, GenericDataSource, SQLDataBase, AzureFileShare, SAPHanaDatabase, SAPAseDatabase): ProtectedItem Type- VM, SqlDataBase, AzureFileShare etcstring
: ARM id of the Recovery Services Vaultobject
: Response contract for enable backup validation requeststring
: Specifies the product specific container name. E.g. iaasvmcontainer;iaasvmcontainer;rgname;vmname. This is requiredstring
: Response error codestring
: Response error messagestring
: Specifies the product specific ds name. E.g. vm;iaasvmcontainer;rgname;vmname. This is required for portalstring
: Recommended action for userstring
(values: Invalid, Succeeded, Failed): Validation Statusobject
: Base class for backup ProtectionIntent.string
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql, AzureStorage, AzureWorkload, DefaultBackup): Type of backup management for the backed up item.string
: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemIdstring
: ID of the backup policy with which this item is backed up.string
: backup protectionIntent type.string
(values: Invalid, NotProtected, Protecting, Protected, ProtectionFailed): Backup state of this backup item.string
: ARM ID of the resource to be backed up.object
: Filters to list protection intent.string
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql, AzureStorage, AzureWorkload, DefaultBackup): Backup management type for the backed up itemstring
: Item name of the intentstring
(values: Invalid, SQLInstance, SQLAvailabilityGroupContainer): Type of workload this item representsstring
: Parent name of the intentobject
: Base class for backup ProtectionIntent.string
: Optional ETag.string
: Resource Id represents the complete path to the resource.string
: Resource location.string
: Resource name associated with the resource.object
: Resource tags.string
: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...object
: List of ProtectionIntent resourcesarray
: List of resources.string
: The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.object
: ARM Resource.string
: Optional ETag.string
: Resource Id represents the complete path to the resource.string
: Resource location.string
: Resource name associated with the resource.object
: Resource tags.string
: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...object
: Base for all lists of resources.string
: The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.Version | Tag | Published |
---|---|---|
4.0.0 | latest | 2yrs ago |