Skip to content

Latest commit

 

History

History
69 lines (54 loc) · 4.54 KB

README.md

File metadata and controls

69 lines (54 loc) · 4.54 KB
Raw

ARMExplorer

This project has dependencies on OAuth authentication.

Note: Guest user scenarios are not supported

Instructions

  1. Clone this repository to your local drive.
  2. Open ARMExplorer.sln with VS 2017+ and compile.

Create AAD application

  1. Go to Azure Portal while logged in as an Org ID (i.e. not MSA) and create AAD Application. You may create an application on existing AAD directory or a new directory altogether.
  2. Select 'Azure Active Directory' and then 'App registrations' and click 'New application registration'
  3. Enter any name for application name and https://localhost:44300/manage as Redirect URIs and click 'Register'
  4. Once created, open the application
  5. On Authentication, check ID tokens (used for implicit and hybrid flows) in Implicit grant and hybrid flows and save.
  6. On API permissions, add Windows Azure Service Management API and check Access Azure Service Management for Delegated Permissions and save.

Fix AADClientId and AADClientSecret in codes

  1. Copy CLIENT ID and paste it in this line, replacing Environment.GetEnvironmentVariable("AADClientId").
  2. On Certificates & secrets section, create a client secret. Copy the key and paste it in the same file, replacing Environment.GetEnvironmentVariable("AADClientSecret").

Test with localhost

  1. Build the solution using VS.
  2. Starting running it in the debugger (F5).
  3. In browser, it should redirect to login page.
  4. Enter AAD account and password. Note: try account that is not in the same directly as the application. Note: currently this does not work with MSA account.
  5. You should be prompt with OAuth allow/deny page, do accept it.

Test ARM apis

  1. https://localhost:44306/api/token - show current token details.
  2. https://localhost:44306/api/tenants - show all tenants (AAD directory) user belongs to.
  3. and so on..

Test with Azure Websites

  1. Create Azure Websites with local git publishing enabled
  2. Add the site https url as the reply URL for AAD application
  3. Deploy the website by pushing the repository
  4. Set AADClientID and AADClientSecret appSettings
  5. To test, simply browse to the website and append the query string "?repository="

Running unit tests

  1. Unit test support is still evolving and the tests are located under ng\test directory.
  2. Tests are built using tsconfig.json file under ng folder.
  3. You will need to have tsc and node installed before you can run the tests. You can use npm for this.
  4. Navigate to ng directory and compile the files using 'tsc' and run the tests using 'node manageWithTests.js'
  5. Remember to update the tsconfig.json file when adding new test files.

Swagger specs

Swagger files can be found at https://github.com/Azure/azure-rest-api-specs. For web apps the specs can be found internally under bin\Hosting\Azure\GeoMaster\Swagger\Service.json

Adding Swagger specs

Swagger files for all ARM providers are under App_Data/SwaggerSpecs. To update specs for any provider, locate the folder corresponding to the specific provider under SwaggerSpecs and do the following:

  1. To update an API in an existing file replace the old file contents with the latest specs.
  2. To move API to a new file, you will have to delete the old API from the existing file apart from adding the new file(s).
  3. To delete an API , remove the API from existing files.
  4. To add new API, copy the new files to the provider folder.
  5. To add new provider, create a new folder for the provider under SwaggerSpecs and place all your files inside the folder. You might also need to add the provider name at https://github.com/projectkudu/AzureResourceExplorer/blob/master/App_Data/providernames.txt if doesnt already exist.
  6. When adding new files, make sure you include them in the csproj file. Ex: https://github.com/projectkudu/AzureResourceExplorer/blob/526106d2690bfadee6125a9e5c9b36ac1381d485/ARMExplorer.csproj#L193
  7. Note: Some spec files might have dependencies on external files using relative paths. In that case the external files also need to be copied over or the swagger will fail to parse completely. Ex: Swagger referencing external file - https://github.com/projectkudu/AzureResourceExplorer/commit/6ea99ea565ac1f69e20e7eb199c71c7119a58bb6#diff-bc13fca161c67ebe7f92e5965a8db19b10fb7927338a5a86e82e5236650142bdR3071 Fix - https://github.com/projectkudu/AzureResourceExplorer/commit/f038fbda41639362182ff3d2aeafa67eb0cab970

Create a pull request with your changes.