你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Collections - List Collections

Service:

Purview

API Version:

2019-11-01-preview

列出帐户中的集合。

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

With optional parameters:

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

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string	Purview 帐户的帐户终结点。 示例：https://{accountName}.purview.azure.com/account/
api-version	query	True	string	要使用的 API 版本。
$skipToken	query		string

响应

名称	类型	说明
200 OK	CollectionList	成功
Other Status Codes	ErrorResponseModel	从提供程序收到的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

Collections_ListCollections

Sample Request

HTTP

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

Sample Response

Status code:

200

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

Response Body

{
  "value": [
    {
      "name": "mycollection1",
      "friendlyName": "Finance",
      "parentCollection": {
        "type": "CollectionReference",
        "referenceName": "accountName"
      },
      "collectionProvisioningState": "Succeeded"
    }
  ]
}

定义

名称	说明
Collection	集合资源。
CollectionList	集合的分页列表。
collectionProvisioningState	获取预配的状态。
CollectionReference	对集合的引用。
createdByType	创建资源的标识类型。
Error	获取或设置错误。
ErrorModel	默认错误模型
ErrorResponseModel	默认错误响应模型
lastModifiedByType	上次修改资源的标识类型。
SystemData	与资源的创建和上次修改相关的元数据。

Collection

集合资源。

名称	类型	说明
collectionProvisioningState	collectionProvisioningState	获取预配的状态。
description	string	获取或设置说明。
friendlyName	string	获取或设置集合的友好名称。
name	string	获取名称。
parentCollection	CollectionReference	获取或设置父集合引用。
systemData	SystemData	与资源的创建和上次修改相关的元数据。

CollectionList

集合的分页列表。

名称	类型	说明
count	integer	项总数。
nextLink	string	下一个结果页的 URL。
value	Collection[]	结果类型的项的集合。

collectionProvisioningState

获取预配的状态。

名称	类型	说明
Creating	string
Deleting	string
Failed	string
Moving	string
Succeeded	string
Unknown	string

CollectionReference

对集合的引用。

名称	类型	说明
referenceName	string	获取或设置引用名称。
type	string	获取或设置引用类型属性。

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

Error

获取或设置错误。

名称	类型	说明
code	string	获取或设置代码。
details	ErrorModel[]	获取或设置详细信息。
message	string	获取或设置消息。
target	string	获取或设置目标。

ErrorModel

默认错误模型

名称	类型	说明
code	string	获取或设置代码。
details	ErrorModel[]	获取或设置详细信息。
message	string	获取或设置消息。
target	string	获取或设置目标。

ErrorResponseModel

默认错误响应模型

名称	类型	说明
error	Error	获取或设置错误。

lastModifiedByType

上次修改资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

SystemData

与资源的创建和上次修改相关的元数据。

名称	类型	说明
createdAt	string	资源创建时间戳 (UTC) 。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识类型。
lastModifiedAt	string	资源上次修改的时间戳 (UTC) 。
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	lastModifiedByType	上次修改资源的标识类型。