Azure ExpressRoute

To create an Azure connection, you will need to:

  1. Create a connection request via the Azure dashboard.
  2. Use the Create an Azure Direct Connect Partner. connection endpoint to create a connection request in Console Connect using the service key from Azure.
    • The connection group will be created and the status will be CREATING.
    • After connection creation is completed, the status will become ACTIVE.
  3. Configure your peering information

Provisioning Statuses

There are several sub-statuses available for Azure connections, which can be found in the connection.partner.peering field. These statuses are listed in the following table.

Provisioning Status Description
NOT PROVISIONED Not yet provisioned.
PROVISIONING In the process of provisioning with Azure.
PROVISIONED Connection is active & ready to use.
DEPROVISIONING In the process of deprovisioning with Azure.

Create Azure Layer 2 connection

After creating a connection request via the Azure dashboard and generating a service key, create the connection by submitting the service key, speed, name and source port.

Azure DirectConnect Partner connections require redundancy - there are always two destination ports.

Because Azure connections require redundancy, this endpoint creates a 'GROUP_LAYER2' connection that groups two 'LAYER2' subconnections rather than a regular 'LAYER2' connection.

Request
path Parameters
username
string

The username of the company.

Example: Acme
Request Body schema: application/json
azureServiceKey
string
name
string
Array of objects
speed
number
paymentType
string
Responses
200

OK

put/api/company/{username}/connections/directConnectPartner/AZURE/layer2/create
Request samples
application/json
{
  • "azureServiceKey": "your_key_here",
  • "name": "Azure ExpressRoute",
  • "srcPort": [
    ],
  • "speed": 100,
  • "paymentType": "payg"
}

Update an Azure connection's peering config

Use this endpoint to update your peering information with the three Azure services:

Type Description
PUBLIC Azure services available via public IP address. Examples include Azure storage, Azure SQL databases Azure Active Directory and Azure websites.
PRIVATE Private Azure services, not available via public IP address. Examples include Azure virtual machines and cloud services hosted within a virtual network.
MICROSOFT Other Microsoft services offered via public IP. Examples include Office 365.

You can not call this endpoint before the connection has been provisioned (before the connection status is ACTIVE)

Request
path Parameters
username
required
string

The username of the company that created the connection.

Example: Acme
connectionId
required
string

The ObjectID from the Create Azure connection endpoint.

Example: 507f1f77bcf86cd799439011
peeringType
required
string

The type of peering i.e Private Azure (PRIVATE), Public Azure (PUBLIC) or Microsoft / Office365 (MICROSOFT)

Example: PRIVATE
Responses
200

OK

post/api/company/{username}/connections/directConnectPartner/AZURE/layer2/{connectionId}/peering/{peeringType}(PUBLIC|PRIVATE|MICROSOFT)

Read an Azure connection's peering config

Read an Azure connection's peering config from the system. Note that if you have recently changed this information in the Azure dashboard it may take some time to propagate back to Console Connect.

syncStatus

Peering sync status can be one of the following values:

syncStatus Description
PENDING The request has been sent to the system
SYNCING The system is syncing the configuration with Azure
SYNCED The configuration is active in Azure

Note that 'advertisedPublicPrefixes' and 'routingRegistryName' are only used for configs of type MICROSOFT.

Request
path Parameters
username
required
string

The username of the company that created the connection.

Example: Acme
connectionId
required
string

The ObjectID from the Create Azure connection endpoint.

Example: 507f1f77bcf86cd799439011
peeringType
required
string

The type of peering i.e Private Azure (PRIVATE), Public Azure (PUBLIC) or Microsoft / Office365 (MICROSOFT)

Example: PRIVATE
Responses
200

OK

get/api/company/{username}/connections/directConnectPartner/AZURE/layer2/{connectionId}/peering/{peeringType}(PUBLIC|PRIVATE|MICROSOFT)

Delete an Azure connection's peering config

Request
path Parameters
username
required
string

The username of the company that created the connection.

Example: Acme
connectionId
required
string

The ObjectID from the Create Azure connection endpoint.

Example: 507f1f77bcf86cd799439011
peeringType
required
string

The type of peering i.e Private Azure (PRIVATE), Public Azure (PUBLIC) or Microsoft / Office365 (MICROSOFT)

Example: PRIVATE
Responses
200

OK

delete/api/company/{username}/connections/directConnectPartner/AZURE/layer2/{connectionId}/peering/{peeringType}(PUBLIC|PRIVATE|MICROSOFT)

Verify the key

You can use this endpoint to verify and retrieve information from the service key before you create the connection.

Request
path Parameters
username
string

The username of the company.

Example: Acme
Request Body schema: application/json
serviceKey
string
Responses
200

OK

post/api/company/{username}/connections/directConnectPartner/AZURE/layer2/serviceKey
Request samples
application/json
{
  • "serviceKey": "example-service-key"
}