Azure Web PubSub for Visual Studio Code (Preview)

Azure Web PubSub helps developer build real-time messaging web applications using WebSockets and the publish-subscribe pattern easily. Use the Azure Web PubSub extension for VS Code to quickly create, manage and utilize Azure Web PubSub Service and its developer tools such as Azure Web PubSub Local Tunnel Tool.

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.

Installation

1. Download and install the Azure Web PubSub extension for Visual Studio Code
2. Wait for the extension to finish installing then reload Visual Studio Code when prompted
3. 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

4. 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"

Create a New Azure Web PubSub Service

1. Once you are signed in, create your Azure Web PubSub Service by clicking the "+" button or by right-clicking your subscription

   

2. Select Create Web PubSub Service. If you are using Socket.IO server, select Create Web PubSub Service For Socket.IO instead. See the document for detail

   

3. Type a unique name for the service. Then select resource group, location, pricing tier and unit count for it

Features

• View, create, delete, and restart Azure Web PubSub Service
• View, create, delete hub setting
• View, create, delete and update event handler
• View metrics
• Scale up and scale out
• Check resource health
• Regenerate access key
• Copy connection string or endpoint of the service to clipboard
• Switch the anonymous connect policy of hub setting
• Attach Azure Web PubSub local tunnel tool
• View LiveTrace Tool

Create a New Hub Setting

1. Right click the service where you want to create a new hub setting.

   

2. Click Create Hub Setting

3. Type a name for the hub setting

4. Select the annoymous connection policy

5. (Optional) Create a single or multiple event handlers to the hub setting

Scale

1. Right click the service you want to scale up or scale out and then click Advanced

   

2. Click Scale up or Scale Out

3. Select the new unit count (scale out) or pricing tier (scale up) for your service

   

Attach Local Tunnel Tool

1. Expand the hub setting dropdown list, right click the hub setting you want to attach the tunnel tool and then click Attach Local tunnel

   

2. A tunnel-enabled event handler will be created to support Local Tunnel Tool

   You could customize its system events and user events

   

3. A new terminal will be created and the command to run Local Tunnel Tool on your chosen hub setting will be executed automatically

4. Click Open Local Tunnel Portal to see detail in web browser

   

Contributing

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 in the Pull Request Session!
• 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 run npm install.
  • To build, press F1 and type in Tasks: Run Build Task.
  • Debug: press F5 to start debugging the extension.

Legal

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.

Code of Conduct

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.

Trademarks

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.

Security

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.

Reporting Security Issues

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.

Preferred Languages

We prefer all communications to be in English.

Policy

Microsoft follows the principle of Coordinated Vulnerability Disclosure.

Telemetry

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.

License

MIT