Incorrect example create_or_update body

[smokethis]

Have spent ages trying to troubleshoot this issue and found the root cause.

Problem

In the official documentation the example body for a filter.create_or_update request is:

   body = {
       "id": "str",  # Optional.
       "name": "str",  # Optional.
       "properties": {
           "excludeUriPrefixes": [
               "str"  # Optional.
           ],
           "includeUriPrefixes": [
               "str"  # Optional.
           ]
       }
   }

However, using this never works and Purview emits an HTTP 400 error with no further details.

Solution

Having traced the Purview Web UI behaviour when making the same change, I have found that the request body should actually contain the following:

   body = {
       "id": "str",  # Optional.
       "name": "str",  # Optional.
       "properties": {
           "excludeUriPrefixes": [
               "str"  # Optional.
           ],
           "includeUriPrefixes": [
               "str"  # Optional.
           ],
       "excludeRegexes": "str", # Mandatory.
       "includeRegexes": "str" # Mandatory.
       }
   }

When specifying the excludeRegexes and includeRegexes properties in the request through the SDK, specifying them as None, the request is successfully processed and the scan filter is updated.

Please check and update documentation and handle this error correctly to inform consumers of the incorrect request body content.

---

Document Details

⚠ Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.

• ID: aef29dff-2214-2a90-3872-0763bbf43cc7
• Version Independent ID: a8fe4273-36e9-3520-4c80-d673ced27dd4
• Content: azure.purview.scanning.operations.FiltersOperations class
• Content Source: preview/docs-ref-autogen/azure-purview-scanning/azure.purview.scanning.operations.FiltersOperations.yml
• GitHub Login: @VSC-Service-Account

[xiangyan99]

Thanks for the feedback, we’ll investigate asap.