Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Bicep Extensibility] Deprecating the term provider in favor of extension #14374

Open
6 of 7 tasks
shenglol opened this issue Jun 20, 2024 · 0 comments
Open
6 of 7 tasks

Comments

@shenglol
Copy link
Contributor

shenglol commented Jun 20, 2024

We plan to deprecate the term provider in Bicep and our public documentation, replacing it with extension for the following reasons:

  • Improve Clarity: The term provider is commonly associated with Azure Resource Providers within the context of ARM. Using provider to refer to a Bicep extensibility provider could lead to confusion. Conversely, the term extension is more intuitive and clearly conveys its purpose within the Bicep Extensibility context.
  • Avoid API Name Clash: To support deployment stacks as part of the Bicep Extensibility GA plan, we need to update the Microsoft.Resource/deployments API by adding a property to capture Bicep extensibility provider information in the API output. However, currently, the API output already includes a providers property, which lists the Azure Resource Providers involved in a template deployment. By using extensions instead, we can avoid conflicts with the existing providers property.

To avoid breaking changes for customers, we will follow these deprecation steps:

@shenglol shenglol added the enhancement New feature or request label Jun 20, 2024
@github-project-automation github-project-automation bot moved this to Todo in Bicep Jun 20, 2024
@shenglol shenglol changed the title [Bicep Extensibility] Deprecating the term provider in favor of extension [Bicep Extensibility Announcement] Deprecating the term provider in favor of extension Jun 20, 2024
@shenglol shenglol changed the title [Bicep Extensibility Announcement] Deprecating the term provider in favor of extension [Bicep Extensibility] Deprecating the term provider in favor of extension Jun 20, 2024
@shenglol shenglol pinned this issue Jun 24, 2024
shenglol added a commit that referenced this issue Jun 24, 2024
As the first step of addressing
#14374, this PR replaces the
provider keyword with the extension keyword. Using the provider keyword
will now trigger a warning diagnostic with a code fix to assist users in
migrating to the new keyword.

To reduce the scope of this PR, the use of `provider` within the Bicep
CLI, Bicep configuration, and the codebase will be replaced separately
in subsequent PRs.

Closes #14378.
###### Microsoft Reviewers: [Open in
CodeFlow](https://microsoft.github.io/open-pr/?codeflow=https://github.com/Azure/bicep/pull/14379)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Todo
Development

No branches or pull requests

1 participant