Add Rule for Deprecated partition_key_path in azurerm_cosmosdb_sql_container #356
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces a new custom rule to detect the use of the deprecated partition_key_path attribute in the azurerm_cosmosdb_sql_container resource. The rule warns users to replace partition_key_path with the updated partition_key_paths attribute, which will be required in future versions of the AzureRM provider.
Key Changes:
New Rule: azurerm_cosmosdb_sql_container_deprecated_partition_key_path:
Added a rule to identify the deprecated partition_key_path in azurerm_cosmosdb_sql_container Terraform resources.
The rule emits a warning when partition_key_path is found, suggesting to update to partition_key_paths.
Test Coverage:
Added test cases to validate that the rule correctly detects partition_key_path and emits the appropriate warning.
Ensured that valid configurations using partition_key_paths pass without any issues.
Benefits:
Ensures Terraform configurations are updated according to the latest AzureRM provider requirements.
Helps users avoid breaking changes in future AzureRM versions by warning about deprecated attributes.
Next Steps:
Users are encouraged to update their Terraform configurations by replacing partition_key_path with partition_key_paths in affected resources.