다음을 통해 공유


Collections - List Collections

계정의 컬렉션을 나열합니다.

GET {endpoint}/collections?api-version=2019-11-01-preview
GET {endpoint}/collections?api-version=2019-11-01-preview&$skipToken={$skipToken}

URI 매개 변수

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

string

Purview 계정의 계정 엔드포인트입니다. 예: https://{accountName}.purview.azure.com/account/

api-version
query True

string

사용할 api 버전입니다.

$skipToken
query

string

응답

Name 형식 Description
200 OK

CollectionList

Success

Other Status Codes

ErrorResponseModel

공급자로부터 받은 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name Description
user_impersonation 사용자 계정 가장

예제

Collections_ListCollections

샘플 요청

GET {endpoint}/collections?api-version=2019-11-01-preview

샘플 응답

Date: Wed, 13 Sep 2017 18:04:32 GMT
x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888
X-Content-Type-Options: nosniff
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd
{
  "value": [
    {
      "name": "mycollection1",
      "friendlyName": "Finance",
      "parentCollection": {
        "type": "CollectionReference",
        "referenceName": "accountName"
      },
      "collectionProvisioningState": "Succeeded"
    }
  ]
}

정의

Name Description
Collection

컬렉션 리소스입니다.

CollectionList

컬렉션의 페이징된 목록입니다.

collectionProvisioningState

프로비전의 상태를 가져옵니다.

CollectionReference

컬렉션에 대한 참조입니다.

createdByType

리소스를 만든 ID의 형식입니다.

Error

오류를 가져오거나 설정합니다.

ErrorModel

기본 오류 모델

ErrorResponseModel

기본 오류 응답 모델

lastModifiedByType

리소스를 마지막으로 수정한 ID 유형입니다.

SystemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

Collection

컬렉션 리소스입니다.

Name 형식 Description
collectionProvisioningState

collectionProvisioningState

프로비전의 상태를 가져옵니다.

description

string

설명을 가져오거나 설정합니다.

friendlyName

string

컬렉션의 이름을 가져오거나 설정합니다.

name

string

이름을 가져옵니다.

parentCollection

CollectionReference

부모 컬렉션 참조를 가져오거나 설정합니다.

systemData

SystemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

CollectionList

컬렉션의 페이징된 목록입니다.

Name 형식 Description
count

integer

총 항목 수입니다.

nextLink

string

다음 결과 페이지의 URL입니다.

value

Collection[]

형식 결과의 항목 컬렉션입니다.

collectionProvisioningState

프로비전의 상태를 가져옵니다.

Name 형식 Description
Creating

string

Deleting

string

Failed

string

Moving

string

Succeeded

string

Unknown

string

CollectionReference

컬렉션에 대한 참조입니다.

Name 형식 Description
referenceName

string

참조 이름을 가져오거나 설정합니다.

type

string

참조 형식 속성을 가져오거나 설정합니다.

createdByType

리소스를 만든 ID의 형식입니다.

Name 형식 Description
Application

string

Key

string

ManagedIdentity

string

User

string

Error

오류를 가져오거나 설정합니다.

Name 형식 Description
code

string

코드를 가져오거나 설정합니다.

details

ErrorModel[]

세부 정보를 가져오거나 설정합니다.

message

string

메시지를 가져오거나 설정합니다.

target

string

대상을 가져오거나 설정합니다.

ErrorModel

기본 오류 모델

Name 형식 Description
code

string

코드를 가져오거나 설정합니다.

details

ErrorModel[]

세부 정보를 가져오거나 설정합니다.

message

string

메시지를 가져오거나 설정합니다.

target

string

대상을 가져오거나 설정합니다.

ErrorResponseModel

기본 오류 응답 모델

Name 형식 Description
error

Error

오류를 가져오거나 설정합니다.

lastModifiedByType

리소스를 마지막으로 수정한 ID 유형입니다.

Name 형식 Description
Application

string

Key

string

ManagedIdentity

string

User

string

SystemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

Name 형식 Description
createdAt

string

UTC(리소스 만들기)의 타임스탬프입니다.

createdBy

string

리소스를 만든 ID입니다.

createdByType

createdByType

리소스를 만든 ID의 형식입니다.

lastModifiedAt

string

리소스를 마지막으로 수정한 타임스탬프(UTC)입니다.

lastModifiedBy

string

리소스를 마지막으로 수정한 ID입니다.

lastModifiedByType

lastModifiedByType

리소스를 마지막으로 수정한 ID 유형입니다.