Azure / Azure/azure-rest-api-specs
Incorrect resource ID description for storage account in HDInsight API
- Dominant language
- TypeSpec
- Stars
- 3.1k
- Forks
- 5.9k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 444
Description
When I use the [API ](https://github.com/Azure/azure-rest-api-specs/blob/d29e6eb4894005c52e67cb4b5ac3faf031113e7d/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/cluster.json#L42)to create a cluster like the sample of [create cluster with network properties](https://github.com/Azure/azure-rest-api-specs/blob/d29e6eb4894005c52e67cb4b5ac3faf031113e7d/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/CreateHDInsightClusterWithCustomNetworkProperties.json), an error returned is as follows. Per the error message, the resource ID of storage account is required when NetworkProperties has ResourceProviderConnection set to Outbound. However, the [description ](https://github.com/Azure/azure-rest-api-specs/blob/d29e6eb4894005c52e67cb4b5ac3faf031113e7d/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/cluster.json#L1176)of resourceID of storage account in API is "The resource ID of storage account, only to be specified for Azure Data Lake Storage Gen 2.". Also, the ` resourceId ` of storage account is not required in the sample of create cluster with custom network properties. If I add "resourceId" in storageaccounts block, the resource could be created successfully.
The response error:
> " Resource ID is missing or invalid but required for storage account acctestsajog9v when NetworkProperties has ResourceProviderConnection set to Outbound. The ID takes format like /subscriptions/$SUBSCRIPTION_ID/resourceGroups/$RESOURCE_GROUP/providers/Microsoft.Storage/storageAccounts/$ACCOUNT_NAME and can be found in Storage Account Properties from Azure Portal"
Contributor guide
Research direction
Start with specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/cluster.json at the linked resourceId description and compare it with CreateHDInsightClusterWithCustomNetworkProperties.json. Update the description and sample so they reflect that resourceId is required when ResourceProviderConnection is set to Outbound, then validate the specification changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure
- Domain
- api, cloud
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100