Add how-to docs for Private Links, Private Endpoints, and NSP Configuration operations#3958
Add how-to docs for Private Links, Private Endpoints, and NSP Configuration operations#3958
Conversation
…twork Security Perimeter operations Co-authored-by: markcowl <1054056+markcowl@users.noreply.github.com>
|
No changes needing a change description found. |
|
/azp run typespec-azure - CI |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
You can try these changes here
|
|
|
||
| The following example shows a complete service with NSP configuration support: | ||
|
|
||
| ```typespec |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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/
There was a problem hiding this comment.
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 |
New how-to documentation for the standard ARM operation templates covering private networking scenarios. These templates exist in
typespec-azure-resource-managerwith samples but had no user-facing guides.Three new pages under
website/src/content/docs/docs/howtos/ARM/:private-links.md—PrivateLinkmodel +PrivateLinks<>interface (Read,ListByParent)private-endpoints.md—PrivateEndpointConnectionResourcemodel +PrivateEndpoints<>interface (full CRUD:Read,CreateOrUpdateAsync,CustomPatchAsync,DeleteAsync,ListByParent, plus sync variants)network-security-perimeter.md—NspConfigurationmodel +NspConfigurations<>interface (Read,ListByParent,Action,ActionAsync), with a note on the v5 common-types minimumEach doc covers: resource model definition → operations alias setup → wiring into
@armResourceOperationsinterface → available operations table → complete example → child resource reuse pattern.Pages auto-appear in the sidebar via the existing
autogenerateconfig 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.