Azure / Azure/azure-rest-api-specs

Unconsistent region for service tags API

Open
#21,590 3 comments 0 reactions 0 assignees View on GitHub
customer-reported needs-team-triage question Service Attention
Dominant language
TypeSpec
Stars
3.1k
Forks
5.9k
Avg merge
2d 22h
Merged PRs (30d)
444

Description

Hello,

In the [service tags API](https://learn.microsoft.com/en-us/rest/api/virtualnetwork/service-tags/list?tabs=HTTP#uri-parameters), the `region` attribute does not have a consistent value compared to the other Azure tools.

Here's a non exhaustive list:
* France Central is `centralfrance`
* France South is `southfrance`
* BrazilSoutheast is `brazilse`
* GermanyNorth is `germanyn`
...

The value is region should be eaither the full name (aka "France Central"), the sort name (aka frc) or the normalized name (aka francecentral). The last one would make sense in my opinion.

Here's a subset of the API response with the issue
```{
"changeNumber": "114",
"cloud": "Public",
"id": "/subscriptions/513f7e88-cb3c-4e80-a6bb-b3a4984cfa6a/providers/Microsoft.Network/serviceTags/Public",
"name": "Public",
"nextLink": "",
"type": "Microsoft.Network/serviceTags",
"values": [

...

{
"id": "ApiManagement.EastUS",
"name": "ApiManagement.EastUS",
"properties": {
"addressPrefixes": [
"20.88.154.20/31",
"40.71.10.204/31",
"40.71.13.128/28",
"52.224.186.99/32",
"2603:1030:210:402::140/124"
],
"changeNumber": "3",
"networkFeatures": [
"API",
"NSG",
"UDR",
"FW"
],
"region": "eastus",
"state": "GA",
"systemService": "AzureApiManagement"
},
"serviceTagChangeNumber": "114"
},
{
"id": "ApiManagement.EastUS2",
"name": "ApiManagement.EastUS2",
"properties": {
"addressPrefixes": [
"20.44.72.3/32",
"20.62.63.254/31",
"40.70.146.76/31",
"40.70.148.16/28",
"2603:1030:40c:402::140/124"
],
"changeNumber": "3",
"networkFeatures": [
"API",
"NSG",
"UDR",
"FW"
],
"region": "eastus2",
"state": "GA",
"systemService": "AzureApiManagement"
},
"serviceTagChangeNumber": "114"
},
{
"id": "ApiManagement.EastUS2EUAP",
"name": "ApiManagement.EastUS2EUAP",
"properties": {
"addressPrefixes": [
"20.47.232.184/31",
"40.74.146.80/31",
"40.74.147.32/28",
"52.253.229.253/32",
"2603:1030:40b:400::940/124"
],
"changeNumber": "3",
"networkFeatures": [
"API",
"NSG",
"UDR",
"FW"
],
"region": "eastus2euap",
"state": "GA",
"systemService": "AzureApiManagement"
},
"serviceTagChangeNumber": "114"
},
{
"id": "ApiManagement.FranceCentral",
"name": "ApiManagement.FranceCentral",
"properties": {
"addressPrefixes": [
"40.66.60.111/32",
"40.79.130.44/31",
"40.79.131.192/28",
"51.138.215.124/31",
"2603:1020:805:402::140/124"
],
"changeNumber": "3",
"networkFeatures": [
"API",
"NSG",
"UDR",
"FW"
],
"region": "centralfrance",
"state": "GA",
"systemService": "AzureApiManagement"
},
"serviceTagChangeNumber": "114"
},
{
"id": "ApiManagement.FranceSouth",
"name": "ApiManagement.FranceSouth",
"properties": {
"addressPrefixes": [
"20.39.80.2/32",
"40.79.178.68/31",
"40.79.179.192/28",
"2603:1020:905:402::140/124"
],
"changeNumber": "2",
"networkFeatures": [
"API",
"NSG",
"UDR",
"FW"
],
"region": "southfrance",
"state": "GA",
"systemService": "AzureApiManagement"
},
"serviceTagChangeNumber": "114"
},
{
"id": "ApiManagement.GermanyNorth",
"name": "ApiManagement.GermanyNorth",
"properties": {
"addressPrefixes": [
"51.116.0.0/32",
"51.116.59.0/28",
"2603:1020:d04:402::140/124"
],
"changeNumber": "2",
"networkFeatures": [
"API",
"NSG",
"UDR",
"FW"
],
"region": "germanyn",
"state": "GA",
"systemService": "AzureApiManagement"
},
"serviceTagChangeNumber": "114"
},
{
"id": "ApiManagement.GermanyWestCentral",
"name": "ApiManagement.GermanyWestCentral",
"properties": {
"addressPrefixes": [
"20.52.94.112/31",
"51.116.96.0/32",
"51.116.155.64/28",
"2603:1020:c04:402::140/124"
],
"changeNumber": "3",
"networkFeatures": [
"API",
"NSG",
"UDR",
"FW"
],
"region": "germanywc",
"state": "GA",
"systemService": "AzureApiManagement"
},
"serviceTagChangeNumber": "114"
},

...

]
}

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the linked Azure service tags API documentation and the repository specification for that API. Compare the documented region values with the response examples, then confirm the expected naming convention and verify that all affected regions use it consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure
Domain
api, cloud
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.