Requesting a Deployment from a Catalog Item Using vRealize Automation Service Broker APIs
To create catalog items and request deployments, you use the vRealize Automation Service Broker Catalog APIs.
This use case includes the procedures required to request a blueprint. You associate a project that you previously created with the catalog source, create a catalog source, and create entitlements, so that you can request a deployment from the catalog item. Optionally, if you want to expire your deployment, you can create a lease policy.
Prerequisites for Requesting a Deployment from a Catalog Item
All tasks for requesting a deployment from a catalog item share the following common prerequisites:
- Verify that you are at least an organization member in VMware vRealize Automation with both a vRealize Automation Cloud Assembly administrator service role and a vRealize Automation Service Broker administrator service role.
- Verify that you have an active access token. See Getting Your Authentication Token.
- Verify that the URL variable is
assigned.
url='https://appliance.domain.com'
- Verify that the API version
variable is assigned to a date as in the following example.
api_version='2019-09-12'
It is not necessary to lock your use case to the date provided in the example. To integrate your use case with the API and lock it to a particular date, you can enter any date you choose. Or if you choose to consume the API without versioning, leave the apiVersion value unspecified and the latest API version is used by default. Backward compatibility is not preserved, but your use case automatically benefits from improvements or enhancements to the API.
- Verify that you have the ID for a project that has the blueprint versioned and released to it. See Version and Release a Blueprint to a vRealize Automation Service Broker Catalog.
- Verify that you have the name of the blueprint that you want to request for deployment. See Create and Update a Blueprint.
- Verify that you have the version of a blueprint released to the project that you want to request for deployment. See Version and Release a Blueprint to a vRealize Automation Service Broker Catalog.
Any additional prerequisites are specified with the individual tasks.