Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections 2024-05-15-preview

• nejnovější
• 12. 12. 2024 ve verzi Preview
• 11. 11. 2024
• 2024-09-01-preview
• 1 5. 8. 2024
• 15. 5. 2024
• 15. 5. 2024 ve verzi Preview
• 2024-024-15-preview
• 11. 11. 2023
• 11. 11. 2023 ve verzi Preview
• 15. 9. 2023
• 2023-09-15-preview
• 2023-04-15
• 15. 3. 2023
• 2023-03-15-preview
• 1. 3. 2023 ve verzi Preview
• 11. 11. 2022
• 11. 11. 2022 ve verzi Preview
• 2022-08-15
• 15. 8. 2022 ve verzi Preview
• 15. 5. 2022
• 2022-05-15-preview
• 2022-022-15-preview
• 11. 11. 2021 ve verzi Preview
• 10. 10. 2021
• 10. 10. 2021 ve verzi Preview
• 2021-07-01-preview
• 15. 6. 2021
• 2021-05-15
• 2021-04-15
• 2021-04-01-preview
• 15. 3. 2021
• 2021-03-01-preview
• 15. 1 5. 2021
• 2020-09-01
• 2020-06-01-preview
• 04.04.2020
• 2020-03-01
• 12. 12. 2019
• 1. 8. 2019

Definice prostředku Bicep

Typ prostředku databaseAccounts/mongodbDatabases/collections je možné nasadit s operacemi, které cílí:

• skupiny prostředků – viz příkazy nasazení skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections, přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-05-15-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      createMode: 'string'
      id: 'string'
      indexes: [
        {
          key: {
            keys: [
              'string'
            ]
          }
          options: {
            expireAfterSeconds: int
            unique: bool
          }
        }
      ]
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
        restoreWithTtlDisabled: bool
      }
      shardKey: {
        {customized property}: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Hodnoty vlastností

Automatické škálováníSettings

Jméno	Popis	Hodnota
maxThroughput	Představuje maximální propustnost a prostředek se může vertikálně navýšit.	Int

Komponenty1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Jméno	Popis	Hodnota

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Jméno	Popis	Hodnota
automatické škálováníSettings	Určuje nastavení automatického škálování. Poznámka: Vyžaduje se propustnost nebo automatické škálováníSettings, ale ne obojí.	automatického škálování
propustnost	Jednotky žádostí za sekundu Například propustnost: 1 0000.	Int

ManagedServiceIdentity

Jméno	Popis	Hodnota
typ	Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity.	None (Žádný) SystemAssigned SystemAssigned, UserAssigned UserAssigned
userAssignedIdentities	Seznam identit uživatelů přidružených k prostředku. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formátu: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Jméno	Popis	Hodnota

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Jméno	Popis	Hodnota
identita	Identita prostředku	ManagedServiceIdentity
umístění	Umístění skupiny prostředků, do které prostředek patří.	řetězec
Jméno	Název prostředku	string (povinné)
rodič	V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek. Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.	Symbolický název prostředku typu: databaseAccounts/mongodbDatabases
vlastnosti	Vlastnosti pro vytvoření a aktualizaci kolekce MongoDB služby Azure Cosmos DB	MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (povinné)
visačky	Značky prostředků	Slovník názvů a hodnot značek Viz Značky v šablonách

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Jméno	Popis	Hodnota
volby	Pár možností klíč-hodnota, které se mají použít pro požadavek. Odpovídá hlavičkám odeslaným s požadavkem.	CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
zdroj	Standardní formát JSON kolekce MongoDB	MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (povinné)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Jméno	Popis	Hodnota
analyticalStorageTtl	Hodnota TTL analytického úložiště.	Int
createMode	Výčet označující režim vytváření prostředků.	Výchozí Obnovit
id	Název kolekce MongoDB služby Cosmos DB	string (povinné)
indexy	Seznam klíčů indexu	MongoIndex[]
restoreParameters	Parametry označující informace o obnovení	ResourceRestoreParameters
shardKey	Pár klíč-hodnota klíče horizontálního oddílu, který se má použít pro požadavek.	ShardKeys

MongoIndex

Jméno	Popis	Hodnota
klíč	Klíče indexu kolekce MongoDB služby Cosmos DB	MongoIndexKeys
volby	Možnosti klíče indexu kolekce MongoDB služby Cosmos DB	MongoIndexOptions

MongoIndexKeys

Jméno	Popis	Hodnota
klíče	Seznam klíčů pro každou kolekci MongoDB ve službě Azure Cosmos DB	string[]

MongoIndexOptions

Jméno	Popis	Hodnota
expireAfterSeconds	Vypršení platnosti po sekundách	Int
jedinečný	Je jedinečný nebo ne	Bool

ResourceRestoreParameters

Jméno	Popis	Hodnota
restoreSource	ID obnovovatelného databázového účtu, ze kterého se má obnovení zahájit. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}	řetězec
restoreTimestampInUtc	Čas obnovení účtu (formát ISO-8601)	řetězec
restoreWithTtlDisabled	Určuje, jestli obnovený účet bude mít po úspěšném obnovení zakázaný časovýTo-Live.	Bool

ShardKeys

Jméno	Popis	Hodnota

Visačky

Jméno	Popis	Hodnota

Příklady použití

Ukázky rychlého startu Azure

Následující šablony Azure pro rychlý start obsahují ukázky Bicep pro nasazení tohoto typu prostředku.

Soubor Bicep	Popis
vytvoření účtu služby Azure Cosmos pro rozhraní MongoDB API	Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní MongoDB API 4.2 ve dvou oblastech pomocí sdílené a vyhrazené propustnosti se dvěma kolekcemi.
Vytvoření účtu služby Azure Cosmos pro automatické škálování rozhraní MongoDB API	Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní MongoDB API 4.2 ve dvou oblastech s využitím sdílené i vyhrazené propustnosti automatického škálování.

Definice prostředku šablony ARM

Typ prostředku databaseAccounts/mongodbDatabases/collections je možné nasadit s operacemi, které cílí:

• skupiny prostředků – viz příkazy nasazení skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections, přidejte do šablony následující JSON.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
  "apiVersion": "2024-05-15-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "createMode": "string",
      "id": "string",
      "indexes": [
        {
          "key": {
            "keys": [ "string" ]
          },
          "options": {
            "expireAfterSeconds": "int",
            "unique": "bool"
          }
        }
      ],
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string",
        "restoreWithTtlDisabled": "bool"
      },
      "shardKey": {
        "{customized property}": "string"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Hodnoty vlastností

Automatické škálováníSettings

Jméno	Popis	Hodnota
maxThroughput	Představuje maximální propustnost a prostředek se může vertikálně navýšit.	Int

Komponenty1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Jméno	Popis	Hodnota

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Jméno	Popis	Hodnota
automatické škálováníSettings	Určuje nastavení automatického škálování. Poznámka: Vyžaduje se propustnost nebo automatické škálováníSettings, ale ne obojí.	automatického škálování
propustnost	Jednotky žádostí za sekundu Například propustnost: 1 0000.	Int

ManagedServiceIdentity

Jméno	Popis	Hodnota
typ	Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity.	None (Žádný) SystemAssigned SystemAssigned, UserAssigned UserAssigned
userAssignedIdentities	Seznam identit uživatelů přidružených k prostředku. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formátu: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Jméno	Popis	Hodnota

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Jméno	Popis	Hodnota
apiVersion	Verze rozhraní API	2024-05-15-preview
identita	Identita prostředku	ManagedServiceIdentity
umístění	Umístění skupiny prostředků, do které prostředek patří.	řetězec
Jméno	Název prostředku	string (povinné)
vlastnosti	Vlastnosti pro vytvoření a aktualizaci kolekce MongoDB služby Azure Cosmos DB	MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (povinné)
visačky	Značky prostředků	Slovník názvů a hodnot značek Viz Značky v šablonách
typ	Typ prostředku	Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Jméno	Popis	Hodnota
volby	Pár možností klíč-hodnota, které se mají použít pro požadavek. Odpovídá hlavičkám odeslaným s požadavkem.	CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
zdroj	Standardní formát JSON kolekce MongoDB	MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (povinné)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Jméno	Popis	Hodnota
analyticalStorageTtl	Hodnota TTL analytického úložiště.	Int
createMode	Výčet označující režim vytváření prostředků.	Výchozí Obnovit
id	Název kolekce MongoDB služby Cosmos DB	string (povinné)
indexy	Seznam klíčů indexu	MongoIndex[]
restoreParameters	Parametry označující informace o obnovení	ResourceRestoreParameters
shardKey	Pár klíč-hodnota klíče horizontálního oddílu, který se má použít pro požadavek.	ShardKeys

MongoIndex

Jméno	Popis	Hodnota
klíč	Klíče indexu kolekce MongoDB služby Cosmos DB	MongoIndexKeys
volby	Možnosti klíče indexu kolekce MongoDB služby Cosmos DB	MongoIndexOptions

MongoIndexKeys

Jméno	Popis	Hodnota
klíče	Seznam klíčů pro každou kolekci MongoDB ve službě Azure Cosmos DB	string[]

MongoIndexOptions

Jméno	Popis	Hodnota
expireAfterSeconds	Vypršení platnosti po sekundách	Int
jedinečný	Je jedinečný nebo ne	Bool

ResourceRestoreParameters

Jméno	Popis	Hodnota
restoreSource	ID obnovovatelného databázového účtu, ze kterého se má obnovení zahájit. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}	řetězec
restoreTimestampInUtc	Čas obnovení účtu (formát ISO-8601)	řetězec
restoreWithTtlDisabled	Určuje, jestli obnovený účet bude mít po úspěšném obnovení zakázaný časovýTo-Live.	Bool

ShardKeys

Jméno	Popis	Hodnota

Visačky

Jméno	Popis	Hodnota

Příklady použití

Šablony azure pro rychlý start

Následující šablony Azure Pro rychlý start nasadit tento typ prostředku.

Šablona	Popis
vytvoření účtu služby Azure Cosmos pro rozhraní MongoDB API nasazení	Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní MongoDB API 4.2 ve dvou oblastech pomocí sdílené a vyhrazené propustnosti se dvěma kolekcemi.
Vytvoření účtu služby Azure Cosmos pro automatické škálování rozhraní MongoDB API nasazení	Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní MongoDB API 4.2 ve dvou oblastech s využitím sdílené i vyhrazené propustnosti automatického škálování.

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku databaseAccounts/mongodbDatabases/collections je možné nasadit s operacemi, které cílí:

• skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections, přidejte do šablony následující Terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-05-15-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        createMode = "string"
        id = "string"
        indexes = [
          {
            key = {
              keys = [
                "string"
              ]
            }
            options = {
              expireAfterSeconds = int
              unique = bool
            }
          }
        ]
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
          restoreWithTtlDisabled = bool
        }
        shardKey = {
          {customized property} = "string"
        }
      }
    }
  })
}

Hodnoty vlastností

Automatické škálováníSettings

Jméno	Popis	Hodnota
maxThroughput	Představuje maximální propustnost a prostředek se může vertikálně navýšit.	Int

Komponenty1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Jméno	Popis	Hodnota

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Jméno	Popis	Hodnota
automatické škálováníSettings	Určuje nastavení automatického škálování. Poznámka: Vyžaduje se propustnost nebo automatické škálováníSettings, ale ne obojí.	automatického škálování
propustnost	Jednotky žádostí za sekundu Například propustnost: 1 0000.	Int

ManagedServiceIdentity

Jméno	Popis	Hodnota
typ	Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity.	None (Žádný) SystemAssigned SystemAssigned, UserAssigned UserAssigned
userAssignedIdentities	Seznam identit uživatelů přidružených k prostředku. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formátu: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Jméno	Popis	Hodnota

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Jméno	Popis	Hodnota
identita	Identita prostředku	ManagedServiceIdentity
umístění	Umístění skupiny prostředků, do které prostředek patří.	řetězec
Jméno	Název prostředku	string (povinné)
parent_id	ID prostředku, který je nadřazený pro tento prostředek.	ID prostředku typu: databaseAccounts/mongodbDatabases
vlastnosti	Vlastnosti pro vytvoření a aktualizaci kolekce MongoDB služby Azure Cosmos DB	MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (povinné)
visačky	Značky prostředků	Slovník názvů a hodnot značek
typ	Typ prostředku	Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-05-15-preview

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Jméno	Popis	Hodnota
volby	Pár možností klíč-hodnota, které se mají použít pro požadavek. Odpovídá hlavičkám odeslaným s požadavkem.	CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
zdroj	Standardní formát JSON kolekce MongoDB	MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (povinné)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Jméno	Popis	Hodnota
analyticalStorageTtl	Hodnota TTL analytického úložiště.	Int
createMode	Výčet označující režim vytváření prostředků.	Výchozí Obnovit
id	Název kolekce MongoDB služby Cosmos DB	string (povinné)
indexy	Seznam klíčů indexu	MongoIndex[]
restoreParameters	Parametry označující informace o obnovení	ResourceRestoreParameters
shardKey	Pár klíč-hodnota klíče horizontálního oddílu, který se má použít pro požadavek.	ShardKeys

MongoIndex

Jméno	Popis	Hodnota
klíč	Klíče indexu kolekce MongoDB služby Cosmos DB	MongoIndexKeys
volby	Možnosti klíče indexu kolekce MongoDB služby Cosmos DB	MongoIndexOptions

MongoIndexKeys

Jméno	Popis	Hodnota
klíče	Seznam klíčů pro každou kolekci MongoDB ve službě Azure Cosmos DB	string[]

MongoIndexOptions

Jméno	Popis	Hodnota
expireAfterSeconds	Vypršení platnosti po sekundách	Int
jedinečný	Je jedinečný nebo ne	Bool

ResourceRestoreParameters

Jméno	Popis	Hodnota
restoreSource	ID obnovovatelného databázového účtu, ze kterého se má obnovení zahájit. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}	řetězec
restoreTimestampInUtc	Čas obnovení účtu (formát ISO-8601)	řetězec
restoreWithTtlDisabled	Určuje, jestli obnovený účet bude mít po úspěšném obnovení zakázaný časovýTo-Live.	Bool

ShardKeys

Jméno	Popis	Hodnota

Visačky

Jméno	Popis	Hodnota