JSON-RPC를 사용하여 프로그래밍 방식 Bicep 사용

jsonrpc 명령은 JSON-RPC 인터페이스를 사용하여 Bicep CLI를 실행합니다. 이 인터페이스를 사용하면 구조적 출력과 프로그래밍 방식으로 상호 작용할 수 있습니다. 또한 여러 파일을 컴파일할 때 콜드 시작 지연을 방지합니다. 이 설정은 프로그래밍 방식으로 Bicep 상호 작용하는 라이브러리 빌드를 지원합니다.

와이어 형식

와이어 형식은 JSON-RPC 2.0 사양을 따릅니다. 각 메시지는 다음 구조를 사용하여 머리글로 구분됩니다. 여기서 \r 캐리지 리턴 및 줄 바꿈 문자를 나타내고 \n 있습니다.

Content-Length: <length>\r\n\r\n<message>\r\n\r\n

• <length> 는 후행을 <message> 포함하여 문자열의 길이입니다 \r\n\r\n.
• <message> 는 원시 JSON 메시지입니다.

예를 들어 메서드를 호출하려면 다음을 수행합니다 bicep/version .

Content-Length: 72\r\n\r\n{"jsonrpc": "2.0", "id": 0, "method": "bicep/version", "params": {}}\r\n\r\n

해당 결과는 다음과 같습니다.

Content-Length: 64\r\n\r\n{"jsonrpc": "2.0", "id": 0, "result": {"version": "0.38.5"}}\r\n\r\n

메서드

다음 메서드는 JSON-RPC 인터페이스를 통해 사용할 수 있습니다.

bicep/version

Bicep CLI의 버전을 반환합니다.

Params

이 메서드는 매개 변수를 사용하지 않습니다.

결과

예시

Params:

{}

결과:

{
  "version": "0.24.211"
}

bicep/compile

지정된 .bicep 파일을 컴파일하고 컴파일된 ARM 템플릿 JSON을 반환합니다.

Params

결과

예시

Params:

{
  "path": "/path/to/main.bicep"
}

결과:

{
  "success": true,
  "diagnostics": [],
  "contents": "{\"$schema\": \"https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#\", ...}"
}

bicep/compileParams

지정된 .bicepparam 파일을 컴파일합니다. 컴파일된 매개 변수 JSON 및 연결된 템플릿을 반환합니다.

Params

결과

예시

Params:

{
  "path": "/path/to/main.bicepparam",
  "parameterOverrides": {}
}

결과:

{
  "success": true,
  "diagnostics": [],
  "parameters": "{\"$schema\": \"https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#\", ...}",
  "template": "{\"$schema\": \"https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#\", ...}",
  "templateSpecId": null
}

bicep/getMetadata

매개 변수, 출력, 내보내기 및 메타데이터 데코레이터를 포함하여 지정된 .bicep 파일에 대한 메타데이터를 반환합니다.

Params

결과

예시

Params:

{
  "path": "/path/to/main.bicep"
}

결과:

{
  "metadata": [
    { "name": "description", "value": "My deployment" }
  ],
  "parameters": [
    {
      "range": { "start": { "line": 0, "char": 0 }, "end": { "line": 0, "char": 20 } },
      "name": "location",
      "type": { "range": null, "name": "string" },
      "description": "The Azure region for deployment"
    }
  ],
  "outputs": [
    {
      "range": { "start": { "line": 5, "char": 0 }, "end": { "line": 5, "char": 30 } },
      "name": "endpoint",
      "type": { "range": null, "name": "string" },
      "description": null
    }
  ],
  "exports": []
}

bicep/getDeploymentGraph

리소스 및 해당 종속성을 설명하는 지정된 .bicep 파일에 대한 배포 그래프를 반환합니다.

Params

결과

예시

Params:

{
  "path": "/path/to/main.bicep"
}

결과:

{
  "nodes": [
    {
      "range": { "start": { "line": 2, "char": 0 }, "end": { "line": 8, "char": 1 } },
      "name": "storageAccount",
      "type": "Microsoft.Storage/storageAccounts",
      "isExisting": false,
      "relativePath": null
    }
  ],
  "edges": [
    { "source": "roleAssignment", "target": "storageAccount" }
  ]
}

bicep/getFileReferences

컴파일에서 참조하는 파일 경로의 전체 목록을 가져옵니다. 변경 내용을 감시할 파일 집합을 결정하는 데 유용합니다.

Params

결과

예시

Params:

{
  "path": "/path/to/main.bicep"
}

결과:

{
  "filePaths": [
    "/path/to/main.bicep",
    "/path/to/modules/storage.bicep",
    "/path/to/bicepconfig.json"
  ]
}

bicep/getSnapshot

지정된 .bicepparam 파일에 대한 배포 스냅샷을 만듭니다. 스냅샷은 배포에 필요한 모든 정보를 단일 자체 포함 JSON 문서에 번들로 묶습니다.

Params

결과

예시

Params:

{
  "path": "/path/to/main.bicepparam",
  "metadata": {
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "subscriptionId": "00000000-0000-0000-0000-000000000000",
    "resourceGroup": "myResourceGroup",
    "location": "eastus",
    "deploymentName": "myDeployment"
  },
  "externalInputs": []
}

결과:

{
  "snapshot": "{...}"
}

bicep/format

지정된 파일의 서식을 .bicep 지정합니다.

Params

결과

예시

Params:

{
  "path": "/path/to/file.bicep"
}

결과:

{
  "contents": "..."
}

유형

다음 형식은 메서드 입력 및 출력에 사용됩니다.

위치

Bicep 소스 파일 내의 0부터 시작하는 위치를 나타냅니다.

범위

Bicep 소스 파일 내의 범위를 나타냅니다.

DiagnosticDefinition

컴파일 또는 분석 중에 생성된 진단 메시지를 나타냅니다.

MetadataDefinition

키워드로 선언된 metadata 파일 수준 메타데이터 항목을 나타냅니다.

SymbolDefinition

Bicep 파일의 매개 변수 또는 출력 기호를 나타냅니다.

TypeDefinition

매개 변수 또는 출력에 대한 형식 참조를 나타냅니다.

익스포트정의

데코레이터로 선언된 내보낸 기호를 @export() 나타냅니다.

노드 (Node)

배포 그래프의 리소스 노드를 나타냅니다.

Microsoft Edge

배포 그래프의 두 리소스 노드 간에 전달되는 종속성 에지를 나타냅니다.

SnapshotMetadata

스냅샷 생성을 위한 Azure 배포 컨텍스트를 제공합니다. 모든 필드는 선택 사항입니다.

ExternalInputValue

스냅샷에 삽입할 외부 입력 값을 나타냅니다.

사용법

명명된 파이프 전송

--pipe 인수를 사용하여 연결할 Bicep CLI의 명명된 파이프를 전달합니다. 호출 프로세스는 이미 파이프를 서버로 시작해야 하며 Bicep CLI는 클라이언트로 연결됩니다.

bicep jsonrpc --pipe <named_pipe>

<named_pipe> 는 JSON-RPC 클라이언트를 연결하는 기존 명명된 파이프입니다.

예시

macOS 또는 Linux에서 명명된 파이프에 연결하려면 다음을 수행합니다.

bicep jsonrpc --pipe /tmp/bicep-81375a8084b474fa2eaedda1702a7aa40e2eaa24b3.sock

Windows 명명된 파이프에 연결하려면 다음을 수행합니다.

bicep jsonrpc --pipe \\.\pipe\\bicep-81375a8084b474fa2eaedda1702a7aa40e2eaa24b3.sock

TCP 소켓 전송 사용

--socket 인수를 사용하여 연결할 Bicep CLI에 대한 TCP 포트를 전달합니다. 호출 프로세스는 이미 포트에서 연결을 수신 대기해야 합니다.

bicep jsonrpc --socket <tcp_socket>

<tcp_socket> 는 JSON-RPC 클라이언트가 연결하는 소켓 번호입니다.

예시

TCP 소켓에 연결하려면:

bicep jsonrpc --socket 12345

stdin/stdout 전송 사용

다음 구문을 사용하여 stdin을 통해 수신된 요청 데이터와 stdout을 통해 전송된 응답 데이터를 사용하여 JSON-RPC 서버를 시작합니다.

bicep jsonrpc --stdio

.NET 클라이언트 라이브러리

Azure.Bicep. RpcClient NuGet 패키지는 Bicep JSON-RPC 인터페이스에 대한 .NET 클라이언트 라이브러리를 제공합니다. 지정된 버전의 Bicep CLI를 자동으로 다운로드하고 수명 주기를 관리할 수 있으므로 별도로 설치할 필요가 없습니다.

예시

다음 예제에서는 Bicep CLI 버전 0.39.26 다운로드하고, Bicep 파일을 컴파일하고, 결과 ARM 템플릿을 출력합니다.

using Bicep.RpcClient;

var factory = new BicepClientFactory();
using var bicep = await factory.Initialize(new() {
    BicepVersion = "0.39.26"
});

var version = await bicep.GetVersion();
Console.WriteLine($"Bicep version: {version}");

var tempFile = Path.Combine(Path.GetTempPath(), $"{Guid.NewGuid()}.bicep");
File.WriteAllText(tempFile, """
    param foo string
    output foo string = foo
    """);

var result = await bicep.Compile(new(tempFile));
Console.Write(result.Contents);