Udostępnij przez

Microsoft.DocumentDB databaseAccounts/apis/databases/collections

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.

Format zasobu

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

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

Nazwa Opis Wartość
nazwa Nazwa zasobu ciąg (wymagany)
nadrzędny W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.		 Nazwa symboliczna zasobu typu: databaseAccounts/apis/databases
Właściwości Właściwości do tworzenia i aktualizowania kolekcji mongoDB usługi Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (wymagane)

CreateUpdateOptions (CreateUpdateOptions)

Nazwa Opis Wartość

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 (Zasób mongoDB)

Nazwa Opis Wartość
id Nazwa kolekcji MongoDB usługi Cosmos DB ciąg (wymagany)
Indeksy Lista kluczy indeksu MongoIndex []
shardKey (klucz odłamka) Para klucz-wartość kluczy do zastosowania dla żądania. Klucze odłamków

Indeks MongoIndex

Nazwa Opis Wartość
klucz Klucze indeksu kolekcji mongoDB usługi Cosmos DB MongoIndexKeys (Klucze MongoIndex)
Opcje Opcje klucza indeksu kolekcji MongoDB usługi Cosmos DB MongoIndexOptions

MongoIndexKeys (Klucze MongoIndex)

Nazwa Opis Wartość
Klucze Lista kluczy dla każdej kolekcji bazy danych MongoDB w usłudze Azure Cosmos DB ciąg znakowy[]

Opcje MongoIndexu

Nazwa Opis Wartość
expireAfterSeconds (Sekundy wygaśnięcia) Wygaśnięcie po sekundach Int
niepowtarzalny Jest unikatowy lub nie Bool

Klucze odłamków

Nazwa Opis Wartość

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.

Format zasobu

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

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

Nazwa Opis Wartość
apiVersion (wersja interfejsu api) 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"

CreateUpdateOptions (CreateUpdateOptions)

Nazwa Opis Wartość

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 (Zasób mongoDB)

Nazwa Opis Wartość
id Nazwa kolekcji MongoDB usługi Cosmos DB ciąg (wymagany)
Indeksy Lista kluczy indeksu MongoIndex []
shardKey (klucz odłamka) Para klucz-wartość kluczy do zastosowania dla żądania. Klucze odłamków

Indeks MongoIndex

Nazwa Opis Wartość
klucz Klucze indeksu kolekcji mongoDB usługi Cosmos DB MongoIndexKeys (Klucze MongoIndex)
Opcje Opcje klucza indeksu kolekcji MongoDB usługi Cosmos DB MongoIndexOptions

MongoIndexKeys (Klucze MongoIndex)

Nazwa Opis Wartość
Klucze Lista kluczy dla każdej kolekcji bazy danych MongoDB w usłudze Azure Cosmos DB ciąg znakowy[]

Opcje MongoIndexu

Nazwa Opis Wartość
expireAfterSeconds (Sekundy wygaśnięcia) Wygaśnięcie po sekundach Int
niepowtarzalny Jest unikatowy lub nie Bool

Klucze odłamków

Nazwa Opis Wartość

Przykłady użycia

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

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.

Format zasobu

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"
  parent_id = "string"
  body = {
    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

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

Nazwa Opis Wartość
nazwa Nazwa zasobu ciąg (wymagany)
parent_id (identyfikator rodzica) Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: databaseAccounts/apis/databases
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@2016-03-31"

CreateUpdateOptions (CreateUpdateOptions)

Nazwa Opis Wartość

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 (Zasób mongoDB)

Nazwa Opis Wartość
id Nazwa kolekcji MongoDB usługi Cosmos DB ciąg (wymagany)
Indeksy Lista kluczy indeksu MongoIndex []
shardKey (klucz odłamka) Para klucz-wartość kluczy do zastosowania dla żądania. Klucze odłamków

Indeks MongoIndex

Nazwa Opis Wartość
klucz Klucze indeksu kolekcji mongoDB usługi Cosmos DB MongoIndexKeys (Klucze MongoIndex)
Opcje Opcje klucza indeksu kolekcji MongoDB usługi Cosmos DB MongoIndexOptions

MongoIndexKeys (Klucze MongoIndex)

Nazwa Opis Wartość
Klucze Lista kluczy dla każdej kolekcji bazy danych MongoDB w usłudze Azure Cosmos DB ciąg znakowy[]

Opcje MongoIndexu

Nazwa Opis Wartość
expireAfterSeconds (Sekundy wygaśnięcia) Wygaśnięcie po sekundach Int
niepowtarzalny Jest unikatowy lub nie Bool

Klucze odłamków

Nazwa Opis Wartość
  • Last updated on