Microsoft Azure DataBoxEdgeManagementClient
Browse all Azure APIs47
AI ReadinessFoundational (D+)47/100
Agent-ready OpenAPI document · curated by JenticIOTDevice Managementoauth249 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Provision and manage Azure Data Box Edge devices and their roles, shares, schedules, and alerts through 49 operations on the Microsoft.DataBoxEdge resource provider.
Use for: I need to order a new Data Box Edge device for our London office, I want to delete a decommissioned Data Box Edge device, List all alerts currently active on a Data Box Edge device, Find all Data Box Edge devices in a subscription that are offline
Not supported: Does not transfer file contents, run workloads on the device, or manage in-flight Data Box appliances - use for Data Box Edge device provisioning and management only.
Jentic publishes the only available OpenAPI specification for DataBoxEdgeManagementClient, keeping it validated and agent-ready. The Azure Data Box Edge management API exposes 49 operations across 32 paths to provision Data Box Edge devices, configure their bandwidth schedules, alerts, roles, shares, storage account credentials, triggers, users, and orders. Use it to onboard new edge appliances at branch sites, push compute roles and storage shares onto them, and monitor alerts across a fleet from a central control plane.
Install Jentic One Beta
Connect the DataBoxEdgeManagementClient to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the DataBoxEdgeManagementClient, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fazure.com%2Fazure-data-box-edge-management" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fazure.com%2Fazure-data-box-edge-management" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with DataBoxEdgeManagementClient API.
Order, list, and delete Data Box Edge devices across resource groups
Configure bandwidth schedules to constrain upload windows on metered links
Deploy and manage compute roles (IoT, Kubernetes) onto an edge device
Create SMB and NFS shares on a device backed by Azure Storage
Manage storage account credentials used for share replication
Set triggers that react to events on the device
List and acknowledge device alerts and check job status across the fleet
Use Cases
Patterns agents use DataBoxEdgeManagementClient API for, with concrete tasks.
★ Onboard New Edge Devices
Order and provision Data Box Edge devices for branch or factory sites by calling the Devices CreateOrUpdate endpoint with the SKU and shipping address details. Once received and connected, the same API configures network, bandwidth schedules, and the initial compute role. The end-to-end onboarding cycle is days physical, minutes API, and the same flow applies whether you are deploying one device or fifty.
Order a Data Box Edge device named 'edge-london-01' in resource group 'rg-edge' with SKU 'Edge' and shipping address from the office record
Manage Bandwidth and Backhaul
Apply bandwidth schedules to constrain when an edge device uploads to Azure, protecting branch links during business hours. The BandwidthSchedules endpoints define start and end time, days of week, and rate limit in Mbps. Schedules can be edited or removed remotely, so changes during peak periods do not require a site visit.
Create a bandwidth schedule on device 'edge-london-01' that limits uploads to 50 Mbps from 09:00 to 17:00 on weekdays
Edge Compute and Share Deployment
Deploy IoT or Kubernetes roles to Data Box Edge devices to run containerised workloads close to the data source, and create SMB or NFS shares that expose Azure Storage to local clients. The Roles, Shares, and StorageAccountCredentials endpoints together let an automation pipeline wire up a new edge environment in a few API calls instead of hours of portal work.
Create a Kubernetes role on device 'edge-london-01' and an SMB share 'orders-share' backed by storage account credential 'orders-sa'
Fleet Alert Monitoring
Pull alerts and jobs from every Data Box Edge device in a subscription on a schedule to drive a central NOC dashboard. Alerts surface hardware errors, sync failures, and threshold breaches; jobs track long-running operations such as software updates. Combining the two views gives one pane of glass over the edge fleet.
List all alerts across every Data Box Edge device in subscription /subscriptions/{id} and report any with severity 'Critical'
AI Agent Edge Operations
An AI agent supporting an operations team can manage Data Box Edge devices through Jentic. The agent searches by intent ('list data box edge alerts'), Jentic returns the Alerts_ListByDataBoxEdgeDevice operation with its schema, and the agent executes the call with managed Azure credentials. The same flow handles bandwidth schedule updates, role deployment, and device decommissioning.
Search Jentic for 'list data box edge alerts', execute Alerts_ListByDataBoxEdgeDevice for each device returned by Devices_ListBySubscription, and summarise critical alerts
Key Endpoints
49 endpoints — jentic publishes the only available openapi specification for databoxedgemanagementclient, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
GET
/subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices
List all Data Box Edge devices in a subscription
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}
Delete a Data Box Edge device
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts
List alerts on a specific device
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules
List bandwidth schedules on a device
GET
/providers/Microsoft.DataBoxEdge/operations
List Microsoft.DataBoxEdge operations
GET
/subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices
List all Data Box Edge devices in a subscription
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}
Delete a Data Box Edge device
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts
List alerts on a specific device
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules
List bandwidth schedules on a device
GET
/providers/Microsoft.DataBoxEdge/operations
List Microsoft.DataBoxEdge operations
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
D
DataBoxEdgeManagementClient
- Foundational (D+)47/100
68
Foundational Compliance63
Developer Experience & Jentic Compatibility25
AI-Readiness & Agent Experience94
Agent Usability35
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
68
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: B+Signals: 4
73%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
25
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
81%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
0%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
21%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
35
Security
Trust, risk posture, and security compliance.
Grade: FSignals: 1
35%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring Azure Data Box Edge by hand means registering an Azure AD app, handling MSAL bearer tokens against management.azure.com with the user_impersonation scope, and polling the Azure-AsyncOperation header for device provisioning and role creation yourself. Through Jentic you install once, import Data Box Edge Management from the API Directory, store the Azure service principal credential once, and your agent calls it.
Permission scoping
Data Box Edge puts the device name in the URL path (/subscriptions/{id}/resourceGroups/{rg}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/...), so a rule can pin your agent to one device and its shares, roles, and alerts. You choose the operations it may call, so destructive ones like Devices_Delete or Shares_Delete are not included unless you add them.
Credential isolation
Your Azure service principal credential is stored once, encrypted, by your own Jentic One instance and injected as a scoped ARM bearer token at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'list Data Box Edge alerts' or 'create a share on an edge device', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without learning the 49 paths under Microsoft.DataBoxEdge.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using DataBoxEdgeManagementClient API through Jentic.
Why is there no official OpenAPI spec for DataBoxEdgeManagementClient?
Microsoft Azure does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call DataBoxEdgeManagementClient via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the Data Box Edge management API use?
It uses Azure Active Directory OAuth 2.0 against https://management.azure.com/ with the user_impersonation scope. The caller needs Contributor or a custom role with Microsoft.DataBoxEdge/* permissions on the resource group. Jentic stores the service principal credentials encrypted and issues short-lived bearer tokens to agents.
Can I deploy Kubernetes workloads to a Data Box Edge through this API?
Yes. The Roles_CreateOrUpdate endpoint accepts a kind of Kubernetes (or IoT) and the role-specific properties needed to deploy and configure the runtime on the device. Once the role is in place, you manage workloads through standard Kubernetes tooling.
What are the rate limits for the Data Box Edge management API?
Azure Resource Manager applies subscription-level read and write throttling (around 1,200 requests per hour). Long-running operations such as device provisioning or role creation return 202 Accepted with an Azure-AsyncOperation header that you poll for completion.
How do I list device alerts through Jentic?
Run pip install jentic and search for 'list data box edge alerts'. Jentic returns the Alerts_ListByDataBoxEdgeDevice operation; load its schema and execute it with the subscriptionId, resourceGroupName, and deviceName.
Does this API let me browse files on the device's shares?
No. This is the management plane only - it provisions shares and credentials. To read or write files, mount the SMB or NFS share and use a standard file client.
Can I limit what my agent is allowed to do with the Data Box Edge Management API?
Yes. Because you run Jentic One yourself, your own rules decide which of the 49 Data Box Edge operations your agent may call, so you can allow read-only actions like Alerts_ListByDataBoxEdgeDevice and Devices_ListBySubscription while withholding destructive ones such as Devices_Delete or Shares_Delete. Since the device name sits in the URL path, a rule can pin the agent to a single device and only its shares, roles, and alerts. Your Azure service principal credential is held encrypted by your own instance and injected as a scoped bearer token at execution time, never reaching the agent's prompt or logs.
GET STARTED