DataBoxEdgeManagementClient

Name: DataBoxEdgeManagementClient API
Brand: Data Box Edge Management
Availability: InStock

★ Only Publicly Available OpenAPI DocumentIOTDevice Managementoauth249 EndpointsREST

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.

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.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic 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

GET STARTED

Start building with DataBoxEdgeManagementClient API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for DataBoxEdgeManagementClient, keeping it validated and agent-ready.

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.

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

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Azure service principal credentials are encrypted in the Jentic vault. Agents receive scoped ARM bearer tokens at execution time; the client secret never enters the agent context.

Intent-based discovery

Agents search by intent ('list data box edge alerts' or 'create a data box edge share') and Jentic returns the matching operation, avoiding the need to learn 49 endpoint paths under Microsoft.DataBoxEdge.

Time to first call

Direct ARM integration: 1-2 days for AAD app registration, MSAL token handling, and per-resource schema marshalling. Through Jentic: under 1 hour.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Data Box Management

One-time bulk data import/export via shipped Data Box appliances rather than persistent edge compute.

Choose Data Box for one-shot data transfer; choose Data Box Edge for ongoing edge compute with continuous Azure sync.

Complementary

Storage Management

Manage the Azure Storage accounts that back Data Box Edge shares.

Use Storage Management to provision the storage account and credentials that a Data Box Edge share references.

Complementary

Azure Monitor Management

Configure metric alerts and diagnostic settings on Data Box Edge devices.

Use when an agent needs to ship Data Box Edge alerts and metrics into a central observability stack.

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 at https://app.jentic.com/sign-up.

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.