다음을 통해 공유

Workspaces - List Workspaces

서비스:
Core
API 버전:
v1

보안 주체가 액세스할 수 있는 작업 영역 목록을 반환합니다. 역할 쿼리 매개 변수를 사용하여 주 작업 영역 역할별로 결과를 필터링합니다.
이 API는 페이지 매김지원합니다.

필요한 위임된 범위

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

Microsoft Entra 지원 식별자

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

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

인터페이스

GET https://api.fabric.microsoft.com/v1/workspaces
선택적 매개 변수: 
GET https://api.fabric.microsoft.com/v1/workspaces?roles={roles}&continuationToken={continuationToken}&preferWorkspaceSpecificEndpoints={preferWorkspaceSpecificEndpoints}

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
continuationToken
 query

string

결과의 다음 페이지를 검색하기 위한 토큰입니다.
preferWorkspaceSpecificEndpoints
 query

boolean

작업 영역당 작업 영역별 API 엔드포인트를 포함할지 여부를 제어하는 설정입니다. True - 작업 영역별 API 엔드포인트 포함, False - 작업 영역별 API 엔드포인트를 포함하지 않습니다.
roles
 query

string

역할 목록입니다. 쉼표로 값을 구분합니다. 제공되지 않으면 모든 작업 영역이 반환됩니다.

응답

Name 형식 Description
200 OK

Workspaces

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

ErrorResponse

일반적인 오류 코드:

  • InvalidParameter - 잘못된 작업 영역 역할입니다.

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

예제

List workspaces example
List workspaces with continuation example
List workspaces with preferWorkspaceSpecificEndpoints example
List workspaces with roles filter example

List workspaces example

샘플 요청

GET https://api.fabric.microsoft.com/v1/workspaces

샘플 응답

상태 코드:
200 
{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "My workspace",
      "description": "",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Marketing",
      "description": "A  workspace used by the marketing team",
      "type": "Workspace"
    },
    {
      "id": "f2d70dc6-8f3e-4f2c-b00e-e2d336d7d711",
      "displayName": "Finance",
      "description": "A workspace used by the finance team",
      "type": "Workspace",
      "capacityId": "171018af-1531-4e61-942a-74f024b7f9fd",
      "domainId": "7c889f28-999b-4945-840d-54da3e3b5a29"
    }
  ]
}

List workspaces with continuation example

샘플 요청

GET https://api.fabric.microsoft.com/v1/workspaces

샘플 응답

상태 코드:
200 
{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "My workspace",
      "description": "",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Marketing",
      "description": "A  workspace used by the marketing team",
      "type": "Workspace"
    },
    {
      "id": "f2d70dc6-8f3e-4f2c-b00e-e2d336d7d711",
      "displayName": "Finance",
      "description": "A workspace used by the finance team",
      "type": "Workspace",
      "capacityId": "171018af-1531-4e61-942a-74f024b7f9fd"
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces?continuationToken=LDEsMTAwMDAwLDA%3D"
}

List workspaces with preferWorkspaceSpecificEndpoints example

샘플 요청

GET https://api.fabric.microsoft.com/v1/workspaces?preferWorkspaceSpecificEndpoints=True

샘플 응답

상태 코드:
200 
{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Alice's Workspace",
      "description": "A workspace for Alice",
      "type": "Workspace",
      "apiEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.w.api.fabric.microsoft.com"
    },
    {
      "id": "0c02a0cd-71bc-410f-aa05-5a7bc98765f7",
      "displayName": "Bob's Workspace",
      "description": "A workspace for Bob",
      "type": "Workspace",
      "apiEndpoint": "https://0c02a0cd71bc410faa055a7bc98765f7.z0c.w.api.fabric.microsoft.com"
    }
  ]
}

List workspaces with roles filter example

샘플 요청

GET https://api.fabric.microsoft.com/v1/workspaces?roles=Admin,Member,Contributor,Viewer

샘플 응답

상태 코드:
200 
{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "Admins workspace",
      "description": "A workspace for admins",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Members workspace",
      "description": "A workspace for members",
      "type": "Workspace"
    },
    {
      "id": "0c02a0cd-71bc-410f-aa05-5a7bc98765f7",
      "displayName": "Contributors workspace",
      "description": "A workspace for contributors",
      "type": "Workspace"
    },
    {
      "id": "99d58687-8903-4dbd-8a78-40f95dca7177",
      "displayName": "Viewers workspace",
      "description": "A workspace for viewers",
      "type": "Workspace"
    }
  ]
}

정의

Name Description
ErrorRelatedResource

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

오류 응답입니다.
ErrorResponseDetails

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

작업 영역 개체입니다.
Workspaces
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

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

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

작업 영역 형식입니다.

Workspaces

Object
Name 형식 Description
continuationToken

string

다음 결과 집합 일괄 처리에 대한 토큰입니다. 레코드가 더 이상 없으면 응답에서 제거됩니다.
continuationUri

string

다음 결과 집합 일괄 처리의 URI입니다. 레코드가 더 이상 없으면 응답에서 제거됩니다.
value

Workspace[]

작업 영역 목록입니다.

WorkspaceType

열거형

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

값 Description
Personal

사용자 항목을 관리하는 데 사용되는 내 폴더 또는 내 작업 영역입니다.
Workspace

패브릭 항목을 관리하는 데 사용되는 작업 영역입니다.
AdminWorkspace

관리자 모니터링 작업 영역. 감사 보고서, 사용 현황 및 채택 보고서와 같은 관리자 보고서를 포함합니다.