Modify Worker Configuration
You can update settings of a worker configuration with the specified ID added to the Veeam Backup for Microsoft Azure configuration database.
Request
To change worker configuration settings, send the HTTP PUT request to the /workerConfiguration/{id} endpoint. {id} is a system ID assigned to the worker configuration in the Veeam Backup for Microsoft Azure REST API.
HTTP Request
PUT https://<hostname>/api/v2/workerConfiguration/{id} |
Request Headers
The request contains the following headers.
Header | Required | Value | Description |
|---|---|---|---|
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Request Body
To update data for the worker configuration, send the following parameters in the request body.
Parameter | Type | Description |
|---|---|---|
minInstances | integer($int32) | The number of workers that Veeam Backup for Microsoft Azure must deploy before the backup and restore operation starts. |
maxInstances | integer($int32) | The maximum number of workers that Veeam Backup for Microsoft Azure can deploy and use simultaneously during backup and restore operations. |
subnet | string | Name of the subnet to which worker instances must be connected. |
virtualNetworkResourceId | string | Azure ID of a network resource group. |
regionId | string | Azure region ID. |
networkSecurityGroupId | string | Azure ID of a network security group. |
virtualMachineType | string | Specify the size of the Azure VM where the worker instance is running. |
Set the parameter values in the following format:
{ "minInstances": 0, "maxInstances": 0, "subnet": "string", "virtualNetworkResourceId": "string", "regionId": "string", "networkSecurityGroupId": "string", "virtualMachineType": "string" } |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 200 (OK).
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Value | Description |
|---|---|---|
Content-length | integer | Identifies the length of the response body message, in bytes. |
Content-type |
| Identifies the media type of the response body message. |
Response Body
In the response body, Veeam Backup for Microsoft Azure returns an updated representation of the worker configuration. The WorkerConfigurationV2 schema is used for the resource representation.
Example
The following request modifies the worker configuration the ID 1.
|