Collections - Create Or Update Collection
컬렉션 엔터티를 만들거나 업데이트합니다.
PUT {endpoint}/collections/{collectionName}?api-version=2019-11-01-preview
URI 매개 변수
| Name | In(다음 안에) | 필수 | 형식 | Description |
|---|---|---|---|---|
|
collection
|
path | True |
string |
|
|
endpoint
|
path | True |
string |
Purview 계정의 계정 엔드포인트입니다. 예: https://{accountName}.purview.azure.com/account/ |
|
api-version
|
query | True |
string |
사용할 api 버전입니다. |
요청 본문
| Name | 형식 | Description |
|---|---|---|
| description |
string |
설명을 가져오거나 설정합니다. |
| friendlyName |
string |
컬렉션의 이름을 가져오거나 설정합니다. |
| parentCollection |
부모 컬렉션 참조를 가져오거나 설정합니다. |
응답
| Name | 형식 | Description |
|---|---|---|
| 200 OK |
성공 |
|
| Other Status Codes |
공급자로부터 받은 오류 응답입니다. |
보안
azure_auth
Azure Active Directory OAuth2 흐름.
형식:
oauth2
Flow:
implicit
권한 부여 URL:
https://login.microsoftonline.com/common/oauth2/authorize
범위
| Name | Description |
|---|---|
| user_impersonation | 사용자 계정 가장 |
예제
Collections_CreateOrUpdateCollection
샘플 요청
PUT {endpoint}/collections/myCollection1?api-version=2019-11-01-preview
{
"parentCollection": {
"referenceName": "myParentCollection1"
}
}
샘플 응답
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"
}
정의
| Name | Description |
|---|---|
| Collection |
컬렉션 리소스입니다. |
|
Collection. |
리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다. |
|
collection |
프로비전의 상태를 가져옵니다. |
|
Collection |
컬렉션에 대한 참조입니다. |
|
created |
리소스를 만든 ID의 형식입니다. |
| Error |
오류를 가져오거나 설정합니다. |
|
Error |
기본 오류 모델 |
|
Error |
기본 오류 응답 모델 |
|
last |
리소스를 마지막으로 수정한 ID의 형식입니다. |
|
System |
리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다. |
Collection
컬렉션 리소스입니다.
| Name | 형식 | Description |
|---|---|---|
| collectionProvisioningState |
프로비전의 상태를 가져옵니다. |
|
| description |
string |
설명을 가져오거나 설정합니다. |
| friendlyName |
string |
컬렉션의 이름을 가져오거나 설정합니다. |
| name |
string |
이름을 가져옵니다. |
| parentCollection |
부모 컬렉션 참조를 가져오거나 설정합니다. |
|
| systemData |
리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다. |
Collection.SystemData
리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.
| Name | 형식 | Description |
|---|---|---|
| createdAt |
string (date-time) |
리소스 만들기의 타임스탬프(UTC)입니다. |
| createdBy |
string |
리소스를 만든 ID입니다. |
| createdByType |
리소스를 만든 ID의 형식입니다. |
|
| lastModifiedAt |
string (date-time) |
리소스를 마지막으로 수정한 타임스탬프(UTC)입니다. |
| lastModifiedBy |
string |
리소스를 마지막으로 수정한 ID입니다. |
| lastModifiedByType |
리소스를 마지막으로 수정한 ID의 형식입니다. |
collectionProvisioningState
프로비전의 상태를 가져옵니다.
| 값 | Description |
|---|---|
| Unknown | |
| Creating | |
| Moving | |
| Deleting | |
| Failed | |
| Succeeded |
CollectionReference
컬렉션에 대한 참조입니다.
| Name | 형식 | Description |
|---|---|---|
| referenceName |
string |
참조 이름을 가져오거나 설정합니다. |
| type |
string |
참조 형식 속성을 가져오거나 설정합니다. |
createdByType
리소스를 만든 ID의 형식입니다.
| 값 | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
Error
오류를 가져오거나 설정합니다.
| Name | 형식 | Description |
|---|---|---|
| code |
string |
코드를 가져오거나 설정합니다. |
| details |
세부 정보를 가져오거나 설정합니다. |
|
| message |
string |
메시지를 가져오거나 설정합니다. |
| target |
string |
대상을 가져오거나 설정합니다. |
ErrorModel
기본 오류 모델
| Name | 형식 | Description |
|---|---|---|
| code |
string |
코드를 가져오거나 설정합니다. |
| details |
세부 정보를 가져오거나 설정합니다. |
|
| message |
string |
메시지를 가져오거나 설정합니다. |
| target |
string |
대상을 가져오거나 설정합니다. |
ErrorResponseModel
기본 오류 응답 모델
| Name | 형식 | Description |
|---|---|---|
| error |
오류를 가져오거나 설정합니다. |
lastModifiedByType
리소스를 마지막으로 수정한 ID의 형식입니다.
| 값 | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
SystemData
리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.
| Name | 형식 | Description |
|---|---|---|
| createdAt |
string (date-time) |
리소스 만들기의 타임스탬프(UTC)입니다. |
| createdBy |
string |
리소스를 만든 ID입니다. |
| createdByType |
리소스를 만든 ID의 형식입니다. |
|
| lastModifiedAt |
string (date-time) |
리소스를 마지막으로 수정한 타임스탬프(UTC)입니다. |
| lastModifiedBy |
string |
리소스를 마지막으로 수정한 ID입니다. |
| lastModifiedByType |
리소스를 마지막으로 수정한 ID의 형식입니다. |