Udostępnij za pośrednictwem

Microsoft.DocumentDB databaseAccounts/apis/databases/collections 2015-04-01

  • Artykuł

Definicja zasobu Bicep

Typ zasobu databaseAccounts/apis/databases/collections można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik 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@2015-04-01' = {
  name: 'string'
  parent: resourceSymbolicName
  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

databaseAccounts/apis/databases/collections

Nazwa Opis Wartość
name Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w aplikacji Bicep.		 ciąg (wymagany)
Nadrzędny W pliku 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.		 Symboliczna nazwa zasobu typu: bazy danych
properties Właściwości do tworzenia i aktualizowania kolekcji mongoDB usługi Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (wymagane)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Nazwa Opis Wartość
opcje Para klucz-wartość opcji do zastosowania dla żądania. Odpowiada to nagłówkom wysłanym z żądaniem. CreateUpdateOptions (wymagane)
zasób Standardowy format JSON kolekcji Bazy danych MongoDB MongoDBCollectionResource (wymagane)

CreateUpdateOptions

Nazwa Opis Wartość
{niestandardowa właściwość} ciąg

MongoDBCollectionResource

Nazwa Opis Wartość
identyfikator Nazwa kolekcji Bazy danych MongoDB usługi Cosmos DB ciąg (wymagany)
Indeksy Lista kluczy indeksu MongoIndex[]
shardKey Para klucz-wartość kluczy, które mają być stosowane do żądania. ShardKeys

MongoIndex

Nazwa Opis Wartość
key Klucze indeksu kolekcji Bazy danych MongoDB w usłudze Cosmos DB MongoIndexKeys
opcje Opcje klucza indeksu kolekcji MongoDB usługi Cosmos DB MongoIndexOptions

MongoIndexKeys

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

MongoIndexOptions

Nazwa Opis Wartość
expireAfterSeconds Wygasanie po sekundach int
unique Jest unikatowa lub nie bool

ShardKeys

Nazwa Opis Wartość
{niestandardowa właściwość} ciąg

Definicja zasobu szablonu usługi ARM

Typ zasobu databaseAccounts/apis/databases/collections można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik 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": "2015-04-01",
  "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

databaseAccounts/apis/databases/collections

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections"
apiVersion Wersja interfejsu API zasobów '2015-04-01'
name Nazwa zasobu

Zobacz, jak ustawiać nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM JSON.		 ciąg (wymagany)
properties Właściwości do tworzenia i aktualizowania kolekcji mongoDB usługi Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (wymagane)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Nazwa Opis Wartość
opcje Para klucz-wartość opcji do zastosowania dla żądania. Odpowiada to nagłówkom wysłanym z żądaniem. CreateUpdateOptions (wymagane)
zasób Standardowy format JSON kolekcji Bazy danych MongoDB MongoDBCollectionResource (wymagane)

CreateUpdateOptions

Nazwa Opis Wartość
{niestandardowa właściwość} ciąg

MongoDBCollectionResource

Nazwa Opis Wartość
identyfikator Nazwa kolekcji Bazy danych MongoDB usługi Cosmos DB ciąg (wymagany)
Indeksy Lista kluczy indeksu MongoIndex[]
shardKey Para klucz-wartość kluczy, które mają być stosowane do żądania. ShardKeys

MongoIndex

Nazwa Opis Wartość
key Klucze indeksu kolekcji Bazy danych MongoDB w usłudze Cosmos DB MongoIndexKeys
opcje Opcje klucza indeksu kolekcji MongoDB usługi Cosmos DB MongoIndexOptions

MongoIndexKeys

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

MongoIndexOptions

Nazwa Opis Wartość
expireAfterSeconds Wygasanie po sekundach int
unique Jest unikatowa lub nie bool

ShardKeys

Nazwa Opis Wartość
{niestandardowa właściwość} ciąg

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu databaseAccounts/apis/databases/collections można wdrożyć z operacjami docelowymi:

  • Grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/apis/databases/collections, dodaj następujące narzędzie Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2015-04-01"
  name = "string"
  parent_id = "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

databaseAccounts/apis/databases/collections

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2015-04-01"
name Nazwa zasobu ciąg (wymagany)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: bazy danych
properties Właściwości do tworzenia i aktualizowania kolekcji bazy danych MongoDB w usłudze Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (wymagane)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Nazwa Opis Wartość
opcje Para klucz-wartość opcji do zastosowania dla żądania. Odpowiada to nagłówkom wysyłanym z żądaniem. CreateUpdateOptions (wymagane)
zasób Standardowy format JSON kolekcji bazy danych MongoDB MongoDBCollectionResource (wymagane)

CreateUpdateOptions

Nazwa Opis Wartość
{niestandardowa właściwość} ciąg

MongoDBCollectionResource

Nazwa Opis Wartość
identyfikator Nazwa kolekcji bazy danych MongoDB usługi Cosmos DB ciąg (wymagany)
Indeksy Lista kluczy indeksu MongoIndex[]
klucz fragmentu Para klucz-wartość kluczy do zastosowania dla żądania. ShardKeys

Indeks Mongo

Nazwa Opis Wartość
key Klucze indeksu kolekcji bazy danych MongoDB w usłudze Cosmos DB MongoIndexKeys
opcje Opcje klucza indeksu kolekcji Bazy danych MongoDB w usłudze Cosmos DB MongoIndexOptions

MongoIndexKeys

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

MongoIndexOptions

Nazwa Opis Wartość
expireAfterSeconds Wygaśnięcie po sekundach int
unique Jest unikatowy lub nie bool

ShardKeys

Nazwa Opis Wartość
{niestandardowa właściwość} ciąg