canonical: https://jentic.com/apis/azure.com/hybriddatamanagementclient # Microsoft Azure HybridDataManagementClient Jentic publishes the only available OpenAPI specification for HybridDataManagementClient, keeping it validated and agent-ready. The Azure Hybrid Data Management API provisions and operates Microsoft.HybridData data managers that move data between on-premises stores and Azure cloud services. It exposes 29 ARM endpoints to create data managers, configure data services and data stores, define job definitions, and run, cancel, or resume hybrid data movement jobs across resource groups and subscriptions. ## For AI agents Provision Azure HybridData data managers, define jobs that move data between on-premises and cloud stores, and run, cancel, or resume those jobs through Azure Resource Manager. ## Scope Does not handle data plane transfers, on-premises agent installation, or Azure storage account provisioning - use for HybridData control-plane management only. ## Capabilities - Create and update HybridData data manager resources scoped to a resource group - Configure data stores and data store types that act as sources and sinks for hybrid data movement - Define job definitions that describe how data moves between paired data stores - Trigger a job run, then cancel or resume in-flight jobs against a job definition - List public keys associated with a data manager for credential exchange - Enumerate Microsoft.HybridData operations available on the subscription ## Use cases ### On-Premises to Azure Data Migration Pipeline Move data from on-premises file shares or storage devices into Azure Storage by provisioning a HybridData data manager, attaching source and sink data stores, and defining a job definition that maps the transfer. The API drives the full lifecycle through Azure Resource Manager, so DevOps teams can codify hybrid migration jobs in ARM templates or scripts and run them on demand. A typical migration setup is a one-day exercise once data manager and store credentials are in place. Example prompt: Create a data manager named 'archive-mover' in resource group 'rg-archive', attach an on-premises file data store as source and an Azure Blob data store as sink, then run the configured job definition and wait for completion. ### Scheduled Hybrid Job Operations Operate recurring data movement jobs by listing job definitions, running them on a schedule, and reacting to failures with cancel and resume calls. The API exposes per-job state under each data service so an orchestrator can poll jobs by jobId and intervene when a job hangs. This is the operational backbone for teams running nightly hybrid ingestion into Azure data lakes. Example prompt: List all jobs under data service 'DataTransfer' for data manager 'nightly-ingest', find any in 'Failed' state, and resume each one via the resume endpoint. ### Hybrid Data Estate Inventory Audit a subscription's hybrid data footprint by enumerating data managers across resource groups, then walking each data manager's data stores, data store types, and job definitions. The output supports compliance reviews and cost allocation by showing which on-premises sources are wired into which Azure resources. Inventory runs complete in minutes against a single subscription. Example prompt: Enumerate all data managers in subscription 'sub-prod', and for each one return the count of data stores and job definitions as a single CSV report. ### Agent-Driven Hybrid Data Workflow via Jentic AI agents can drive Azure HybridData operations end-to-end through Jentic without handling raw Azure AD tokens. An agent searches Jentic for 'run an Azure hybrid data job', loads the run-job operation schema, and executes with the data manager and job definition names. Jentic's your Jentic One instance holds the OAuth credentials and supplies a scoped token for the call, so the agent never sees the client secret or refresh token. Example prompt: Use the Jentic MCP tool azure_hybriddata_run_job to start the 'daily-archive' job under data manager 'prod-mover' and report the returned job status. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | /subscriptions/{subscriptionId}/providers/Microsoft.HybridData/dataManagers | List data managers across the subscription | | PUT | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName} | Create or update a data manager | | GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions | List job definitions under a data service | | POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}/run | Trigger a run of the named job definition | | POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}/jobs/{jobId}/cancel | Cancel a running job | | POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}/jobs/{jobId}/resume | Resume a paused or failed job | ## Key resources - **DataManagers** — Top-level Azure Resource Manager resource that hosts hybrid data movement configuration - **DataServices** — Service categories within a data manager that expose specific transfer capabilities - **DataStores** — Source and sink endpoints (on-premises or cloud) participating in hybrid jobs - **DataStoreTypes** — Catalogue of supported store kinds available to a data manager - **JobDefinitions** — Reusable specifications that describe a transfer between paired data stores - **Jobs** — Individual job runs with cancel and resume operations - **PublicKeys** — Keys used to authenticate on-premises agents against the data manager ## Why Jentic - **Setup:** Wiring the Azure HybridData management API by hand means registering an Azure AD app, negotiating OAuth 2.0 bearer tokens for the management.azure.com audience, and threading subscription and resource-group scope through every ARM call. Through Jentic you install once, import HybridDataManagementClient from the API Directory, store the Azure AD credential once, and your agent calls it. - **Permission scoping:** This API puts the data manager in the URL path (/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/...), so a rule can pin your agent to one data manager: it can list job definitions and run them for that resource and nothing else. You choose the operations it may call, so a destructive one like cancelling or resuming a running job is not included unless you add it. - **Credential handling:** Your Azure AD credential for the HybridData management surface is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'list Azure HybridData job definitions' or 'run a data manager job', and Jentic returns the matching HybridData operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Azure IoT Hub** — IoT Hub ingests device telemetry that HybridData jobs can subsequently move into long-term Azure storage. - **Azure Key Vault** — Key Vault stores the secrets and certificates that HybridData data stores consume for source and sink credentials. - **Azure Stack Infrastructure Insights** — Infrastructure Insights covers Azure Stack health and inventory rather than data movement, but is the closest hybrid-management peer. ## FAQ ### Why is there no official OpenAPI spec for HybridDataManagementClient? Microsoft Azure does not publish an OpenAPI 3 specification for the HybridData control plane. Jentic generates and maintains this spec so that AI agents and developers can call HybridDataManagementClient 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 HybridDataManagementClient use? The API uses Azure Active Directory OAuth 2.0 with the user_impersonation scope against the management.azure.com audience. Through Jentic, the AAD client secret and refresh token are stored in the your Jentic One instance, and a scoped bearer token is injected into each request so the agent never handles raw credentials. ### Can I run and cancel hybrid data jobs with this API? Yes. Trigger a run by POSTing to the .../jobDefinitions/{jobDefinitionName}/run endpoint, then cancel or resume the resulting job at .../jobs/{jobId}/cancel or .../jobs/{jobId}/resume. The job state is returned from the standard list and get operations under the data service. ### What are the rate limits for HybridDataManagementClient? It uses the standard Azure Resource Manager throttling - typically 12,000 read and 1,200 write operations per hour per subscription, tracked via the x-ms-ratelimit-remaining-subscription-reads and x-ms-ratelimit-remaining-subscription-writes response headers. The HybridData provider does not document tighter limits, so plan against the ARM defaults. ### How do I trigger a hybrid data job through Jentic? Install the SDK with pip install jentic, then search Jentic with the query 'run an Azure hybrid data job', load the run-job operation, and execute with subscriptionId, resourceGroupName, dataManagerName, dataServiceName, and jobDefinitionName. Jentic returns the job resource so you can poll it via the jobs endpoint. ### Is the HybridDataManagementClient API free to call? The control-plane calls themselves are billed under standard ARM usage and are effectively free. The underlying Microsoft.HybridData resources, on-premises agents, and Azure storage egress are billed separately under your Azure subscription per the published Azure pricing pages. ### Can I limit what my agent is allowed to do with the Microsoft Azure HybridData API? Yes. Because you run Jentic One yourself, your own rules decide which HybridData operations and credentials the agent may use. Since this API carries the data manager in the URL path, a rule can pin the agent to a single data manager, letting it list and run that manager's job definitions and nothing else. You choose the operations it may call, so destructive ones like cancelling or resuming a running job are excluded unless you explicitly allow them.