다음을 통해 공유

Items - Update Environment Definition

서비스:
Environment
API 버전:
v1

지정된 환경에 대한 정의를 재정의합니다.
이 API는 LRO(장기 실행 작업)지원합니다.

환경의 정의를 업데이트해도 민감도 레이블에는 영향을 주지 않습니다.

Permissions

호출자에게는 환경에 대한 읽기 및 쓰기 권한이 있어야 합니다.

필요한 위임된 범위

Environment.ReadWrite.All 또는 Item.ReadWrite.All

Microsoft Entra 지원 식별자

이 API는 이 섹션에 나열된 Microsoft ID 지원합니다.

아이덴티티 Support
사용자 Yes
서비스 주체 및 관리 ID Yes

인터페이스

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/updateDefinition
선택적 매개 변수: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/updateDefinition?updateMetadata={updateMetadata}

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
environmentId
 path True

string (uuid)

환경 ID입니다.
workspaceId
 path True

string (uuid)

작업 영역 ID입니다.
updateMetadata
 query

boolean

true로 설정하고 .platform 파일이 정의의 일부로 제공되면 .platform 파일의 메타데이터를 사용하여 항목의 메타데이터가 업데이트됩니다.

요청 본문

Name 필수 형식 Description
definition True

EnvironmentDefinition

환경 공용 정의 개체입니다. 환경 공용 정의를 만드는 방법에 대한 자세한 내용은 이 문서를 참조하세요.

응답

Name 형식 Description
200 OK

요청이 성공적으로 완료되었습니다.
202 Accepted

요청이 수락되었습니다. 업데이트 정의가 진행 중입니다.

헤더

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

일반적인 오류 코드:

  • OperationNotSupportedForItem - 요청된 항목에 대해 지원되지 않는 작업입니다.

  • CorruptedPayload - 제공된 페이로드가 손상되었습니다.

예제

Update a environment definition example

샘플 요청

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/environments/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "parts": [
      {
        "path": "Libraries/CustomLibraries/samplelibrary.jar",
        "payload": "eyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/samplepython.py",
        "payload": "FyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/samplewheel-0.18.0-py2.py3-none-any.whl",
        "payload": "LyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/sampleR.tar.gz",
        "payload": "ZyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/PublicLibraries/environment.yml",
        "payload": "IyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Setting/Sparkcompute.yml",
        "payload": "GyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

샘플 응답

상태 코드:
200
상태 코드:
202 
Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

정의

Name Description
EnvironmentDefinition

환경 공용 정의 개체입니다. 환경 공용 정의를 만드는 방법에 대한 자세한 내용은 이 문서를 참조하세요.
EnvironmentDefinitionPart

환경 정의 부분 개체입니다.
ErrorRelatedResource

오류 관련 리소스 세부 정보 개체입니다.
ErrorResponse

오류 응답입니다.
ErrorResponseDetails

오류 응답 세부 정보입니다.
PayloadType

정의 파트 페이로드의 형식입니다. 추가 페이로드 유형은 시간이 지남에 따라 추가될 수 있습니다.
UpdateEnvironmentDefinitionRequest

환경 공용 정의 요청 페이로드를 업데이트합니다.

EnvironmentDefinition

Object

환경 공용 정의 개체입니다. 환경 공용 정의를 만드는 방법에 대한 자세한 내용은 이 문서를 참조하세요.

Name 형식 Description
format

string

환경 정의의 형식입니다.
parts

EnvironmentDefinitionPart[]

정의 부분 목록입니다.

EnvironmentDefinitionPart

Object

환경 정의 부분 개체입니다.

Name 형식 Description
path

string

환경 파트 경로입니다.
payload

string

환경 부분 페이로드입니다.
payloadType

PayloadType

페이로드 형식입니다.

ErrorRelatedResource

Object

오류 관련 리소스 세부 정보 개체입니다.

Name 형식 Description
resourceId

string

오류와 관련된 리소스 ID입니다.
resourceType

string

오류와 관련된 리소스의 형식입니다.

ErrorResponse

Object

오류 응답입니다.

Name 형식 Description
errorCode

string

오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.
message

string

사용자가 읽을 수 있는 오류 표현입니다.
moreDetails

ErrorResponseDetails[]

추가 오류 세부 정보 목록입니다.
relatedResource

ErrorRelatedResource

오류 관련 리소스 세부 정보입니다.
requestId

string

오류와 연결된 요청의 ID입니다.

ErrorResponseDetails

Object

오류 응답 세부 정보입니다.

Name 형식 Description
errorCode

string

오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.
message

string

사용자가 읽을 수 있는 오류 표현입니다.
relatedResource

ErrorRelatedResource

오류 관련 리소스 세부 정보입니다.

PayloadType

열거형

정의 파트 페이로드의 형식입니다. 추가 페이로드 유형은 시간이 지남에 따라 추가될 수 있습니다.

값 Description
InlineBase64

인라인 베이스 64.

UpdateEnvironmentDefinitionRequest

Object

환경 공용 정의 요청 페이로드를 업데이트합니다.

Name 형식 Description
definition

EnvironmentDefinition

환경 공용 정의 개체입니다. 환경 공용 정의를 만드는 방법에 대한 자세한 내용은 이 문서를 참조하세요.