POST v1/bunits/{bunitId}/consumers
Add a consumption unit to a business unit.
If the consumption unit already exists on another business unit, it will be moved. Otherwise the consumption unit will be created.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
bunitId |
The business unit that the consumption unit is related to. | integer |
Required |
Body Parameters
The consumption unit to create
Consumer| Name | Description | Type | Additional information |
|---|---|---|---|
DataSourceType |
The type of data-source the consumer is related to |
DataSourceType |
None. |
DataSourceIsPotentialParent |
The related data-source (if any) can have children that can be assigned to a business unit |
boolean |
None. |
DataSourceState |
State of related data-source |
DataSourceState |
None. |
LatestRestorePoint |
date |
None. |
|
Name |
A descriptive name for the consumption unit. |
string |
Required. |
ExternalReference |
An optional external reference property. |
string |
None. |
BillingStartDate |
The date the consumption unit will start being billed |
date |
None. |
BillingEndDate |
The consumption unit will not be billed after this date |
date |
None. |
ScheduledDeletionDate |
The consumption unit will be archived on this date. |
date |
None. |
BusinessUnit |
BusinessUnit which owns the consumption unit |
BusinessUnit |
None. |
LastCommentTime |
The time the latest comment was created |
date |
None. |
LastCommentTypeId |
The type of the latest comment |
integer |
None. |
Comments |
A list of all comments for the consumption unit |
Collection of Comment |
None. |
Note |
Extra information regarding the consumption unit |
string |
None. |
Node |
The backup node related to the consumption unit (if any) |
Node |
None. |
VmFilespace |
The virtual machine related to the consumption unit (if any) |
Filespace |
None. |
Hypervisor |
The SP Plus hypervisor related to the consumption unit (if any) |
Hypervisor |
None. |
RubrikDataSource |
The Rubrik data-source related to the consumption unit (if any) |
RubrikDataSource |
None. |
CohesityDataSource |
The Cohesity data-source related to the consumption unit (if any) |
CohesityDataSource |
None. |
PointBucket |
The PoINT bucket related to the consumption unit (if any) |
PointBucket |
None. |
Vm |
The SP Plus VM related to the consumption unit (if any) |
Vm |
None. |
Microsoft365Tenant |
The Microsoft 365 tenant related to the consumption unit (if any) |
Microsoft365Tenant |
None. |
Microsoft365Account |
The Microsoft 365 account related to the consumption unit (if any) |
Microsoft365Account |
None. |
LimitLowTransferred |
How few GB's can the data-source transfer before a warning is added (null for no low limit) |
decimal number |
None. |
LimitHighTransferred |
How many GB's can the data-source transfer before a warning is added (null for unlimited) |
decimal number |
None. |
LimitLowStorage |
How few GB's can the data-source backup before a warning is added (null for no low limit) |
decimal number |
None. |
LimitHighStorage |
How many GB's can the data-source backup before a warning is added (null for unlimited) |
decimal number |
None. |
AllowNoActivity |
In regards to reporting status and alarms; it is acceptable for this data-source to have no activities or events. |
boolean |
None. |
AlarmDeactivationStartDate |
Start date for deactivation of alarms |
date |
None. |
AlarmDeactivationEndDate |
End date for deactivation of alarms |
date |
None. |
AlarmDeactivationReason |
Option to describe why alarms have been deactivated This message will be included in the backup node report instead of alarms |
string |
None. |
DeleteRequest |
Information about any requests for deleting the consumption unit |
DeleteRequest |
None. |
DeletionComment |
If the consumption unit has been manually deleted, information about why is added here |
string |
None. |
Tags |
A list of tags describing the consumption unit |
Collection of Tag |
None. |
Id |
A unique ID for the object. |
integer |
Read-only. |
CreatedDate |
Time and date the object was created. |
date |
Read-only. |
ArchivedDate |
Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate |
date |
Read-only. |
Operations |
Collection of OperationResult |
None. |
Request Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
Response Information
Resource Description
The newly created consumption unit
Consumer| Name | Description | Type | Additional information |
|---|---|---|---|
DataSourceType |
The type of data-source the consumer is related to |
DataSourceType |
None. |
DataSourceIsPotentialParent |
The related data-source (if any) can have children that can be assigned to a business unit |
boolean |
None. |
DataSourceState |
State of related data-source |
DataSourceState |
None. |
LatestRestorePoint |
date |
None. |
|
Name |
A descriptive name for the consumption unit. |
string |
Required. |
ExternalReference |
An optional external reference property. |
string |
None. |
BillingStartDate |
The date the consumption unit will start being billed |
date |
None. |
BillingEndDate |
The consumption unit will not be billed after this date |
date |
None. |
ScheduledDeletionDate |
The consumption unit will be archived on this date. |
date |
None. |
BusinessUnit |
BusinessUnit which owns the consumption unit |
BusinessUnit |
None. |
LastCommentTime |
The time the latest comment was created |
date |
None. |
LastCommentTypeId |
The type of the latest comment |
integer |
None. |
Comments |
A list of all comments for the consumption unit |
Collection of Comment |
None. |
Note |
Extra information regarding the consumption unit |
string |
None. |
Node |
The backup node related to the consumption unit (if any) |
Node |
None. |
VmFilespace |
The virtual machine related to the consumption unit (if any) |
Filespace |
None. |
Hypervisor |
The SP Plus hypervisor related to the consumption unit (if any) |
Hypervisor |
None. |
RubrikDataSource |
The Rubrik data-source related to the consumption unit (if any) |
RubrikDataSource |
None. |
CohesityDataSource |
The Cohesity data-source related to the consumption unit (if any) |
CohesityDataSource |
None. |
PointBucket |
The PoINT bucket related to the consumption unit (if any) |
PointBucket |
None. |
Vm |
The SP Plus VM related to the consumption unit (if any) |
Vm |
None. |
Microsoft365Tenant |
The Microsoft 365 tenant related to the consumption unit (if any) |
Microsoft365Tenant |
None. |
Microsoft365Account |
The Microsoft 365 account related to the consumption unit (if any) |
Microsoft365Account |
None. |
LimitLowTransferred |
How few GB's can the data-source transfer before a warning is added (null for no low limit) |
decimal number |
None. |
LimitHighTransferred |
How many GB's can the data-source transfer before a warning is added (null for unlimited) |
decimal number |
None. |
LimitLowStorage |
How few GB's can the data-source backup before a warning is added (null for no low limit) |
decimal number |
None. |
LimitHighStorage |
How many GB's can the data-source backup before a warning is added (null for unlimited) |
decimal number |
None. |
AllowNoActivity |
In regards to reporting status and alarms; it is acceptable for this data-source to have no activities or events. |
boolean |
None. |
AlarmDeactivationStartDate |
Start date for deactivation of alarms |
date |
None. |
AlarmDeactivationEndDate |
End date for deactivation of alarms |
date |
None. |
AlarmDeactivationReason |
Option to describe why alarms have been deactivated This message will be included in the backup node report instead of alarms |
string |
None. |
DeleteRequest |
Information about any requests for deleting the consumption unit |
DeleteRequest |
None. |
DeletionComment |
If the consumption unit has been manually deleted, information about why is added here |
string |
None. |
Tags |
A list of tags describing the consumption unit |
Collection of Tag |
None. |
Id |
A unique ID for the object. |
integer |
Read-only. |
CreatedDate |
Time and date the object was created. |
date |
Read-only. |
ArchivedDate |
Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate |
date |
Read-only. |
Operations |
Collection of OperationResult |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.