search

bradygaster-zz / azure-tools-vscode

azure tools extension for visual studio code
Apache License 2.0
29 stars 10 forks source link

readme

Azure Tools for Visual Studio Code

This extension for Visual Studio Code gives Azure developers some convenient commands for creating or accessing resources directly in the editor.

New in v 1.2.9

By default the Azure Tools output window is opened on startup. If you prefer that it isn't opened on startup then you can change the azure.showToolsWindowOnStartup setting to false:

Disable tools window on startup

New in v1.2.3

Output window messages

To address the perceived lack of action in the UX during execution we've added a custom Debug Console window that shows the progress of commands executed by the extension. The information in the output window will help customers have more information for error reporting.

Export command

Azure Functions Tools dependency

This release also takes a dependency on the Azure Functions Tools from John Papa that make it easy for you to develop Azure Functions with some handy snippets.

Azure Functions

Misc.

In this release the telemetry-reporting feature has been optimized for better performance and tighter collection.

Previously Released Features

Export Template

In 1.2.0 we've added support for exporting existing resource groups to ARM templates saved in your workspace. First, you invoke the Export command using the palette.

Export command

Then you select an existing resource group.

Select a resource group

A few seconds later, the resource group's contents are downloaded as an ARM template and stored into your current workspace's arm-templates folder.

Export command

Note: As of the 1.2.0 release time frame there are a few kinks in the particular Azure API call we're using; certain details of your resources might not be persisted exactly right. You can use the great features contained in the Azure Resource Manager Tools extension (which bundled with this extension) to make tweaks. The API owners are working on making great improvements to this functionality so it'll improve in future releases of the back-end API.

Azure Batch account creation

From within Visual Studio Code you can use the Create Azure Batch command from the palette, shown below, to create new Azure Batch accounts. Future releases may add support for scripting against your Batch account, creating Jobs, and so forth. Feel free to send the team requests for additional Batch features via our GitHub Issues page.

Create Key Vault

Telemetry Collection

This release introduces the collection of basic usage telemetry. We're using Application Insights to collect and understand how customers are using the extension. To disable the collection of telemetry data simply edit set the azure.enableTelemetry configuration setting to false as shown below.

How to disable usage telemetry

Note: No performance degradation has occurred during this addition, and no private customer information is being persisted. Our telemetry code tracks the name of the call being made (like CreateAppService) and the GUID-based subscription id being affected. We capture the subscription ID so we can understand the frequency of customer usage; the ID can't be used to reversely-identify customers. No customer-identifying data, passwords, connection strings, or resource names are being persisted to our telemetry system.

Features

Each of these commands is visible directly from commands visible in the command palette.

Azure Tools Commands

Azure Key Vault creation

You can now use the Azure Tools for Visual Studio Code to create new Key Vault instances. Selecting the Create Key Vault command. Then you can create a new or select an existing resource group into which your new Key Vault will be created.

Create Key Vault

Azure Resource Manager (ARM) Features

You can use keyword searches to find one of the numerous existing templates in the Azure QuickStart Templates repository, then download the templates you find and deploy them all within Visual Studio Code.

Search and Download from the Azure Template QuickStart Repository

Templates in the QuickStart repository are easily searchable from within Visual Studio Code.

Search for templates

Type in a string or combination of strings for which you're searching:

Search for templates

Select the appropriate template from the resulting list:

Select your template

Note that the templates you select are downloaded into the arm-templates folder in your workspace. This way you can open the parameters file, make changes, and customize your deployment.

Downloaded templates

Now that the Azure Tools for Visual Studio Code takes a dependency on the Azure Resource Manager Tools for Visual Studio Code, editing of ARM templates you download from the repository is easier due to auto-completion, IntelliSense support, and the other ARM editing features provided in the Azure Resource Manager Tools extension.

Deploying Templates

Once you've edited your ARM template you can even use Visual Studio Code to deploy the template and add your Azure resources to your subscription. The Deploy command is visible in the command list below.

Deploy command

The various ARM templates you may have downloaded into your workspace will be shown in a list. This way, if you have multiple resources you wish to deploy in phases or you're just testing various templates out, you can deploy them individually.

Select the template to be deployed

Deployments can be made to new or existing resource groups:

Create new resource group

The status bar shows that the deployment being created:

Deployment happening

In this template scenario a GitHub-backed Web App is created. The portal screenshot below shows how the site is being deployed from GitHub once the template is deployed.

Portal view

Finally, Visual Studio Code provides an update when the deployment has completed.

Deployment complete

Getting Started

Once you've installed the extension you can log in using either your organizational account or a Microsoft account such as a @live.com address. If you need to log in using an "organizationa account" there is no setup work to be done. Simply pull up the command palette and look for the Azure: Login command. This command runs the web-based interactive login process.

Login Command

Logging in with a Microsoft Account?

If you're logging in using a Microsoft account (such as a @hotmail.com, @live.com, or @outlook.com account) you will need to set the azure.tenantId setting. The screenshot below shows this setting being entered using the File -> Preferences -> User Settings feature.

Adding the Azure tenant ID setting

Once you've added the GUID-based setting (available Active Directory area in the classic portal to the user or workspace settings using the azure.tenantId setting you can login using your Microsoft Account. The animated gif below demonstrates the full process of logging in using an MSA.

Signing in using an MSA

Creating Azure Resources

You can use the Azure Tools for Code to create App Service Web and Function Apps, and Azure Storage Accounts (and more resources are on the way). The video embedded below demonstrates using VS Code along with Yeoman templates to create a new Azure Function App.

Create an Azure Function using Code

In the case of Web and Function Apps the Azure Tools Extension allows for creation of your apps using a Simple flow, which creates a resource group, server farm, and app all at once. Or, you can use the Advanced flow to select an existing resource group or server farm in which to create your app.

Creating and Using Storage Accounts

You can also use the Azure Tools for Visual Studio Code to create an Azure Storage Account. In the video below you'll see how you can create a new Storage Account in a new or existing resource group. Then, using the Get Storage Account Connection String command, you can get the connection string for an existing storage account copied to your clipboard. Then, you can easily paste it into a configuration file so your app can store and retrieve data using Azure Storage.

Create an Azure Storage Account using Code

Browsing Resources in the Azure Portal

Two commands are provided to enable easy access to your Azure resources in the portal. By opening the command palette and typing Browse you will see the convenient "Browse in Portal" options.

Browse Commands

You can navigate directly to an individual resource's portal page:

Select a resource

Or to a resource group's portal page:

Select a resource group

Extension Settings

Setting Description
azure.tenantId The GUID specifier for the tenant you intend on authenticating against. This is required if you're attempting to log in using a Microsoft Account like @outlook.com, @hotmail.com, or @live.com.
azure.enableTelemetry To opt out of sending basic usage telemetry set this to false. Default is true.
azure.showToolsWindowOnStartup To prevent the Azure Tools panel showing on startup set this to false. Default is true

Requirements

All dependencies are listed in package.json. You will need an Azure subscription. If you don't yet have an Azure subscription sign up for a free account and then you can make use of the features in this extension, not to mention all the great features Azure offers.

Known Issues

All feature ideas and issues should be reported using GitHub issues.

Release Notes

You can find notes for each release in the changelog.