Default off, broker only: redeem a TCP ticket into a lease
Internal broker only; excluded from public SDK methods. Default off. Check exact tenant, route, role, generation, credential, unconsumed ticket and current authorizing administrator/paid authority. Atomic admission limits are 128 live legs globally, 16 per organization and 8 per route. A consumed ticket remains consumed after broker restart. Compare every returned lease binding. Strict JSON, 4096-byte bodies, 2000 requests/minute.
Authorization
HostedGatewayTcpBrokerAuth Internal service only: the dedicated HOSTED_GATEWAY_TCP_BROKER_TOKEN, at least 48 characters. Route credentials, organization API keys, account sessions and the worker token are never accepted. Never distribute this bearer to a customer or public SDK.
In: header
Request Body
application/json
Sensitive opaque capability; never put in a URL, log, analytics event or ordinary resource view.
^[A-Za-z0-9_-]{43}$uuidlength <= 253Value in
- "connector"
- "client"
Response Body
application/json
curl -X POST "https://example.com/v1/internal/gateway/tcp/redeem" \ -H "Content-Type: application/json" \ -d '{ "ticket": "string", "route_id": "dd833dbc-f3c5-44d9-98a2-7ba12ebc8160", "tenant_host": "string", "role": "connector" }'{ "lease_id": "2bb93227-93ec-4b58-a0aa-93b5a1121b74", "lease_token": "string", "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b", "route_id": "dd833dbc-f3c5-44d9-98a2-7ba12ebc8160", "generation": 1, "tenant_host": "string", "role": "connector", "resource_hash": "string", "expires_at": "2019-08-24T14:15:22Z"}Apply a Microsoft platform subscription's state to its organization (internal producers) PUT
Internal; default off, with the same flag and producer capability as provisionMicrosoftPlatformOrganization. Commerce sends each state its Microsoft lifecycle records for the subscription (plan change, Suspend, Reinstate, Unsubscribe), numbered by `revision`. Only the subscription the organization was created for is accepted. A higher revision applies: SUBSCRIBED grants the plan; SUSPENDED and UNSUBSCRIBED keep the plan with API access off, so decisions answer 402 until Reinstate. The same revision with the same state is `replayed`, an older one `stale`; neither changes anything. The organization's entitlement moves only while it is the default or this source's own (`marketplace:microsoft:platform`); otherwise the state is recorded and `projected` is false. 404 subscription_not_found when Core created no organization for this subscription; 409 subscription_conflict with reason subscription (another subscription), revision (the same revision with another state) or ended (a change after UNSUBSCRIBED); 422 plan_unknown for a plan code Core does not sell.
Default off, broker only: renew a still-valid TCP lease POST
Internal broker only; excluded from public SDK methods. Default off. Refresh every 10 seconds. Recheck enabled route, generation, role credential and current authorizing administrator membership and paid active entitlement. Return the same bound grant with at most 30 seconds of validity; an expired lease never revives and total lifetime cannot exceed one hour. The broker closes a leg before the last valid expiry if renewal fails. Strict JSON, 4096-byte bodies, 2000 requests/minute.