Manage your resource with SDK & APIs

Important

Test Base for Microsoft 365 will transition to end-of-life (EOL) on May 31, 2024. We're committed to working closely with each customer to provide support and guidance to make the transition as smooth as possible. If you have any questions, concerns, or need assistance, submit a support request.

Automation is a key aspect of DevOps and agile development. Are you looking to manage Test Base for Microsoft 365 resources, get test results programmatically, and integrate them with our CI tools? Test Base APIs/SDK can help you achieve all these and more!

These APIs/SDK enable IT professionals and app developers to:

• Manage Test Base accounts, including create, update, and offboard.
• Manage application packages, including create, update, delete, and download package.
• Get the test summary, detailed test results, and analysis results. The analysis result includes CPU regression analysis, CPU utilization analysis, memory regression analysis, and memory utilization analysis.
• Download test results and test execution video recording.

Check out the step-by-step outline below to find out how to access this new capability in Test Base for Microsoft 365 service.

A step-by-step example of Test Base account creation by using Python SDK

1. Pre-requisites:

   • Install below required components:

     • Azure account with an active subscription if you don't have a subscription
     • Python 2.7+ or 3.6+
     • Azure Command-Line Interface (CLI)

   • Install library packages by using pip install from console

     pip install azure-identity
     pip install azure-mgmt-testbase
     

   • Authenticating in dev environment

     When debugging and executing code locally it is typical for developers to use their own accounts for authenticating calls to Azure services. The azure-identity package supports authenticating through Azure CLI to simplify local development. To sign in to Azure CLI, run az login. On a system with a default web browser, the Azure CLI will launch the browser to authenticate a user.

     Check How to authenticate Python applications with Azure services| Microsoft Docs and https://pypi.org/project/azure-identity/ for other supported authentication methods.

   • Create a Resource Group with your desired name which will be used in following steps.

2. Below code snippet covers flow to create a Test Base Account including

   • Request credential via Azure CLI for interaction with Azure
   • Initialize Test Base SDK client with the credential and subscription ID for later operations
   • Invoke begin_create from test_base_accounts model to create Test Base Account

   Copy the code to your Python development environment, and replace "subscription-id" with your Azure subscription ID and "resource-group-name" with your Resource Group you created above.

   from azure.identity import AzureCliCredential
   from azure.mgmt.testbase import TestBase
   from azure.mgmt.testbase.models import TestBaseAccountResource
   from azure.mgmt.testbase.models import TestBaseAccountSKU
   
   # requesting token from Azure CLI for request
   # For other authentication approaches, please see: https://pypi.org/project/azure-identity/
   credential = AzureCliCredential()
   subscription_id = "<subscription-id>"
   resource_group = "<resource-group-name>"
   testBaseAccount_name = "contoso-testbaseAccount"
   testBaseAccount_location = "global"
   sku_name = "S0"
   sku_tier = "Standard"
   sku_locations = {"global"}
   
   # Create client
   testBase_client = TestBase(credential, subscription_id)
   
   # Create sku for test base account
   sku = TestBaseAccountSKU(name=sku_name, tier=sku_tier, locations=sku_locations)
   
   # Create test base account
   parameters = TestBaseAccountResource(location=testBaseAccount_location, sku=sku)
   testBaseAccount = testBase_client.test_base_accounts.begin_create(resource_group, testBaseAccount_name, parameters).result()
   print("Create test base account:\n{}".format(testBaseAccount))
   

Learn more

Check below links to learn more details about the SDK & API.

Azure Subscription:

• Azure account with an active subscription

Python SDK:

• Test Base Python SDK Documentation
• Test Base Python SDK Sample
• Azure General Usage Pattern of Python SDK

REST API:

• REST API Documentation