Skip to main content

Private Self-Made Cloud Connector - Create

Prepare the Azure credentials and ExpressRoute information before submitting a Private Self-Made cloud connector.

1. Retrieve Azure credentials​

List the credentials for the project and select the returned id for azureCredentialId.

GET https://ope-obs.apibackbone.orange.com/evolutionplatform/azure/api/v1/projects/{projectId}/azure/credentials?limit=20&offset=0

2. Retrieve a technical VPN (optional)​

The Azure Private Self-Made create schema accepts technicalVpnId, but does not require it. If you want to associate a technical VPN, replace {tenantId} with the tenant or organization UUID, then use the returned VPN id.

GET https://ope-obs.apibackbone.orange.com/evolutionplatform/vpnaaservice/api/v2/tenant/{tenantId}/vpns?connectivity=Any2Any&limit=100&offset=0

3. Retrieve the ExpressRoute service key​

Use the service key for the ExpressRoute circuit that will be connected. Find it in the Azure portal on the ExpressRoute circuit overview page. Treat the key as sensitive configuration.

Set this value as azureExpressRouteServiceKey in the create request.

4. Retrieve the ExpressRoute VNet gateway name​

In the Azure portal, find the virtual network gateway associated with the ExpressRoute circuit and use its resource name as expressRouteVnetGatewayName.

5. Set the connector values​

Choose the connector name, bandwidth, and routing policy. The request schema also supports an optional state, purchase order number, external billing reference, and inbound or outbound routing policies.

Supported routing policy values are basicAggregate, defaultRoute, noAggregate, and customRouting. The Swagger does not mark individual request-body properties as required.

6. Create the Private Self-Made cloud connector​

POST https://ope-obs.apibackbone.orange.com/evolutionplatform/azure/api/v1/projects/{projectId}/azure/cloudconnectors/privateselfmades
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json

Replace {projectId} with the UUID of the project that will own the connector. Example request:

{
  "name": "YOUR_CONNECTOR_NAME",
  "azureCredentialId": "YOUR_AZURE_CREDENTIAL_ID",
  "technicalVpnId": "YOUR_TECHNICAL_VPN_ID",
  "azureExpressRouteServiceKey": "YOUR_EXPRESS_ROUTE_SERVICE_KEY",
  "expressRouteVnetGatewayName": "YOUR_VNET_GATEWAY_NAME",
  "bandwidth": 50,
  "routingPolicy": "basicAggregate"
}

Omit technicalVpnId if you are not associating a technical VPN. A successful request returns 201 Created with a CloudConnectorPrivateSelfMade response and a Content-Location header. Error responses defined by the Swagger are 400, 401, 403, and 500.