Skip to content

[System.ClientModel] Add a WaitUntil equivalent for long-running operations #61721

Description

@JoshLove-msft

Description

System.ClientModel does not have an equivalent of Azure.WaitUntil for indicating whether an LRO method should return after the operation starts or wait until it completes.

The unbranded LRO generator currently has to use a bool waitUntilCompleted, which is less expressive and diverges from the established Azure.Core API shape.

This gap was identified while adding unbranded LRO generation in #61699.

Proposed API

Add a public enum in the System.ClientModel surface equivalent to Azure.Core's WaitUntil, with values representing:

Completed
Started

The name and namespace should be finalized through API review, but the generated LRO method shape should be able to use the enum instead of a boolean.

Acceptance criteria

  • System.ClientModel exposes a public enum representing started-versus-completed LRO behavior.
  • Unbranded generated LRO methods can use the enum in their public signatures.
  • XML documentation clearly describes both values.

Metadata

Metadata

Assignees

No one assigned

    Labels

    ClientThis issue points to a problem in the data-plane of the library.System.ClientModelBase Core libraryfeature-requestThis issue requires a new behavior in the product in order be resolved.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions