# azapi-vscode

**Repository Path**: mirrors_Azure/azapi-vscode

## Basic Information

- **Project Name**: azapi-vscode
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MPL-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-04-13
- **Last Updated**: 2026-02-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Terraform AzApi Provider Visual Studio Code Extension

The Terraform AzApi Provider Visual Studio Code (VS Code) extension adds editing features like completion/hover/diagnositics for [terraform-provider-azapi](https://github.com/Azure/terraform-provider-azapi) Terraform files using the [Terraform AzApi Provider Language Server](https://github.com/Azure/azapi-lsp).

## ⚠️ Notice

⚠️ This project has been deprecated and archived. All the features of this project have been merged into the [vscode-azureterraform](https://github.com/Azure/vscode-azureterraform).

Please use the [Microsoft Terraform extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azureterraform) instead, which includes all the features of this extension and more.


## Features

- Manages the [Terraform AzApi Provider Language Server](https://github.com/Azure/azapi-lsp), exposing its features:
- Completion of `azapi` resources and data sources
- Completion of allowed azure resource types when input `type` in `azapi` resources
- Completion of allowed azure resource properties when input `body` in `azapi` resources, limitation: it only works when use `jsonencode` function to build the JSON
- Show hint when hover on `azapi` resources
- Diagnostics to indicate schema errors as you type
- Convert resource JSON to azapi configuration.
- Convert ARM template to azapi configuration.

## Demo

Completion of allowed azure resource types when input `type` in `azapi` resources

![intellisense being displayed for all available types for a resource](/images/list-types-intellisense.gif)

Completion of allowed azure resource properties when input `body` in `azapi` resources

![intellisense being displayed for available property names and property values where applicable of an azapi resource](/images/resource-property-names-and-values.gif)

Completion of required properties for any discriminated objects.

![intellisense being displayed for available required property names and property values where applicable of a discriminated object](/images/discriminated-object-property-names-and-values.gif)

Show hint when hover on `azapi` resources and diagnostics to indicate schema errors as you type.

![hint message being displayed when hover on an azapi property](/images/hovers.gif)

Paste resource JSON to the terraform configuration, it will convert to azapi configuration.

![convert resource JSON to azapi configuration](/images/paste-json-as-config.png)


Paste ARM template to the terraform configuration, it will convert to azapi configuration.

![convert ARM template to azapi configuration](/images/paste-arm-templates-as-config.png)

Migrate from AzureRM provider to AzApi provider. More details can be found in [Guide to migrate AzureRM resources to AzAPi in Module](https://github.com/Azure/azapi-lsp/blob/main/docs/migrate_to_azapi_in_module_guide.md)

![migrate from AzureRM provider to AzApi provider](/images/migrate-to-azapi-provider.png)


## Configuration

This extension offers several configuration options. To modify these, navigate to the extension view within VS Code, select the settings cog and choose Extension settings, or alternatively, modify the `.vscode/settings.json` file in the root of your working directory. 

## Telemetry

We use telemetry to send error reports to our team, so we can respond more effectively. If you want to [disable this setting](https://code.visualstudio.com/docs/getstarted/telemetry#_disable-telemetry-reporting), add `"telemetry.enableTelemetry": false` to your settings.json and that will turn off all telemetry in VSCode. You can also [monitor what's being sent](https://code.visualstudio.com/docs/getstarted/telemetry#_output-channel-for-telemetry-events) in your logs.

## Release History

See the [CHANGELOG](https://github.com/Azure/azapi-vscode/blob/develop/CHANGELOG.md) for more information.

## Local development
0. Prerequisites: golang >1.22, node 23.X, npm 10.X
1. Clone [Terraform AzApi Provider Language Server](https://github.com/Azure/azapi-lsp) to local
2. Run `go install` under project folder
3. Add the following configuration to vscode setting file.
```
   "azapi.languageServer": {
        "external": true,
        "pathToBinary": "C:\\Users\\henglu\\go\\bin\\azapi-lsp.exe",  //file path to language server
        "args": [
            "serve"
        ],
        "trace.server": "messages"
    },
```
4. Clone this project to local
5. Run `npm install` to download dependencies
6. Run `code .` to open this project in VSCode
7. Press `F5`, it will open a new VSCode Window, you can test its features in it.

## Credits

We wish to thank HashiCorp for the use of some MPLv2-licensed code from their open source project [vscode-terraform](https://github.com/hashicorp/vscode-terraform).