$filter does not work in "Backup Jobs - List" REST API.

Question

$filter does not work in "Backup Jobs - List" REST API.

Rosa Junior, Carlos 20

I am trying to use $filter in (Backup Jobs - List)[https://learn.microsoft.com/en-us/rest/api/backup/backup-jobs/list?view=rest-backup-2024-04-01&tabs=HTTP#list-jobs-with-time-filter] but with no success. This is how I have set up my URL:
https://management.azure.com/subscriptions/xxxxx/resourceGroups/yyyyy/providers/Microsoft.RecoveryServices/vaults/vvvvv/backupJobs?api-version=2024-04-01&$filter=startTime lt '2024-08-15 00:00:00 AM'.

But I still get records from after this date. I've tried other format as well like startTime lt '2024-08-15T00:00:00Z', which also does not work.

Am I missing something here?

SadiqhAhmed-MSFT 49,326 Reputation points Microsoft Employee Moderator

2024-08-22T09:17:32.21+00:00

@Rosa Junior, Carlos Greetings from Microsoft!

When using the $filter parameter in the Azure REST API, especially for the Backup Jobs API, getting the expected results can be tricky due to various factors such as correct syntax, time format, and API behavior. Please try the following suggestion:

Ensure that the date and time format in your filte

r query is correct. The API expects the date and time in the ISO 8601 format. For example, you can use startTime lt '2024-08-15T00:00:00Z' to specify the date and time in UTC.

Make sure that the date and time value is enclosed in single quotes. This is necessary for the filter query to be parsed correctly.

Ensure that the entire URL is properly encoded. Special characters like $ and single quotes should be URL-encoded. For example, the $filter parameter should be encoded as %24filter and single quotes as %27.

Here is an example of how your URL should look after applying these suggestions:

Let us know how it goes!
Rosa Junior, Carlos 20 Reputation points

2024-08-22T13:38:38.72+00:00
Hi @SadiqhAhmed-MSFT thanks for your response!

Ok I have now encoded the URL and tried your suggestion and a few different filters but still with no success when filtering the date field startTime.
I got these two filters to work:

"operation eq 'ConfigureBackup' and backupManagementType eq 'AzureIaasVM'" operation+eq+%27ConfigureBackup%27+and+backupManagementType+eq+%27AzureIaasVM%27

and

"status eq 'Failed'" status+eq+%27Failed%27

However if I try a simple date filter like the one you suggested and it does not work.
You mentioned the ISO 8601 format but the API docs show a bit of a different format so I've tried both, but none seems to work. Am I still missing something?
SadiqhAhmed-MSFT 49,326 Reputation points Microsoft Employee Moderator

2024-08-22T18:50:32.07+00:00

@Rosa Junior, Carlos Are you providing both start time and end time as the example has both?

Backup Jobs - List - REST API (Azure Recovery Services - Backup) | Microsoft Learn

$filter=startTime eq '2016-01-01 00:00:00 AM' and endTime eq '2017-11-29 00:00:00 AM'
Rosa Junior, Carlos 20 Reputation points

2024-08-23T13:12:14.56+00:00
Hi @SadiqhAhmed-MSFT
The behaviour here is a bit weird to explain:

"$filter": "startTime eq '2024-08-10 00:00:00 AM' and endTime eq '2024-08-11 00:00:00 AM'"

That actually does some filtering, I get back jobs that started on the 10th and ended on the 11th.
However if I change the operator to 'ge', 'le', 'gt' or 'lt', it stops filtering.

Or even if I just remove the endTime and keep the startTime only, it won't filter.
I ended up switching to the Resource Graph Resources API to get the records I needed (this one was also behaving weirdly until I added a sort statement).
It'd be nice to be able to filter using both fields startTime and endTime but so far I've just not been able to.

Either way, I appreciate your time and effort @SadiqhAhmed-MSFT
SadiqhAhmed-MSFT 49,326 Reputation points Microsoft Employee Moderator

2024-08-27T03:56:03.4333333+00:00

@Rosa Junior, Carlos Apologies for delayed response. Looks like the REST APIs and the resource graph APIs aren't yielding you an expected results. Considering your requirement, it is a good idea to reach out Azure technical support by raising a support request to assist you in this matter.

Please let us know if there are any challenges contacting Azure support. Here is the link - https://docs.microsoft.com/en-us/azure/azure-portal/supportability/how-to-create-azure-support-request to create support case.
Rosa Junior, Carlos 20 Reputation points

2024-08-27T11:08:31.36+00:00

@SadiqhAhmed-MSFT no worries, thank you for the links!
SadiqhAhmed-MSFT 49,326 Reputation points Microsoft Employee Moderator

2024-08-27T11:32:15.5033333+00:00

@Rosa Junior, Carlos Thanks for your kindness! :)

Your answer

SadiqhAhmed-MSFT 49,326 Reputation points Microsoft Employee Moderator

2024-08-22T09:17:32.21+00:00

@Rosa Junior, Carlos Greetings from Microsoft!

When using the $filter parameter in the Azure REST API, especially for the Backup Jobs API, getting the expected results can be tricky due to various factors such as correct syntax, time format, and API behavior. Please try the following suggestion:

Ensure that the date and time format in your filte

r query is correct. The API expects the date and time in the ISO 8601 format. For example, you can use startTime lt '2024-08-15T00:00:00Z' to specify the date and time in UTC.

Make sure that the date and time value is enclosed in single quotes. This is necessary for the filter query to be parsed correctly.

Ensure that the entire URL is properly encoded. Special characters like $ and single quotes should be URL-encoded. For example, the $filter parameter should be encoded as %24filter and single quotes as %27.

Here is an example of how your URL should look after applying these suggestions:

Let us know how it goes!
Rosa Junior, Carlos 20 Reputation points

2024-08-22T13:38:38.72+00:00

Hi @SadiqhAhmed-MSFT thanks for your response!

Ok I have now encoded the URL and tried your suggestion and a few different filters but still with no success when filtering the date field startTime.
I got these two filters to work:

"operation eq 'ConfigureBackup' and backupManagementType eq 'AzureIaasVM'" operation+eq+%27ConfigureBackup%27+and+backupManagementType+eq+%27AzureIaasVM%27

and

"status eq 'Failed'" status+eq+%27Failed%27

However if I try a simple date filter like the one you suggested and it does not work.
You mentioned the ISO 8601 format but the API docs show a bit of a different format so I've tried both, but none seems to work. Am I still missing something?
SadiqhAhmed-MSFT 49,326 Reputation points Microsoft Employee Moderator

2024-08-22T18:50:32.07+00:00

@Rosa Junior, Carlos Are you providing both start time and end time as the example has both?

Backup Jobs - List - REST API (Azure Recovery Services - Backup) | Microsoft Learn

$filter=startTime eq '2016-01-01 00:00:00 AM' and endTime eq '2017-11-29 00:00:00 AM'
Rosa Junior, Carlos 20 Reputation points

2024-08-23T13:12:14.56+00:00

Hi @SadiqhAhmed-MSFT
The behaviour here is a bit weird to explain:

"$filter": "startTime eq '2024-08-10 00:00:00 AM' and endTime eq '2024-08-11 00:00:00 AM'"

That actually does some filtering, I get back jobs that started on the 10th and ended on the 11th.
However if I change the operator to 'ge', 'le', 'gt' or 'lt', it stops filtering.

Or even if I just remove the endTime and keep the startTime only, it won't filter.
I ended up switching to the Resource Graph Resources API to get the records I needed (this one was also behaving weirdly until I added a sort statement).
It'd be nice to be able to filter using both fields startTime and endTime but so far I've just not been able to.

Either way, I appreciate your time and effort @SadiqhAhmed-MSFT
SadiqhAhmed-MSFT 49,326 Reputation points Microsoft Employee Moderator

2024-08-27T03:56:03.4333333+00:00

@Rosa Junior, Carlos Apologies for delayed response. Looks like the REST APIs and the resource graph APIs aren't yielding you an expected results. Considering your requirement, it is a good idea to reach out Azure technical support by raising a support request to assist you in this matter.

Please let us know if there are any challenges contacting Azure support. Here is the link - https://docs.microsoft.com/en-us/azure/azure-portal/supportability/how-to-create-azure-support-request to create support case.
Rosa Junior, Carlos 20 Reputation points

2024-08-27T11:08:31.36+00:00

@SadiqhAhmed-MSFT no worries, thank you for the links!
SadiqhAhmed-MSFT 49,326 Reputation points Microsoft Employee Moderator

2024-08-27T11:32:15.5033333+00:00

@Rosa Junior, Carlos Thanks for your kindness! :)

Share via

$filter does not work in "Backup Jobs - List" REST API.

Your answer