This is an archive version of the document. To get the most up-to-date information, see the current version.Exporting Worker Configuration List
This section explains how to export a list with worker configurations.
Request
GET https://<hostname>/api/v1/workerConfiguration/export |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
None.
Request Body
None.
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 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
Property | Type | Description |
|---|---|---|
id | integer | Shows the identification number of the worker configuration. |
minInstances | integer | Shows the minimum allowed number of instances that might be deployed in accordance with the worker configuration. |
maxInstances | integer | Shows the maximum allowed number of instances that might be deployed in accordance with the worker configuration. |
virtualNetwork | Contains the WorkerVirtualNetwork object. | |
region | Contains the Region object. | |
networkSecurityGroup | Contains the NetworkSecurityGroup object. | |
virtualMachineType | string | Shows the type of which to deploy VMs as workers. |
numberOfCores | integer | Shows how many cores VMs may have. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Property | Type | Description |
|---|---|---|
name | string | Shows the name if the virtual network. |
resourceId | string | Shows the identification number of the network. |
subnet | string | Shows the subnetwork name. |
regionId | string | Shows the identification number of the Azure region to which the virtual network belongs. |
resourceGroupId | string | Shows the identification number of the resource group. |
subscriptionId | string | Shows the identification number of the Azure subscription. |
resourceGroupName | string | Shows the name of the resource group. |
Property | Type | Description |
|---|---|---|
id | string | Shows the identification number of the region. |
name | string | Shows the name of the region. |
Property | Type | Description |
|---|---|---|
id | string | Shows the identification number of the security group. |
name | string | Shows the name of the security group. |
regionId | string | Shows the identification number of the region to which the network security group belongs. |
resourceGroupName | string | Shows the name of the resource group to which the network security group belongs. |
subscriptionId | string | Shows the identification number of the subscription. |
Example
Request: GET https://abc.ukwest.cloudapp.azure.com/api/v1/workerConfiguration/export
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: [{ "id": 1, "minInstances": 1, "maxInstances": 5, "virtualNetwork": { "resourceId": "/subscriptions/3a9a8330-7bbc-4b03-9c68-15d674fbc809/resourcegroups/jenkins-abc/providers/microsoft.network/virtualnetworks/vba_vnet-eastus-0", "subnet": "abc-Subnet", "subscriptionId": "3a9a8330-7bbc-4b03-9c68-15d674fbc809" }, "region": { "id": "ukwest", "name": "UK West" }, "networkSecurityGroup": { "id": "/subscriptions/3a9a8330-7bbc-4b03-9c68-15d674fbc809/resourcegroups/cpm-backup-martin/providers/microsoft.network/networksecuritygroups/controller-nsg", "name": "controller-nsg", "regionId": "ukwest", "resourceGroupName": "cpm-backup-martin", "subscriptionId": "3a9a8330-7bbc-4b03-9c68-15d674fbc809" }, "virtualMachineType": "Standard_A2", "numberOfCores": 2, "_links": {"self": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/workerConfiguration/1?expand=All"}} }] |