DeploymentScriptsClient

Name: DeploymentScriptsClient API
Brand: DeploymentScriptsClient
Availability: InStock

★ Only Publicly Available OpenAPI DocumentDeveloper ToolsCi Cdoauth28 EndpointsREST

For Agents

Create, manage, and inspect Azure ARM Deployment Scripts — including their execution logs — at subscription and resource group scope.

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.

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 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

GET STARTED

Start building with DeploymentScriptsClient API

Explore with Jentic

View OpenAPI Document

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

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.

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}

Why though Jentic?

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

Credential isolation

Azure AD OAuth 2.0 client credentials are stored encrypted in the Jentic vault. Agents receive a scoped bearer token at execute time; client secrets and refresh tokens never reach the agent's context.

Intent-based discovery

Agents search by intent (e.g., 'create azure deployment script') and Jentic returns the matching create operation with its resource-group, script-name, kind, and inline-script parameters resolved from the spec.

Time to first call

Direct integration with the Microsoft.Resources/deploymentScripts API, including AAD setup and managed-identity wiring, typically takes 1-2 days. Through Jentic: under 1 hour to first successful script run.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

DeploymentAdminClient

Lists Azure Stack deployment action plans rather than ARM Deployment Scripts

Pick this when the deployment runs on Azure Stack rather than standard Azure ARM.

Complementary

DevTestLabsClient

Manages DevTest Labs environments and ARM-template-based artefacts

Pick this when the agent needs to manage lab environments that may invoke deployment scripts as part of their templates.

Complementary

DeletedWebApps API Client

Tracks soft-deleted App Service apps that may have been removed by a deployment

Pick this when the agent is investigating App Service apps that disappeared after a deployment.

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

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.