Collections - Get Collection

Referensi

Service:: Purview

API Version:: 2019-11-01-preview

Mendapatkan koleksi

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

Parameter URI

Name	In	Required	Type	Description
collectionName	path	True	string
endpoint	path	True	string	Titik akhir akun akun Purview Anda. Contoh: https://{accountName}.purview.azure.com/account/
api-version	query	True	string	Versi api yang akan digunakan.

Respons

Name	Type	Description
200 OK	Collection	Berhasil
Other Status Codes	ErrorResponseModel	Respons kesalahan diterima dari penyedia.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2.

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

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

Collections_GetCollection

Sample Request

HTTP

GET {endpoint}/collections/myCollection1?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

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

Definisi

Collection	Sumber daya koleksi.
collectionProvisioningState	Mendapatkan status provisi.
CollectionReference	Referensi ke Koleksi.
createdByType	Jenis identitas yang membuat sumber daya.
Error	Mendapatkan atau mengatur kesalahan.
ErrorModel	Model kesalahan default
ErrorResponseModel	Model respons kesalahan default
lastModifiedByType	Jenis identitas yang terakhir mengubah sumber daya.
SystemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Collection

Sumber daya koleksi.

Name	Type	Description
collectionProvisioningState	collectionProvisioningState	Mendapatkan status provisi.
description	string	Mendapatkan atau mengatur deskripsi.
friendlyName	string	Mendapatkan atau mengatur nama koleksi yang mudah diingat.
name	string	Mendapatkan nama.
parentCollection	CollectionReference	Mendapatkan atau mengatur referensi koleksi induk.
systemData	SystemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

collectionProvisioningState

Mendapatkan status provisi.

Name	Type	Description
Creating	string
Deleting	string
Failed	string
Moving	string
Succeeded	string
Unknown	string

CollectionReference

Referensi ke Koleksi.

Name	Type	Description
referenceName	string	Mendapatkan atau mengatur nama referensi.
type	string	Mendapatkan atau mengatur properti jenis referensi.

createdByType

Jenis identitas yang membuat sumber daya.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Mendapatkan atau mengatur kesalahan.

Name	Type	Description
code	string	Mendapatkan atau mengatur kode.
details	ErrorModel[]	Mendapatkan atau mengatur detailnya.
message	string	Mendapatkan atau mengatur pesan.
target	string	Mendapatkan atau menetapkan target.

ErrorModel

Model kesalahan default

Name	Type	Description
code	string	Mendapatkan atau mengatur kode.
details	ErrorModel[]	Mendapatkan atau mengatur detailnya.
message	string	Mendapatkan atau mengatur pesan.
target	string	Mendapatkan atau menetapkan target.

ErrorResponseModel

Model respons kesalahan default

Name	Type	Description
error	Error	Mendapatkan atau mengatur kesalahan.

lastModifiedByType

Jenis identitas yang terakhir mengubah sumber daya.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

SystemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Name	Type	Description
createdAt	string	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string	Tanda waktu modifikasi terakhir sumber daya (UTC).
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	lastModifiedByType	Jenis identitas yang terakhir mengubah sumber daya.