Skip to content

Add how-to docs for Private Links, Private Endpoints, and NSP Configuration operations#3958

Open
Copilot wants to merge 2 commits intomainfrom
copilot/add-how-to-documentation-standard-operations
Open

Add how-to docs for Private Links, Private Endpoints, and NSP Configuration operations#3958
Copilot wants to merge 2 commits intomainfrom
copilot/add-how-to-documentation-standard-operations

Conversation

Copy link
Contributor

Copilot AI commented Feb 21, 2026

New how-to documentation for the standard ARM operation templates covering private networking scenarios. These templates exist in typespec-azure-resource-manager with samples but had no user-facing guides.

Three new pages under website/src/content/docs/docs/howtos/ARM/:

  • private-links.mdPrivateLink model + PrivateLinks<> interface (Read, ListByParent)
  • private-endpoints.mdPrivateEndpointConnectionResource model + PrivateEndpoints<> interface (full CRUD: Read, CreateOrUpdateAsync, CustomPatchAsync, DeleteAsync, ListByParent, plus sync variants)
  • network-security-perimeter.mdNspConfiguration model + NspConfigurations<> interface (Read, ListByParent, Action, ActionAsync), with a note on the v5 common-types minimum

Each doc covers: resource model definition → operations alias setup → wiring into @armResourceOperations interface → available operations table → complete example → child resource reuse pattern.

// Pattern shown in each doc
model PrivateEndpointConnection is PrivateEndpointConnectionResource;
alias PrivateEndpointOps = PrivateEndpoints<PrivateEndpointConnection>;

@armResourceOperations
interface Employees {
  getConnection is PrivateEndpointOps.Read<Employee>;
  createConnection is PrivateEndpointOps.CreateOrUpdateAsync<Employee>;
  deleteConnection is PrivateEndpointOps.DeleteAsync<Employee>;
  listConnections is PrivateEndpointOps.ListByParent<Employee>;
}

Pages auto-appear in the sidebar via the existing autogenerate config for the howtos directory.


🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

…twork Security Perimeter operations

Co-authored-by: markcowl <1054056+markcowl@users.noreply.github.com>
Copilot AI changed the title [WIP] Add how-to documentation for standard operation templates Add how-to docs for Private Links, Private Endpoints, and NSP Configuration operations Feb 21, 2026
Copilot AI requested a review from markcowl February 21, 2026 01:29
@markcowl markcowl marked this pull request as ready for review February 21, 2026 01:52
@azure-sdk
Copy link
Collaborator

No changes needing a change description found.

@markcowl
Copy link
Member

/azp run typespec-azure - CI

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@azure-sdk
Copy link
Collaborator

You can try these changes here

🛝 Playground 🌐 Website


The following example shows a complete service with NSP configuration support:

```typespec
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is that a copy of one of our examples? One thing I wanted to do as well with the examples is provide a

so we don't have dup and out dated examples

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It isn't precisely a copy (in either case) because it uses ListByParent instead of ListSinglePageByParent, but what would be the right format to include a reference to the playground sample? SHould we wait until your PR is merged/

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there isn't right now but if we want to have that it should be easy to add, just wanted to keep track of the samples to replace if we add it.
Created an issue if you can add what sample it would be and where so we can replace after #3968 you think its valuable for this one)


The following example shows a complete service with private link support:

```typespec
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants