Collections - Create Or Update Collection

參考

服務:: Purview

API 版本:: 2019-11-01-preview

建立或更新集合實體。

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

URI 參數

名稱	位於	必要	類型	Description
collectionName	path	True	string
endpoint	path	True	string	Purview 帳戶的帳戶的帳戶端點。範例：https://{accountName}.purview.azure.com/account/
api-version	query	True	string	要使用的 API 版本。

要求本文

名稱	類型	Description
description	string	取得或設定描述。
friendlyName	string	取得或設定集合的易記名稱。
parentCollection	CollectionReference	取得或設定父集合參考。

回應

名稱	類型	Description
200 OK	Collection	Success
Other Status Codes	ErrorResponseModel	從提供者收到的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Collections_CreateOrUpdateCollection

範例要求

HTTP

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

{
  "parentCollection": {
    "referenceName": "myParentCollection1"
  }
}

範例回覆

狀態碼:: 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": "myParentCollection1"
  },
  "collectionProvisioningState": "Succeeded"
}

定義

名稱	Description
Collection	集合資源。
Collection.SystemData	與建立和上次修改資源相關的元數據。
collectionProvisioningState	取得布建的狀態。
CollectionReference	集合的參考。
createdByType	建立資源的身分識別類型。
Error	取得或設定錯誤。
ErrorModel	默認錯誤模型
ErrorResponseModel	默認錯誤回應模型
lastModifiedByType	上次修改資源的身分識別類型。
SystemData	與建立和上次修改資源相關的元數據。

Collection

集合資源。

名稱	類型	Description
collectionProvisioningState	collectionProvisioningState	取得布建的狀態。
description	string	取得或設定描述。
friendlyName	string	取得或設定集合的易記名稱。
name	string	取得名稱。
parentCollection	CollectionReference	取得或設定父集合參考。
systemData	SystemData	與建立和上次修改資源相關的元數據。

Collection.SystemData

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string	資源建立的時間戳 (UTC) 。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改資源的時間戳 (UTC) 。
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	lastModifiedByType	上次修改資源的身分識別類型。

collectionProvisioningState

取得布建的狀態。

名稱	類型	Description
Creating	string
Deleting	string
Failed	string
Moving	string
Succeeded	string
Unknown	string

CollectionReference

集合的參考。

名稱	類型	Description
referenceName	string	取得或設定參考名稱。
type	string	取得或設定參考型別屬性。

createdByType

建立資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Error

取得或設定錯誤。

名稱	類型	Description
code	string	取得或設定程序代碼。
details	ErrorModel[]	取得或設定詳細數據。
message	string	取得或設定訊息。
target	string	取得或設定目標。

ErrorModel

默認錯誤模型

名稱	類型	Description
code	string	取得或設定程序代碼。
details	ErrorModel[]	取得或設定詳細數據。
message	string	取得或設定訊息。
target	string	取得或設定目標。

ErrorResponseModel

默認錯誤回應模型

名稱	類型	Description
error	Error	取得或設定錯誤。

lastModifiedByType

上次修改資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

SystemData