KeyRefresh: Adds AzureKeyCredential support to enable key refresh scenarios

[kirankumarkolli]

Type of change

Please delete options that are not relevant.

• [] New feature (non-breaking change which adds functionality)

Description

CosmosClient supporting Azure.AzureKeyCredential
This capability enables applications to

• Leverage AzureKeyCredential type with Azure CosmosDB
• Leverage AzureKeyCredential.Update API to dynamically change credentials in-flight (with-out client re-creation)

New scenarios

• ResourceToken hot-swap: ResourceTokens are time-bound (max 24Hours). Token can now be hot-swapped with-out ComsosClient re-creation
• Hot swapping master key credentials (Primary <-> Secondary): For scenarios of keys recycle, clients can be refreshed with new credentials with-out re-creation

Sample usage

    AzureKeyCredential keyCredential = new AzureKeyCredential(<account-key/resource-token>);
    CosmosClient client = new CosmosClient(
            <Account Endpoint>,
            keyCredential);
    ....

    // Update key-credentials
    keyCredential.Update(<Refreshed account-key/resource-token>);

    ....

⚠️ Key changes are posible only through the AzureKeyCredential instance used during the CosmosClient creation

API changes

namespace Microsoft.Azure.Cosmos
{
    public class CosmosClient : IDisposable
    {
        public CosmosClient(
            string accountEndpoint,
            AzureKeyCredential authKeyOrResourceTokenCredential,
            CosmosClientOptions clientOptions = null);

         public Task<CosmosClient> CreateAndInitializeAsync(string accountEndpoint,
            AzureKeyCredential authKeyOrResourceTokenCredential,
            IReadOnlyList<(string databaseId, string containerId)> containers,
            CosmosClientOptions cosmosClientOptions = null,
            CancellationToken cancellationToken = default)
    }
}

namespace Microsoft.Azure.Cosmos.Fluent
{
    public class CosmosClientBuilder
    {
        public CosmosClientBuilder(
            string accountEndpoint,
            AzureKeyCredential authKeyOrResourceTokenCredential)
    }
}

Micro benchmark result

Closing issues

To automatically close an issue: closes #IssueNumber

[github-actions]

Please follow the required format: "[Internal] Category: (Adds|Fixes|Refactors|Removes) Description"

Internal should be used for PRs that have no customer impact. This flag is used to help generate the changelog to know which PRs should be included. Examples:
Diagnostics: Adds GetElapsedClientLatency to CosmosDiagnostics
PartitionKey: Fixes null reference when using default(PartitionKey)
[v4] Client Encryption: Refactors code to external project
[Internal] Query: Adds code generator for CosmosNumbers for easy additions in the future.

[FabianMeiswinkel]

LGTM except for few NITs

[github-actions]

Please follow the required format: "[Internal] Category: (Adds|Fixes|Refactors|Removes) Description"

Internal should be used for PRs that have no customer impact. This flag is used to help generate the changelog to know which PRs should be included. Examples:
Diagnostics: Adds GetElapsedClientLatency to CosmosDiagnostics
PartitionKey: Fixes null reference when using default(PartitionKey)
[v4] Client Encryption: Refactors code to external project
[Internal] Query: Adds code generator for CosmosNumbers for easy additions in the future.

[kirankumarkolli]

TODO: Needs to re-work the merge strategy (Other changes are showing up) :-(

[FabianMeiswinkel]

LGTM

Valid title, bad bot