search

Azure / azure-rest-api-specs

The source for REST API specifications for Microsoft Azure.
MIT License
2.69k stars 5.12k forks source link

[BUG] Microsoft.Security pricings 2024-01-01 has incorrect scope in documentation #29808

Open tony-box opened 4 months ago

tony-box commented 4 months ago

API Spec link

https://github.com/Azure/azure-rest-api-specs/blob/main/specification/security/resource-manager/Microsoft.Security/stable/2024-01-01/pricings.json

API Spec version

2024-01-01

Describe the bug

The API documentation for Microsoft.Security pricings has the incorrect required scope. https://learn.microsoft.com/en-us/azure/templates/microsoft.security/2024-01-01/pricings?pivots=deployment-language-bicep

The documentation states the scope should be a ResourceGroup but the actual API expects a SubscriptionId or a ResourceId. This breaks the bicep linter which seems to look at the API documentation.

Expected behavior

The documentation should reflect the appropriate target scope for a pricing resource

Actual behavior

Attempting to deploy a pricing with target scope = resourceGroup fails with the error that only Subscription or Resource are allowed

Reproduction Steps

Attempting to deploy a pricing with target scope = resourceGroup

Environment

No response

v-jiaodi commented 4 months ago

@bamus1166 Please help take a look, thanks.

tfitzmac commented 4 months ago

pricing is an extension type so it should have a Scope property. The doc generation process was not correctly identifying it as an extension type, which means the Scope property was missing. I am fixing the docs issue and will regenerate the reference docs.