Azure VMware Solution (AVS) REST API: A Complete Postman Collection for Deploying and Managing Your AVS Clusters

As a cloud builder, I have been working with Azure VMware Solution (AVS) for a couple of months now, and one thing that has been very useful for me is having a prepared list of API calls on a notebook or quick-reference document. After collecting enough sample API calls, I decided to create a full Postman collection to cover the complete AVS REST API. In this blog post, I will share with you the complete Postman collection for the AVS REST API, as well as some tips and tricks for using it effectively.

The Complete Postman Collection

The Azure VMware Solution REST API Postman collection is available in the GitHub repository: . This collection includes all the API calls that are currently available in the AVS REST API, as of version 2021-12-01.

The collection includes API calls for deploying and managing your AVS clusters, such as creating and updating deployments, scaling your clusters, and monitoring their status. It also includes API calls for managing your VMware products, such as configuring network settings and adding or removing hosts from your cluster.

Tips and Tricks for Using the Collection

Here are some tips and tricks for using the Postman collection effectively:

1. Import the Environment Sample: In addition to the API calls, the repository includes an environment sample that you can use to populate your own data. This will save you time and effort in setting up your API calls.

2. Use the Access Token Variable: When importing the collection, be sure to set the access token variable correctly. The easiest way to get an authentication token is by using the Azure Command-Line Interface, as described in the documentation.

3. Update the Access Token Manually: Unfortunately, when exporting and importing the Postman collection, the variable used for authentication is lost and needs to be set manually. To avoid this issue, you can use a tool like jq to extract the access token value from the response.

4. Test the Collection: Once you have imported the collection and set the access token variable correctly, you can test it by listing the AVS deployments in your subscription. This will give you an overview of all your deployments and help you identify any issues or errors.

5. Refer to the Official Documentation: While the Postman collection covers the complete AVS REST API, the official reference documentation remains the one from the Azure docs website: . This documentation contains much more information about each API call and response, so it is essential to refer to it when using the Postman collection.

Conclusion

In this blog post, I have shared with you the complete Postman collection for the Azure VMware Solution REST API, as well as some tips and tricks for using it effectively. The Postman collection includes all the API calls that are currently available in the AVS REST API, as of version 2021-12-01. By using this collection, you can easily deploy and manage your AVS clusters, as well as monitor their status and configure your VMware products. Remember to refer to the official documentation for more information about each API call and response.