Azure Web PubSub provides a managed service that lets you run microservices on Azure using Spring Boot with no code changes. Use the Azure Web PubSub extension for VS Code to quickly create, manage and deploy apps to an Azure Web PubSub instance.
Sign up today for your free Azure account and receive 12 months of free popular services, $200 free credit and 25+ always free services 👉 Start Free.
- Download and install the Azure Web PubSub extension for Visual Studio Code
- Wait for the extension to finish installing then reload Visual Studio Code when prompted
- Once complete, you'll see an Azure icon in the Activity Bar
If your activity bar is hidden, you won't be able to access the extension. Show the Activity Bar by clicking View > Appearance > Show Activity Bar
- Sign in to your Azure Account by clicking Sign in to Azure…
If you don't already have an Azure Account, click "Create a Free Azure Account" or you can try Azure for free
Once you are signed in to your Azure account and you have your app open in Visual Studio Code, click the Azure icon in the Activity Bar to open the Azure Explorer and you will see the Azure Web PubSub panel.
-
Right-click on your subscription and click Create Azure Web PubSub in Portal. Finish the following steps on Azure Portal to create an Azure Web PubSub instance.
-
After the Azure Web PubSub instance is created, refresh the Azure Explorer and it will show up. Right-click on the Azure Web PubSub instance and click Create App. Type app name, select Java version and then press Enter to start creating.
 -
The app will be ready in a few minutes, right click on the App and click Deploy, select your built Jar file when prompted.
-
You can see the deployment status on the bottom right. Once done, click Access Public Endpoint to test the app running on Azure, click Yes when prompted to assign public endpoint. Be aware that only Spring Boot fat Jar is supported, learn more about apps on Azure Web PubSub.
-
You can easily scale the app by right click on the Instance count under Scale Settings and click Edit. Type 2 and press Enter to scale the app.
-
Expand the App Instances node, right click the instance you want to see logs and click Start Streaming Logs.
-
The Visual Studio Code output window opens with a connection to the log stream
There are a couple of ways you can contribute to this repo:
- Ideas, feature requests and bugs: We are open to all ideas and we want to get rid of bugs! Use the Issues section to either report a new issue, provide your ideas or contribute to existing threads.
- Documentation: Found a typo or strangely worded sentences? Submit a PR!
- Code: Contribute bug fixes, features or design changes:
- Clone the repository locally and open in VS Code.
- Install TSLint for Visual Studio Code.
- Open the terminal (press
CTRL+`) and runnpm install. - To build, press
F1and type inTasks: Run Build Task. - Debug: press
F5to start debugging the extension.
You will need to sign a Contribution License Agreement before we can accept your pull request.
All you need to do is to submit a pull request, then the PR will get appropriately labelled (e.g. cla-required, cla-norequired, cla-signed, cla-already-signed). If you already signed the agreement we will continue with reviewing the PR, otherwise system will tell you how you can sign the CLA. Once you sign the CLA all future PR's will be labeled as cla-signed.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft’s Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party’s policies.
Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include Microsoft, Azure, DotNet, AspNet, Xamarin, and our GitHub organizations.
If you believe you have found a security vulnerability in any Microsoft-owned repository that meets Microsoft's definition of a security vulnerability, please report it to us as described below.
Please do not report security vulnerabilities through public GitHub issues.
Instead, please report them to the Microsoft Security Response Center (MSRC) at https://msrc.microsoft.com/create-report.
If you prefer to submit without logging in, send email to secure@microsoft.com. If possible, encrypt your message with our PGP key; please download it from the Microsoft Security Response Center PGP Key page.
You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at microsoft.com/msrc.
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
- Full paths of source file(s) related to the manifestation of the issue
- The location of the affected source code (tag/branch/commit or direct URL)
- Any special configuration required to reproduce the issue
- Step-by-step instructions to reproduce the issue
- Proof-of-concept or exploit code (if possible)
- Impact of the issue, including how an attacker might exploit the issue
This information will help us triage your report more quickly.
If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our Microsoft Bug Bounty Program page for more details about our active programs.
We prefer all communications to be in English.
Microsoft follows the principle of Coordinated Vulnerability Disclosure.
VS Code collects usage data and sends it to Microsoft to help improve our products and services. Read our privacy statement to learn more. If you don’t wish to send usage data to Microsoft, you can set the telemetry.enableTelemetry setting to false. Learn more in our FAQ.