Collections - Get Collection
取得集合
GET {endpoint}/collections/{collectionName}?api-version=2019-11-01-previewURI 參數
| 名稱 | 位於 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
collection
|
path | True |
string |
|
|
endpoint
|
path | True |
string |
Purview 帳戶的帳戶的帳戶端點。 範例：https://{accountName}.purview.azure.com/account/ |
|
api-version
|
query | True |
string |
要使用的 API 版本。 |
回應
| 名稱 | 類型 | Description |
|---|---|---|
| 200 OK |
成功 |
|
| Other Status Codes |
從提供者收到的錯誤回應。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
| 名稱 | Description |
|---|---|
| user_impersonation | 模擬您的用戶帳戶 |
範例
Collections_GetCollection
範例要求
GET {endpoint}/collections/myCollection1?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{
"name": "mycollection1",
"friendlyName": "Finance",
"parentCollection": {
"type": "CollectionReference",
"referenceName": "accountName"
},
"collectionProvisioningState": "Succeeded"
}定義
| 名稱 | Description |
|---|---|
| Collection |
集合資源。 |
|
collection |
取得布建的狀態。 |
|
Collection |
集合的參考。 |
|
created |
建立資源的身分識別類型。 |
| Error |
取得或設定錯誤。 |
|
Error |
默認錯誤模型 |
|
Error |
默認錯誤回應模型 |
|
last |
上次修改資源的身分識別類型。 |
|
System |
與建立和上次修改資源相關的元數據。 |
Collection
集合資源。
| 名稱 | 類型 | Description |
|---|---|---|
| collectionProvisioningState |
取得布建的狀態。 |
|
| description |
string |
取得或設定描述。 |
| friendlyName |
string |
取得或設定集合的易記名稱。 |
| name |
string |
取得名稱。 |
| parentCollection |
取得或設定父集合參考。 |
|
| systemData |
與建立和上次修改資源相關的元數據。 |
collectionProvisioningState
取得布建的狀態。
| 值 | Description |
|---|---|
| Unknown | |
| Creating | |
| Moving | |
| Deleting | |
| Failed | |
| Succeeded |
CollectionReference
集合的參考。
| 名稱 | 類型 | Description |
|---|---|---|
| referenceName |
string |
取得或設定參考名稱。 |
| type |
string |
取得或設定參考型別屬性。 |
createdByType
建立資源的身分識別類型。
| 值 | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
Error
取得或設定錯誤。
| 名稱 | 類型 | Description |
|---|---|---|
| code |
string |
取得或設定程序代碼。 |
| details |
取得或設定詳細數據。 |
|
| message |
string |
取得或設定訊息。 |
| target |
string |
取得或設定目標。 |
ErrorModel
默認錯誤模型
| 名稱 | 類型 | Description |
|---|---|---|
| code |
string |
取得或設定程序代碼。 |
| details |
取得或設定詳細數據。 |
|
| message |
string |
取得或設定訊息。 |
| target |
string |
取得或設定目標。 |
ErrorResponseModel
默認錯誤回應模型
| 名稱 | 類型 | Description |
|---|---|---|
| error |
取得或設定錯誤。 |
lastModifiedByType
上次修改資源的身分識別類型。
| 值 | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
SystemData
與建立和上次修改資源相關的元數據。
| 名稱 | 類型 | Description |
|---|---|---|
| createdAt |
string (date-time) |
資源建立的時間戳（UTC）。 |
| createdBy |
string |
建立資源的身分識別。 |
| createdByType |
建立資源的身分識別類型。 |
|
| lastModifiedAt |
string (date-time) |
上次修改資源的時間戳（UTC）。 |
| lastModifiedBy |
string |
上次修改資源的身分識別。 |
| lastModifiedByType |
上次修改資源的身分識別類型。 |