Workspaces - Update Workspace

서비스:

Core

API 버전:

v1

지정된 작업 영역 속성을 업데이트합니다.

권한

호출자에게는 관리자 작업 영역 역할이 있어야 합니다.

필요한 위임된 범위

작업 공간. 읽기쓰기. 전체

Microsoft Entra 지원 식별자

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

아이덴티티	지원
사용자	예
서비스 주체 및 관리 ID	예

인터페이스

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
workspaceId	path	True	string (uuid)	작업 영역 ID입니다.

요청 본문

Name	형식	Description
description	string	작업 영역 설명입니다. 설명은 4000자를 초과할 수 없습니다.
displayName	string	작업 영역 표시 이름입니다. 표시 이름에는 256자를 초과할 수 없습니다. 작업 영역 이름은 테넌트 내에서 고유해야 합니다. "관리자 모니터링"은 예약된 작업 영역 이름입니다.

응답

Name	형식	Description
200 OK	Workspace	요청이 성공적으로 완료되었습니다.
Other Status Codes	ErrorResponse	일반적인 오류 코드: UnknownError - 오류가 발생했습니다.

예제

Update a workspace example

샘플 요청

HTTP

PATCH https://api.fabric.microsoft.com/v1/workspaces/33bae707-5fe7-4352-89bd-061a1318b60a

{
  "displayName": "Workspace New displayName",
  "description": "Workspace New description"
}

샘플 응답

상태 코드:

200

{
  "id": "33bae707-5fe7-4352-89bd-061a1318b60a",
  "displayName": "Workspace New displayName",
  "description": "Workspace New description",
  "type": "Workspace",
  "domainId": "686177b9-ef29-45e4-a5db-1786ca6dbb9f"
}

정의

Name	Description
ErrorRelatedResource	오류 관련 리소스 세부 정보 개체입니다.
ErrorResponse	오류 응답입니다.
ErrorResponseDetails	오류 응답 세부 정보입니다.
UpdateWorkspaceRequest	작업 영역 요청 페이로드를 업데이트합니다.
Workspace	작업 영역 개체입니다.
WorkspaceType	작업 영역 형식입니다. 추가 작업 영역 형식은 시간이 지남에 따라 추가될 수 있습니다.

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	오류 관련 리소스 세부 정보입니다.

UpdateWorkspaceRequest

Object

작업 영역 요청 페이로드를 업데이트합니다.

Name	형식	Description
description	string	작업 영역 설명입니다. 설명은 4000자를 초과할 수 없습니다.
displayName	string	작업 영역 표시 이름입니다. 표시 이름에는 256자를 초과할 수 없습니다. 작업 영역 이름은 테넌트 내에서 고유해야 합니다. "관리자 모니터링"은 예약된 작업 영역 이름입니다.

Workspace

Object

작업 영역 개체입니다.

Name	형식	Description
apiEndpoint	string (uri)	작업 영역과 관련된 API 엔드포인트를 나타내는 HTTP URL입니다. 이 엔드포인트 값은 사용자가 preferWorkspaceSpecificEndpoints를 사용하도록 설정하면 반환됩니다. 프라이빗 링크를 통해 API에 액세스할 수 있습니다.
capacityId	string (uuid)	작업 영역이 할당된 용량의 ID입니다.
description	string	작업 영역 설명입니다.
displayName	string	작업 영역 표시 이름입니다.
domainId	string (uuid)	작업 영역이 할당된 도메인의 ID입니다.
id	string (uuid)	작업 영역 ID입니다.
type	WorkspaceType	작업 영역 형식입니다.

WorkspaceType

열거형

작업 영역 형식입니다. 추가 작업 영역 형식은 시간이 지남에 따라 추가될 수 있습니다.

값	Description
Personal	사용자 항목을 관리하는 데 사용되는 내 폴더 또는 내 작업 영역입니다.
Workspace	패브릭 항목을 관리하는 데 사용되는 작업 영역입니다.
AdminWorkspace	관리자 모니터링 작업 영역. 감사 보고서, 사용 현황 및 채택 보고서와 같은 관리자 보고서를 포함합니다.