Collections - List Collections

Ссылка

Служба:: Purview

Версия API:: 2019-11-01-preview

Перечисляет коллекции в учетной записи.

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

С использованием необязательных параметров:

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

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Collections_ListCollections

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 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

{
  "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	Тип удостоверения, изменяющего ресурс в последний раз.

Поделиться через