Files
azuredatastudio/extensions/arc/README.md
Candice Ye 914fe8fc29 Replacing all azdata with az (#16502)
* Changed azdata to az in azcli extension and resource-deployment, and some arc. Removed user, pass, url from controller connect blade. Commented out tests. Ported over work from old branch.

* Changed unit tests, all unit tests passing. Changed parameters to new ones, fixed some Controller Connect issues.

* Connect data controller and create dc working.

* Changed az back to azdata in necessary places in resource-deployment.

* Changed notebook values and added namespace to some params.

* Added some changes from PR to this branch

* Changed azdata.ts to az.ts and changed subscription parameter

* Brought over changes from azcli PR into this branch.

* added endpoint, username, password to getIsPassword

* Changed notebooks to use proper az params, hard coded in some values to verify it is working, removed some variableNames from package.json.

* Changed -sc to --storage-class in notebook

* Added namespace to SQL deploy, deleted dc create in api

* Deleted more dc create code and uncommented findAz() with unfinished work on Do Not Ask Again.

* Removed (preview) from extensions/arc and extensions/azcli excluding preview:true in package.json

* Commented out install/update prompts until DoNotAskAgain is implemented

* Fixed bugs: JSON Output errors are now being caught, --infrastructure now has a required UI component with dropdown options, config page loads properly, SQL create flags use full names instead of shortnames.

* Adds validation to pg extensions and bug fixes (#16486)

* Extensions

* Server parameters

* Change locaiton of postgres extensions, pr fixes

* Change location of list

* List spacing

* Commented out Don't Ask Again prompt implementation.

* Uncommented header of a test file.

* Added Azure CLI arcdata extension to Prerequisites

* Reverted package.json and yarn.lock

* Took away casting of stderr and stdout in executeCommand.

* Deleted override function for initializeFields in connectControllerDialog.ts

* Removed fakeAzApi for testing and added back in (Preview)

* Removed en-us from python notebook links.

* Deleted azdata tool from tool tests in resource-deployment

* Deleted another instance of azdata in tool test

* Add back in azdata tooltype

* Remove en-us

* Replaced AzdataTool in typings

* Reverting adding azdata tool back in

* Changed Azdata to AzdataToolOld

* Added back azdata tool type

* Added AzdataToolOld to tool types

* fix test

Co-authored-by: Candice Ye <canye@microsoft.com>
Co-authored-by: nasc17 <nasc@microsoft.com>
Co-authored-by: nasc17 <69922333+nasc17@users.noreply.github.com>
Co-authored-by: chgagnon <chgagnon@microsoft.com>
2021-08-01 15:12:24 -07:00

2.9 KiB

Microsoft Azure Arc Extension for Azure Data Studio

Welcome to Microsoft Azure Arc Extension for Azure Data Studio!

Overview

This extension adds the following features to Azure Data Studio.

Deployment Wizards

A gui-based experience to deploy an Azure Arc data controller as well as resources on an existing Azure Arc data controller. Current list of supported resources:

  • SQL Managed Instance
  • PostgreSQL server groups

Management Dashboards

After connecting to an existing Azure Arc data controller in the Azure Arc Controllers view of the Connections viewlet a list of the active resources registered to the controller is shown, which allow launching a dashboard for further management capabilities.

Usage Guide

Deployment Wizards

  • After installing this extension open the Connections viewlet
  • Click on '...' in the top right corner of the viewlet panel and click on 'New Deployment...'.
  • This opens a dialog box that shows several deployment tiles. This extension adds tiles for the supported resources listed above.
  • Click on that tile, accept any license agreements, and choose the appropriate 'Resource Type' to install
  • A required tools check will run, if any required tools are missing then instructions will be given for installing those tools
  • Once the check has passed successfully then click the Select button
  • This opens up a new dialog where you can enter input parameters specific to the deployment selected and then open a notebook that does the actual deployment.

Controller View/Management Dashboards

  • The Azure Arc Controllers view can be found in the Connections viewlet
  • You can create a new controller by clicking the + button in the view title bar. This will launch the deployment wizard detailed above
  • You can connect to an existing controller by clicking the plug button in the view title bar or the Connect Controller button in the view area when no controllers are registered
  • You will then be prompted for the connection information to the controller, if it's successful then a node will be added to the tree for that controller
  • Right click on one of the nodes to launch a dashboard for that resource - either the Data Controller or an instance deployed on it

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.

Privacy Statement

The Microsoft Enterprise and Developer Privacy Statement describes the privacy statement of this software.

License

Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under the Source EULA.