퍼블릭 API를 통해 환경 관리

Microsoft Fabric REST API는 Fabric 항목의 CRUD(만들기, 읽기, 업데이트 및 삭제) 작업을 위한 서비스 엔드포인트를 제공합니다. 이 문서에서는 사용 가능한 환경 REST API 및 해당 사용에 대해 설명합니다.

환경 API를 안정적인 GA 버전으로 마이그레이션

중요한

GA 릴리스에는 기존 API, API 사용 중단 및 새 API의 요청/응답 계약에 업데이트가 포함됩니다. 다음 섹션에서 세부 정보를 찾을 수 있습니다.
요청/응답 계약 변경의 전환을 용이하게 하기 위해 새 쿼리 매개 변수 beta 가 도입되었습니다. 쿼리 매개 변수는 beta 기본적으로 True2026년 3월 31일까지 설정되므로 미리 보기 계약을 계속 사용할 수 있습니다. 안정적인 릴리스 버전의 계약 사용을 시작하도록 False 값을 설정합니다.
Preview 쿼리 매개 변수가 .로 대체 beta되었습니다. 이전 버전과의 호환성을 위해 미리 보기는 계속 지원되며 베타와 동일하게 작동합니다.
폐기 예정인 API는 2026년 3월 31일까지 계속 지원됩니다. 새로 도입된 API를 사용하여 빠르게 교체하시기 바랍니다.

요청/응답 계약 업데이트가 있는 API

범주	응용 프로그램 인터페이스 (API)	설명	비고	미리보기 버전 Swagger	릴리스 버전 Swagger
항목 작업	게시 환경	현재 보류 중인 변경 내용을 사용하여 환경의 게시 작업을 트리거합니다.	응답 계약에 따라 업데이트합니다.	게시 환경(미리 보기)	게시 환경
무대 설정	스테이징 라이브러리를 나열	전체 스테이징 라이브러리 목록을 가져옵니다. 이 목록에는 게시된 라이브러리와 보류 중인 라이브러리가 포함됩니다.	응답 계약에 따라 업데이트합니다.	스테이징 라이브러리 목록(미리 보기)	스테이징 라이브러리를 연출 목록에 추가
무대 설정	스테이징 중인 Spark 컴퓨트를 나열	전체 스테이징 컴퓨팅 구성을 가져옵니다. 스테이징 구성에는 게시된 계산 구성과 보류 중인 계산 구성이 포함됩니다.	응답 계약에 따라 업데이트합니다.	Spark 컴퓨팅 스테이징 목록 작성(미리 보기)	준비 중인 Spark 컴퓨팅 나열
무대 설정	Spark 컴퓨팅 업데이트	환경에 대한 컴퓨팅 구성 및 Spark 속성을 업데이트합니다.	요청 및 응답 계약에서의 업데이트.	Spark 컴퓨팅 업데이트(미리 보기)	Spark 컴퓨팅 업데이트
출판됨	게시된 라이브러리 나열	Spark 세션에서 게시되고 효과적인 라이브러리를 가져옵니다.	응답 계약에 따라 업데이트합니다.	게시된 라이브러리 나열(미리 보기)	게시된 라이브러리 나열
출판됨	게시된 Spark 계산 나열	Spark 세션에서 게시되고 효과적인 Spark 컴퓨팅 구성 및 Spark 속성을 가져옵니다.	응답 계약에 따라 업데이트합니다.	게시된 라이브러리 나열(미리 보기)	게시된 라이브러리 나열

매개 변수의 기본값 beta 은 True2026년 3월 31일까지입니다. 즉, 시스템은 사용 중단 날짜까지 이 매개 변수를 지정하지 않고 요청이 전송되는 것처럼 True 매개 변수를 고려합니다. 가능한 한 빨리 매개 변수를 beta으로 명시적으로 설정하여 False 안정적인 버전으로 구현을 마이그레이션할 것을 강력히 추천합니다.

API 응답에 업데이트가 있는 API를 예로 사용합니다 List staging libraries .

매개 변수를 beta로 하여 True 요청을 보내는 경우

샘플 요청:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/libraries?beta=True

샘플 응답:

{
  "customLibraries": {
    "wheelFiles": [
      "samplewheel-0.18.0-py2.py3-none-any.whl"
    ],
    "pyFiles": [
      "samplepython.py"
    ],
    "jarFiles": [
      "samplejar.jar"
    ],
    "rTarFiles": [
      "sampleR.tar.gz"
    ]
  },
  "environmentYml": "name: sample-environment\ndependencies:\n  - fuzzywuzzy==0.0.1\n  - matplotlib==0.0.1"
}

매개 변수를 preview로 하여 False 요청을 보내는 경우

샘플 요청:

  GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/libraries?beta=False

샘플 응답:

{
  "libraries": [
    {
      "name": "samplewheel-0.18.0-py2.py3-none-any.whl",
      "libraryType": "Custom"
    },
    {
      "name": "fuzzywuzzy",
      "libraryType": "External",
      "version": "0.0.1"
    }
  ],
  "continuationToken": "null",
  "continuationUri": "null"
}

곧 사용 중단될 API

중요한

사용 중단 예정인 API는 2026년 3월 31일까지 계속 지원됩니다. 새로 도입된 API를 사용하여 가능한 한 빨리 구현을 교체하는 것이 좋습니다.

범주	응용 프로그램 인터페이스 (API)	설명	참고
무대 설정	스테이징 라이브러리 업로드	환경에 하나의 사용자 지정 라이브러리 또는 하나/여러 공용 라이브러리를 추가합니다.	2026년 3월 31일까지 지원합니다. 새로 도입된 `Import external libraries`/`Upload custom library` API를 사용하여 교체하세요.
무대 설정	스테이징 라이브러리 삭제	하나의 스테이징 사용자 지정 라이브러리 또는 모든 공용 라이브러리를 삭제합니다.	2026년 3월 31일까지 지원합니다. 새로 도입된 `Remove external library`/`Delete custom library` API를 사용하여 교체하세요.

다음은 스테이징 라이브러리를 관리할 때의 시나리오를 설명하는 몇 가지 예입니다.

사용자 환경에 공용 라이브러리 추가

이전에는 API를 사용하여 Upload staging libraries 업데이트된 YAML 파일을 업로드할 수 있었고, 이제 API를 사용하여 Import external libraries 업데이트된 YAML을 가져올 수 있습니다.
사용자 환경에서 하나의 공용 라이브러리 삭제

이전에는 API를 사용하여 Upload staging libraries 업데이트된 YAML 파일을 업로드할 수 있었고, 이제 API를 사용하여 Remove external library 제거할 수 있습니다.
사용자 환경의 모든 공용 라이브러리 삭제

이전에는 API를 사용하여 Delete staging libraries 모든 공용 라이브러리를 삭제할 수 있었고, 이제 API를 사용하여 Remove external library 공용 라이브러리를 하나씩 제거하거나 Import external libraries 빈 YAML 파일을 업로드하여 동일한 기능을 달성할 수 있습니다.

새로운 API

범주	응용 프로그램 인터페이스 (API)	설명	참고
항목 작업	정의를 사용하여 환경 만들기	정의를 사용하여 새 환경을 만듭니다.	새 API.
항목 작업	환경 정의 가져오기	환경의 정의를 가져옵니다.	새 API.
항목 작업	환경 정의 업데이트	환경의 정의를 업데이트합니다.	새 API.
무대 설정	외부 라이브러리 가져오기	외부 라이브러리를 환경에 environment.yml 파일로 업로드합니다. 환경의 기존 외부 라이브러리 목록을 재정의합니다.	새 API.
무대 설정	외부 라이브러리 내보내기	전체 외부 라이브러리를 environment.yml 파일로 가져옵니다.	새 API.
무대 설정	외부 라이브러리 제거	환경에서 외부 라이브러리를 삭제합니다. 이 API는 한 번에 하나의 라이브러리를 허용합니다.	새 API.
무대 설정	사용자 지정 라이브러리 업로드	환경에서 사용자 지정 패키지를 업로드합니다. 이 API는 한 번에 하나의 파일 업로드를 허용합니다. 지원되는 파일 형식은 .jar, .py, .whl 및 .tar.gz.	새 API.
무대 설정	사용자 지정 라이브러리 삭제	환경에서 사용자 지정 패키지를 삭제합니다. 제거하려면 API 요청에 확장명을 사용하여 사용자 지정 패키지 전체 이름을 입력합니다.	새 API.
출판됨	외부 라이브러리 내보내기	게시된 외부 라이브러리를 environment.yml 파일로 가져옵니다.	새 API.

업데이트가 없는 API

범주	응용 프로그램 인터페이스 (API)	설명
항목 작업	환경 만들기	작업 영역에서 빈 환경을 새로 만듭니다.
항목 작업	환경 가져오기	환경의 메타데이터를 가져옵니다. 응답에는 환경의 상태가 포함됩니다.
항목 작업	환경 삭제	기존 환경 삭제
항목 작업	환경 설정	작업 영역의 환경 목록을 가져옵니다.
항목 작업	업데이트 환경	이름 및 설명과 같은 환경의 메타데이터를 업데이트합니다.
항목 작업	게시 환경 취소	환경에서 진행 중인 게시 작업을 취소합니다.

환경 공용 API에 대한 자세한 내용은 항목 API - 환경을 참조하세요.

환경 퍼블릭 API 사용 사례

중요한

이 섹션은 안정적인 릴리스 버전의 API를 사용하여 설명합니다.

이 섹션에서는 API를 사용하여 환경을 관리할 때 특정 시나리오를 달성하는 방법을 보여 줍니다. 다음 예제의 {WORKSPACE_ID} 속성과 {ARTIFACT_ID} 속성을 적절한 값으로 바꿀 수 있습니다.

새 환경 만들기

빈 환경을 새로 만들려면 다음 API를 사용합니다.

샘플 요청

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments

{
    "displayName": "Environment_1",
    "description": "An environment description"
}

스테이징 라이브러리 관리

스테이징 라이브러리 API 업로드 및 삭제를 사용하여 환경에서 라이브러리 섹션을 관리할 수 있습니다.

환경에 게시된 라이브러리가 있는지 확인

라이브러리를 추가하거나 삭제하기 전에 게시된 라이브러리 가져오기 API를 사용하여 현재 유효한 라이브러리를 확인합니다.

샘플 요청

GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/libraries?beta=False

샘플 응답

{
  "libraries": [
    {
      "name": "samplewheel-0.18.0-py2.py3-none-any.whl",
      "libraryType": "Custom"
    },
    {
      "name": "fuzzywuzzy",
      "libraryType": "External",
      "version": "0.0.1"
    }
  ],
  "continuationToken": "null",
  "continuationUri": "null"
}

공용 라이브러리 가져오기 또는 사용자 지정 라이브러리 업로드

외부 라이브러리 가져오기 및 사용자 지정 라이브러리 API 업로드를 사용하여 환경에 새 공용/사용자 지정 라이브러리를 추가할 수 있습니다. 외부 라이브러리 가져오기 API는 environment.yml 파일을 허용하지만 지원되는 파일 형식은 .whl, .jar, .tar.gz.py 사용자 지정 라이브러리 API를 업로드합니다.

참고

공용 라이브러리를 보다 효율적으로 조작하려면 PyPI 및 Conda의 모든 예상 라이브러리를 environment.yml 파일로 작성하는 것이 좋습니다.

업로드 API는 한 요청에서 최대 200MB의 파일을 허용합니다. 현재 이 크기 제한을 초과하는 라이브러리는 공용 API에서 지원되지 않습니다.

샘플 요청

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries/importExternalLibraries

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries/samplelibrary.jar

사용자 지정 라이브러리 삭제

형식 접미사를 사용하여 전체 라이브러리 파일 이름을 지정하면 한 번에 하나의 사용자 지정 라이브러리를 삭제할 수 있습니다.

참고

기존 공용 라이브러리 또는 모든 라이브러리의 하위 집합을 제거하려면 API를 통해 Import public libraries 업데이트된 YAML 파일을 가져오세요.

샘플 요청

DELETE https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries/samplelibrary.jar

스테이징 Spark 연산 관리

스테이징 Spark 컴퓨팅 업데이트를 사용하여 Spark 컴퓨팅을 관리할 수 있습니다.

환경에 게시된 Spark 컴퓨팅 리소스를 확인하십시오.

환경에 대한 구성을 변경하기 전에 게시된 Spark 컴퓨팅 가져오기 API를 사용하여 현재 유효한 Spark 컴퓨팅 구성을 확인합니다.

샘플 요청

GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/sparkcompute?beta=False

샘플 응답

{
  "instancePool": {
    "name": "MyWorkspacePool",
    "type": "Workspace",
    "id": "78942136-106c-4f3e-80fc-7ff4eae11603"
  },
  "driverCores": 4,
  "driverMemory": "56g",
  "executorCores": 4,
  "executorMemory": "56g",
  "dynamicExecutorAllocation": {
    "enabled": false,
    "minExecutors": 1,
    "maxExecutors": 1
  },
  "sparkProperties": [
    {
      "key": "spark.acls.enable",
      "value": "false"
    }
  ],
  "runtimeVersion": "1.2"
}

컴퓨팅 구성 업데이트

Spark 런타임을 업데이트하고, 다른 풀로 전환하고, 컴퓨팅 구성을 구체화하고, 이 API의 요청 본문을 편집하여 Spark 속성을 추가하거나 제거할 수 있습니다.

풀 이름 및 풀을 지정하여 연결된 풀을 전환할 수 있습니다. 풀 이름을 Starter Pool로 지정하여 풀을 기본 설정으로 전환합니다. REST API로 작업 영역의 사용 가능한 사용자 지정 풀의 전체 목록을 보려면 사용자 지정 풀 - 작업 영역 사용자 지정 풀 나열을 참조하세요.

기존 Spark 속성을 제거하려면 제거하려는 키와 마찬가지로 null 값을 지정합니다.

샘플 요청

PATCH https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/707cfd07-cbf1-41da-aad7-dd157ddb8c11/staging/sparkcompute?beta=False

{
  "instancePool": {
    "name": "MyWorkspacePool",
    "type": "Workspace"
  },
  "driverCores": 4,
  "driverMemory": "56g",
  "executorCores": 4,
  "executorMemory": "56g",
  "dynamicExecutorAllocation": {
    "enabled": false,
    "minExecutors": 1,
    "maxExecutors": 1
  },
  "sparkProperties": [
    {
      "key": "spark.acls.enable",
      "value": "false"
    },
    {
      "key": "spark.admin.acls",
      "value": null
    }
  ],
  "runtimeVersion": "1.2"
}

변경 내용을 효력 있게 만들기

다음 API 집합을 사용하여 변경 내용을 게시합니다.

게시 작업 준비

환경은 한 번에 하나의 게시 작업을 수락할 수 있습니다. 환경을 게시하기 전에 환경 상태의 유효성을 검사하고 스테이징 변경 내용을 최종 검토합니다. 환경이 성공적으로 게시되면 스테이징 상태의 모든 구성이 적용됩니다.

1단계: 환경의 메타데이터를 가져옵니다.
```
GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/
```
응답 본문에서 환경의 상태를 명확하게 알 수 있습니다. 다음 단계로 이동하기 전에 게시 작업이 진행되지 않는지 확인합니다.

2단계: 최종 검토를 위해 스테이징 라이브러리/Spark 컴퓨팅을 가져옵니다.

GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries?beta=False

GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/sparkcompute?beta=False

환경의 게시 작업을 실행합니다

스테이징 라이브러리 및 Spark 컴퓨팅에 대해 수행한 변경 내용은 캐시되지만, 효력을 발휘하려면 게시해야 합니다. 다음 예제를 사용하여 게시 작업을 트리거합니다. 응답은 LRO(장기 실행 작업) 패턴을 따르고 HTTP 응답 코드 202가 반환될 수 있습니다.

샘플 요청

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/publish?beta=False

샘플 응답

Location: https://api.fabric.microsoft.com/v1/operations/abcdef00-9d7e-469a-abf1-fca847a0ea69
x-ms-operation-id: abcdef00-9d7e-469a-abf1-fca847a0ea69
Retry-After: 120

게시 작업 중에 다음 API를 호출하여 취소할 수도 있습니다.

샘플 요청

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/cancelPublish

피드백

이 페이지가 도움이 되었나요?

Last updated on 2025-11-21

다음을 통해 공유

퍼블릭 API를 통해 환경 관리

환경 API를 안정적인 GA 버전으로 마이그레이션

요청/응답 계약 업데이트가 있는 API

곧 사용 중단될 API

새로운 API

업데이트가 없는 API

환경 퍼블릭 API 사용 사례

새 환경 만들기

스테이징 라이브러리 관리

환경에 게시된 라이브러리가 있는지 확인

공용 라이브러리 가져오기 또는 사용자 지정 라이브러리 업로드

사용자 지정 라이브러리 삭제

스테이징 Spark 연산 관리

환경에 게시된 Spark 컴퓨팅 리소스를 확인하십시오.

컴퓨팅 구성 업데이트

변경 내용을 효력 있게 만들기

게시 작업 준비

환경의 게시 작업을 실행합니다

관련 콘텐츠

피드백

추가 리소스