Compartilhar via


Database Accounts - Create Update Mongo DB Collection

Criar ou atualizar uma coleção do MongoDB do Azure Cosmos DB

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
accountName
path True

string

Nome da conta de banco de dados do Cosmos DB.

Padrão Regex: ^[a-z0-9]+(-[a-z0-9]+)*

collectionName
path True

string

Nome da coleção do Cosmos DB.

databaseName
path True

string

Nome do banco de dados do Cosmos DB.

resourceGroupName
path True

string

Nome de um grupo de recursos do Azure.

Padrão Regex: ^[-\w\._\(\)]+$

subscriptionId
path True

string

Id de assinatura do Azure.

api-version
query True

string

Versão da API a ser usada com a solicitação do cliente. A versão atual é 2015-04-08.

Corpo da solicitação

Nome Obrigatório Tipo Description
properties.options True

object

Um par chave-valor de opções a serem aplicadas à solicitação. Isso corresponde aos cabeçalhos enviados com a solicitação.

properties.resource True

MongoDBCollectionResource

O formato JSON padrão de uma coleção do MongoDB

Respostas

Nome Tipo Description
200 OK

MongoDBCollection

A operação de criação ou atualização da Coleção MongoDB foi concluída com êxito.

202 Accepted

A operação de criação ou atualização da Coleção Do MongoDB será concluída de forma assíncrona.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation Representar sua conta de usuário

Exemplos

CosmosDBMongoDBCollectionCreateUpdate

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

Nome Description
MongoDBCollection

Uma coleção do MongoDB do Azure Cosmos DB.

MongoDBCollectionCreateUpdateParameters

Parâmetros para criar e atualizar a coleção do MongoDB do Cosmos DB.

MongoDBCollectionResource

Objeto de recurso de coleção do MongoDB do Cosmos DB

MongoIndex

Chave de índice da coleção do MongoDB do Cosmos DB

MongoIndexKeys

Objeto de recurso de coleção do MongoDB do Cosmos DB

MongoIndexOptions

Opções de índice de coleção do MongoDB do Cosmos DB

MongoDBCollection

Uma coleção do MongoDB do Azure Cosmos DB.

Nome Tipo Description
id

string

O identificador de recurso exclusivo da conta de banco de dados.

location

string

O local do grupo de recursos ao qual o recurso pertence.

name

string

O nome da conta de banco de dados.

properties.id

string

Nome da coleção MongoDB do Cosmos DB

properties.indexes

MongoIndex[]

Lista de chaves de índice

properties.shardKey

object

Um par chave-valor de chaves de fragmento a serem aplicadas à solicitação.

tags

object

As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas para exibir e agrupar esse recurso (entre grupos de recursos). Um máximo de 15 marcas pode ser fornecido para um recurso. Cada marca deve ter uma chave com no máximo 128 caracteres e um valor com no máximo 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB".

type

string

O tipo de recurso do Azure.

MongoDBCollectionCreateUpdateParameters

Parâmetros para criar e atualizar a coleção do MongoDB do Cosmos DB.

Nome Tipo Description
properties.options

object

Um par chave-valor de opções a serem aplicadas à solicitação. Isso corresponde aos cabeçalhos enviados com a solicitação.

properties.resource

MongoDBCollectionResource

O formato JSON padrão de uma coleção do MongoDB

MongoDBCollectionResource

Objeto de recurso de coleção do MongoDB do Cosmos DB

Nome Tipo Description
id

string

Nome da coleção MongoDB do Cosmos DB

indexes

MongoIndex[]

Lista de chaves de índice

shardKey

object

Um par chave-valor de chaves de fragmento a serem aplicadas à solicitação.

MongoIndex

Chave de índice da coleção do MongoDB do Cosmos DB

Nome Tipo Description
key

MongoIndexKeys

Chaves de índice da coleção do MongoDB do Cosmos DB

options

MongoIndexOptions

Opções de chave de índice da coleção do MongoDB do Cosmos DB

MongoIndexKeys

Objeto de recurso de coleção do MongoDB do Cosmos DB

Nome Tipo Description
keys

string[]

Lista de chaves para cada coleção do MongoDB no serviço do Azure Cosmos DB

MongoIndexOptions

Opções de índice de coleção do MongoDB do Cosmos DB

Nome Tipo Description
expireAfterSeconds

integer

Expirar após segundos

unique

boolean

É exclusivo ou não