Azure Cosmos DB (애저 코스모스 DB)
Azure Cosmos DB는 포괄적인 SLA를 사용하여 여러 지리적 지역에 걸쳐 처리량 및 스토리지를 탄력적이고 독립적으로 확장할 수 있도록 설계된 전역적으로 분산된 다중 모델 데이터베이스 서비스입니다.
이 커넥터는 다음 제품 및 지역에서 사용할 수 있습니다.
| 서비스 | 클래스 | Regions |
|---|---|---|
| Copilot Studio | Premium | 모든 Power Automate 지역 |
| 논리 앱 | 스탠다드 | 모든 Logic Apps 지역 |
| Power Apps | - | 사용할 수 없음 |
| Power Automate | Premium | 모든 Power Automate 지역 |
| 커넥터 메타데이터 | |
|---|---|
| 게시자 | Microsoft |
이 통합을 사용하려면 Azure Portal에서 구성된 Cosmos DB SQL API 계정이 필요합니다. Mongo DB API 계정은 현재 지원되지 않습니다.
SQL API 계정이 만들어지면 형식의 연결을 Access Key 만드는 경우 Azure Cosmos DB 커넥터와의 연결을 만들 때 계정 ID('documents.azure.com' 제외)를 제공합니다. 이 계정 ID는 Microsoft Entra ID 인증을 지원하는 최신 작업 버전에도 필요합니다.
Microsoft Entra ID 인증 및 Cosmos DB 커넥터
Microsoft Entra ID 인증을 사용하려면 사용 중인 계정에 특정 역할 할당을 할당해야 합니다. 자세한 내용은 Azure Cosmos DB 계정에 대한 Microsoft Entra ID를 사용하여 역할 기반 액세스 제어 구성을 참조하세요.
비고
데이터 액세스에 대해 명시적으로 정의된 역할만 보안 주체가 Cosmos DB 데이터에 액세스할 수 있도록 허용합니다. Microsoft Entra ID를 Owner통해 해당 계정 내의 Cosmos DB 데이터에 대한 액세스를 제공하거나 Contributor 같은 기본 제공 역할을 제공하지 않습니다.
Azure Cosmos DB에서 노출하는 기본 제공 역할은 2개입니다.
-
Cosmos DB Built-in Data Reader(역할 정의 ID00000000-0000-0000-0000-000000000001) -
Cosmos DB Built-in Data Contributor(역할 정의 ID00000000-0000-0000-0000-000000000002)
역할은 다양한 방법으로 할당할 수 있으며 보다 세부적인 액세스를 위해 사용자 지정 역할을 만들 수 있습니다.
다음은 PowerShell을 통해 할당 Cosmos DB Built-in Data Reader 할 사용자에 대한 예제입니다(이 명령 New-AzCosmosDBSqlRoleAssignment에 대한 자세한 내용).
$resourceGroupName = "<myResourceGroup>"
$accountName = "<myCosmosAccount>"
$principalId = "<myPrincipalId>"
$roleDefinitionId = "/subscriptions/<<mySubscription>>/resourceGroups/<<myResourceGroup>>/providers/Microsoft.DocumentDB/databaseAccounts/<<myCosmosAccount>>/sqlRoleDefinitions/00000000-0000-0000-0000-000000000001"
New-AzCosmosDBSqlRoleAssignment -AccountName $accountName `
-ResourceGroupName $resourceGroupName `
-RoleDefinitionId $roleDefinitionId `
-PrincipalId $principalId `
-AssignableScope "/"
이러한 역할 할당을 추가하지 못하면 다음과 같은 권한이 없는 요청이 발생합니다. Request is blocked because principal [<<principal-id>>] does not have the required RBAC permissions to perform action <unauthorized actions>.
비고
Azure Cosmos DB는 Microsoft Entra ID 인증을 사용하는 모든 종류의 관리 작업을 지원하지 않습니다 ( 여기에 설명되어 있음). 다음 작업은 연결에서 Access Key만 작동합니다.
- 저장 프로시저 만들기(V1 및 V2 버전)
- 저장 프로시저 삭제(V1 및 V2 버전)
- 저장 프로시저 업데이트(V1 및 V2 버전)
Microsoft Entra ID 인증에서 지원되지 않는 작업
Microsoft Entra ID 인증을 사용하는 경우 Cosmos DB 계정 이름을 매개 변수로 사용하는 작업만 지원됩니다. 사용되지 않는 작업은 인증에서 Access Key 계속 작동하지만 Microsoft Entra ID 연결과 함께 사용하면 실패합니다.
알려진 문제 및 제한 사항
DocumentDB(Azure Cosmos DB) 커넥터에서 지원하는 문서의 최대 크기는 2MB입니다.
Azure Cosmos DB 제한 사항은 여기에 설명되어 있습니다.
쓰기 지역 및 다중 쓰기 지역 선택도 커넥터에서 지원되지 않습니다.
형식에 따라 "파티션 키 값"을 제공해야 합니다. 예를 들어 문자열 값은 따옴표로 묶어야 하며, 숫자를 있는 그대로 제공해야 합니다. 예: "문자열 값", 123, 0.5.
분할된 컬렉션에서 실행되는 등
DISTINCT과 같은ORDER BY쿼리에는 "파티션 키 값"이 필요합니다.문서 V2 [사용되지 않음], 문서 V3 쿼리, 모든 문서 가져오기 V2(미리 보기) 작업은 SQL API용 Azure Cosmos DB .NET SDK(버전 2.13.1)를 사용합니다.
문서 쿼리 V4(미리 보기) 작업은 SQL API용 Azure Cosmos DB .NET SDK(버전 3.15.0)를 사용합니다.
문서 쿼리(V5)(미리 보기) 작업은 SQL API용 Azure Cosmos DB .NET SDK(버전 3.20.0)를 사용합니다.
"최대 항목 수" 매개 변수 값은 1에서 1000까지의 숫자일 수 있습니다. 이 범위를 벗어난 모든 수는 암시적으로 "-1"로 변환되며, 이는 Cosmos DB 서비스에 최적 항목 수를 결정하도록 지시합니다.
비워 두면 파티션 키 값이 없는 문서에서만 다음 작업이 작동합니다. 파티션 키 값이 있는 항목은 이 작업에서 제외됩니다 .
Azure Cosmos DB가 Microsoft Entra ID 인증을 사용하여 어떤 종류의 관리 작업도 지원하지 않기 때문에(여기에 설명된) 작업 저장 프로시저 실행(V2)(미리 보기)은 기반 연결을 사용할
Access Key때 사용 가능한 저장 프로시저(SprocId매개 변수용)만 표시합니다.Token기반 인증(Microsoft Entra ID 인증)은 빈 목록을 표시하며sprocId사용자 지정 값으로 수동으로 입력해야 합니다.
중요합니다
Microsoft Entra ID 통합(Azure Commercial) 연결은 기본적으로 GCC(미국 정부) 환경에서 사용하지 않도록 설정됩니다. 이러한 유형의 연결을 사용하도록 설정하려면 테넌트 관리자가 Power Platform 관리 센터에서 Azure Commercial에 연결 설정을 사용하도록 설정해야 합니다.
이 설정을 켜면 Power Platform 미국 정부 규정 준수 경계 외부에서 데이터를 작동하고 전송하는 Azure Commercial의 리소스에 연결할 수 있습니다. 이는 특히 GCC 클라우드 버전의 Power Platform Connectors에서 상용 리소스에 대한 액세스를 허용하는 데 사용됩니다.
Microsoft Entra ID 통합(Azure Commercial)은 GCC(미국 정부) 환경에서 Azure 상업용 리소스로 작동하는 유일한 인증 유형입니다.
Azure 상용 인증은 기본적으로 사용하지 않도록 설정됨: 
Power Platform 관리 센터의 Azure Commercial에 연결 설정: 
연결을 만드는 중
커넥터는 다음 인증 유형을 지원합니다.
| 액세스 키 | 계정 이름 및 액세스 키를 제공하여 Cosmos DB 계정에 액세스합니다. | Azure Government 및 GCC(미국 정부) 및 미국 정부(GCC-High)의 Azure Government 및 국방부(DoD)를 제외한 모든 지역 | 공유 가능 |
| 액세스 키(Azure Government) | 계정 이름 및 액세스 키를 제공하여 Cosmos DB 계정에 액세스합니다. | Azure Government 및 GCC(미국 정부) 및 미국 정부(GCC-High)의 Azure 정부 및 국방부(DoD)만 | 공유 가능 |
| Logic Apps 앱 관리 ID | LogicApps 관리 ID를 사용하여 연결 만들기 | LOGICAPPS만 | 공유 가능 |
| Microsoft Entra ID 통합 | Microsoft Entra ID를 사용하여 Azure Blob Storage에 액세스합니다. | Azure Government 및 GCC(미국 정부) 및 미국 정부(GCC-High)의 Azure Government 및 국방부(DoD)를 제외한 모든 지역 | 공유할 수 없음 |
| Microsoft Entra ID 통합(Azure Commercial) | Microsoft Entra ID를 사용하여 Azure Commercial에서 Azure Blob Storage에 액세스합니다. | GCC(미국 정부) | 공유할 수 없음 |
| Microsoft Entra ID 통합(Azure Government) | Microsoft Entra ID를 사용하여 Azure Blob Storage에 액세스합니다. | Azure Government 및 GCC(미국 정부) 및 미국 정부(GCC-High)의 Azure 정부 및 국방부(DoD)만 | 공유할 수 없음 |
| 기본값 [사용되지 않음] | 이 옵션은 명시적 인증 유형이 없는 이전 연결에만 해당되며 이전 버전과의 호환성을 위해서만 제공됩니다. | 모든 지역 | 공유할 수 없음 |
액세스 키
인증 ID: keyBasedAuth
적용 가능: Azure Government 및 GCC(미국 정부) 및 미국 정부(GCC-High)의 Azure Government 및 국방부(DoD)를 제외한 모든 지역
계정 이름 및 액세스 키를 제공하여 Cosmos DB 계정에 액세스합니다.
공유 가능한 연결입니다. 전원 앱이 다른 사용자와 공유되면 연결도 공유됩니다. 자세한 내용은 캔버스 앱에 대한 커넥터 개요를 참조하세요. - Power Apps | Microsoft Docs
| 이름 | 유형 | Description | 필수 |
|---|---|---|---|
| 계정 ID | 문자열 | 'documents.azure.com' 부분이 없는 계정의 이름 | 진실 |
| Azure Cosmos DB 계정에 대한 액세스 키 | 시큐어스트링 (보안 문자열) | 기본 또는 보조 키 | 진실 |
액세스 키(Azure Government)
인증 ID: keyBasedAuth
적용 가능: Azure Government 및 GCC(미국 정부) 및 미국 정부(GCC-High)의 Azure Government 및 국방부(DoD)
계정 이름 및 액세스 키를 제공하여 Cosmos DB 계정에 액세스합니다.
공유 가능한 연결입니다. 전원 앱이 다른 사용자와 공유되면 연결도 공유됩니다. 자세한 내용은 캔버스 앱에 대한 커넥터 개요를 참조하세요. - Power Apps | Microsoft Docs
| 이름 | 유형 | Description | 필수 |
|---|---|---|---|
| 계정 ID | 문자열 | 'documents.azure.com' 부분이 없는 계정의 이름 | 진실 |
| Azure Cosmos DB 계정에 대한 액세스 키 | 시큐어스트링 (보안 문자열) | 기본 또는 보조 키 | 진실 |
Logic Apps 관리 ID
인증 ID: managedIdentityAuth
적용 가능: LOGICAPPS만 해당
LogicApps 관리 ID를 사용하여 연결 만들기
공유 가능한 연결입니다. 전원 앱이 다른 사용자와 공유되면 연결도 공유됩니다. 자세한 내용은 캔버스 앱에 대한 커넥터 개요를 참조하세요. - Power Apps | Microsoft Docs
| 이름 | 유형 | Description | 필수 |
|---|---|---|---|
| LogicApps 관리 ID | 관리되는 ID | Logic Apps 관리 ID로 로그인 | 진실 |
Microsoft Entra ID 통합
인증 ID: tokenBasedAuth
적용 가능: Azure Government 및 GCC(미국 정부) 및 미국 정부(GCC-High)의 Azure Government 및 국방부(DoD)를 제외한 모든 지역
Microsoft Entra ID를 사용하여 Azure Blob Storage에 액세스합니다.
공유 가능한 연결이 아닙니다. 전원 앱이 다른 사용자와 공유되면 다른 사용자에게 새 연결을 명시적으로 만들라는 메시지가 표시됩니다.
Microsoft Entra ID 통합(Azure Commercial)
인증 ID: oauthCom
적용 가능: GCC(미국 정부) 전용
Microsoft Entra ID를 사용하여 Azure Commercial에서 Azure Blob Storage에 액세스합니다.
공유 가능한 연결이 아닙니다. 전원 앱이 다른 사용자와 공유되면 다른 사용자에게 새 연결을 명시적으로 만들라는 메시지가 표시됩니다.
Microsoft Entra ID 통합(Azure Government)
인증 ID: tokenBasedAuth
적용 가능: Azure Government 및 GCC(미국 정부) 및 미국 정부(GCC-High)의 Azure Government 및 국방부(DoD)
Microsoft Entra ID를 사용하여 Azure Blob Storage에 액세스합니다.
공유 가능한 연결이 아닙니다. 전원 앱이 다른 사용자와 공유되면 다른 사용자에게 새 연결을 명시적으로 만들라는 메시지가 표시됩니다.
기본값 [사용되지 않음]
적용 가능: 모든 지역
이 옵션은 명시적 인증 유형이 없는 이전 연결에만 해당되며 이전 버전과의 호환성을 위해서만 제공됩니다.
공유 가능한 연결이 아닙니다. 전원 앱이 다른 사용자와 공유되면 다른 사용자에게 새 연결을 명시적으로 만들라는 메시지가 표시됩니다.
| 이름 | 유형 | Description | 필수 |
|---|---|---|---|
| 계정 ID | 문자열 | 'documents.azure.com' 부분이 없는 계정의 이름 | 진실 |
| Azure Cosmos DB 계정에 대한 액세스 키 | 시큐어스트링 (보안 문자열) | 기본 또는 보조 키 | 진실 |
제한 한도
| Name | 호출 | 갱신 기간 |
|---|---|---|
| 연결당 API 호출 | 1500 | 60초 |
동작
| 모든 문서 가져오기(V3) |
모든 문서 가져오기(V3). |
| 모든 문서 가져오기 [사용되지 않음] |
이 작업은 더 이상 사용되지 않습니다. 대신 모든 문서 가져오기(V3) 를 사용하세요.
|
| 모든 문서 가져오기 V2 [사용되지 않음] |
이 작업은 더 이상 사용되지 않습니다. 대신 모든 문서 가져오기(V3) 를 사용하세요.
|
| 문서 가져오기(V2) |
문서 가져오기(V2). |
| 문서 가져오기 [사용되지 않음] |
이 작업은 더 이상 사용되지 않습니다. 대신 문서 가져오기(V2)를 사용하세요.
|
| 문서 만들기 또는 업데이트(V2) [사용되지 않음] |
이 작업은 더 이상 사용되지 않습니다. 대신 문서 만들기 또는 업데이트(V3) 를 사용하세요.
|
| 문서 만들기 또는 업데이트(V3) |
문서를 만들거나 업데이트합니다. DocumentDB에서 문서를 만들 때 본문에는 ID 속성이 포함되어야 합니다. |
| 문서 만들기 또는 업데이트 [사용되지 않음] |
이 작업은 더 이상 사용되지 않습니다. 대신 문서 만들기 또는 업데이트(V3) 를 사용하세요.
|
| 문서 바꾸기(V2) |
문서(V2)를 바꿉니다. |
| 문서 바꾸기 [사용되지 않음] |
이 작업은 더 이상 사용되지 않습니다. 대신 문서 바꾸기(V2)를 사용하세요.
|
| 문서 삭제(V2) |
문서(V2)를 삭제합니다. |
| 문서 삭제 [사용되지 않음] |
이 작업은 더 이상 사용되지 않습니다. 대신 문서 삭제(V2) 를 사용하세요.
|
| 문서 쿼리 [사용되지 않음] |
이 작업은 더 이상 사용되지 않습니다. 대신 쿼리 문서 V5 를 사용하세요.
|
| 문서 쿼리 V2 [사용되지 않음] |
이 작업은 더 이상 사용되지 않습니다. 대신 쿼리 문서 V5 를 사용하세요.
|
| 문서 쿼리 V3 [사용되지 않음] |
이 작업은 더 이상 사용되지 않습니다. 대신 쿼리 문서 V5 를 사용하세요.
|
| 문서 쿼리 V4 [사용되지 않음] |
이 작업은 더 이상 사용되지 않습니다. 대신 쿼리 문서 V5 를 사용하세요.
|
| 문서 쿼리 V5 |
문서 쿼리(V5). |
| 저장 프로시저 가져오기(V2) |
지정된 컬렉션(V2)에서 저장 프로시저를 가져옵니다. |
| 저장 프로시저 가져오기 [사용되지 않음] |
이 작업은 더 이상 사용되지 않습니다. 대신 저장 프로시저 가져오기(V2) 를 사용하세요.
|
| 저장 프로시저 만들기(V2) |
저장 프로시저(V2)를 만듭니다. |
| 저장 프로시저 만들기 [사용되지 않음] |
이 작업은 더 이상 사용되지 않습니다. 대신 저장 프로시저 만들기(V2) 를 사용하세요.
|
| 저장 프로시저 바꾸기(V2) |
저장 프로시저(V2)를 바꿉니다. |
| 저장 프로시저 바꾸기 [사용되지 않음] |
이 작업은 더 이상 사용되지 않습니다. 저장 프로시저 바꾸기(V2) 를 대신 사용하세요.
|
| 저장 프로시저 삭제(V2) |
저장 프로시저(V2)를 삭제합니다. |
| 저장 프로시저 삭제 [사용되지 않음] |
이 작업은 더 이상 사용되지 않습니다. 저장 프로시저 삭제(V2) 를 대신 사용하세요.
|
| 저장 프로시저 실행(V2) |
지정된 컬렉션(V2)에서 저장 프로시저를 실행합니다. |
| 저장 프로시저 실행 [사용되지 않음] |
이 작업은 더 이상 사용되지 않습니다. 저장 프로시저 실행(V2) 을 대신 사용하세요.
|
모든 문서 가져오기(V3)
모든 문서 가져오기(V3).
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
파티션 키 값
|
x-ms-documentdb-raw-partitionkey | string |
요청된 문서 또는 첨부 파일 작업에 대한 파티션 키 값입니다. |
|
|
최대 항목 수
|
x-ms-max-item-count | number |
페이지당 반환할 최대 항목 수를 나타내는 정수입니다. |
|
|
연속 토큰
|
x-ms-continuation | string |
읽을 결과가 더 있는 경우 쿼리 및 읽기 피드 작업에 대해 반환되는 문자열 토큰입니다. |
|
|
일관성 수준
|
x-ms-consistency-level | string |
일관성 수준 재정의입니다. 유효한 값은 Strong, Bounded, Session 또는 Eventual입니다(가장 강한 값에서 가장 약한 순서로). |
|
|
세션 토큰
|
x-ms-session-token | string |
세션 수준 일관성에 사용되는 문자열 토큰입니다. |
|
|
활동 ID
|
x-ms-activity-id | string |
서버 응답에 에코되는 작업에 대한 클라이언트 제공 식별자입니다. |
|
|
Azure Cosmos DB 계정 이름
|
cosmosDbAccountName | True | string |
Azure Cosmos DB 계정 이름(documents.azure.com 제외)입니다. |
|
데이터베이스 ID
|
databaseId | True | string |
데이터베이스의 이름입니다. |
|
컬렉션 ID
|
collectionId | True | string |
컬렉션의 이름입니다. |
|
API 버전
|
x-ms-version | string |
API 버전. |
반환
모든 문서 가져오기 [사용되지 않음]
이 작업은 더 이상 사용되지 않습니다. 대신 모든 문서 가져오기(V3) 를 사용하세요.
모든 문서를 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
파티션 키 값
|
x-ms-documentdb-raw-partitionkey | string |
요청된 문서 또는 첨부 파일 작업에 대한 파티션 키 값입니다. |
|
|
최대 항목 수
|
x-ms-max-item-count | number |
페이지당 반환할 최대 항목 수를 나타내는 정수입니다. |
|
|
연속 토큰
|
x-ms-continuation | string |
읽을 결과가 더 있는 경우 쿼리 및 읽기 피드 작업에 대해 반환되는 문자열 토큰입니다. |
|
|
일관성 수준
|
x-ms-consistency-level | string |
일관성 수준 재정의입니다. 유효한 값은 Strong, Bounded, Session 또는 Eventual입니다(가장 강한 값에서 가장 약한 순서로). |
|
|
세션 토큰
|
x-ms-session-token | string |
세션 수준 일관성에 사용되는 문자열 토큰입니다. |
|
|
활동 ID
|
x-ms-activity-id | string |
서버 응답에 에코되는 작업에 대한 클라이언트 제공 식별자입니다. |
|
|
데이터베이스 ID
|
databaseId | True | string |
데이터베이스의 이름입니다. |
|
컬렉션 ID
|
collectionId | True | string |
컬렉션의 이름입니다. |
|
API 버전
|
x-ms-version | string |
API 버전. |
반환
모든 문서 가져오기 V2 [사용되지 않음]
이 작업은 더 이상 사용되지 않습니다. 대신 모든 문서 가져오기(V3) 를 사용하세요.
모든 문서 V2를 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
데이터베이스 ID
|
databaseId | True | string |
데이터베이스의 이름입니다. |
|
컬렉션 ID
|
collectionId | True | string |
컬렉션의 이름입니다. |
|
파티션 키 값
|
partitionKey | string |
비어 있으면 모든 파티션이 문서를 검색하는 데 사용됩니다. |
|
|
최대 항목 수
|
maxItemCount | integer |
페이지당 반환할 최대 항목 수를 나타내는 정수입니다. |
|
|
연속 토큰
|
continuationToken | string |
추가 결과를 가져오는 토큰입니다. |
|
|
일관성 수준
|
consistencyLevel | string |
피드(쿼리/읽기 피드) 작업에 필요한 일관성 수준입니다. |
|
|
세션 토큰
|
sessionToken | string |
세션 일관성에 사용할 세션 토큰입니다. |
반환
요청된 쿼리 및 관련 메타데이터와 일치하는 문서 배열입니다.
문서 가져오기(V2)
문서 가져오기(V2).
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
파티션 키 값
|
x-ms-documentdb-raw-partitionkey | string |
요청된 문서 또는 첨부 파일 작업에 대한 파티션 키 값입니다. |
|
|
최대 항목 수
|
x-ms-max-item-count | number |
페이지당 반환할 최대 항목 수를 나타내는 정수입니다. |
|
|
연속 토큰
|
x-ms-continuation | string |
읽을 결과가 더 있는 경우 쿼리 및 읽기 피드 작업에 대해 반환되는 문자열 토큰입니다. |
|
|
일관성 수준
|
x-ms-consistency-level | string |
일관성 수준 재정의입니다. 유효한 값은 Strong, Bounded, Session 또는 Eventual입니다(가장 강한 값에서 가장 약한 순서로). |
|
|
세션 토큰
|
x-ms-session-token | string |
세션 수준 일관성에 사용되는 문자열 토큰입니다. |
|
|
활동 ID
|
x-ms-activity-id | string |
서버 응답에 에코되는 작업에 대한 클라이언트 제공 식별자입니다. |
|
|
Azure Cosmos DB 계정 이름
|
cosmosDbAccountName | True | string |
Azure Cosmos DB 계정 이름(documents.azure.com 제외)입니다. |
|
데이터베이스 ID
|
databaseId | True | string |
데이터베이스의 이름입니다. |
|
컬렉션 ID
|
collectionId | True | string |
컬렉션의 이름입니다. |
|
문서 ID
|
documentId | True | string |
문서의 식별자입니다. |
|
API 버전
|
x-ms-version | string |
API 버전. |
반환
- response
- object
문서 가져오기 [사용되지 않음]
이 작업은 더 이상 사용되지 않습니다. 대신 문서 가져오기(V2)를 사용하세요.
문서를 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
파티션 키 값
|
x-ms-documentdb-raw-partitionkey | string |
요청된 문서 또는 첨부 파일 작업에 대한 파티션 키 값입니다. |
|
|
최대 항목 수
|
x-ms-max-item-count | number |
페이지당 반환할 최대 항목 수를 나타내는 정수입니다. |
|
|
연속 토큰
|
x-ms-continuation | string |
읽을 결과가 더 있는 경우 쿼리 및 읽기 피드 작업에 대해 반환되는 문자열 토큰입니다. |
|
|
일관성 수준
|
x-ms-consistency-level | string |
일관성 수준 재정의입니다. 유효한 값은 Strong, Bounded, Session 또는 Eventual입니다(가장 강한 값에서 가장 약한 순서로). |
|
|
세션 토큰
|
x-ms-session-token | string |
세션 수준 일관성에 사용되는 문자열 토큰입니다. |
|
|
활동 ID
|
x-ms-activity-id | string |
서버 응답에 에코되는 작업에 대한 클라이언트 제공 식별자입니다. |
|
|
데이터베이스 ID
|
databaseId | True | string |
데이터베이스의 이름입니다. |
|
컬렉션 ID
|
collectionId | True | string |
컬렉션의 이름입니다. |
|
문서 ID
|
documentId | True | string |
문서의 식별자입니다. |
|
API 버전
|
x-ms-version | string |
API 버전. |
반환
- response
- object
문서 만들기 또는 업데이트(V2) [사용되지 않음]
이 작업은 더 이상 사용되지 않습니다. 대신 문서 만들기 또는 업데이트(V3) 를 사용하세요.
문서를 만들거나 업데이트합니다. DocumentDB에서 문서를 만들 때 본문에는 ID 속성이 포함되어야 합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
최대 항목 수
|
x-ms-max-item-count | number |
페이지당 반환할 최대 항목 수를 나타내는 정수입니다. |
|
|
연속 토큰
|
x-ms-continuation | string |
읽을 결과가 더 있는 경우 쿼리 및 읽기 피드 작업에 대해 반환되는 문자열 토큰입니다. |
|
|
일관성 수준
|
x-ms-consistency-level | string |
일관성 수준 재정의입니다. 유효한 값은 Strong, Bounded, Session 또는 Eventual입니다(가장 강한 값에서 가장 약한 순서로). |
|
|
세션 토큰
|
x-ms-session-token | string |
세션 수준 일관성에 사용되는 문자열 토큰입니다. |
|
|
활동 ID
|
x-ms-activity-id | string |
서버 응답에 에코되는 작업에 대한 클라이언트 제공 식별자입니다. |
|
|
IsUpsert
|
x-ms-documentdb-is-upsert | boolean |
true로 설정하면 문서가 다른 문서로 만들어지면 바뀝니다. |
|
|
사전 트리거
|
x-ms-documentdb-pre-trigger-include | string |
문서 작업이 실행되기 전에 실행할 트리거 이름의 쉼표로 구분된 목록입니다. |
|
|
사후 트리거
|
x-ms-documentdb-post-trigger-include | string |
문서 작업이 실행된 후 실행할 트리거 이름의 쉼표로 구분된 목록입니다. |
|
|
데이터베이스 ID
|
databaseId | True | string |
데이터베이스의 이름입니다. |
|
컬렉션 ID
|
collectionId | True | string |
컬렉션의 이름입니다. |
|
API 버전
|
x-ms-version | string |
API 버전. |
반환
문서 만들기 또는 업데이트(V3)
문서를 만들거나 업데이트합니다. DocumentDB에서 문서를 만들 때 본문에는 ID 속성이 포함되어야 합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
최대 항목 수
|
x-ms-max-item-count | number |
페이지당 반환할 최대 항목 수를 나타내는 정수입니다. |
|
|
연속 토큰
|
x-ms-continuation | string |
읽을 결과가 더 있는 경우 쿼리 및 읽기 피드 작업에 대해 반환되는 문자열 토큰입니다. |
|
|
일관성 수준
|
x-ms-consistency-level | string |
일관성 수준 재정의입니다. 유효한 값은 Strong, Bounded, Session 또는 Eventual입니다(가장 강한 값에서 가장 약한 순서로). |
|
|
세션 토큰
|
x-ms-session-token | string |
세션 수준 일관성에 사용되는 문자열 토큰입니다. |
|
|
활동 ID
|
x-ms-activity-id | string |
서버 응답에 에코되는 작업에 대한 클라이언트 제공 식별자입니다. |
|
|
IsUpsert
|
x-ms-documentdb-is-upsert | boolean |
true로 설정하면 문서가 다른 문서로 만들어지면 바뀝니다. |
|
|
사전 트리거
|
x-ms-documentdb-pre-trigger-include | string |
문서 작업이 실행되기 전에 실행할 트리거 이름의 쉼표로 구분된 목록입니다. |
|
|
사후 트리거
|
x-ms-documentdb-post-trigger-include | string |
문서 작업이 실행된 후 실행할 트리거 이름의 쉼표로 구분된 목록입니다. |
|
|
Azure Cosmos DB 계정 이름
|
cosmosDbAccountName | True | string |
Azure Cosmos DB 계정 이름(documents.azure.com 제외)입니다. |
|
데이터베이스 ID
|
databaseId | True | string |
데이터베이스의 이름입니다. |
|
컬렉션 ID
|
collectionId | True | string |
컬렉션의 이름입니다. |
|
API 버전
|
x-ms-version | string |
API 버전. |
반환
문서 만들기 또는 업데이트 [사용되지 않음]
이 작업은 더 이상 사용되지 않습니다. 대신 문서 만들기 또는 업데이트(V3) 를 사용하세요.
문서를 만들거나 업데이트합니다. DocumentDB에서 문서를 만들 때 본문에는 ID 속성이 포함되어야 합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
파티션 키 값
|
x-ms-documentdb-raw-partitionkey | string |
요청된 문서 또는 첨부 파일 작업에 대한 파티션 키 값입니다. |
|
|
최대 항목 수
|
x-ms-max-item-count | number |
페이지당 반환할 최대 항목 수를 나타내는 정수입니다. |
|
|
연속 토큰
|
x-ms-continuation | string |
읽을 결과가 더 있는 경우 쿼리 및 읽기 피드 작업에 대해 반환되는 문자열 토큰입니다. |
|
|
일관성 수준
|
x-ms-consistency-level | string |
일관성 수준 재정의입니다. 유효한 값은 Strong, Bounded, Session 또는 Eventual입니다(가장 강한 값에서 가장 약한 순서로). |
|
|
세션 토큰
|
x-ms-session-token | string |
세션 수준 일관성에 사용되는 문자열 토큰입니다. |
|
|
활동 ID
|
x-ms-activity-id | string |
서버 응답에 에코되는 작업에 대한 클라이언트 제공 식별자입니다. |
|
|
IsUpsert
|
x-ms-documentdb-is-upsert | boolean |
true로 설정하면 문서가 다른 문서로 만들어지면 바뀝니다. |
|
|
사전 트리거
|
x-ms-documentdb-pre-trigger-include | string |
문서 작업이 실행되기 전에 실행할 트리거 이름의 쉼표로 구분된 목록입니다. |
|
|
사후 트리거
|
x-ms-documentdb-post-trigger-include | string |
문서 작업이 실행된 후 실행할 트리거 이름의 쉼표로 구분된 목록입니다. |
|
|
데이터베이스 ID
|
databaseId | True | string |
데이터베이스의 이름입니다. |
|
컬렉션 ID
|
collectionId | True | string |
컬렉션의 이름입니다. |
|
API 버전
|
x-ms-version | string |
API 버전. |
반환
문서 바꾸기(V2)
문서(V2)를 바꿉니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
파티션 키 값
|
x-ms-documentdb-raw-partitionkey | string |
요청된 문서 또는 첨부 파일 작업에 대한 파티션 키 값입니다. |
|
|
최대 항목 수
|
x-ms-max-item-count | number |
페이지당 반환할 최대 항목 수를 나타내는 정수입니다. |
|
|
연속 토큰
|
x-ms-continuation | string |
읽을 결과가 더 있는 경우 쿼리 및 읽기 피드 작업에 대해 반환되는 문자열 토큰입니다. |
|
|
일관성 수준
|
x-ms-consistency-level | string |
일관성 수준 재정의입니다. 유효한 값은 Strong, Bounded, Session 또는 Eventual입니다(가장 강한 값에서 가장 약한 순서로). |
|
|
세션 토큰
|
x-ms-session-token | string |
세션 수준 일관성에 사용되는 문자열 토큰입니다. |
|
|
활동 ID
|
x-ms-activity-id | string |
서버 응답에 에코되는 작업에 대한 클라이언트 제공 식별자입니다. |
|
|
사전 트리거
|
x-ms-documentdb-pre-trigger-include | string |
문서 작업이 실행되기 전에 실행할 트리거 이름의 쉼표로 구분된 목록입니다. |
|
|
사후 트리거
|
x-ms-documentdb-post-trigger-include | string |
문서 작업이 실행된 후 실행할 트리거 이름의 쉼표로 구분된 목록입니다. |
|
|
Azure Cosmos DB 계정 이름
|
cosmosDbAccountName | True | string |
Azure Cosmos DB 계정 이름(documents.azure.com 제외)입니다. |
|
데이터베이스 ID
|
databaseId | True | string |
데이터베이스의 이름입니다. |
|
컬렉션 ID
|
collectionId | True | string |
컬렉션의 이름입니다. |
|
문서 ID
|
documentId | True | string |
문서의 식별자입니다. |
|
API 버전
|
x-ms-version | string |
API 버전. |
반환
문서 바꾸기 [사용되지 않음]
이 작업은 더 이상 사용되지 않습니다. 대신 문서 바꾸기(V2)를 사용하세요.
문서를 대체합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
파티션 키 값
|
x-ms-documentdb-raw-partitionkey | string |
요청된 문서 또는 첨부 파일 작업에 대한 파티션 키 값입니다. |
|
|
최대 항목 수
|
x-ms-max-item-count | number |
페이지당 반환할 최대 항목 수를 나타내는 정수입니다. |
|
|
연속 토큰
|
x-ms-continuation | string |
읽을 결과가 더 있는 경우 쿼리 및 읽기 피드 작업에 대해 반환되는 문자열 토큰입니다. |
|
|
일관성 수준
|
x-ms-consistency-level | string |
일관성 수준 재정의입니다. 유효한 값은 Strong, Bounded, Session 또는 Eventual입니다(가장 강한 값에서 가장 약한 순서로). |
|
|
세션 토큰
|
x-ms-session-token | string |
세션 수준 일관성에 사용되는 문자열 토큰입니다. |
|
|
활동 ID
|
x-ms-activity-id | string |
서버 응답에 에코되는 작업에 대한 클라이언트 제공 식별자입니다. |
|
|
사전 트리거
|
x-ms-documentdb-pre-trigger-include | string |
문서 작업이 실행되기 전에 실행할 트리거 이름의 쉼표로 구분된 목록입니다. |
|
|
사후 트리거
|
x-ms-documentdb-post-trigger-include | string |
문서 작업이 실행된 후 실행할 트리거 이름의 쉼표로 구분된 목록입니다. |
|
|
데이터베이스 ID
|
databaseId | True | string |
데이터베이스의 이름입니다. |
|
컬렉션 ID
|
collectionId | True | string |
컬렉션의 이름입니다. |
|
문서 ID
|
documentId | True | string |
문서의 식별자입니다. |
|
API 버전
|
x-ms-version | string |
API 버전. |
반환
문서 삭제(V2)
문서(V2)를 삭제합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
파티션 키 값
|
x-ms-documentdb-raw-partitionkey | string |
요청된 문서 또는 첨부 파일 작업에 대한 파티션 키 값입니다. |
|
|
최대 항목 수
|
x-ms-max-item-count | number |
페이지당 반환할 최대 항목 수를 나타내는 정수입니다. |
|
|
연속 토큰
|
x-ms-continuation | string |
읽을 결과가 더 있는 경우 쿼리 및 읽기 피드 작업에 대해 반환되는 문자열 토큰입니다. |
|
|
일관성 수준
|
x-ms-consistency-level | string |
일관성 수준 재정의입니다. 유효한 값은 Strong, Bounded, Session 또는 Eventual입니다(가장 강한 값에서 가장 약한 순서로). |
|
|
세션 토큰
|
x-ms-session-token | string |
세션 수준 일관성에 사용되는 문자열 토큰입니다. |
|
|
활동 ID
|
x-ms-activity-id | string |
서버 응답에 에코되는 작업에 대한 클라이언트 제공 식별자입니다. |
|
|
사전 트리거
|
x-ms-documentdb-pre-trigger-include | string |
문서 작업이 실행되기 전에 실행할 트리거 이름의 쉼표로 구분된 목록입니다. |
|
|
사후 트리거
|
x-ms-documentdb-post-trigger-include | string |
문서 작업이 실행된 후 실행할 트리거 이름의 쉼표로 구분된 목록입니다. |
|
|
Azure Cosmos DB 계정 이름
|
cosmosDbAccountName | True | string |
Azure Cosmos DB 계정 이름(documents.azure.com 제외)입니다. |
|
데이터베이스 ID
|
databaseId | True | string |
데이터베이스의 이름입니다. |
|
컬렉션 ID
|
collectionId | True | string |
컬렉션의 이름입니다. |
|
문서 ID
|
documentId | True | string |
문서의 식별자입니다. |
|
API 버전
|
x-ms-version | string |
API 버전. |
문서 삭제 [사용되지 않음]
이 작업은 더 이상 사용되지 않습니다. 대신 문서 삭제(V2) 를 사용하세요.
문서를 삭제합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
파티션 키 값
|
x-ms-documentdb-raw-partitionkey | string |
요청된 문서 또는 첨부 파일 작업에 대한 파티션 키 값입니다. |
|
|
최대 항목 수
|
x-ms-max-item-count | number |
페이지당 반환할 최대 항목 수를 나타내는 정수입니다. |
|
|
연속 토큰
|
x-ms-continuation | string |
읽을 결과가 더 있는 경우 쿼리 및 읽기 피드 작업에 대해 반환되는 문자열 토큰입니다. |
|
|
일관성 수준
|
x-ms-consistency-level | string |
일관성 수준 재정의입니다. 유효한 값은 Strong, Bounded, Session 또는 Eventual입니다(가장 강한 값에서 가장 약한 순서로). |
|
|
세션 토큰
|
x-ms-session-token | string |
세션 수준 일관성에 사용되는 문자열 토큰입니다. |
|
|
활동 ID
|
x-ms-activity-id | string |
서버 응답에 에코되는 작업에 대한 클라이언트 제공 식별자입니다. |
|
|
사전 트리거
|
x-ms-documentdb-pre-trigger-include | string |
문서 작업이 실행되기 전에 실행할 트리거 이름의 쉼표로 구분된 목록입니다. |
|
|
사후 트리거
|
x-ms-documentdb-post-trigger-include | string |
문서 작업이 실행된 후 실행할 트리거 이름의 쉼표로 구분된 목록입니다. |
|
|
데이터베이스 ID
|
databaseId | True | string |
데이터베이스의 이름입니다. |
|
컬렉션 ID
|
collectionId | True | string |
컬렉션의 이름입니다. |
|
문서 ID
|
documentId | True | string |
문서의 식별자입니다. |
|
API 버전
|
x-ms-version | string |
API 버전. |
문서 쿼리 [사용되지 않음]
이 작업은 더 이상 사용되지 않습니다. 대신 쿼리 문서 V5 를 사용하세요.
문서를 쿼리합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
파티션 키 값
|
x-ms-documentdb-raw-partitionkey | string |
요청된 문서 또는 첨부 파일 작업에 대한 파티션 키 값입니다. |
|
|
최대 항목 수
|
x-ms-max-item-count | number |
페이지당 반환할 최대 항목 수를 나타내는 정수입니다. |
|
|
연속 토큰
|
x-ms-continuation | string |
읽을 결과가 더 있는 경우 쿼리 및 읽기 피드 작업에 대해 반환되는 문자열 토큰입니다. |
|
|
파티션 간 사용
|
x-ms-documentdb-query-enablecrosspartition | boolean |
컬렉션이 분할된 경우 여러 파티션에서 실행을 허용하려면 True로 설정해야 합니다. |
|
|
일관성 수준
|
x-ms-consistency-level | string |
일관성 수준 재정의입니다. 유효한 값은 Strong, Bounded, Session 또는 Eventual입니다(가장 강한 값에서 가장 약한 순서로). |
|
|
세션 토큰
|
x-ms-session-token | string |
세션 수준 일관성에 사용되는 문자열 토큰입니다. |
|
|
활동 ID
|
x-ms-activity-id | string |
서버 응답에 에코되는 작업에 대한 클라이언트 제공 식별자입니다. |
|
|
데이터베이스 ID
|
databaseId | True | string |
데이터베이스의 이름입니다. |
|
컬렉션 ID
|
collectionId | True | string |
컬렉션의 이름입니다. |
|
query
|
query | string |
반환
문서 쿼리 V2 [사용되지 않음]
이 작업은 더 이상 사용되지 않습니다. 대신 쿼리 문서 V5 를 사용하세요.
문서 V2를 쿼리합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
데이터베이스 ID
|
databaseId | True | string |
데이터베이스의 이름입니다. |
|
컬렉션 ID
|
collectionId | True | string |
컬렉션의 이름입니다. |
|
쿼리텍스트
|
QueryText | string |
문서에 대한 SQL 구문 쿼리 |
|
|
파티션 키 값
|
partitionKey | string |
파티션 키 값입니다. |
|
|
연속 토큰
|
continuationToken | string |
작업에서 추가 결과를 가져오는 토큰입니다. |
반환
요청된 쿼리 및 관련 메타데이터와 일치하는 문서 배열입니다.
문서 쿼리 V3 [사용되지 않음]
이 작업은 더 이상 사용되지 않습니다. 대신 쿼리 문서 V5 를 사용하세요.
문서 V3를 쿼리합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
데이터베이스 ID
|
databaseId | True | string |
데이터베이스의 이름입니다. |
|
컬렉션 ID
|
collectionId | True | string |
컬렉션의 이름입니다. |
|
SQL 구문 쿼리
|
queryText | True | string |
SQL 쿼리. |
|
파티션 키 값
|
partitionKey | string |
비어 있으면 모든 파티션이 문서를 검색하는 데 사용됩니다. |
|
|
최대 항목 수
|
maxItemCount | integer |
페이지당 반환할 최대 항목 수를 나타내는 정수입니다. |
|
|
연속 토큰
|
continuationToken | string |
추가 결과를 가져오는 토큰입니다. |
|
|
파티션 간 사용
|
enableCrossPartition | boolean |
사용자가 쿼리를 실행하기 위해 둘 이상의 요청을 보낼 수 있는지 여부를 나타냅니다. |
|
|
일관성 수준
|
consistencyLevel | string |
피드(쿼리/읽기 피드) 작업에 필요한 일관성 수준입니다. |
|
|
세션 토큰
|
sessionToken | string |
세션 일관성에 사용할 세션 토큰입니다. |
반환
요청된 쿼리 및 관련 메타데이터와 일치하는 문서 배열입니다.
문서 쿼리 V4 [사용되지 않음]
이 작업은 더 이상 사용되지 않습니다. 대신 쿼리 문서 V5 를 사용하세요.
문서 V4를 쿼리합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
데이터베이스 ID
|
databaseId | True | string |
데이터베이스의 이름입니다. |
|
컨테이너 ID
|
containerId | True | string |
컨테이너의 이름입니다. |
|
SQL 구문 쿼리
|
queryText | string |
SQL 쿼리. 비어 있는 경우 모든 문서를 반환합니다. |
|
|
파티션 키 값
|
partitionKey | string |
비어 있으면 모든 파티션이 문서를 검색하는 데 사용됩니다. |
|
|
최대 항목 수
|
maxItemCount | integer |
페이지당 반환할 최대 항목 수를 나타내는 정수입니다. |
|
|
연속 토큰
|
continuationToken | string |
추가 결과를 가져오는 토큰입니다. |
|
|
일관성 수준
|
consistencyLevel | string |
피드(쿼리/읽기 피드) 작업에 필요한 일관성 수준입니다. |
|
|
세션 토큰
|
sessionToken | string |
세션 일관성에 사용할 세션 토큰입니다. |
반환
요청된 쿼리 및 관련 메타데이터와 일치하는 문서 배열입니다.
문서 쿼리 V5
문서 쿼리(V5).
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Azure Cosmos DB 계정 이름
|
cosmosDbAccountName | True | string |
Azure Cosmos DB 계정 이름(documents.azure.com 제외)입니다. |
|
데이터베이스 ID
|
databaseId | True | string |
데이터베이스의 이름입니다. |
|
컨테이너 ID
|
containerId | True | string |
컨테이너의 이름입니다. |
|
SQL 구문 쿼리
|
queryText | string |
SQL 쿼리. 비어 있는 경우 모든 문서를 반환합니다. |
|
|
파티션 키 값
|
partitionKey | string |
값은 해당 형식("string", 42, 0.5)에 따라 제공해야 합니다. 비어 있으면 모든 파티션이 문서를 검색하는 데 사용됩니다. |
|
|
최대 항목 수
|
maxItemCount | integer |
페이지당 반환할 최대 항목 수를 나타내는 정수입니다. |
|
|
연속 토큰
|
continuationToken | string |
추가 결과를 가져오는 토큰입니다. |
|
|
일관성 수준
|
consistencyLevel | string |
피드(쿼리/읽기 피드) 작업에 필요한 일관성 수준입니다. |
|
|
세션 토큰
|
sessionToken | string |
세션 일관성에 사용할 세션 토큰입니다. |
반환
요청된 쿼리 및 관련 메타데이터와 일치하는 문서 배열입니다.
저장 프로시저 가져오기(V2)
지정된 컬렉션(V2)에서 저장 프로시저를 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Azure Cosmos DB 계정 이름
|
cosmosDbAccountName | True | string |
Azure Cosmos DB 계정 이름(documents.azure.com 제외)입니다. |
|
데이터베이스 ID
|
databaseId | True | string |
데이터베이스의 이름입니다. |
|
컬렉션 ID
|
collectionId | True | string |
컬렉션의 이름입니다. |
|
API 버전
|
x-ms-version | string |
API 버전. |
반환
저장 프로시저 가져오기 [사용되지 않음]
이 작업은 더 이상 사용되지 않습니다. 대신 저장 프로시저 가져오기(V2) 를 사용하세요.
지정된 컬렉션에서 저장 프로시저를 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
데이터베이스 ID
|
databaseId | True | string |
데이터베이스의 이름입니다. |
|
컬렉션 ID
|
collectionId | True | string |
컬렉션의 이름입니다. |
|
API 버전
|
x-ms-version | string |
API 버전. |
반환
저장 프로시저 만들기(V2)
저장 프로시저(V2)를 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Azure Cosmos DB 계정 이름
|
cosmosDbAccountName | True | string |
Azure Cosmos DB 계정 이름(documents.azure.com 제외)입니다. |
|
데이터베이스 ID
|
databaseId | True | string |
데이터베이스의 이름입니다. |
|
컬렉션 ID
|
collectionId | True | string |
컬렉션의 이름입니다. |
|
함수 정의
|
body | string |
저장 프로시저를 정의하는 함수(예: 'function(params){ ... }' |
|
|
아이디
|
id | string |
저장 프로시저의 새 ID입니다. |
|
|
API 버전
|
x-ms-version | string |
API 버전. |
반환
저장 프로시저 만들기 [사용되지 않음]
이 작업은 더 이상 사용되지 않습니다. 대신 저장 프로시저 만들기(V2) 를 사용하세요.
저장 프로시저를 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
데이터베이스 ID
|
databaseId | True | string |
데이터베이스의 이름입니다. |
|
컬렉션 ID
|
collectionId | True | string |
컬렉션의 이름입니다. |
|
함수 정의
|
body | string |
저장 프로시저를 정의하는 함수(예: 'function(params){ ... }' |
|
|
아이디
|
id | string |
저장 프로시저의 새 ID입니다. |
|
|
API 버전
|
x-ms-version | string |
API 버전. |
반환
저장 프로시저 바꾸기(V2)
저장 프로시저(V2)를 바꿉니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Azure Cosmos DB 계정 이름
|
cosmosDbAccountName | True | string |
Azure Cosmos DB 계정 이름(documents.azure.com 제외)입니다. |
|
데이터베이스 ID
|
databaseId | True | string |
데이터베이스의 이름입니다. |
|
컬렉션 ID
|
collectionId | True | string |
컬렉션의 이름입니다. |
|
Sproc ID
|
sprocId | True | string |
저장 프로시저의 이름입니다. |
|
함수 정의
|
body | string |
저장 프로시저를 정의하는 함수(예: 'function(params){ ... }' |
|
|
아이디
|
id | string |
기존 저장 프로시저의 ID입니다. |
|
|
API 버전
|
x-ms-version | string |
API 버전. |
반환
저장 프로시저 바꾸기 [사용되지 않음]
이 작업은 더 이상 사용되지 않습니다. 저장 프로시저 바꾸기(V2) 를 대신 사용하세요.
저장 프로시저를 바꿉다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
데이터베이스 ID
|
databaseId | True | string |
데이터베이스의 이름입니다. |
|
컬렉션 ID
|
collectionId | True | string |
컬렉션의 이름입니다. |
|
Sproc ID
|
sprocId | True | string |
저장 프로시저의 이름입니다. |
|
함수 정의
|
body | string |
저장 프로시저를 정의하는 함수(예: 'function(params){ ... }' |
|
|
아이디
|
id | string |
기존 저장 프로시저의 ID입니다. |
|
|
API 버전
|
x-ms-version | string |
API 버전. |
반환
저장 프로시저 삭제(V2)
저장 프로시저(V2)를 삭제합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Azure Cosmos DB 계정 이름
|
cosmosDbAccountName | True | string |
Azure Cosmos DB 계정 이름(documents.azure.com 제외)입니다. |
|
데이터베이스 ID
|
databaseId | True | string |
데이터베이스의 이름입니다. |
|
컬렉션 ID
|
collectionId | True | string |
컬렉션의 이름입니다. |
|
Sproc ID
|
sprocId | True | string |
저장 프로시저의 이름입니다. |
|
API 버전
|
x-ms-version | string |
API 버전. |
반환
- response
- string
저장 프로시저 삭제 [사용되지 않음]
이 작업은 더 이상 사용되지 않습니다. 저장 프로시저 삭제(V2) 를 대신 사용하세요.
저장 프로시저를 삭제합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
데이터베이스 ID
|
databaseId | True | string |
데이터베이스의 이름입니다. |
|
컬렉션 ID
|
collectionId | True | string |
컬렉션의 이름입니다. |
|
Sproc ID
|
sprocId | True | string |
저장 프로시저의 이름입니다. |
|
API 버전
|
x-ms-version | string |
API 버전. |
반환
- response
- string
저장 프로시저 실행(V2)
지정된 컬렉션(V2)에서 저장 프로시저를 실행합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Azure Cosmos DB 계정 이름
|
cosmosDbAccountName | True | string |
Azure Cosmos DB 계정 이름(documents.azure.com 제외)입니다. |
|
데이터베이스 ID
|
databaseId | True | string |
데이터베이스의 이름입니다. |
|
컬렉션 ID
|
collectionId | True | string |
컬렉션의 이름입니다. |
|
파티션 키 값
|
x-ms-documentdb-raw-partitionkey | string |
요청된 문서 또는 첨부 파일 작업에 대한 파티션 키 값입니다. |
|
|
Sproc ID
|
sprocId | True | string |
저장 프로시저의 이름입니다. |
|
저장 프로시저에 대한 매개 변수
|
parameters | string |
저장 프로시저의 매개 변수에 유효한 JSON을 지정합니다(예: ["param1", "param2"]). |
|
|
API 버전
|
x-ms-version | string |
API 버전. |
반환
- response
- ObjectWithoutType
저장 프로시저 실행 [사용되지 않음]
이 작업은 더 이상 사용되지 않습니다. 저장 프로시저 실행(V2) 을 대신 사용하세요.
지정된 컬렉션에서 저장 프로시저를 실행합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
데이터베이스 ID
|
databaseId | True | string |
데이터베이스의 이름입니다. |
|
컬렉션 ID
|
collectionId | True | string |
컬렉션의 이름입니다. |
|
파티션 키 값
|
x-ms-documentdb-raw-partitionkey | string |
요청된 문서 또는 첨부 파일 작업에 대한 파티션 키 값입니다. |
|
|
Sproc ID
|
sprocId | True | string |
저장 프로시저의 이름입니다. |
|
저장 프로시저에 대한 매개 변수
|
parameters | string |
저장 프로시저의 매개 변수에 유효한 JSON을 지정합니다(예: ["param1", "param2"]). |
|
|
API 버전
|
x-ms-version | string |
API 버전. |
반환
- response
- ObjectWithoutType
정의
QueryDocumentsResponse
요청된 쿼리 및 관련 메타데이터와 일치하는 문서 배열입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
문서
|
Documents | array of ObjectWithoutType |
요청과 일치하는 문서 배열입니다. |
|
문서 수
|
_count | integer |
문서 수입니다. |
|
활동 ID
|
ActivityId | string |
Azure Cosmos DB 서비스 활동 ID입니다. |
DocumentsCollection
요청된 쿼리 및 관련 메타데이터와 일치하는 문서 배열입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
문서
|
value | array of ObjectWithoutType | |
|
연속 토큰
|
ContinuationToken | string | |
|
문서 수
|
Count | integer | |
|
요청 요금
|
RequestCharge | double | |
|
세션 토큰
|
SessionToken | string | |
|
활동 ID
|
ActivityId | string |
postDocumentsResponse
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
_ts
|
_ts | integer | |
|
_자신
|
_self | string | |
|
_etag
|
_etag | string | |
|
_첨부 파일
|
_attachments | string | |
|
아이디
|
id | string |
putDocumentResponse
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
아이디
|
id | string |
getDocumentsResponse
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
문서
|
Documents | array of object |
queryResponse
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
_세다
|
_count | number | |
|
문서
|
Documents | array of |
getStoredProceduresResponse
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
_세다
|
_count | integer |
_세다 |
|
_rid
|
_rid | string |
_rid |
|
Stored프로시저
|
StoredProcedures | array of object |
Stored프로시저 |
|
_etag
|
StoredProcedures._etag | string |
_etag |
|
_rid
|
StoredProcedures._rid | string |
_rid |
|
_자신
|
StoredProcedures._self | string |
_자신 |
|
_ts
|
StoredProcedures._ts | integer |
_ts |
|
body
|
StoredProcedures.body | string |
body |
|
아이디
|
StoredProcedures.id | string |
아이디 |
createStoredProcedureResponse
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
_etag
|
_etag | string |
_etag |
|
_rid
|
_rid | string |
_rid |
|
_자신
|
_self | string |
_자신 |
|
_ts
|
_ts | integer |
_ts |
|
body
|
body | string |
body |
|
아이디
|
id | string |
아이디 |
ObjectWithoutType
문자열
기본 데이터 형식 'string'입니다.
객체
'object' 형식입니다.