Azure / Azure/typespec-azure

Add templates to the Azure.Core library to make custom StatusMonitors easy to construct and use

Open
#1,872 0 comments 1 reaction 0 assignees View on GitHub
design:needed lib:azure-core
Dominant language
TypeScript
Stars
27
Forks
90
Avg merge
1d 22h
Merged PRs (30d)
156

Description

It is the recommended pattern that service teams explicitly define the shape of their StatusMonitor. Update the existing templates so that

- There is a model template that contains required standard properties that can be used with spread or `is` to define the status monitor
- Add an operation template to take a StatusMonitor model from the user and produce an opeation to get the status monitor
- Update documentation to recommend this pattern in creating LRO operations

Contributor guide

Open the contributing guide

Research direction

Start by locating the existing Azure.Core model and operation templates, then read the documentation for creating LRO operations. Confirm how templates accept user-defined StatusMonitor models and identify the expected standard properties. Done means both templates support the recommended pattern and the documentation explains how to use it.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.