Microsoft Storage Sync

Name: Microsoft Storage Sync API
Brand: Microsoft Storage Sync
Availability: InStock

★ Only Publicly Available OpenAPI DocumentStorageObject Storageoauth237 EndpointsREST

For Agents

Provision Azure File Sync services, register on-premises servers, and create sync groups that mirror file shares between Windows file servers and Azure storage. Covers 37 management endpoints across storage sync services, registered servers, sync groups, and cloud and server endpoints.

Connect the Microsoft Storage Sync to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Microsoft Storage Sync, 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 Microsoft Storage Sync API.

Create and update Storage Sync Service resources scoped to an Azure resource group

Define sync groups that pair an Azure file share with one or more server endpoints

Configure cloud endpoints that connect a sync group to a specific Azure file share

GET STARTED

Start building with Microsoft Storage Sync API

Explore with Jentic

View OpenAPI Document

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

Jentic publishes the only available OpenAPI specification for Microsoft Storage Sync, keeping it validated and agent-ready. The Microsoft Storage Sync API manages Azure File Sync deployments that centralize on-premises file shares in Azure while keeping the flexibility, performance, and compatibility of a local file server. It exposes operations to provision Storage Sync Services, enroll registered servers, define sync groups, configure cloud endpoints to Azure file shares, and add server endpoints that pair on-prem volumes with the cloud. Workflow operations allow agents to track long-running provisioning and synchronization tasks across regions.

Use Cases

Patterns agents use Microsoft Storage Sync API for, with concrete tasks.

★ Hybrid file server consolidation

Centralize branch office and headquarters file shares in Azure while keeping local read and write performance. The Microsoft Storage Sync API lets operators create a Storage Sync Service, register each on-premises file server, and pair on-prem volumes with Azure file shares through sync groups. Cloud tiering keeps frequently accessed files on local storage and offloads cold data to Azure, reducing on-prem capacity needs by 80 percent or more.

Create a Storage Sync Service named contoso-sync in resource group prod-files, register server srv-fs01, and create a sync group named legal-docs with a cloud endpoint pointing at the legal Azure file share.

Disaster recovery for on-premises file shares

Protect critical on-premises file shares by continuously syncing them to a geo-redundant Azure storage account. Operations teams use the Storage Sync API to add server endpoints to existing sync groups, monitor workflow status, and validate that all files have replicated to the cloud endpoint before declaring DR readiness. Recovery point objectives can drop from days to minutes.

Add a server endpoint mapping D:\shares\finance on srv-fs02 to the finance-sync sync group with cloud tiering disabled and confirm the provisioning workflow has completed successfully.

Capacity-aware cloud tiering policies

Reduce local storage spend on Windows file servers by configuring cloud tiering thresholds per server endpoint. Through the Storage Sync API, agents can patch existing server endpoint resources to adjust the volume free-space percentage that triggers tiering, monitor the resulting tiering activity through workflow operations, and roll out updated policies across many servers in a single batch.

Patch every server endpoint under sync group archive-data to set volumeFreeSpacePercent to 20 and report which workflows completed within five minutes.

Agent-driven Azure File Sync operations

AI agents can use Jentic to discover Microsoft Storage Sync operations by intent, load the structured input schema, and execute calls against management.azure.com without browsing Azure Resource Manager docs. Agents handle routine tasks like registering a server, recutting an expiring server certificate, or expanding a sync group to a new branch office without operator intervention.

Search Jentic for create a storage sync service, load the input schema, and execute it for resource group ops-sync in westeurope with the SKU StandardLRS.

Key Endpoints

37 endpoints — jentic publishes the only available openapi specification for microsoft storage sync, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}

Create or update a Storage Sync Service

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices

List Storage Sync Services in a resource group

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers

List registered servers under a Storage Sync Service

POST

/subscriptions/{subscriptionId}/providers/Microsoft.StorageSync/locations/{locationName}/checkNameAvailability

Check Storage Sync Service name availability in a region

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}

Create or update a Storage Sync Service

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices

List Storage Sync Services in a resource group

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers

List registered servers under a Storage Sync Service

Why though Jentic?

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

Credential isolation

Azure AD OAuth credentials and service principals are stored encrypted in the Jentic vault. Agents receive scoped bearer tokens for management.azure.com at execution time; client secrets and certificates never enter the agent context.

Intent-based discovery

Agents search by intent (for example create a storage sync service or register a file server) and Jentic returns the matching ARM operation with its full input schema, so the agent can call the right path without browsing Microsoft Learn docs.

Time to first call

Direct integration with Azure File Sync ARM contracts: 2-4 days for AAD auth, long-running operation handling, and server certificate flow. Through Jentic: under 1 hour to search, load, and execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

Azure Storage Management

Manages the Azure storage accounts and file shares that Storage Sync replicates to.

Choose this when the agent needs to create or configure the underlying storage account or file share before pointing a Storage Sync cloud endpoint at it.

Complementary

Azure Resource Management

Manages the resource groups and tags that contain Storage Sync Services.

Use this when the agent needs to create the resource group or apply tags before deploying a Storage Sync Service.

Alternative

Azure Recovery Services Backup

Backs up file shares and on-premises servers without continuous sync semantics.

Choose this when the user wants point-in-time backup and restore of file data rather than continuous synchronization with cloud tiering.

FAQs

Specific to using Microsoft Storage Sync API through Jentic.

Why is there no official OpenAPI spec for Microsoft Storage Sync?

Microsoft Azure does not publish an OpenAPI specification for the Storage Sync Service Resource Provider. Jentic generates and maintains this spec from the Azure Resource Manager contracts so that AI agents and developers can call Microsoft Storage Sync 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 Microsoft Storage Sync API use?

The API uses Azure Active Directory OAuth 2.0 with the user_impersonation scope against https://login.microsoftonline.com/common/oauth2/authorize. Jentic stores the Azure AD client secret or service principal credentials encrypted in its vault; agents receive scoped bearer tokens at execution time and never see the underlying credential.

Can I register a new on-premises file server with the Microsoft Storage Sync API?

Yes. Use PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId} to enroll a server. The server agent must already be installed on the host and must present a registration certificate, which the API validates before completing registration.

What are the rate limits for the Microsoft Storage Sync API?

Microsoft Storage Sync follows the standard Azure Resource Manager throttling limits, which apply per subscription and per region. Most management operations are limited to 1200 reads and 600 writes per hour per subscription. Long-running operations such as sync group provisioning return 202 Accepted and should be polled via the workflows endpoint rather than retried aggressively.

How do I create a sync group through Jentic?

Search Jentic for create azure storage sync group, then load the schema for PUT under storageSyncServices/{name}/syncGroups/{syncGroupName}. Execute the call with subscriptionId, resourceGroupName, storageSyncServiceName, and syncGroupName populated. Jentic handles the OAuth token exchange and returns the provisioned sync group identifier.

Does the Microsoft Storage Sync API handle cloud tiering policy?

Yes. Cloud tiering is configured on the server endpoint resource. When you create or patch a server endpoint, set cloudTiering to true and supply volumeFreeSpacePercent and tierFilesOlderThanDays to control which files are offloaded to the Azure file share.