HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. thirdPartyServices

Create or update Azure LAN-side subscription

post
http://127.0.0.1:8080/thirdPartyServices/azure/lan-side-connectivity/lanSideSubscription

Creates or updates the Azure LAN-side subscription credentials for SD-WAN LAN-side connectivity automation. The subscription enables integration with Azure Virtual Hubs, Route Servers, and Load Balancers. On success, Azure reserved BGP ASNs are automatically configured and a scheduled job is created for orchestration.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Azure account configuration with subscription credentials. The id field must reference an existing Azure cloud deployment account to retrieve the clientSecret.

Azure LAN-side subscription account configuration for SD-WAN cloud integration with Virtual Hubs, Route Servers, and Load Balancers.

string
required

Reference to an existing Azure cloud deployment account ID. The clientSecret is retrieved from this account.

string

Human-readable display name for the Azure subscription account. Used for identification in the UI.

string
required
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Azure subscription ID (GUID format). Found in Azure Portal under Subscriptions.

string
required
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Azure Active Directory tenant ID (GUID format). Found in Azure Portal under Azure Active Directory > Properties.

string
required

Azure AD application (service principal) client ID. The app must have Network Contributor permissions.

string

Azure AD application client secret. Not required in POST (retrieved from existing account); always null in GET responses.

string

Optional notes or description for this Azure subscription configuration.

Responses

Updated about 12 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 12 hours ago

Did this page help you?