Adding Support for DedicatedGatewayRequestOptions and MaxIntegratedCacheStaleness

[JericHunter]

• Currently, the integrated cache (with the dedicated gateway) has a default expiration time for each of the entries in the cache (CacheEntryExpirationTime) of 5 minutes. Any response served from cache is guaranteed to be no staler than this CacheEntryExpirationTime. In the existing design, CacheEntryExpirationTime cannot be configured by customers.

• For customers to have more control over how stale each of their requests could be, we plan to introduce a new “RequestOption” called “MaxIntegratedCacheStaleness”. This option will allow the customer to set a lower bound on the lifespan of the response from the cache for each request. If the lifetime of the response stored in the cache is greater than the value indicated by “MaxIntegratedCacheStaleness”, that item will not be served from the cache and the request will go to the backend.

• Similar PRs: [Cosmos] Add max_integrated_cache_staleness param option to item methods azure-sdk-for-python#22946 / Added Dedicated Gateway MaxIntegratedCacheStaleness to CosmosItemRequestOptions and CosmosQueryRequestOptions azure-sdk-for-java#20971

• Related Docs: https://docs.microsoft.com/en-us/azure/cosmos-db/dedicated-gateway / https://docs.microsoft.com/en-us/azure/cosmos-db/integrated-cache

[check-enforcer]

This pull request is protected by Check Enforcer.

What is Check Enforcer?

Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass.

Why am I getting this message?

You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged.

What should I do now?

If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

What if I am onboarding a new service?

Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment:
/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run js - [service] - ci

[ghost]

Hi @JericHunter. Thank you for your interest in helping to improve the Azure SDK experience and for your contribution. We've noticed that there hasn't been recent engagement on this pull request. If this is still an active work stream, please let us know by pushing some changes or leaving a comment. Otherwise, we'll close this out in 7 days.

[ghost]

Hi @JericHunter. Thank you for your contribution. Since there hasn't been recent engagement, we're going to close this out. Feel free to respond with a comment containing "/reopen" if you'd like to continue working on these changes. Please be sure to use the command to reopen or remove the "no-recent-activity" label; otherwise, this is likely to be closed again with the next cleanup pass.