Azure / Azure/azure-rest-api-specs

[FEATURE REQ] Add missing `inUseWithResource` field in IPAddressAvailabilityResult

Open
#28,564 0 comments 0 reactions 0 assignees View on GitHub
customer-reported feature-request Mgmt Network - Virtual Network question Service Attention
Dominant language
TypeSpec
Stars
3.1k
Forks
5.9k
Avg merge
3d 2h
Merged PRs (30d)
424

Description

### API Spec link

https://github.com/Azure/azure-rest-api-specs/blob/main/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/virtualNetwork.json

### API Spec version

2023-09-01

### Please describe the feature.

Docs page: https://learn.microsoft.com/en-us/rest/api/virtualnetwork/virtual-networks/check-ip-address-availability

When sending request for IP which is currently in use, I get response like this:
```
{
"available": false,
"availableIPAddresses": [
"10.0.2.4",
"10.0.2.5",
"10.0.2.6",
"10.0.2.7",
"10.0.2.8"
],
"isPlatformReserved": false,
"inUseWithResource": "/subscriptions//resourceGroups//providers/Microsoft.Network/networkInterfaces/"
}
```
This response contains extremely helpful field `inUseWithResource`, but this field is not documented anywhere.
It would be great to have it documented and added in SDKs.

Contributor guide

Open the contributing guide

Research direction

Start with specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/virtualNetwork.json, linked in the issue, and compare the IPAddressAvailabilityResult definition with the example response. Done means the inUseWithResource field is represented in the API specification and the requested documentation and SDK surfaces include it.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, openapi
Domain
api, cloud
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.