Adding Object Storage
You can add a new Azure object storage repository to the Veeam Backup for Microsoft 365 backup infrastructure.
Request
POST https://<hostname>:4443/v6/objectstoragerepositories |
Request Headers
The request header must contain an authorization token of the current session.
Request Body
The request body must contain the following properties:
Property | Type | Description |
|---|---|---|
name | string | Specifies the object storage name. |
description | string | Specifies the object storage description. |
type | string | Specifies the object storage type. The following types are available:
|
accountId | string | Specifies ID of the account under which the object storage is being added. |
azureContainer | Contains Azure container properties. | |
azureFolder | string | Specifies storage folder where backups will reside. |
sizeLimitEnabled | boolean | Defines whether the size limit is set. |
sizeLimitGB | integer | Specifies size limit in GB. |
useArchiverAppliance | boolean | Defines that Veeam Backup for Microsoft 365 uses the Azure archiver appliance when transferring backed-up data to the archive object storage. |
azureArchiverAppliance | Contains a definition of the Azure archiver appliance that Veeam Backup for Microsoft 365 uses when transferring backed-up data to the archive object storage. | |
azureServiceAccount | Specifies properties of the Microsoft Azure service account that the Azure archiver appliance uses to access Microsoft Azure. | |
azureSubscription | Specifies properties of the Microsoft Azure subscription associated with a user account that is used to access Azure Blob storage. |
Property | Type | Description |
|---|---|---|
name | string | Specifies a container name. |
regionType | string | Specifies a region type. The following types are available:
|
Property | Type | Description |
|---|---|---|
virtualMachineSize | Specifies the Azure archiver appliance size. | |
resourceGroup | Specifies a resource group associated with the Azure archiver appliance. | |
virtualNetwork | Specifies a virtual network to which the Azure archiver appliance is connected. | |
subnet | Specifies the Azure archiver appliance subnet. | |
region | string | Specifies a Microsoft Azure region. |
appliancePort | integer | Specifies a port number that is used to route requests between the Azure archiver appliance and Veeam Backup for Microsoft 365 backup infrastructure components. |
Request Example
Request: POST https://abc.tech.local:4443/v6/objectstoragerepositories
Request Header: Authorization: Bearer <Access-Token> Request Body: { "useArchiverAppliance": "true", "accountId": "fc0ac22b-a067-4e65-8790-5f43348d109e", "type": "AzureBlobArchive", "description": "", "sizeLimitGB": "10224", "azureFolder": "Folder1", "sizeLimitEnabled": "true", "azureContainer": { "regionType": "Global", "name": "container1" }, "azureServiceAccount": { "displayName": "Application", "azureEnvironment": "Global", "id": "576705c3-a1af-49bd-878f-9067865bfcf9", "applicationCertificateThumbprint": "FF2577A7586ACAD713FEBA43C62B67C1603CF7EC", "azureTenantId": "4468fde5-48b8-4f24-b3f0-ce8a4078ca3f", "lastModified": "2022-02-16T17:46:16.8070443Z", "type": "Azure", "applicationId": "2415230a-51ea-4e0d-a924-54c699a5431a" }, "name": "Azure Archive Object Storage", "azureSubscription": { "displayName": "Enterprise Subscription", "subscriptionId": "be7051ea-8fa4-4605-c607-89f3dd09fffd" }, "azureArchiverAppliance": { "virtualMachineSize": { "name": "Standard_B4ms", "coresCount": "string", "memoryMB": 16384, "osDiskSizeMB": 0, "resourceDiskSizeMB": 0 }, "resourceGroup": { "name": "ResourceGroup10", "location": "northcentralus" }, "virtualNetwork": { "id": "/subscriptions/be7051ea-8fa4-4605-c607-89f3dd09fffd/resourceGroups/ResourceGroup10/providers/Microsoft.Network/virtualNetworks/groupvnet775", "name": "groupvnet775", "type": "Microsoft.Network/virtualNetworks", "location": "northcentralus", "addressSpaces": [ "10.5.0.0/16" ] }, "subnet": { "name": "default", "addressPrefix": "10.5.0.0/24" }, "region": "northcentralus", "appliancePort": 443 } } |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 201 Created.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTPS headers.
Header | Description |
|---|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the response body message: application/json; charset=utf-8 |
Response Body
The response body contains the following properties:
Property | Type | Description |
|---|---|---|
azureContainer | Contains Azure container properties. | |
azureFolder | string | Specifies storage folder where backups reside. |
id | string | Specifies the object storage ID. |
name | string | Specifies the object storage name. |
description | string | Specifies the object storage description. |
accountId | string | Specifies ID of the account under which the object storage was added. |
sizeLimitEnabled | boolean | Defines whether the size limit is set. |
sizeLimitGB | integer | Specifies size limit in GB. |
usedSpaceBytes | integer | Specifies used space in Bytes. |
freeSpaceBytes | integer | Specifies free space in Bytes. |
type | string | Specifies the object storage type. The following types are available:
|
useArchiverAppliance | boolean | Defines that Veeam Backup for Microsoft 365 uses the Azure archiver appliance when transferring backed-up data to the archive object storage. |
azureArchiverAppliance | Contains a definition of the Azure archiver appliance that Veeam Backup for Microsoft 365 uses when transferring backed-up data to the archive object storage. | |
azureServiceAccount | Specifies properties of the Microsoft Azure service account that the Azure archiver appliance uses to access Microsoft Azure. | |
azureSubscription | Specifies properties of the Microsoft Azure subscription associated with a user account that is used to access Azure Blob storage. | |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Property | Type | Description |
|---|---|---|
name | string | Specifies a container name. |
regionType | string | Specifies a region type. The following types are available:
|
Property | Type | Description |
|---|---|---|
virtualMachineSize | Specifies the Azure archiver appliance size. | |
resourceGroup | Specifies a resource group associated with the Azure archiver appliance. | |
virtualNetwork | Specifies a virtual network to which the Azure archiver appliance is connected. | |
subnet | Specifies the Azure archiver appliance subnet. | |
region | string | Specifies a Microsoft Azure region. |
appliancePort | integer | Specifies a port number that is used to route requests between the Azure archiver appliance and Veeam Backup for Microsoft 365 backup infrastructure components. |
Response Example
Response: 201 Created
Response Body: { "id": "74fd81f6-c724-495b-89b6-8e35408d1f0a", "name": "Azure Archive Object Storage", "description": "", "accountId": "fc0ac22b-a067-4e65-8790-5f43348d109e", "sizeLimitEnabled": true, "sizeLimitGB": 10224, "usedSpaceBytes": 0, "freeSpaceBytes": 10977936408576, "type": "AzureBlobArchive", "_links": { "self": { "href": "/v6/objectstoragerepositories/74fd81f6-c724-495b-89b6-8e35408d1f0a" }, "account": { "href": "/v6/accounts/fc0ac22b-a067-4e65-8790-5f43348d109e" }, "container": { "href": "/v6/AzureResources/containers/container1?accountId=fc0ac22b-a067-4e65-8790-5f43348d109e&RegionType=Global" }, "folder": { "href": "/v6/AzureResources/containers/container1/folders/Folder1?accountId=fc0ac22b-a067-4e65-8790-5f43348d109e®ionType=Global" } }, "useArchiverAppliance": true, "azureContainer": { "name": "container1", "regionType": "Global" }, "azureFolder": "Folder1", "azureServiceAccount": { "id": "576705c3-a1af-49bd-878f-9067865bfcf9", "type": "Azure", "displayName": "Application", "applicationId": "2415230a-51ea-4e0d-a924-54c699a5431a", "applicationCertificateThumbprint": "FF2577A7586ACAD713FEBA43C62B67C1603CF7EC", "azureEnvironment": "Global", "azureTenantId": "4468fde5-48b8-4f24-b3f0-ce8a4078ca3f", "lastModified": "2022-02-16T17:46:16.8070443Z" }, "azureSubscription": { "displayName": "Enterprise Subscription", "subscriptionId": "be7051ea-8fa4-4605-c607-89f3dd09fffd" }, "azureArchiverAppliance": { "virtualMachineSize": { "name": "Standard_B4ms", "coresCount": "string", "memoryMB": 16384, "osDiskSizeMB": 0, "resourceDiskSizeMB": 0 }, "resourceGroup": { "name": "ResourceGroup10", "location": "northcentralus" }, "virtualNetwork": { "id": "/subscriptions/be7051ea-8fa4-4605-c607-89f3dd09fffd/resourceGroups/ResourceGroup10/providers/Microsoft.Network/virtualNetworks/groupvnet775", "name": "groupvnet775", "type": "Microsoft.Network/virtualNetworks", "location": "northcentralus", "addressSpaces": [ "10.5.0.0/16" ] }, "subnet": { "name": "default", "addressPrefix": "10.5.0.0/24" }, "region": "northcentralus", "appliancePort": 443 } } |