Workspaces - List Workspaces

서비스:
Admin
API 버전:
v1

작업 영역 목록을 반환합니다.

Note

이 API는 미리 보기 릴리스의 일부이며 평가 및 개발 목적으로만 제공됩니다. 피드백에 따라 변경 될 수 있으며 프로덕션 사용에는 권장되지 않습니다.

이 API는 페이지 매김지원합니다. 요청당 최대 10,000개의 레코드를 반환할 수 있습니다. 응답에 제공된 연속 토큰을 사용하여 다음 10,000개의 레코드를 가져올 수 있습니다.

Permissions

호출자는 패브릭 관리자이거나 서비스 주체를 사용하여 인증해야 합니다.

필요한 위임된 범위

Tenant.Read.All 또는 Tenant.ReadWrite.All

Limitations

시간당 최대 200개 요청

필터는 encryptionStatus 매개 변수에 .가 include 포함된 경우에만 적용됩니다.encryption

Microsoft Entra 지원 식별자

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

Identity Support
User Yes
서비스 주체 및 관리 ID Yes

Interface

GET https://api.fabric.microsoft.com/v1/admin/workspaces
선택적 매개 변수: 
GET https://api.fabric.microsoft.com/v1/admin/workspaces?type={type}&capacityId={capacityId}&name={name}&state={state}&continuationToken={continuationToken}&encryptionStatus={encryptionStatus}&include={include}

URI 매개 변수

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

string (uuid)

작업 영역의 용량 ID입니다.
continuationToken
 query

string

연속 토큰입니다. 목록에서 다음 항목을 가져오는 데 사용됩니다.
encryptionStatus
 query

string

작업 영역의 CMK 암호화 상태를 나타내며 지정된 상태와 일치하는 작업 영역을 필터링하는 데 사용됩니다.
include
 query

string

응답의 각 작업 영역에 포함할 추가 데이터를 지정합니다. 지원되는 값: encryption.
name
 query

string

작업 영역 이름입니다.
state
 query

string

작업 영역 상태입니다. 지원되는 상태는 활성 상태이며 삭제됩니다.
type
 query

string

작업 영역 형식입니다. 지원되는 유형은 개인, 작업 영역, adminworkspace입니다.

응답

Name 형식 Description
200 OK

Workspaces

작업이 성공했습니다.
429 Too Many Requests

ErrorResponse

서비스 속도 제한을 초과했습니다. 서버는 클라이언트가 Retry-After 추가 요청을 보내기 전에 대기해야 하는 시간을 초 단위로 나타내는 헤더를 반환합니다.

헤더

Retry-After: integer
Other Status Codes

ErrorResponse

일반적인 오류 코드:

  • BadRequest - 쿼리 매개 변수(예: workspaceType 유효하지 않음)workspaceState

  • InsufficientPrivileges - 호출자에게 API를 호출할 수 있는 권한이 없습니다.

예제

Get a list of workspaces example
Get a list of workspaces using state query parameter example
List workspaces for a given capacity, ignoring the encryptionStatus filter.
List workspaces with active encryption status in a given capacity
List workspaces with encryption details

Get a list of workspaces example

샘플 요청

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

샘플 응답

상태 코드:
200 
{
  "workspaces": [
    {
      "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "name": "test report",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "tags": [
        {
          "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
          "displayName": "Finance"
        },
        {
          "id": "6f1a8d3b-92c4-4f67-8c2d-1e5a9b7f4a23",
          "displayName": "Production"
        }
      ]
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Get a list of workspaces using state query parameter example

샘플 요청

GET https://api.fabric.microsoft.com/v1/admin/workspaces?state=Active

샘플 응답

상태 코드:
200 
{
  "workspaces": [
    {
      "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "name": "test report",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84"
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

List workspaces for a given capacity, ignoring the encryptionStatus filter.

샘플 요청

GET https://api.fabric.microsoft.com/v1/admin/workspaces?capacityId=61d6811f-7544-4e75-a1e6-1c59c0383312&encryptionStatus=Active

샘플 응답

상태 코드:
200 
{
  "workspaces": [
    {
      "id": "abf49964-6f70-4aea-a66c-4b78a22e3ddc",
      "name": "Contoso Workspace 1",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9"
    },
    {
      "id": "90119767-07b4-4657-82ee-53e90fece225",
      "name": "Contoso Workspace 3",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9"
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

List workspaces with active encryption status in a given capacity

샘플 요청

GET https://api.fabric.microsoft.com/v1/admin/workspaces?capacityId=61d6811f-7544-4e75-a1e6-1c59c0383312&encryptionStatus=Active&include=encryption

샘플 응답

상태 코드:
200 
{
  "workspaces": [
    {
      "id": "90119767-07b4-4657-82ee-53e90fece225",
      "name": "Contoso Workspace 3",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Active",
        "keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/"
      }
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

List workspaces with encryption details

샘플 요청

GET https://api.fabric.microsoft.com/v1/admin/workspaces?encryptionStatus={encryptionStatus}&include=encryption

샘플 응답

상태 코드:
200 
{
  "workspaces": [
    {
      "id": "abf49964-6f70-4aea-a66c-4b78a22e3ddc",
      "name": "Contoso Workspace 1",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Disabled"
      }
    },
    {
      "id": "9c7f06cc-e850-4961-b2bd-181a70b1a784",
      "name": "Contoso Workspace 2",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Disabled"
      }
    },
    {
      "id": "90119767-07b4-4657-82ee-53e90fece225",
      "name": "Contoso Workspace 3",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Active",
        "keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/"
      }
    },
    {
      "id": "adaa3051-b1de-41ed-b1b4-d5e08887c1e9",
      "name": "Contoso Workspace 4",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "EnableInProgress",
        "keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/",
        "previousStatus": "Active",
        "previousKeyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test4k/"
      }
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

정의

Name Description
Encryption

CMK(고객 관리형 키)를 사용하는 작업 영역 암호화 세부 정보입니다.
ErrorRelatedResource

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

오류 응답입니다.
ErrorResponseDetails

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

Workspace.
WorkspaceAppliedTag

적용된 태그를 나타냅니다.
WorkspaceEncryptionStatus

작업 영역의 CMK 암호화 상태입니다.
Workspaces

작업 영역 목록입니다.
WorkspaceState

작업 영역 상태입니다. 시간이 지남에 따라 추가 작업 영역 상태가 추가될 수 있습니다.
WorkspaceType

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

Encryption

Object

CMK(고객 관리형 키)를 사용하는 작업 영역 암호화 세부 정보입니다.

Name 형식 Description
keyIdentifier

string

암호화 키 식별자입니다.
previousKeyIdentifier

string

이전 암호화 키 식별자입니다.
previousStatus

WorkspaceEncryptionStatus

작업 영역의 이전 CMK 암호화 상태입니다.
status

WorkspaceEncryptionStatus

작업 영역의 CMK 암호화 상태입니다.

ErrorRelatedResource

Object

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

Name 형식 Description
resourceId

string

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

string

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

ErrorResponse

Object

오류 응답입니다.

Name 형식 Description
errorCode

string

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

boolean

true이면 요청을 다시 시도 할 수 있습니다. 응답 헤더를 Retry-After 사용하여 가능한 경우 지연을 확인합니다.
message

string

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

ErrorResponseDetails[]

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

ErrorRelatedResource

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

string (uuid)

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

ErrorResponseDetails

Object

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

Name 형식 Description
errorCode

string

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

string

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

ErrorRelatedResource

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

Workspace

Object

Workspace.

Name 형식 Description
capacityId

string (uuid)

작업 영역의 용량 ID입니다.
domainId

string (uuid)

작업 영역의 도메인 ID입니다.
encryption

Encryption

작업 영역의 암호화 세부 정보입니다.
id

string (uuid)

작업 영역 ID입니다.
name

string

작업 영역 이름입니다.
state

WorkspaceState

작업 영역 상태입니다.
tags

WorkspaceAppliedTag[]

적용된 태그 목록입니다.
type

WorkspaceType

작업 영역 형식입니다.

WorkspaceAppliedTag

Object

적용된 태그를 나타냅니다.

Name 형식 Description
displayName

string

태그의 이름입니다.
id

string (uuid)

태그 ID입니다.

WorkspaceEncryptionStatus

열거형

작업 영역의 CMK 암호화 상태입니다.

값 Description
Disabled

작업 영역 암호화가 활성화되지 않았습니다.
Active

작업 영역 암호화가 활성화되고 작업 영역이 암호화됩니다.
EnableInProgress

작업 영역 암호화를 사용하도록 설정합니다.
DisableInProgress

작업 영역 암호화를 사용하지 않도록 설정됩니다.
Failed

작업 영역 암호화 애플리케이션이 실패했습니다.

Workspaces

Object

작업 영역 목록입니다.

Name 형식 Description
continuationToken

string

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

string

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

Workspace[]

패브릭 작업 영역 목록입니다.

WorkspaceState

열거형

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

값 Description
Active

작업 영역이 활성화되어 있습니다. 분리된 작업 영역은 활성으로 표시됩니다.
Deleted

작업 영역이 삭제됩니다.

WorkspaceType

열거형

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

값 Description
Personal

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

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

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