Azure / Azure/azure-rest-api-specs

Network PrivateEndpointProperties calls for subnet as definitions/Subnet, but probably should be definitions/SubResource

Open
#24,611 1 comment 0 reactions 0 assignees View on GitHub
Network Service Attention
Dominant language
TypeSpec
Stars
3.1k
Forks
5.9k
Avg merge
2d 22h
Merged PRs (30d)
444

Description

"PrivateEndpointProperties": {
"properties": {
"subnet": {
"$ref": "./virtualNetwork.json#/definitions/Subnet",
"description": "The ID of the subnet from which the private IP will be allocated."
},

(from specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/privateEndpoint.json)

based on what comes back from the Microsoft.Network RP, it looks like that ref should be to SubResource, not Subnet

When run through autorest, this generates SDKs that use types that can confuse applications.

Contributor guide

Open the contributing guide

Research direction

Open specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/privateEndpoint.json and compare the subnet reference with the Subnet and SubResource definitions in virtualNetwork.json. Update the reference if the RP response confirms the issue, then run the specification through AutoRest and verify that the generated SDK uses the appropriate type.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
api
Issue type
Bug
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.