다음을 통해 공유


Database Accounts - Create Update Mongo DB Collection

Azure Cosmos DB MongoDB 컬렉션 만들기 또는 업데이트

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/apis/mongodb/databases/{databaseName}/collections/{collectionName}?api-version=2016-03-31

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
accountName
path True

string

Cosmos DB 데이터베이스 계정 이름입니다.

regex 패턴: ^[a-z0-9]+(-[a-z0-9]+)*

collectionName
path True

string

Cosmos DB 컬렉션 이름입니다.

databaseName
path True

string

Cosmos DB 데이터베이스 이름입니다.

resourceGroupName
path True

string

Azure 리소스 그룹의 이름입니다.

regex 패턴: ^[-\w\._\(\)]+$

subscriptionId
path True

string

Azure 구독 ID입니다.

api-version
query True

string

클라이언트 요청과 함께 사용할 API의 버전입니다. 현재 버전은 2015-04-08입니다.

요청 본문

Name 필수 형식 Description
properties.options True

object

요청에 적용할 키-값 옵션 쌍입니다. 이는 요청과 함께 전송된 헤더에 해당합니다.

properties.resource True

MongoDBCollectionResource

MongoDB 컬렉션의 표준 JSON 형식

응답

Name 형식 Description
200 OK

MongoDBCollection

MongoDB 컬렉션 만들기 또는 업데이트 작업이 성공적으로 완료되었습니다.

202 Accepted

MongoDB 컬렉션 만들기 또는 업데이트 작업이 비동기적으로 완료됩니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name Description
user_impersonation 사용자 계정 가장

예제

CosmosDBMongoDBCollectionCreateUpdate

샘플 요청

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/apis/mongodb/databases/databaseName/collections/collectionName?api-version=2016-03-31

{
  "properties": {
    "resource": {
      "id": "testcoll",
      "indexes": [
        {
          "key": {
            "keys": [
              "testKey"
            ]
          },
          "options": {
            "expireAfterSeconds": 100,
            "unique": true
          }
        }
      ],
      "shardKey": {
        "testKey": "Hash"
      }
    },
    "options": {}
  }
}

샘플 응답

{
  "id": "collectionName",
  "name": "collectionName",
  "type": "Microsoft.DocumentDB/databaseAccounts/apis/collection",
  "properties": {
    "id": "testcoll",
    "indexes": [
      {
        "key": {
          "keys": [
            "testKey"
          ]
        },
        "options": {
          "expireAfterSeconds": 100,
          "unique": true
        }
      }
    ],
    "shardKey": {
      "testKey": "Hash"
    }
  }
}

정의

Name Description
MongoDBCollection

Azure Cosmos DB MongoDB 컬렉션입니다.

MongoDBCollectionCreateUpdateParameters

Cosmos DB MongoDB 컬렉션을 만들고 업데이트하는 매개 변수입니다.

MongoDBCollectionResource

Cosmos DB MongoDB 컬렉션 리소스 개체

MongoIndex

Cosmos DB MongoDB 컬렉션 인덱스 키

MongoIndexKeys

Cosmos DB MongoDB 컬렉션 리소스 개체

MongoIndexOptions

Cosmos DB MongoDB 컬렉션 인덱스 옵션

MongoDBCollection

Azure Cosmos DB MongoDB 컬렉션입니다.

Name 형식 Description
id

string

데이터베이스 계정의 고유 리소스 식별자입니다.

location

string

리소스가 속한 리소스 그룹의 위치입니다.

name

string

데이터베이스 계정의 이름입니다.

properties.id

string

Cosmos DB MongoDB 컬렉션의 이름

properties.indexes

MongoIndex[]

인덱스 키 목록

properties.shardKey

object

요청에 적용할 분할 키의 키-값 쌍입니다.

tags

object

태그는 리소스를 설명하는 키-값 쌍의 목록입니다. 여러 리소스 그룹에서 이 리소스를 보고 그룹화할 때 이러한 태그를 사용할 수 있습니다. 리소스에 대해 최대 15개의 태그를 제공할 수 있습니다. 각 태그에는 128자 이하의 키와 256자 이하의 값이 포함되어야 합니다. 예를 들어 템플릿 형식의 기본 환경은 "defaultExperience": "Cassandra"로 설정됩니다. 현재 "defaultExperience" 값에는 "Table", "Graph", "DocumentDB" 및 "MongoDB"도 포함됩니다.

type

string

Azure 리소스의 유형입니다.

MongoDBCollectionCreateUpdateParameters

Cosmos DB MongoDB 컬렉션을 만들고 업데이트하는 매개 변수입니다.

Name 형식 Description
properties.options

object

요청에 적용할 키-값 옵션 쌍입니다. 이는 요청과 함께 전송된 헤더에 해당합니다.

properties.resource

MongoDBCollectionResource

MongoDB 컬렉션의 표준 JSON 형식

MongoDBCollectionResource

Cosmos DB MongoDB 컬렉션 리소스 개체

Name 형식 Description
id

string

Cosmos DB MongoDB 컬렉션의 이름

indexes

MongoIndex[]

인덱스 키 목록

shardKey

object

요청에 적용할 분할 키의 키-값 쌍입니다.

MongoIndex

Cosmos DB MongoDB 컬렉션 인덱스 키

Name 형식 Description
key

MongoIndexKeys

Cosmos DB MongoDB 컬렉션 인덱스 키

options

MongoIndexOptions

Cosmos DB MongoDB 컬렉션 인덱스 키 옵션

MongoIndexKeys

Cosmos DB MongoDB 컬렉션 리소스 개체

Name 형식 Description
keys

string[]

Azure Cosmos DB 서비스의 각 MongoDB 컬렉션에 대한 키 목록

MongoIndexOptions

Cosmos DB MongoDB 컬렉션 인덱스 옵션

Name 형식 Description
expireAfterSeconds

integer

몇 초 후에 만료

unique

boolean

고유 여부