https://github.com/Azure/bicep-types-az
Bicep type definitions for ARM resources
https://github.com/Azure/bicep-types-az
Last synced: about 13 hours ago
JSON representation
Bicep type definitions for ARM resources
- Host: GitHub
- URL: https://github.com/Azure/bicep-types-az
- Owner: Azure
- License: mit
- Created: 2020-09-29T16:31:20.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-19T13:08:09.000Z (12 months ago)
- Last Synced: 2024-05-20T09:29:28.641Z (12 months ago)
- Language: TypeScript
- Size: 90 MB
- Stars: 79
- Watchers: 17
- Forks: 27
- Open Issues: 374
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- AWESOME-Azure-Bicep - Bicep type definitions for ARM resources
README
 [](https://codecov.io/gh/Azure/bicep-types-az) [](https://dev.azure.com/msazure/One/_build/latest?definitionId=179851&repoName=BicepMirror-Types-Az&branchName=main)
# bicep-types-az
Bicep type definitions for ARM resources
## Browsing available types
See [/generated/index.md](./generated/index.md) for a searchable list of all the available types. You can view individual type definitions by clicking on api versions.
## Re-generating types from swagger
1. Under [GitHub Actions](https://github.com/azure/bicep-types-az/actions), run the "Update Types" workflow on the main branch. Usually you'll want to leave the git ref input as "master" for this workflow.
1. After ~2hrs, this action will generate a PR in this repo from a branch named `autogenerate`.
1. To workaround [this issue](https://github.com/peter-evans/create-pull-request/issues/48), close the PR and open it to trigger Merge Validation to run.
1. Merge the PR. Type differences can be reviewed by looking at the Markdown files in [/generated](./generated).
## Running generation locally
### Initial setup
1. Clone this repo
1. Check out submodules:
```sh
git submodule update --init --recursive
```
1. Build the `bicep-types` dependency:
```sh
pushd bicep-types/src/bicep-types
npm ci
npm run build
popd
```
1. Ensure you have a copy of the [azure-rest-api-specs](https://github.com/Azure/azure-rest-api-specs) repo checked out locally.
1. Build the autorest extension code:
```sh
cd src/autorest.bicep
npm ci
npm run build
```
1. Change to the generator directory, and install dependencies:
```sh
cd ../../src/generator
npm ci
```
### Running
1. To run generation across the entire specs repo:
```sh
npm run generate -- --specs-dir {path to azure-rest-api-specs}
```
1. To run generation for a single path in the specs repo (e.g. 'compute'):
```sh
npm run generate -- --specs-dir {path to azure-rest-api-specs} --single-path compute
```
1. To see other available generation parameters, including debugging options:
```sh
npm run generate -- --help
```
### Debugging in VSCode
1. Ensure you have cloned the [azure-rest-api-specs](https://github.com/Azure/azure-rest-api-specs) repo into the same directory that you have cloned this repo - e.g. so you have the following folder structure:
```
.
./bicep-types-az
./azure-rest-api-specs
```
1. Use the `Generate Single` VSCode action, and specify a 'base path' from the `specifications` folder in the [azure-rest-api-specs](https://github.com/Azure/azure-rest-api-specs) repo - e.g. `compute` or `automation`. You should now be able to step through the `src/generator` and `src/autorest.bicep` extension code with the VSCode debugger.
## Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.