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

Collections - Get Collection

  • Ссылка
Служба:
Purview
Версия API:
2019-11-01-preview

Получение коллекции

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

Параметры URI

Имя В Обязательно Тип Описание
collectionName
 path True

string

endpoint
 path True

string

Конечная точка учетной записи Purview. Пример: https://{accountName}.purview.azure.com/account/
api-version
 query True

string

Используемая версия API.

Ответы

Имя Тип Описание
200 OK

Collection

Успех
Other Status Codes

ErrorResponseModel

Ответ об ошибке, полученный от поставщика.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

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

Примеры

Collections_GetCollection

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

GET {endpoint}/collections/myCollection1?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
{
  "name": "mycollection1",
  "friendlyName": "Finance",
  "parentCollection": {
    "type": "CollectionReference",
    "referenceName": "accountName"
  },
  "collectionProvisioningState": "Succeeded"
}

Определения

Имя Описание
Collection

Ресурс коллекции.
collectionProvisioningState

Возвращает состояние подготовки.
CollectionReference

Ссылка на коллекцию.
createdByType

Тип удостоверения, создавшего ресурс.
Error

Возвращает или задает ошибку.
ErrorModel

Модель ошибок по умолчанию
ErrorResponseModel

Модель ответа об ошибках по умолчанию
lastModifiedByType

Тип удостоверения, который последний раз изменил ресурс.
SystemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Collection

Object

Ресурс коллекции.

Имя Тип Описание
collectionProvisioningState

collectionProvisioningState

Возвращает состояние подготовки.
description

string

Возвращает или задает описание.
friendlyName

string

Возвращает или задает понятное имя коллекции.
name

string

Возвращает имя.
parentCollection

CollectionReference

Возвращает или задает ссылку на родительскую коллекцию.
systemData

SystemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

collectionProvisioningState

Перечисление

Возвращает состояние подготовки.

Значение Описание
Creating
Deleting
Failed
Moving
Succeeded
Unknown

CollectionReference

Object

Ссылка на коллекцию.

Имя Тип Описание
referenceName

string

Возвращает или задает имя ссылки.
type

string

Возвращает или задает свойство ссылочного типа.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение Описание
Application
Key
ManagedIdentity
User

Error

Object

Возвращает или задает ошибку.

Имя Тип Описание
code

string

Возвращает или задает код.
details

ErrorModel[]

Возвращает или задает сведения.
message

string

Возвращает или задает сообщения.
target

string

Возвращает или задает целевой объект.

ErrorModel

Object

Модель ошибок по умолчанию

Имя Тип Описание
code

string

Возвращает или задает код.
details

ErrorModel[]

Возвращает или задает сведения.
message

string

Возвращает или задает сообщения.
target

string

Возвращает или задает целевой объект.

ErrorResponseModel

Object

Модель ответа об ошибках по умолчанию

Имя Тип Описание
error

Error

Возвращает или задает ошибку.

lastModifiedByType

Перечисление

Тип удостоверения, который последний раз изменил ресурс.

Значение Описание
Application
Key
ManagedIdentity
User

SystemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя Тип Описание
createdAt

string (date-time)

Метка времени создания ресурса (UTC).
createdBy

string

Удостоверение, создающее ресурс.
createdByType

createdByType

Тип удостоверения, создавшего ресурс.
lastModifiedAt

string (date-time)

Метка времени последнего изменения ресурса (UTC).
lastModifiedBy

string

Идентификатор, который последний раз изменил ресурс.
lastModifiedByType

lastModifiedByType

Тип удостоверения, который последний раз изменил ресурс.