Microsoft Bicep

Microsoft Bicep is a domain-specific language (DSL) that uses declarative syntax to deploy Azure resources. It provides a transparent abstraction over ARM templates and offers a more concise syntax, improved type safety, and better support for modularity and code reuse.

4 APIs 0 Features

ARM TemplatesAzureCloudDeploymentDevOpsInfrastructure as Code

APIs

Bicep CLI

Command-line interface for compiling and deploying Bicep files.

Bicep Language Server

Language server implementation for Bicep providing IntelliSense and validation.

Bicep Deployments REST API

Azure Resource Manager Deployments REST API used by Microsoft Bicep to deploy infrastructure as code templates. Provides operations for creating, validating, and managing ARM/Bi...

Bicep Template Specs REST API

Azure Resource Manager Template Specs REST API used by Microsoft Bicep for publishing and managing reusable infrastructure templates. Template Specs allow you to store ARM/Bicep...

Collections

Microsoft Bicep Deployments API

OPEN

Microsoft Bicep Template Specs API

OPEN

Pricing Plans

Microsoft Bicep Plans Pricing

3 plans

PLANS

Rate Limits

Microsoft Bicep Rate Limits

6 limits

RATE LIMITS

FinOps

Microsoft Bicep Finops

FINOPS

Semantic Vocabularies

Microsoft Bicep Context

0 classes · 9 properties

JSON-LD

Resources

👥

GitHubOrganization

Learning Resources

Contributing Guide

Sources

opencollection: 1.0.0
info:
  name: Microsoft Bicep Template Specs API
  version: '2021-05-01'
request:
  auth:
    type: oauth2
    flow: implicit
    authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
    credentials:
      clientId: '{{clientId}}'
items:
- info:
    name: Template Specs
    type: folder
  items:
  - info:
      name: Microsoft Bicep Get a Template Spec
      type: http
    http:
      method: GET
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Resources/templateSpecs/:templateSpecName
      params:
      - name: subscriptionId
        value: ''
        type: path
        description: Subscription ID which forms part of the URI for every service call
      - name: resourceGroupName
        value: ''
        type: path
        description: The name of the resource group. The name is case insensitive.
      - name: templateSpecName
        value: ''
        type: path
        description: Name of the Template Spec
      - name: api-version
        value: ''
        type: query
        description: Client API version
      - name: $expand
        value: ''
        type: query
        description: Allows for expansion of additional Template Spec details. Set to 'versions' to include version information.
    docs: Gets a Template Spec with a given name.
  - info:
      name: Microsoft Bicep Create or update a Template Spec
      type: http
    http:
      method: PUT
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Resources/templateSpecs/:templateSpecName
      params:
      - name: subscriptionId
        value: ''
        type: path
        description: Subscription ID which forms part of the URI for every service call
      - name: resourceGroupName
        value: ''
        type: path
        description: The name of the resource group. The name is case insensitive.
      - name: templateSpecName
        value: ''
        type: path
        description: Name of the Template Spec
      - name: api-version
        value: ''
        type: query
        description: Client API version
      body:
        type: json
        data: '{}'
    docs: Creates or updates a Template Spec. Template Specs enable you to store compiled Bicep templates as Azure resources
      for reuse and sharing.
  - info:
      name: Microsoft Bicep Update Template Spec tags
      type: http
    http:
      method: PATCH
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Resources/templateSpecs/:templateSpecName
      params:
      - name: subscriptionId
        value: ''
        type: path
        description: Subscription ID which forms part of the URI for every service call
      - name: resourceGroupName
        value: ''
        type: path
        description: The name of the resource group. The name is case insensitive.
      - name: templateSpecName
        value: ''
        type: path
        description: Name of the Template Spec
      - name: api-version
        value: ''
        type: query
        description: Client API version
      body:
        type: json
        data: '{}'
    docs: Updates Template Spec tags with specified values.
  - info:
      name: Microsoft Bicep Delete a Template Spec
      type: http
    http:
      method: DELETE
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Resources/templateSpecs/:templateSpecName
      params:
      - name: subscriptionId
        value: ''
        type: path
        description: Subscription ID which forms part of the URI for every service call
      - name: resourceGroupName
        value: ''
        type: path
        description: The name of the resource group. The name is case insensitive.
      - name: templateSpecName
        value: ''
        type: path
        description: Name of the Template Spec
      - name: api-version
        value: ''
        type: query
        description: Client API version
    docs: Deletes a Template Spec by name. When the operation completes, status code 200 is returned without content.
  - info:
      name: Microsoft Bicep List Template Specs by resource group
      type: http
    http:
      method: GET
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Resources/templateSpecs
      params:
      - name: subscriptionId
        value: ''
        type: path
        description: Subscription ID which forms part of the URI for every service call
      - name: resourceGroupName
        value: ''
        type: path
        description: The name of the resource group. The name is case insensitive.
      - name: api-version
        value: ''
        type: query
        description: Client API version
      - name: $expand
        value: ''
        type: query
        description: Allows for expansion of additional Template Spec details. Set to 'versions' to include version information.
    docs: Lists all the Template Specs within the specified resource group.
  - info:
      name: Microsoft Bicep List Template Specs by subscription
      type: http
    http:
      method: GET
      url: https://management.azure.com/subscriptions/:subscriptionId/providers/Microsoft.Resources/templateSpecs
      params:
      - name: subscriptionId
        value: ''
        type: path
        description: Subscription ID which forms part of the URI for every service call
      - name: api-version
        value: ''
        type: query
        description: Client API version
      - name: $expand
        value: ''
        type: query
        description: Allows for expansion of additional Template Spec details. Set to 'versions' to include version information.
    docs: Lists all the Template Specs within the specified subscription.
- info:
    name: Template Spec Versions
    type: folder
  items:
  - info:
      name: Microsoft Bicep Get a Template Spec version
      type: http
    http:
      method: GET
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Resources/templateSpecs/:templateSpecName/versions/:templateSpecVersion
      params:
      - name: subscriptionId
        value: ''
        type: path
        description: Subscription ID which forms part of the URI for every service call
      - name: resourceGroupName
        value: ''
        type: path
        description: The name of the resource group. The name is case insensitive.
      - name: templateSpecName
        value: ''
        type: path
        description: Name of the Template Spec
      - name: templateSpecVersion
        value: ''
        type: path
        description: The version of the Template Spec
      - name: api-version
        value: ''
        type: query
        description: Client API version
    docs: Gets a Template Spec version by name.
  - info:
      name: Microsoft Bicep Create or update a Template Spec version
      type: http
    http:
      method: PUT
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Resources/templateSpecs/:templateSpecName/versions/:templateSpecVersion
      params:
      - name: subscriptionId
        value: ''
        type: path
        description: Subscription ID which forms part of the URI for every service call
      - name: resourceGroupName
        value: ''
        type: path
        description: The name of the resource group. The name is case insensitive.
      - name: templateSpecName
        value: ''
        type: path
        description: Name of the Template Spec
      - name: templateSpecVersion
        value: ''
        type: path
        description: The version of the Template Spec
      - name: api-version
        value: ''
        type: query
        description: Client API version
      body:
        type: json
        data: '{}'
    docs: Creates or updates a version of a Template Spec. Each version contains the actual compiled Bicep/ARM template content.
  - info:
      name: Microsoft Bicep Delete a Template Spec version
      type: http
    http:
      method: DELETE
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Resources/templateSpecs/:templateSpecName/versions/:templateSpecVersion
      params:
      - name: subscriptionId
        value: ''
        type: path
        description: Subscription ID which forms part of the URI for every service call
      - name: resourceGroupName
        value: ''
        type: path
        description: The name of the resource group. The name is case insensitive.
      - name: templateSpecName
        value: ''
        type: path
        description: Name of the Template Spec
      - name: templateSpecVersion
        value: ''
        type: path
        description: The version of the Template Spec
      - name: api-version
        value: ''
        type: query
        description: Client API version
    docs: Deletes a specific version from a Template Spec.
  - info:
      name: Microsoft Bicep List Template Spec versions
      type: http
    http:
      method: GET
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Resources/templateSpecs/:templateSpecName/versions
      params:
      - name: subscriptionId
        value: ''
        type: path
        description: Subscription ID which forms part of the URI for every service call
      - name: resourceGroupName
        value: ''
        type: path
        description: The name of the resource group. The name is case insensitive.
      - name: templateSpecName
        value: ''
        type: path
        description: Name of the Template Spec
      - name: api-version
        value: ''
        type: query
        description: Client API version
    docs: Lists all the versions of a Template Spec.
bundled: true