Add Garnet cache cluster PowerShell cmdlets

[kcheekuri]

Add PowerShell cmdlet support for Garnet cache cluster management under the Az.CosmosDB module. This includes:

• New-AzCosmosDBGarnetCluster: Create a new Garnet cache cluster
• Get-AzCosmosDBGarnetCluster: Get Garnet cluster(s) by name, resource group, or subscription
• Update-AzCosmosDBGarnetCluster: Update properties of an existing Garnet cluster (cluster type, extensions, auth method, persistence)
• Remove-AzCosmosDBGarnetCluster: Delete a Garnet cache cluster

Supporting changes:

• PSGarnetClusterGetResults model wrapper
• Garnet constants for help messages
• SDK autorest config updated to include 2026-04-01-preview openapi.json
• Module manifest updated to export new cmdlets
• ChangeLog updated

Description

Mandatory Checklist

• Please choose the target release of Azure PowerShell. (⚠️Target release is a different concept from API readiness. Please click below links for details.)

  • General release
  • Public preview
  • Private preview
  • Engineering build
  • No need for a release

• Check this box to confirm: I have read the Submitting Changes section of CONTRIBUTING.md and reviewed the following information:

• SHOULD update ChangeLog.md file(s) appropriately
  • Update src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.
    • A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header in the past tense.
  • Should not change ChangeLog.md if no new release is required, such as fixing test case only.
• SHOULD regenerate markdown help files if there is cmdlet API change. Instruction
• SHOULD have proper test coverage for changes in pull request.
• SHOULD NOT adjust version of module manually in pull request

[microsoft-github-policy-service]

Thank you for your contribution @kcheekuri! We will review the pull request and get back to you soon.

[Copilot]

Pull request overview

This PR adds new Az.CosmosDB cmdlets and supporting model/constants intended to manage “Garnet” cache clusters (create/get/update/delete), and wires them into the module export surface and changelog.

Changes:

• Added new Garnet cluster cmdlets: New-, Get-, Update-, Remove-AzCosmosDBGarnetCluster.
• Added a PowerShell-facing result wrapper model (PSGarnetClusterGetResults) and help-message constants.
• Updated module exports (psd1), CosmosDB management SDK AutoRest config (README), and CosmosDB module ChangeLog entry.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
src/CosmosDB/CosmosDB/Models/PSGarnetClusterGetResults.cs	Adds PowerShell wrapper types for Garnet cluster get results/properties.
src/CosmosDB/CosmosDB/Helpers/Constants.cs	Introduces help-message constants for the new cmdlets’ parameters.
src/CosmosDB/CosmosDB/Garnet/NewAzCosmosDBGarnetCluster.cs	Implements New-AzCosmosDBGarnetCluster cmdlet.
src/CosmosDB/CosmosDB/Garnet/GetAzCosmosDBGarnetCluster.cs	Implements Get-AzCosmosDBGarnetCluster cmdlet.
src/CosmosDB/CosmosDB/Garnet/UpdateAzCosmosDBGarnetCluster.cs	Implements Update-AzCosmosDBGarnetCluster cmdlet.
src/CosmosDB/CosmosDB/Garnet/RemoveAzCosmosDBGarnetCluster.cs	Implements Remove-AzCosmosDBGarnetCluster cmdlet.
src/CosmosDB/CosmosDB/ChangeLog.md	Adds an “Upcoming Release” entry describing the new cmdlets.
src/CosmosDB/CosmosDB/Az.CosmosDB.psd1	Exports the new cmdlets from the Az.CosmosDB module.
src/CosmosDB/CosmosDB.Management.Sdk/README.md	Updates AutoRest input configuration to include the 2026-04-01-preview Garnet OpenAPI.

Comments suppressed due to low confidence (8)

src/CosmosDB/CosmosDB/Garnet/NewAzCosmosDBGarnetCluster.cs:95

• CosmosDBManagementClient from the in-repo CosmosDB.Management.Sdk project does not currently expose a GarnetClusters operation group (there are no "Garnet"/"GarnetClusters" types in CosmosDB.Management.Sdk/Generated). These calls to CosmosDBManagementClient.GarnetClusters will fail to compile until the management SDK is regenerated and committed (or the correct SDK reference is added).

                GarnetClusterResource result = CosmosDBManagementClient.GarnetClusters.CreateUpdateWithHttpMessagesAsync(
                    ResourceGroupName,
                    Name,
                    garnetCluster).GetAwaiter().GetResult().Body;
                WriteObject(new PSGarnetClusterGetResults(result));

src/CosmosDB/CosmosDB/Garnet/NewAzCosmosDBGarnetCluster.cs:55

• Using SwitchParameter here only allows setting AvailabilityZone to true (presence) or leaving it unspecified; it doesn't allow explicitly setting it to false. Other CosmosDB cmdlets typically use nullable booleans (bool?) for these optional flags so callers can pass $true or $false.

        public SwitchParameter AvailabilityZone { get; set; }

src/CosmosDB/CosmosDB/Garnet/NewAzCosmosDBGarnetCluster.cs:79

• After changing the AvailabilityZone parameter to bool?, the model assignment should pass the value through directly rather than converting from a SwitchParameter.

                    AvailabilityZone = AvailabilityZone.IsPresent ? true : (bool?)null,

src/CosmosDB/CosmosDB/Garnet/NewAzCosmosDBGarnetCluster.cs:61

• Using SwitchParameter for Persistence prevents callers from explicitly setting persistence to false (it can only be enabled via switch presence). Consider using bool? to allow $true/$false and preserve 'not specified' via null.

        public SwitchParameter Persistence { get; set; }

src/CosmosDB/CosmosDB/Garnet/NewAzCosmosDBGarnetCluster.cs:81

• After changing the Persistence parameter to bool?, pass the value through directly into the SDK model instead of translating from a SwitchParameter.

                    Persistence = Persistence.IsPresent ? true : (bool?)null,

src/CosmosDB/CosmosDB/Garnet/GetAzCosmosDBGarnetCluster.cs:57

• When -Name is provided without -ResourceGroupName, this cmdlet currently ignores Name and returns all clusters in the subscription. Either Name should be rejected without a resource group, or the subscription list should be filtered by name.

            else
            {
                IEnumerable<GarnetClusterResource> garnetClusters = CosmosDBManagementClient.GarnetClusters.ListBySubscriptionWithHttpMessagesAsync().GetAwaiter().GetResult().Body;
                foreach (GarnetClusterResource garnetCluster in garnetClusters)
                {

src/CosmosDB/CosmosDB/Garnet/NewAzCosmosDBGarnetCluster.cs:27

• This PR adds four new cmdlets with non-trivial create/get/update/delete behavior, but no corresponding scenario tests (and recordings) were added under src/CosmosDB/CosmosDB.Test. CosmosDB already has extensive ScenarioTests coverage for other cmdlets, so these should be covered as well to prevent regressions.

    [Cmdlet(VerbsCommon.New, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "CosmosDBGarnetCluster", DefaultParameterSetName = NameParameterSet, SupportsShouldProcess = true), OutputType(typeof(PSGarnetClusterGetResults))]
    public class NewAzCosmosDBGarnetCluster : AzureCosmosDBCmdletBase

src/CosmosDB/CosmosDB/Garnet/GetAzCosmosDBGarnetCluster.cs:43

• This references CosmosDBManagementClient.GarnetClusters, but the in-repo CosmosDB.Management.Sdk project currently has no generated GarnetClusters operation group (no "Garnet" types under CosmosDB.Management.Sdk/Generated). This will not compile until the management SDK is regenerated/updated to include GarnetClusters.

                GarnetClusterResource garnetCluster = CosmosDBManagementClient.GarnetClusters.GetWithHttpMessagesAsync(ResourceGroupName, Name).GetAwaiter().GetResult().Body;
                WriteObject(new PSGarnetClusterGetResults(garnetCluster));

[Copilot]

Pull request overview

Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.

Comments suppressed due to low confidence (3)

src/CosmosDB/CosmosDB/Garnet/NewAzCosmosDBGarnetCluster.cs:28

• OutputType should describe objects written to the pipeline, not exceptions that may be thrown. Listing an exception type here can mislead tooling/help generation.

    [Cmdlet(VerbsCommon.New, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "CosmosDBGarnetCluster", DefaultParameterSetName = NameParameterSet, SupportsShouldProcess = true), OutputType(typeof(PSGarnetClusterResource), typeof(ConflictingResourceException))]

src/CosmosDB/CosmosDB/Garnet/NewAzCosmosDBGarnetCluster.cs:33

• No markdown help files were added/updated for the new Garnet cluster cmdlets (there are no src/CosmosDB/CosmosDB/help/*Garnet* files). This module keeps cmdlet help in src/CosmosDB/CosmosDB/help/, so these should be generated/checked in as part of adding new cmdlets.

    [Cmdlet(VerbsCommon.New, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "CosmosDBGarnetCluster", DefaultParameterSetName = NameParameterSet, SupportsShouldProcess = true), OutputType(typeof(PSGarnetClusterResource), typeof(ConflictingResourceException))]
    public class NewAzCosmosDBGarnetCluster : NewOrUpdateAzGarnetCluster
    {
        [Parameter(Mandatory = true, HelpMessage = Constants.GarnetClusterLocationHelpMessage)]
        [ValidateNotNullOrEmpty]
        public string Location { get; set; }

src/CosmosDB/CosmosDB/Garnet/NewAzCosmosDBGarnetCluster.cs:66

• The CosmosDB module has extensive scenario coverage under src/CosmosDB/CosmosDB.Test/ScenarioTests/, but there are no new scenario tests or session records for the newly added Garnet cluster cmdlets. Adding at least basic create/get/update/remove (including piping -InputObject / -ResourceId parameter sets) tests would help prevent regressions.

        public override void ExecuteCmdlet()
        {
            GarnetClusterResource existingCluster = null;
            try
            {
                existingCluster = CosmosDBManagementClient.GarnetClusters.GetWithHttpMessagesAsync(ResourceGroupName, ClusterName).GetAwaiter().GetResult().Body;
            }
            catch (CloudException e)
            {
                if (e.Response.StatusCode != System.Net.HttpStatusCode.NotFound)
                {
                    throw;
                }
            }

[Copilot]

Pull request overview

Copilot reviewed 11 out of 11 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (5)

src/CosmosDB/CosmosDB/Helpers/Constants.cs:332

• Help messages in this file consistently use “Resource ID” capitalization. This new Garnet help message uses “Resource id”, which is inconsistent in user-facing help output.

        public const string GarnetClusterSubnetIdHelpMessage = "Resource id of a subnet that this cluster's management service should have its network interface attached to.";

src/CosmosDB/CosmosDB/Garnet/NewOrUpdateAzGarnetCluster.cs:45

• The help message constrains -ClusterType to specific values, but the parameter currently accepts any string. Adding a PSArgumentCompleter (or ValidateSet) would make the cmdlet easier to use and fail earlier on invalid input.

        [Parameter(Mandatory = false, HelpMessage = Constants.GarnetClusterClusterTypeHelpMessage)]
        [ValidateNotNullOrEmpty]
        public string ClusterType { get; set; }

src/CosmosDB/CosmosDB/Garnet/NewAzCosmosDBGarnetCluster.cs:29

• This PR adds new cmdlets but does not add the corresponding markdown help files under src/CosmosDB/CosmosDB/help (e.g., New-AzCosmosDBGarnetCluster.md, Get-AzCosmosDBGarnetCluster.md, etc.). This will leave the module without up-to-date Get-Help content for the new surface area.

    [Cmdlet(VerbsCommon.New, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "CosmosDBGarnetCluster", DefaultParameterSetName = NameParameterSet, SupportsShouldProcess = true), OutputType(typeof(PSGarnetClusterResource), typeof(ConflictingResourceException))]
    public class NewAzCosmosDBGarnetCluster : NewOrUpdateAzGarnetCluster

src/CosmosDB/CosmosDB/Garnet/NewAzCosmosDBGarnetCluster.cs:55

• The new Garnet cluster cmdlets introduce create/get/update/delete behavior, but this PR doesn’t add CosmosDB scenario tests covering these cmdlets (compare with existing CosmosDB.Test ScenarioTests for other resource types). Adding at least a basic playback test for the CRUD flow would help prevent regressions.

        public override void ExecuteCmdlet()
        {
            GarnetClusterResource existingCluster = null;
            try

src/CosmosDB/CosmosDB/Garnet/NewOrUpdateAzGarnetCluster.cs:41

• The help message constrains -AuthenticationMethod to specific values, but the parameter currently accepts any string. Adding a PSArgumentCompleter (or ValidateSet) here would guide users and prevent accidental invalid values being sent to the service.

        [Parameter(Mandatory = false, HelpMessage = Constants.GarnetClusterAuthenticationMethodHelpMessage)]
        [ValidateNotNullOrEmpty]
        public string AuthenticationMethod { get; set; }

[Copilot]

Pull request overview

Copilot reviewed 12 out of 27 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (2)

src/CosmosDB/CosmosDB/Garnet/NewAzCosmosDBGarnetCluster.cs:28

• The module uses per-cmdlet markdown help files under src/CosmosDB/CosmosDB/help (e.g., help/Remove-AzManagedCassandraCluster.md), but this PR adds new Garnet cmdlets without adding corresponding help docs. This will leave the cmdlets undocumented in the module's help folder and can break doc/help validation steps that expect these files.

    [Cmdlet(VerbsCommon.New, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "CosmosDBGarnetCluster", DefaultParameterSetName = NameParameterSet, SupportsShouldProcess = true), OutputType(typeof(PSGarnetClusterResource), typeof(ConflictingResourceException))]

src/CosmosDB/CosmosDB/Garnet/NewAzCosmosDBGarnetCluster.cs:56

• New cmdlets introduce create/update/get/delete behavior for Garnet clusters, but there are no matching scenario tests under src/CosmosDB/CosmosDB.Test/ScenarioTests (the test project has coverage for other CosmosDB cmdlets, e.g. ManagedCassandraOperationsTests.ps1). Adding scenario tests (and recordings if applicable) would help prevent regressions in parameter sets and basic CRUD flows.

        public override void ExecuteCmdlet()
        {
            GarnetClusterResource existingCluster = null;
            try
            {

[Copilot]

Pull request overview

Copilot reviewed 12 out of 27 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (4)

src/CosmosDB/CosmosDB/Models/Garnet/PSGarnetClusterResourceProperties.cs:53

• The PowerShell model is missing an EndPoints property, so endpoint data from the service response can’t be returned to users.

        /// <summary>
        /// Gets or sets resource id of the subnet for the cluster's management service.
        /// </summary>
        public string SubnetId { get; set; }

src/CosmosDB/CosmosDB/Garnet/NewAzCosmosDBGarnetCluster.cs:52

• New Garnet cluster cmdlets are introduced here, but there are no corresponding scenario tests in src/CosmosDB/CosmosDB.Test/ScenarioTests (there are tests for Accounts/SQL/ManagedCassandra/etc.). Adding scenario tests for create/get/update/remove would help prevent regressions and align with the repo’s expected validation workflow.

        public override void ExecuteCmdlet()

src/CosmosDB/CosmosDB/Models/Garnet/PSGarnetClusterResourceProperties.cs:41

• PSGarnetClusterResourceProperties doesn’t surface the cluster EndPoints returned by the SDK (GarnetClusterResourceProperties.EndPoints). Since these endpoints are how clients connect to the cluster, omitting them makes Get-AzCosmosDBGarnetCluster output incomplete.

This issue also appears on line 49 of the same file.

            ProvisioningState = properties.ProvisioningState;
            SubnetId = properties.SubnetId;
            ReplicationFactor = properties.ReplicationFactor;
            ShardCount = properties.ShardCount;
            NodeSku = properties.NodeSku;
            AvailabilityZone = properties.AvailabilityZone;
            AuthenticationMethod = properties.AuthenticationMethod;
            Persistence = properties.Persistence;
            AllocationState = properties.AllocationState;
            ClusterType = properties.ClusterType;
            Extensions = properties.Extensions;

src/CosmosDB/CosmosDB/Garnet/NewAzCosmosDBGarnetCluster.cs:29

• This PR adds new cmdlets but doesn’t include the corresponding markdown help files under src/CosmosDB/CosmosDB/help/ (for example, New-AzCosmosDBGarnetCluster.md, Get-AzCosmosDBGarnetCluster.md, etc.). Without these, users won’t get Get-Help content consistent with the rest of the module.

This issue also appears on line 52 of the same file.

    [Cmdlet(VerbsCommon.New, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "CosmosDBGarnetCluster", DefaultParameterSetName = NameParameterSet, SupportsShouldProcess = true), OutputType(typeof(PSGarnetClusterResource), typeof(ConflictingResourceException))]
    public class NewAzCosmosDBGarnetCluster : NewOrUpdateAzGarnetCluster

[VeryEarly]

please merge swagger to azure-rest-api-specs, do not check in it here