Azure Cloud Connectivity API - Endpoint reference
Before you start
- Follow the Set up access guide to obtain an access token for API calls.
- You need access to an Evolution Platform organization and project.
- The examples use the host
ope-obs.apibackbone.orange.com. Replace{projectId}with your project UUID. - Send the JWT as an
Authorizationheader. - For JSON requests, send
Content-Type: application/json; useAccept: application/jsonwhen requesting JSON. - Replace path placeholders such as
{projectId}and{id}with values from your project and connector.
Base URL for the Azure Cloud Connectivity API:
https://ope-obs.apibackbone.orange.com/evolutionplatform/azure/api/v1
Credentials
| Method | Route | Success | Guide |
|---|---|---|---|
POST | /projects/{projectId}/azure/credentials | 201 | Create |
GET | /projects/{projectId}/azure/credentials | 200 | List |
GET | /projects/{projectId}/azure/credentials/{id} | 200 | Get |
PUT | /projects/{projectId}/azure/credentials/{id} | 200 | Update |
PATCH | /projects/{projectId}/azure/credentials/{id} | 200 | Update |
DELETE | /projects/{projectId}/azure/credentials/{id} | 204 | Delete |
Private Self-Made Cloud Connector
| Method | Route | Success | Guide |
|---|---|---|---|
POST | /projects/{projectId}/azure/cloudconnectors/privateselfmades | 201 | Create |
GET | /projects/{projectId}/azure/cloudconnectors/privateselfmades | 200 | List |
GET | /projects/{projectId}/azure/cloudconnectors/privateselfmades/{id} | 200 | Get |
PUT | /projects/{projectId}/azure/cloudconnectors/privateselfmades/{id} | 200 | Replace |
PATCH | /projects/{projectId}/azure/cloudconnectors/privateselfmades/{id} | 200 | Update |
DELETE | /projects/{projectId}/azure/cloudconnectors/privateselfmades/{id} | 204 | Delete |
GET | /projects/{projectId}/azure/cloudconnectors/privateselfmades/{id}/resources | 200 | Read resources |
DELETE | /projects/{projectId}/azure/cloudconnectors/privateselfmades/{id}/cloudresources/{rssId} | 204 | Delete a cloud resource |
POST | /projects/{projectId}/azure/cloudconnectors/privateselfmades/{id}/updatereservedbandwidth | 200 | Update reserved bandwidth |
GET | /projects/{projectId}/azure/cloudconnectors/privateselfmades/{id}/usage | 200 | Read usage |
Public Standard Cloud Connector
| Method | Route | Success | Guide |
|---|---|---|---|
POST | /projects/{projectId}/azure/cloudconnectors/publicstandarddynamics | 201 | Create |
GET | /projects/{projectId}/azure/cloudconnectors/publicstandarddynamics | 200 | List |
GET | /projects/{projectId}/azure/cloudconnectors/publicstandarddynamics/{id} | 200 | Get |
PUT | /projects/{projectId}/azure/cloudconnectors/publicstandarddynamics/{id} | 200 | Update |
PATCH | /projects/{projectId}/azure/cloudconnectors/publicstandarddynamics/{id} | 200 | Update |
DELETE | /projects/{projectId}/azure/cloudconnectors/publicstandarddynamics/{id} | 204 | Delete |
GET | /projects/{projectId}/azure/cloudconnectors/publicstandarddynamics/{id}/resources | 200 | — |
DELETE | /projects/{projectId}/azure/cloudconnectors/publicstandarddynamics/{id}/cloudresources/{rssId} | 204 | — |
GET | /projects/{projectId}/azure/cloudconnectors/publicstandarddynamics/{id}/usage | 200 | — |
Public High Availability Cloud Connector
| Method | Route | Success | Guide |
|---|---|---|---|
POST | /projects/{projectId}/azure/cloudconnectors/publichadynamics | 201 | Create |
GET | /projects/{projectId}/azure/cloudconnectors/publichadynamics | 200 | List |
GET | /projects/{projectId}/azure/cloudconnectors/publichadynamics/{id} | 200 | Get |
PUT | /projects/{projectId}/azure/cloudconnectors/publichadynamics/{id} | 200 | Update |
PATCH | /projects/{projectId}/azure/cloudconnectors/publichadynamics/{id} | 200 | Update |
DELETE | /projects/{projectId}/azure/cloudconnectors/publichadynamics/{id} | 204 | Delete |
GET | /projects/{projectId}/azure/cloudconnectors/publichadynamics/{id}/resources | 200 | — |
DELETE | /projects/{projectId}/azure/cloudconnectors/publichadynamics/{id}/cloudresources/{rssId} | 204 | — |
GET | /projects/{projectId}/azure/cloudconnectors/publichadynamics/{id}/usage | 200 | — |
Private Cloud Connector
| Method | Route | Success | Guide |
|---|---|---|---|
GET | /projects/{projectId}/azure/cloudconnectors/privates?limit=10&offset=0 | 200 | — |
GET | /projects/{projectId}/azure/cloudconnectors/privates/{id} | 200 | — |
GET | /projects/{projectId}/azure/cloudconnectors/privates/{id}/usage?startDate={startDate}&endDate={endDate}&unitFactor=mega&usageType=bandwidth | 200 | — |
Azure lookup operations
| Purpose | Method and route |
|---|---|
| List Azure regions | GET /projects/{projectId}/azure/regions?azureCspCredentialId={azureCspCredentialId} |
| List resource groups | GET /projects/{projectId}/azure/resourcegroups?azureCspCredentialId={azureCspCredentialId}&azureRegion={azureRegion} |
| List virtual networks | GET /projects/{projectId}/azure/vnets?azureCspCredentialId={azureCspCredentialId}&azureResourceGroup={azureResourceGroup} |
| List Azure locations | GET /projects/{projectId}/azure/locations?azureCspCredentialId={azureCspCredentialId} |
| List ExpressRoute gateways | GET /projects/{projectId}/azure/expressroutegateways?azureCspCredentialId={azureCspCredentialId}&azureResourceGroup={azureResourceGroup} |
| Retrieve service-key data | GET /projects/{projectId}/azure/skey/{skey}/data |
| Estimate Public Standard connector cost | GET /azurecosting/publicstandarddynamics?azureRegion={azureRegion}&bandwidth={bandwidth}¤cy={currency} |
| List bandwidths by location | GET /bandwidths?connectivityType={connectivityType}&displayLocation={displayLocation}&location={location}&limit=10&offset=0 |
| List bandwidths by connectivity type | GET /connectivity/{connectivityType}/bandwidths?limit=10&offset=0 |