[Reference feedback]: CLI command to initiate adhoc backup documented to have rule name as required and others are optional which seems to be wrong

[jeevanions]

Type of issue

Other (describe below)

Reference command name

Command I used

az dataprotection backup-instance adhoc-backup \
    --rule-name "$BACKUP_POLICY_DEFAULT_RULE_NAME" \
    --resource-group "$VAULT_RG" \
    --vault-name "$VAULT_NAME" \
    --name "$BACKUP_INSTANCE"

I validated the parameter passed to this command and all are valid. Please advice which parameter is having issue. I tried to re-run this command with debug enabled after some time and still getting the blocked error message. I will update the debug log once Azure unblocks me.

This is so annoying that the error message are not providing any assistance.

Feedback

As per the documentation the ad-hoc backup command requires only the rule name and other parameters are marked as optional. The command doesnt work with just the rule name and the doc confuses even more.

I am using azure cli to trigger the adhoc backup and getting below error where it doesn't provide any clue which input has the issue.

(BMSUserErrorInvalidInput) Input provided for the call is invalid
Code: BMSUserErrorInvalidInput
Message: Input provided for the call is invalid
Additional Information:Type: UserFacingError
Info: {
    "message": "Input provided for the call is invalid",
    "recommendedAction": [
        "Please check the required inputs"
    ],
    "code": "BMSUserErrorInvalidInput",
    "target": "",
    "isRetryable": false,
    "isUserError": false,
    "properties": {
        "ActivityId": "a58d1782-0fdc-11f0-a975-4689437afdb3"
    }
}

On repeated attempts now ended up being blocked with below error message

(CloudDosTimeboudLimitReached) The operation is blocked, as a security precaution, since multiple attempts were made beyond an internal limit.
Code: CloudDosTimeboudLimitReached
Message: The operation is blocked, as a security precaution, since multiple attempts were made beyond an internal limit.
Additional Information:Type: UserFacingError
Info: {
    "message": "The operation is blocked, as a security precaution, since multiple attempts were made beyond an internal limit.",
    "recommendedAction": [
        "Please retry after few hours"
    ],
    "details": null,
    "code": "CloudDosTimeboudLimitReached",
    "target": "",
    "innerError": null,
    "isRetryable": false,
    "isUserError": false,
    "properties": {
        "ActivityId": "fb751cac-0fdd-11f0-9063-4689437afdb3"
    }
}

I am trying to take a backup of the Azure postgresql flexible server and could trigger a backup from Azure portal.

Command I used

az dataprotection backup-instance adhoc-backup \
    --rule-name "$BACKUP_POLICY_DEFAULT_RULE_NAME" \
    --resource-group "$VAULT_RG" \
    --vault-name "$VAULT_NAME" \
    --name "$BACKUP_INSTANCE"

I validated the parameter passed to this command and all are valid. Please advice which parameter is having issue. I tried to re-run this command with debug enabled after some time and still getting the blocked error message. I will update the debug log once Azure unblocks me.

This is so annoying that the error message are not providing any assistance.

Page URL

https://learn.microsoft.com/en-us/cli/azure/dataprotection/backup-instance?view=azure-cli-latest#az-dataprotection-backup-instance-adhoc-backup

Content source URL

https://github.com/MicrosoftDocs/azure-docs-cli/blob/main/docs-ref-autogen/Latest-version/latest/dataprotection/backup-instance.yml

Author

@mikefrobbins

Document Id

0567f838-4a61-00e0-fc9c-5348e1ce0fcf

[yonzhan]

Thank you for opening this issue, we will look into it.

[jeevanions]

Found where this is going wrong. I have inspected the Backup Policy in azure and mine looks like below. I was using the Default AzureRetentionRule in the policyRules as my --rule-name param value. This should the name of the "objectType": "AzureBackupRule" in the policyRules I would benefit to update the doc to have some example cli commands to get these values from existing resources. The error message returned from Azure does not pin point the issue here.

{
    "properties": {
        "policyRules": [
            {
                "lifecycles": [
                    {
                        "deleteAfter": {
                            "objectType": "AbsoluteDeleteOption",
                            "duration": "P6M"
                        },
                        "sourceDataStore": {
                            "dataStoreType": "VaultStore",
                            "objectType": "DataStoreInfoBase"
                        }
                    }
                ],
                "isDefault": false,
                "name": "Monthly",
                "objectType": "AzureRetentionRule"
            },
            {
                "lifecycles": [
                    {
                        "deleteAfter": {
                            "objectType": "AbsoluteDeleteOption",
                            "duration": "P10Y"
                        },
                        "sourceDataStore": {
                            "dataStoreType": "VaultStore",
                            "objectType": "DataStoreInfoBase"
                        }
                    }
                ],
                "isDefault": true,
                "name": "Default",
                "objectType": "AzureRetentionRule"
            },
            {
                "backupParameters": {
                    "backupType": "full",
                    "objectType": "AzureBackupParams"
                },
                "trigger": {
                    "schedule": {
                        "repeatingTimeIntervals": [
                            "R/2024-08-25T06:00:00-06:00/P1W",
                            "R/2024-08-26T06:00:00-06:00/P1W",
                            "R/2024-08-27T06:00:00-06:00/P1W",
                            "R/2024-08-28T06:00:00-06:00/P1W",
                            "R/2024-08-29T06:00:00-06:00/P1W",
                            "R/2024-08-30T06:00:00-06:00/P1W",
                            "R/2024-08-31T06:00:00-06:00/P1W"
                        ],
                        "timeZone": "Central Standard Time"
                    },
                    "taggingCriteria": [
                        {
                            "tagInfo": {
                                "tagName": "Monthly",
                                "id": "Monthly_"
                            },
                            "taggingPriority": 15,
                            "isDefault": false,
                            "criteria": [
                                {
                                    "absoluteCriteria": [
                                        "FirstOfMonth"
                                    ],
                                    "objectType": "ScheduleBasedBackupCriteria"
                                }
                            ]
                        },
                        {
                            "tagInfo": {
                                "tagName": "Default",
                                "id": "Default_"
                            },
                            "taggingPriority": 99,
                            "isDefault": true
                        }
                    ],
                    "objectType": "ScheduleBasedTriggerContext"
                },
                "dataStore": {
                    "dataStoreType": "VaultStore",
                    "objectType": "DataStoreInfoBase"
                },
                "name": "BackupWeekly",
                "objectType": "AzureBackupRule"
            }
        ],
        "datasourceTypes": [
            "Microsoft.DBforPostgreSQL/flexibleServers"
        ],
        "objectType": "BackupPolicy"
    },
    "id": "/sdfsdfsdfsdfs/dev-backup-policy",
    "name": "dev-backup-policy",
    "type": "Microsoft.DataProtection/backupVaults/backupPolicies",
    "apiVersion": "2025-01-01"
}