Acronis #CyberFit Developer Training Part II: Offering Items and Applications Management

This is the second part of the course focusing on offering items management. The first part can be found here Acronis #CyberFit Developer Training Part I: Get Started, Authorization, and Tenant Management.  

The hands-on manuals, hands-on code, and presentations are for the full course.

Business Automation and account management training course is focused on the Acronis Cyber Platform Account Management API. It provides you the knowledge and hands-on experience you’ll need to successfully automate the provisioning of accounts, applications, offering items, quota management, user creation, and activation, as well as reports management and much more.

The training’s Hands-on Manuals

The training’s Hands-on Code

  1. Bash
  2. PowerShell
  3. Postman
  4. Python

The training's presentation in PDF

Account Management API

Offering Items Management

The following Services (aka Applications in API) can be selected when creating a new tenant:

  • Cyber Protection
  • Files Sync & Share
  • Notary
  • Physical Data Shipping
  • Cyber Infrastructure

For Cyber Protection service, 1 or more editions can be selected:

  • Partner and Folder tenants: select 1 or more editions will be available for selection when child Customer tenants are subsequently created
  • Customer tenant: only 1 edition can be selected

Depending on the Acronis Data Center that the Service Provider is based on and settings made in the parent tenant, some services/editions may not be available.

Cyber Protect and Cyber Backup Editions Enabled for Tenant

Cyber Protect and Cyber Backup Editions Enabled for Tenant

Services can be customized by disabling/enabling their corresponding offering items, which determine the tenant's functionalities. The set of services and offering items configured for a tenant is known as the offering.

The offering determines what are shown in Management Portal and what is available when creating child tenants. Offering items also have quotas that can be used to refine the offering further.

Cyber Protect Offering Items Configuration 

Cyber Protect Offering Items Configuration 

Set Offering Items for Tenants Initially

You don’t need to enable applications, aka services like Cyber Protect, Files Sync & Share, Notary, or Physical Data Shipping for a partner separately. As soon as you enable at least one offering item to belong for a specific service, a corresponding application is enabled automatically for a partner.

You can request offering items available for a partner with GET /tenants/{tenant_id}/offering_items/available_for_child  call specifying edition parameter either Cyber Protect (per_workload) or Cyber Backup (per_gigabyte) depending on the billing model you decided to have for that partner. As well, you need to set the kind parameter to partner. As tenant_id for this call URL parameter, you should use parent tenant’s id.

If you need to enable both models, you need to call the API twice with different edition parameters. Then you need to merge JSON arrays and filter out doubled JSON items in the received array with null edition value corresponding to Files Sync & Share,Notary, and Physical Disk Shipping services.

As well, you can use * as a value for the edition parameter. In this case, you receive offering items for all editions available for your parent tenant, including legacy ones, if you have it enabled.

If you want to apply custom logic, what kind of offering items should be enabled for a partner, you may filter results of the calls using infra_id, application_id, edition, or/and name of an offering item in the received JSON array.

As soon as your final JSON array filtered, change the array root element name from items to offering_items and use this JSON as a body for PUT /tenants/{tenant_id}/offering_items call.

Update Tenant Offering Items

You need to provide only an updated offering items list. However, if you apply full JSON with all offering items including non-changed, there won't be any issues.

For quota updates, you should use the current version for quota version.

Switch Editions

Check if possible to switch to a specific edition using a dry run call GET /tenants/{tenant_id}/edition?application_id={application_id}&target_edition={target_edition}, then resolve all blockers and perform real a switch edition call.

PUT /tenants/{tenant_id}/edition

{

    "application_id": "{application_id}",

    "target_edition":  "{target_edition}"

}

Quotas Management

Quotas can be set for each offering item in Configure services

Quotas enable you to limit the ability to use the service. The quota is managed through the offering items which represent the set of services and service features.

Setting Quota for WorktasPartner Tenant

Setting Quota for WorktasPartner Tenant

The user account quotas are controlled via user account personal tenants

The quota is considered “soft” when you do not set a quota overage. It means you allow an unlimited quota overage. As a result, restrictions on using the service are not applied

The quota is considered “hard” when you set a quota overage. It means you allow a limited quota overage.  An overage allows for exceeding the quota by the specified value. When the overage is exceeded, restrictions on using the service are applied.

For Partner and Folder tenants only Quota settings are available. Quota are “soft”; when Quota value is exceeded, an e-mail notification is sent to Administrators of own and parent tenant, service continues to function without any restrictions.

For Customer tenants Quota and Overage settings are available. When the Quota value is exceeded, an e-mail notification is sent to Administrators of own and parent tenant, service continues to function without any restrictions.  When the Overage (usage is more than Quota + Overage)  is exceeded, restrictions on using the service are applied.

Application Management

Disabling an application is not a reversible operation and results in the following:

  • The service becomes unavailable and stops operating within this tenant and all its sub-tenants
  • All offering items of the service are disabled for this tenant and all its sub-tenants
  • All service-related data (e.g., backups, synced files) that belong to users of this tenant and all its sub-tenants are deleted.

Summary

With the second part of Acronis #CyberFit Developer Training for Bussiness Automation, you now know how to manage offering items and applications.

The next part of Acronis #CyberFit Developer Training for Bussiness Automation will be about users management and retrieving usage information for UI/UX purposes.

Updated
Stas Pavlov
Technology Evangelist
Account management API
Acronis Cyber Platform