Microsoft.DocumentDB databaseAccounts/apis/databases/collections
Artykuł 12/21/2024
Współautorzy: 2
Opinia
W tym artykule
Definicja zasobu Bicep
Typ zasobu databaseAccounts/apis/databases/collections można wdrożyć przy użyciu operacji docelowych:
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian .
Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/apis/databases/collections, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2016-03-31' = {
parent: resourceSymbolicName
name: 'string'
properties: {
options: {
{customized property}: 'string'
}
resource: {
id: 'string'
indexes: [
{
key: {
keys: [
'string'
]
}
options: {
expireAfterSeconds: int
unique: bool
}
}
]
shardKey: {
{customized property}: 'string'
}
}
}
}
Wartości właściwości
CreateUpdateOptions
Microsoft.DocumentDB/databaseAccounts/apis/databases/collections
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties
Nazwa
Opis
Wartość
Opcje
Para klucz-wartość opcji, które mają zostać zastosowane do żądania. Odpowiada to nagłówkom wysyłanym z żądaniem.
createUpdateOptions (wymagane)
zasób
Standardowy format JSON kolekcji mongoDB
MongoDBCollectionResource (wymagane)
MongoDBCollectionResource
Nazwa
Opis
Wartość
id
Nazwa kolekcji MongoDB usługi Cosmos DB
ciąg (wymagany)
Indeksy
Lista kluczy indeksu
MongoIndex []
shardKey
Para klucz-wartość kluczy do zastosowania dla żądania.
ShardKeys
MongoIndex
Nazwa
Opis
Wartość
klucz
Klucze indeksu kolekcji mongoDB usługi Cosmos DB
MongoIndexKeys
Opcje
Opcje klucza indeksu kolekcji MongoDB usługi Cosmos DB
MongoIndexOptions
MongoIndexKeys
Nazwa
Opis
Wartość
Klucze
Lista kluczy dla każdej kolekcji bazy danych MongoDB w usłudze Azure Cosmos DB
string[]
MongoIndexOptions
Nazwa
Opis
Wartość
expireAfterSeconds
Wygaśnięcie po sekundach
Int
niepowtarzalny
Jest unikatowy lub nie
Bool
ShardKeys
Definicja zasobu szablonu usługi ARM
Typ zasobu databaseAccounts/apis/databases/collections można wdrożyć przy użyciu operacji docelowych:
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian .
Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/apis/databases/collections, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections",
"apiVersion": "2016-03-31",
"name": "string",
"properties": {
"options": {
"{customized property}": "string"
},
"resource": {
"id": "string",
"indexes": [
{
"key": {
"keys": [ "string" ]
},
"options": {
"expireAfterSeconds": "int",
"unique": "bool"
}
}
],
"shardKey": {
"{customized property}": "string"
}
}
}
}
Wartości właściwości
CreateUpdateOptions
Microsoft.DocumentDB/databaseAccounts/apis/databases/collections
Nazwa
Opis
Wartość
apiVersion
Wersja interfejsu API
'2016-03-31'
nazwa
Nazwa zasobu
ciąg (wymagany)
Właściwości
Właściwości do tworzenia i aktualizowania kolekcji mongoDB usługi Azure Cosmos DB.
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (wymagane)
typ
Typ zasobu
"Microsoft.DocumentDB/databaseAccounts/apis/databases/collections"
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties
Nazwa
Opis
Wartość
Opcje
Para klucz-wartość opcji, które mają zostać zastosowane do żądania. Odpowiada to nagłówkom wysyłanym z żądaniem.
createUpdateOptions (wymagane)
zasób
Standardowy format JSON kolekcji mongoDB
MongoDBCollectionResource (wymagane)
MongoDBCollectionResource
Nazwa
Opis
Wartość
id
Nazwa kolekcji MongoDB usługi Cosmos DB
ciąg (wymagany)
Indeksy
Lista kluczy indeksu
MongoIndex []
shardKey
Para klucz-wartość kluczy do zastosowania dla żądania.
ShardKeys
MongoIndex
Nazwa
Opis
Wartość
klucz
Klucze indeksu kolekcji mongoDB usługi Cosmos DB
MongoIndexKeys
Opcje
Opcje klucza indeksu kolekcji MongoDB usługi Cosmos DB
MongoIndexOptions
MongoIndexKeys
Nazwa
Opis
Wartość
Klucze
Lista kluczy dla każdej kolekcji bazy danych MongoDB w usłudze Azure Cosmos DB
string[]
MongoIndexOptions
Nazwa
Opis
Wartość
expireAfterSeconds
Wygaśnięcie po sekundach
Int
niepowtarzalny
Jest unikatowy lub nie
Bool
ShardKeys
Typ zasobu databaseAccounts/apis/databases/collections można wdrożyć przy użyciu operacji docelowych:
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian .
Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/apis/databases/collections, dodaj następujący program Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2016-03-31"
name = "string"
body = jsonencode({
properties = {
options = {
{customized property} = "string"
}
resource = {
id = "string"
indexes = [
{
key = {
keys = [
"string"
]
}
options = {
expireAfterSeconds = int
unique = bool
}
}
]
shardKey = {
{customized property} = "string"
}
}
}
})
}
Wartości właściwości
CreateUpdateOptions
Microsoft.DocumentDB/databaseAccounts/apis/databases/collections
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties
Nazwa
Opis
Wartość
Opcje
Para klucz-wartość opcji, które mają zostać zastosowane do żądania. Odpowiada to nagłówkom wysyłanym z żądaniem.
createUpdateOptions (wymagane)
zasób
Standardowy format JSON kolekcji mongoDB
MongoDBCollectionResource (wymagane)
MongoDBCollectionResource
Nazwa
Opis
Wartość
id
Nazwa kolekcji MongoDB usługi Cosmos DB
ciąg (wymagany)
Indeksy
Lista kluczy indeksu
MongoIndex []
shardKey
Para klucz-wartość kluczy do zastosowania dla żądania.
ShardKeys
MongoIndex
Nazwa
Opis
Wartość
klucz
Klucze indeksu kolekcji mongoDB usługi Cosmos DB
MongoIndexKeys
Opcje
Opcje klucza indeksu kolekcji MongoDB usługi Cosmos DB
MongoIndexOptions
MongoIndexKeys
Nazwa
Opis
Wartość
Klucze
Lista kluczy dla każdej kolekcji bazy danych MongoDB w usłudze Azure Cosmos DB
string[]
MongoIndexOptions
Nazwa
Opis
Wartość
expireAfterSeconds
Wygaśnięcie po sekundach
Int
niepowtarzalny
Jest unikatowy lub nie
Bool
ShardKeys