How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Bicep Deployments API

Create, validate, and manage ARM/Bicep template deployments

Microsoft Bicep Deployments API is one of 5 APIs that Microsoft Bicep publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Deployment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 13 operations across 9 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version 2025-04-01.

Requests are made against a single base URL, https://management.azure.com.

13 operations 9 paths 21 schemas 1 DELETE3 GET1 HEAD6 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2025-04-01
Base URL
https://github.com/Azure/bicep
Authentication
OAuth 2.0
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Microsoft Bicep Deployments API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (azure_auth) using the implicit flow, exposing 1 scope. By default, every request must be authenticated.

  • azure_auth — Azure Active Directory OAuth2 Flow

Paths & Operations 13

Across 9 paths, the API surfaces 13 operations — 1 DELETE, 3 GET, 1 HEAD, 6 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Deployments 13

Create, validate, and manage ARM/Bicep template deployments

PUT
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}
Microsoft Bicep Create or update a deployment
Deployments_CreateOrUpdate 4 params body → 200201default
GET
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}
Microsoft Bicep Get a deployment
Deployments_Get 4 params → 200default
DELETE
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}
Microsoft Bicep Delete a deployment
Deployments_Delete 4 params → 202204default
HEAD
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}
Microsoft Bicep Check deployment existence
Deployments_CheckExistence 4 params → 204404
POST
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/validate
Microsoft Bicep Validate a deployment template
Deployments_Validate 4 params body → 200202400default
POST
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel
Microsoft Bicep Cancel a running deployment
Deployments_Cancel 4 params → 204default
POST
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate
Microsoft Bicep Export a deployment template
Deployments_ExportTemplate 4 params → 200default
POST
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf
Microsoft Bicep Run what-if analysis
Deployments_WhatIf 4 params body → 200202default
GET
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments
Microsoft Bicep List deployments by resource group
Deployments_ListByResourceGroup 5 params → 200default
PUT
/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}
Microsoft Bicep Create or update a deployment at subscription scope
Deployments_CreateOrUpdateAtSubscriptionScope 3 params body → 200201default
GET
/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}
Microsoft Bicep Get a deployment at subscription scope
Deployments_GetAtSubscriptionScope 3 params → 200default
POST
/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate
Microsoft Bicep Validate a deployment at subscription scope
Deployments_ValidateAtSubscriptionScope 3 params body → 200202400default
POST
/providers/Microsoft.Resources/calculateTemplateHash
Microsoft Bicep Calculate template hash
Deployments_CalculateTemplateHash 1 param body → 200default

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are DeploymentPropertiesExtended (16 properties), DeploymentProperties (9 properties), DeploymentExtended (6 properties), DeploymentValidateResult (5 properties). Each schema is shown below with its type and property counts.

DeploymentExportResult
object
1 property
CloudError
object
1 property
Deployment
object
4 properties 1 required
TemplateLink
object
5 properties
DeploymentIdentity
object
2 properties
DeploymentValidateResult
object
5 properties
DeploymentWhatIf
object
2 properties 1 required
Dependency
object
4 properties
DeploymentListResult
object
2 properties
DeploymentDiagnostic
object
4 properties
Provider
object
2 properties
ParametersLink
object
2 properties 1 required
DeploymentPropertiesExtended
object
16 properties
DeploymentExtended
object
6 properties
DeploymentProperties
object
9 properties 1 required
ScopedDeployment
object
4 properties 2 required
WhatIfChange
object
5 properties
ErrorResponse
object
5 properties
WhatIfOperationResult
object
3 properties
ResourceReference
object
3 properties
DeploymentParameter
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-bicep-deployments-api-openapi.yml Raw ↑

Other APIs Microsoft Bicep publishes across the network.

Bicep CLI
Bicep Language Server
Microsoft Bicep Template Spec Versions API
Microsoft Bicep Template Specs API
Where this information came from

This is an independent, third-party profile of Microsoft Bicep Deployments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.