Workspaces - Get Workspace

서비스:: Core

API 버전:: v1

지정된 작업 영역 정보를 반환합니다.

권한

호출자에게는 뷰어 이상의 작업 영역 역할이 있어야 합니다.

필요한 위임된 범위

Workspace.Read.All 또는 Workspace.ReadWrite.All

Microsoft Entra 지원 식별자

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

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

인터페이스

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

선택적 매개 변수:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}?preferWorkspaceSpecificEndpoints={preferWorkspaceSpecificEndpoints}

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
workspaceId	path	True	string (uuid)	작업 영역 ID입니다.
preferWorkspaceSpecificEndpoints	query		boolean	API 및 OneLake 액세스에 대한 작업 영역별 또는 일반 퍼블릭 엔드포인트를 포함할지 여부를 제어하는 설정입니다. True - API 및 OneLake 액세스에 대한 작업 영역별 엔드포인트 포함, False - OneLake 액세스에 대한 일반 퍼블릭 엔드포인트를 포함합니다.

응답

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

Name

형식

Description

200 OK

WorkspaceInfo

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

Other Status Codes

ErrorResponse

일반적인 오류 코드:

UnknownError - 오류가 발생했습니다.

예제

Get a workspace example

Get a workspace with preferWorkspaceSpecificEndpoints example

Get a workspace example

샘플 요청

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227

샘플 응답

상태 코드:: 200

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
  "displayName": "New workspace",
  "description": "New workspace description",
  "type": "Workspace",
  "domainId": "9ce364e0-8e9d-4605-887a-b599b3e8b123",
  "capacityId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
  "capacityAssignmentProgress": "Completed",
  "workspaceIdentity": {
    "applicationId": "00a4a8f9-78d3-41b3-b87a-6ae5271c8d0d",
    "servicePrincipalId": "5ba4ae58-d402-45c6-a848-0253e834fd78"
  },
  "capacityRegion": "East US",
  "oneLakeEndpoints": {
    "blobEndpoint": "https://eastus-onelake.blob.fabric.microsoft.com",
    "dfsEndpoint": "https://eastus-onelake.dfs.fabric.microsoft.com"
  }
}

Get a workspace with preferWorkspaceSpecificEndpoints example

샘플 요청

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227?preferWorkspaceSpecificEndpoints=True

샘플 응답

상태 코드:: 200

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
  "displayName": "New workspace",
  "description": "New workspace description",
  "type": "Workspace",
  "capacityId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
  "capacityAssignmentProgress": "Completed",
  "workspaceIdentity": {
    "applicationId": "00a4a8f9-78d3-41b3-b87a-6ae5271c8d0d",
    "servicePrincipalId": "5ba4ae58-d402-45c6-a848-0253e834fd78"
  },
  "capacityRegion": "East US",
  "oneLakeEndpoints": {
    "blobEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.blob.fabric.microsoft.com",
    "dfsEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.dfs.fabric.microsoft.com"
  },
  "apiEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.w.api.fabric.microsoft.com"
}

정의

Name	Description
CapacityAssignmentProgress	용량 진행 상태에 대한 작업 영역 할당입니다. 추가 용량 할당 진행률 값은 시간이 지남에 따라 추가될 수 있습니다.
CapacityRegion	이 작업 영역과 연결된 용량의 영역입니다. 추가 용량 지역 값은 시간이 지남에 따라 추가될 수 있습니다.
ErrorRelatedResource	오류 관련 리소스 세부 정보 개체입니다.
ErrorResponse	오류 응답입니다.
ErrorResponseDetails	오류 응답 세부 정보입니다.
OneLakeEndpoints	이 작업 영역과 연결된 OneLake API 엔드포인트입니다.
WorkspaceIdentity	작업 영역 ID 개체입니다.
WorkspaceInfo	작업 영역 개체입니다.
WorkspaceType	작업 영역 형식입니다. 추가 작업 영역 형식은 시간이 지남에 따라 추가될 수 있습니다.

CapacityAssignmentProgress

열거형

용량 진행 상태에 대한 작업 영역 할당입니다. 추가 용량 할당 진행률 값은 시간이 지남에 따라 추가될 수 있습니다.

값	Description
Completed	마지막 용량 할당 작업이 성공적으로 완료되었습니다.
Failed	용량 할당 작업에 오류 또는 오류가 발생하여 완료할 수 없습니다.
InProgress	용량 할당 작업이 현재 실행 중이며 아직 완료되지 않았습니다.

CapacityRegion

열거형

이 작업 영역과 연결된 용량의 영역입니다. 추가 용량 지역 값은 시간이 지남에 따라 추가될 수 있습니다.

값	Description
Australia East	오스트레일리아 동부 지역
Australia Southeast	오스트레일리아 남동부 지역
Brazil South	브라질 남부 지역
Brazil Southeast	브라질 남동부 지역
Canada Central	캐나다 중부 지역
Canada East	캐나다 동부 지역
Central India	인도 중부 지역
Central US	미국 중부 지역
Central US EUAP	미국 중부 EUAP 지역
East Asia	동아시아 지역
East US	미국 동부 지역
East US 2	미국 동부 2 지역
France Central	프랑스 중부 지역
France South	프랑스 남부 지역
Germany Central	독일 중부 지역
Germany Northeast	독일 북동부 지역
Israel Central	이스라엘 중부 지역
Italy North	이탈리아 북부 지역
Japan East	일본 동부 지역
Japan West	일본 서부 지역
Korea Central	한국 중부 지역
Korea South	대한민국 남부 지역
Mexico Central	멕시코 중부 지역
North Central US	미국 중북부 지역
North Europe	북유럽 지역
Norway East	노르웨이 동부 지역
Norway West	노르웨이 서부 지역
Poland Central	폴란드 중부 지역
South Africa North	남아프리카 북부 지역
South Africa West	남아프리카 서부 지역
South Central US	미국 중남부 지역
South India	인도 남부 지역
Southeast Asia	동남 아시아 지역
Spain Central	스페인 중부 지역
Sweden Central	스웨덴 중부 지역
Switzerland North	스위스 북부 지역
Switzerland West	스위스 서부 지역
West Europe	서유럽 지역
West India	인도 서부 지역
West US	미국 서부 지역
West US 2	미국 서부 2 지역
West US 3	미국 서부 3 지역
West Central US	미국 중서부 지역
UAE Central	UAE 중부 지역
UAE North	UAE 북부 지역
Qatar Central	카타르 중부 지역
Germany West Central	독일 중서부 지역
Germany North	독일 북부 지역
UK South	영국 남부 지역
UK West	영국 서부 지역
China North	중국 북부 지역
China East	중국 동부 지역
China East 2	중국 동부 2 지역
China East 3	중국 동부 3 지역
China North 2	중국 북부 2 지역
China North 3	중국 북부 3 지역

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

OneLakeEndpoints

Object

이 작업 영역과 연결된 OneLake API 엔드포인트입니다.

Name	형식	Description
blobEndpoint	string	Blob API 작업에 사용할 수 있는 OneLake API 엔드포인트입니다. 기본적으로 이 엔드포인트는 지역별 엔드포인트입니다. 사용자가 preferWorkspaceSpecificEndpoints를 사용하도록 설정하거나 작업 영역에 공용 액세스가 사용하지 않도록 설정된 경우 프라이빗 링크를 통해 액세스할 수 있도록 작업 영역별 엔드포인트가 제공됩니다.
dfsEndpoint	string	DFS(분산 파일 시스템) 또는 ADLSgen2 파일 시스템 API 작업에 사용할 수 있는 OneLake API 엔드포인트입니다. 기본적으로 이 엔드포인트는 지역별 엔드포인트입니다. 사용자가 preferWorkspaceSpecificEndpoints를 사용하도록 설정하거나 작업 영역에 공용 액세스가 사용하지 않도록 설정된 경우 프라이빗 링크를 통해 액세스할 수 있도록 작업 영역별 엔드포인트가 제공됩니다.

WorkspaceIdentity

Object

작업 영역 ID 개체입니다.

Name	형식	Description
applicationId	string	애플리케이션 ID입니다.
servicePrincipalId	string	서비스 주체 ID입니다.

WorkspaceInfo

Object

작업 영역 개체입니다.

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

WorkspaceType

열거형

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

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

다음을 통해 공유

Workspaces - Get Workspace

권한

필요한 위임된 범위

Microsoft Entra 지원 식별자

인터페이스

URI 매개 변수

응답

예제

Get a workspace example

샘플 요청

샘플 응답

Get a workspace with preferWorkspaceSpecificEndpoints example

샘플 요청

샘플 응답

정의

CapacityAssignmentProgress

CapacityRegion

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

OneLakeEndpoints

WorkspaceIdentity

WorkspaceInfo

WorkspaceType