你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Collections - Create Or Update Collection

创建或更新集合实体。

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

URI 参数

Name In Required Type Description
collectionName
path True
  • string
endpoint
path True
  • string

Purview 帐户的帐户终结点。 示例:https://{accountName}.purview.azure.com/account/

api-version
query True
  • string

要使用的 API 版本。

请求正文

Name Type Description
description
  • string

获取或设置说明。

friendlyName
  • string

获取或设置集合的友好名称。

parentCollection

获取或设置父集合引用。

响应

Name Type Description
200 OK

Success

Other Status Codes

从提供程序收到的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

Collections_CreateOrUpdateCollection

Sample Request

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

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

Sample Response

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"
}

定义

Collection

集合资源。

Collection.SystemData

与创建和上次修改资源相关的元数据。

collectionProvisioningState

获取预配的状态。

CollectionReference

对集合的引用。

createdByType

创建资源的标识的类型。

Error

获取或设置错误。

ErrorModel

默认错误模型

ErrorResponseModel

默认错误响应模型

lastModifiedByType

上次修改资源的标识的类型。

SystemData

与创建和上次修改资源相关的元数据。

Collection

集合资源。

Name Type Description
collectionProvisioningState

获取预配的状态。

description
  • string

获取或设置说明。

friendlyName
  • string

获取或设置集合的友好名称。

name
  • string

获取名称。

parentCollection

获取或设置父集合引用。

systemData

与创建和上次修改资源相关的元数据。

Collection.SystemData

与创建和上次修改资源相关的元数据。

Name Type Description
createdAt
  • string

资源创建时间戳 (UTC) 。

createdBy
  • string

创建资源的标识。

createdByType

创建资源的标识的类型。

lastModifiedAt
  • string

上次修改资源的时间戳 (UTC) 。

lastModifiedBy
  • string

上次修改资源的标识。

lastModifiedByType

上次修改资源的标识的类型。

collectionProvisioningState

获取预配的状态。

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

CollectionReference

对集合的引用。

Name Type Description
referenceName
  • string

获取或设置引用名称。

type
  • string

获取或设置引用类型属性。

createdByType

创建资源的标识的类型。

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

Error

获取或设置错误。

Name Type Description
code
  • string

获取或设置代码。

details

获取或设置详细信息。

message
  • string

获取或设置消息。

target
  • string

获取或设置目标。

ErrorModel

默认错误模型

Name Type Description
code
  • string

获取或设置代码。

details

获取或设置详细信息。

message
  • string

获取或设置消息。

target
  • string

获取或设置目标。

ErrorResponseModel

默认错误响应模型

Name Type Description
error

获取或设置错误。

lastModifiedByType

上次修改资源的标识的类型。

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

SystemData

与创建和上次修改资源相关的元数据。

Name Type Description
createdAt
  • string

资源创建时间戳 (UTC) 。

createdBy
  • string

创建资源的标识。

createdByType

创建资源的标识的类型。

lastModifiedAt
  • string

上次修改资源的时间戳 (UTC) 。

lastModifiedBy
  • string

上次修改资源的标识。

lastModifiedByType

上次修改资源的标识的类型。