Microsoft Azure

Microsoft Azure Bicep Client

The Microsoft Azure Bicep Client is a tool that allows users to author and deploy infrastructure as code on the Azure cloud platform. It enables developers to define and manage Azure resources using a declarative syntax that is easier to read and write than traditional template languages like JSON or ARM templates. With Bicep, users can create reusable modules, parameterize their configurations, and validate their code for best practices and compliance.

Documentation GitHub OpenAPI

Documentation

📖

Documentation

https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/bicepclient-openapi-original.yml

OpenAPI Specification

swagger: '2.0'
info:
  title: Microsoft Azure BicepClient
  description: >-
    The APIs listed in this specification can be used to manage Bicep related
    operations through the Azure Resource Manager.
  version: '2023-11-01'
host: management.azure.com
schemes:
  - https
consumes:
  - application/json
produces:
  - application/json
security:
  - azure_auth:
      - user_impersonation
securityDefinitions:
  azure_auth:
    type: oauth2
    authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
    flow: implicit
    description: Azure Active Directory OAuth2 Flow
    scopes:
      user_impersonation: impersonate your user account
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/decompileBicep:
    post:
      tags:
        - BicepClient
      operationId: microsoftAzureDecompileBicep
      description: Decompiles an ARM json template into a Bicep template
      x-ms-examples:
        Decompile an ARM json template into a Bicep file:
          $ref: ./examples/DecompileBicep.json
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
        - name: decompileOperationRequest
          in: body
          required: true
          schema:
            $ref: '#/definitions/DecompileOperationRequest'
          description: Decompile operation request supplied to the operation.
      responses:
        '200':
          description: OK - The decompilation has succeeded.
          schema:
            $ref: '#/definitions/DecompileOperationSuccessResponse'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      summary: >-
        Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Resources Decompilebicep
definitions:
  DecompileOperationRequest:
    required:
      - template
    type: object
    description: The body of the request for the decompileBicep operation
    properties:
      template:
        type: string
        description: The ARM json template to be decompiled into a Bicep file
  DecompileOperationSuccessResponse:
    required:
      - files
      - entryPoint
    type: object
    description: The response of the decompileBicep operation
    properties:
      files:
        type: array
        items:
          $ref: '#/definitions/FileDefinition'
        x-ms-identifiers:
          - path
        description: >-
          An array of key-value pairs containing the entryPoint string as the
          key for the Bicep file decompiled from the ARM json template
      entryPoint:
        type: string
        description: >-
          The file path to the main Bicep file generated from the decompiled ARM
          json template.
  FileDefinition:
    type: object
    properties:
      path:
        type: string
      contents:
        type: string
    description: The definition of a file along with its contents
tags:
  - name: BicepClient