Microsoft Azure DeploymentScriptsClient
Browse all Azure APIs44
AI ReadinessFoundational (D)44/100
Agent-ready OpenAPI document · curated by JenticDeveloper ToolsCi Cdoauth28 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Create, manage, and inspect Azure ARM Deployment Scripts - including their execution logs - at subscription and resource group scope.
Use for: Create an ARM Deployment Script that runs an inline Bash command during a deployment, List all Deployment Scripts in a resource group, Get the latest execution logs for a specific Deployment Script, Delete a Deployment Script after the deployment workflow has completed
Not supported: Does not run arbitrary scripts outside an ARM deployment, manage deployments themselves, or schedule recurring jobs - use for ARM Deployment Script resources and their logs only.
Jentic publishes the only available OpenAPI specification for DeploymentScriptsClient, keeping it validated and agent-ready. The API manages Azure Resource Manager Deployment Scripts under Microsoft.Resources, the resource type that lets ARM templates run inline PowerShell or Bash scripts during a deployment. It covers create, get, update, delete, and listing of script resources at subscription and resource-group scope, plus the dedicated logs endpoints for retrieving execution output.
Install Jentic One Beta
Connect the DeploymentScriptsClient to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the DeploymentScriptsClient, 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%2Fdeploymentscriptsclient" | 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%2Fdeploymentscriptsclient" | 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 DeploymentScriptsClient API.
Create or update an ARM Deployment Script with inline PowerShell or Bash content
List Deployment Scripts at subscription and resource-group scope
Retrieve a specific Deployment Script and its current provisioning state
Patch tags and configuration on an existing Deployment Script
Delete a Deployment Script and its associated runtime resources
Fetch the captured stdout/stderr logs from a Deployment Script run
Use Cases
Patterns agents use DeploymentScriptsClient API for, with concrete tasks.
★ Inline scripts inside ARM deployments
ARM templates often need a small piece of imperative logic - generating a random password, calling out to another service, or seeding a resource - that pure declarative templates cannot express. Deployment Scripts let the template author embed PowerShell or Bash that runs as part of the deployment, and this API manages the resulting script resources that record execution and outputs.
Create a Deployment Script named 'seed-db' in resource group 'app-rg' that runs an inline Bash one-liner against the configured storage account and exposes the script output via outputs
Post-deployment log retrieval
When a Deployment Script run fails, the operator needs the captured stdout and stderr to diagnose the failure. The logs endpoints return the latest log stream for a script, so an automation flow can collect, archive, and surface the output without logging into the Azure portal.
Fetch the default log stream for the Deployment Script 'seed-db' in resource group 'app-rg' and return the last 200 lines
Cleanup of completed scripts
Deployment Script resources persist after a run and can accumulate. A nightly job lists Deployment Scripts in a subscription and deletes any whose deployments have completed and whose logs have been archived, keeping the resource graph tidy without touching active scripts.
List Deployment Scripts in resource group 'app-rg' older than 30 days and delete every script whose provisioning state is Succeeded
Agent-driven deployment hook
An AI agent stitching together an Azure environment deployment uses a Deployment Script as an extension point. Through Jentic the agent searches for the create operation, supplies the inline script and identity, then polls the get-and-logs endpoints until the script completes - all without leaving its scoped credential context.
Create a Deployment Script that prints the current Azure region, then poll its provisioning state until Succeeded and return the captured log output
Key Endpoints
8 endpoints — jentic publishes the only available openapi specification for deploymentscriptsclient, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
GET
/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentScripts
List Deployment Scripts in a subscription
GET
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts
List Deployment Scripts in a resource group
PUT
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}
Create or update a Deployment Script
GET
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}
Get a Deployment Script
DELETE
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}
Delete a Deployment Script
GET
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}/logs
List logs for a Deployment Script
GET
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}/logs/default
Get the default log stream for a Deployment Script
GET
/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentScripts
List Deployment Scripts in a subscription
GET
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts
List Deployment Scripts in a resource group
PUT
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}
Create or update a Deployment Script
GET
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}
Get a Deployment Script
DELETE
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}
Delete a Deployment Script
GET
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}/logs
List logs for a Deployment Script
GET
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}/logs/default
Get the default log stream for a Deployment Script
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
DeploymentScriptsClient
- Foundational (D)44/100
66
Foundational Compliance63
Developer Experience & Jentic Compatibility22
AI-Readiness & Agent Experience94
Agent Usability35
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
66
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: BSignals: 4
90%
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).
75%
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.
22
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
89%
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.
0%
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 the Microsoft.Resources/deploymentScripts API by hand means acquiring Azure AD OAuth 2.0 bearer tokens, building the long ARM URLs under management.azure.com, and polling the long-running create and delete operations with your own backoff. Through Jentic you install once, import DeploymentScriptsClient from the API Directory, store the Azure AD credential once, and your agent calls it.
Permission scoping
The script resource id sits in the URL path (/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}), so a rule can pin your agent to one subscription and resource group and the scripts inside it. You choose the operations it may call, so destructive ones like deleting a Deployment Script are not included unless you add them.
Credential isolation
Your Azure AD credential is stored once, encrypted, by your own Jentic One instance and injected as a short-lived 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 'create an azure arm deployment script' or 'get deployment script logs', and Jentic returns the matching operation with its resource-group, script-name, kind, and inline-script input schema so the agent calls the right endpoint without reading the ARM reference.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using DeploymentScriptsClient API through Jentic.
Why is there no official OpenAPI spec for DeploymentScriptsClient?
Microsoft Azure does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call DeploymentScriptsClient 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 Deployment Scripts API use?
The API runs through Azure Resource Manager and uses OAuth 2.0 bearer tokens issued by Azure Active Directory. Through Jentic, the AAD client secret or managed identity refresh token is held in the encrypted vault and a short-lived access token is supplied at execute time so the bearer token never appears in the agent's context.
Can I retrieve the output of a Deployment Script run with this API?
Yes. GET .../deploymentScripts/{scriptName}/logs lists the available log streams and GET .../deploymentScripts/{scriptName}/logs/default returns the captured stdout/stderr from the script's container run. Logs persist as long as the Deployment Script resource exists.
What are the rate limits for the Deployment Scripts API?
Azure Resource Manager applies subscription-level read and write throttles (around 12,000 reads per hour and 1,200 writes per hour per region per subscription) and returns 429 with a Retry-After header when exceeded. Deployment Script create and delete are long-running and should be polled with backoff.
How do I create a Deployment Script through Jentic?
Search Jentic for 'create azure deployment script', load the schema for PUT .../deploymentScripts/{scriptName}, then execute with the script kind (AzurePowerShell or AzureCLI), the inline script body, retentionInterval, and a user-assigned managed identity. The pip install jentic Python SDK uses the async search, load, execute pattern.
Is the Deployment Scripts API free?
Deployment Scripts run inside an Azure Container Instance plus a backing storage account; you pay for the container runtime and storage consumed by the run, not for the management API calls themselves. The retentionInterval on the resource controls how long the runtime artefacts persist.
Can I limit what my agent is allowed to do with the Deployment Scripts API?
Yes. Because you run Jentic One yourself, your own rules decide which operations and credentials the agent may use, and the Deployment Script resource id lives right in the URL path (/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}), so a rule can pin the agent to a single subscription and resource group. You also choose exactly which operations it may call, for example granting only the list and get-logs endpoints while withholding the create/update (PUT) and delete operations. That way a destructive call like deleting a Deployment Script is unavailable unless you deliberately add it to the agent's allowed set.
GET STARTED