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

• najnowsze
• 2024-12-01-preview
• 2024-11-15
• 2024-09-01-preview
• 2024-08-15
• 2024-05-15
• 2024-05-15-preview
• 2024-02-15-preview
• 2023-11-15
• 2023-11-15-preview
• 2023-09-15
• 2023-09-15-preview
• 2023-04-15
• 2023-03-15
• 2023-03-15-preview
• 2023-03-01-preview
• 2022-11-15
• 2022-11-15-preview
• 2022-08-15
• 2022-08-15-preview
• 2022-05-15
• 2022-05-15-preview
• 2022-02-15-preview
• 2021-11-15-preview
• 2021-10-15
• 2021-10-15-preview
• 2021-07-01-preview
• 2021-06-15
• 2021-05-15
• 2021-04-15
• 2021-04-01-preview
• 2021-03-15
• 2021-03-01-preview
• 2021-01-15
• 2020-09-01
• 2020-06-01-preview
• 2020-04-01
• 2020-03-01
• 2019-12-12
• 2019-08-01

Definicja zasobu Bicep

Typ zasobu databaseAccounts/mongodbDatabases/collections można wdrożyć przy użyciu operacji docelowych:

• grupy zasobów — zobacz polecenia wdrażania grupy zasobów

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/mongodbDatabases/collections, dodaj następujący kod Bicep do szablonu.

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'
  }
}

Wartości właściwości

AutoskalowanieUstawienia

Nazwa	Opis	Wartość
maxThroughput	Reprezentuje maksymalną przepływność, zasób może być skalowany w górę do.	Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nazwa	Opis	Wartość

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Nazwa	Opis	Wartość
autoskalowanieUstawienia	Określa ustawienia autoskalu. Uwaga: wymagana jest przepływność lub autoskalowanieUstawienia, ale nie obie.	AutoskalowanieUstawienia
przepustowość	Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000.	Int

ManagedServiceIdentity

Nazwa	Opis	Wartość
typ	Typ tożsamości używany dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi.	"Brak" "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned"
userAssignedIdentities	Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nazwa	Opis	Wartość

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Nazwa	Opis	Wartość
tożsamość	Tożsamość zasobu.	ManagedServiceIdentity
lokalizacja	Lokalizacja grupy zasobów, do której należy zasób.	struna
nazwa	Nazwa zasobu	ciąg (wymagany)
rodzic	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/mongodbDatabases
Właściwości	Właściwości do tworzenia i aktualizowania kolekcji mongoDB usługi Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (wymagane)
Tagi	Tagi zasobów	Słownik nazw tagów i wartości. Zobacz tagi w szablonach

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Nazwa	Opis	Wartość
Opcje	Para klucz-wartość opcji, które mają zostać zastosowane do żądania. Odpowiada to nagłówkom wysyłanym z żądaniem.	CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
zasób	Standardowy format JSON kolekcji mongoDB	MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (wymagane)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Nazwa	Opis	Wartość
analyticalStorageTtl	Analityczny czas wygaśnięcia.	Int
createMode	Wyliczenie wskazujące tryb tworzenia zasobów.	"Wartość domyślna" "Przywracanie"
id	Nazwa kolekcji MongoDB usługi Cosmos DB	ciąg (wymagany)
Indeksy	Lista kluczy indeksu	MongoIndex []
restoreParameters	Parametry wskazujące informacje o przywracaniu	ResourceRestoreParameters
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

ResourceRestoreParameters

Nazwa	Opis	Wartość
restoreSource	Identyfikator przywracalnego konta bazy danych, z którego należy zainicjować przywracanie. Na przykład: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}	struna
restoreTimestampInUtc	Godzina przywrócenia konta (format ISO-8601).	struna
restoreWithTtlDisabled	Określa, czy przywrócone konto będzie mieć czas-To-Live wyłączone po pomyślnym przywróceniu.	Bool

ShardKeys

Nazwa	Opis	Wartość

Tagi

Nazwa	Opis	Wartość

Przykłady z przewodnika Szybki start

W poniższych przykładach szybkiego startu wdrożono ten typ zasobu.

Plik Bicep	Opis
Tworzenie konta usługi Azure Cosmos dla interfejsu API bazy danych MongoDB	Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API bazy danych MongoDB 4.2 w dwóch regionach przy użyciu udostępnionej i dedykowanej przepływności z dwiema kolekcjami.
Tworzenie konta usługi Azure Cosmos dla interfejsu API bazy danych MongoDB	Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API bazy danych MongoDB 4.2 w dwóch regionach przy użyciu udostępnionej i dedykowanej przepływności autoskalowania.

Definicja zasobu szablonu usługi ARM

Typ zasobu databaseAccounts/mongodbDatabases/collections można wdrożyć przy użyciu operacji docelowych:

• grupy zasobów — zobacz polecenia wdrażania grupy zasobów

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/mongodbDatabases/collections, dodaj następujący kod JSON do szablonu.

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

Wartości właściwości

AutoskalowanieUstawienia

Nazwa	Opis	Wartość
maxThroughput	Reprezentuje maksymalną przepływność, zasób może być skalowany w górę do.	Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nazwa	Opis	Wartość

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Nazwa	Opis	Wartość
autoskalowanieUstawienia	Określa ustawienia autoskalu. Uwaga: wymagana jest przepływność lub autoskalowanieUstawienia, ale nie obie.	AutoskalowanieUstawienia
przepustowość	Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000.	Int

ManagedServiceIdentity

Nazwa	Opis	Wartość
typ	Typ tożsamości używany dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi.	"Brak" "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned"
userAssignedIdentities	Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nazwa	Opis	Wartość

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Nazwa	Opis	Wartość
apiVersion	Wersja interfejsu API	"2024-05-15-preview"
tożsamość	Tożsamość zasobu.	ManagedServiceIdentity
lokalizacja	Lokalizacja grupy zasobów, do której należy zasób.	struna
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.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (wymagane)
Tagi	Tagi zasobów	Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ	Typ zasobu	"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections"

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Nazwa	Opis	Wartość
Opcje	Para klucz-wartość opcji, które mają zostać zastosowane do żądania. Odpowiada to nagłówkom wysyłanym z żądaniem.	CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
zasób	Standardowy format JSON kolekcji mongoDB	MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (wymagane)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Nazwa	Opis	Wartość
analyticalStorageTtl	Analityczny czas wygaśnięcia.	Int
createMode	Wyliczenie wskazujące tryb tworzenia zasobów.	"Wartość domyślna" "Przywracanie"
id	Nazwa kolekcji MongoDB usługi Cosmos DB	ciąg (wymagany)
Indeksy	Lista kluczy indeksu	MongoIndex []
restoreParameters	Parametry wskazujące informacje o przywracaniu	ResourceRestoreParameters
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

ResourceRestoreParameters

Nazwa	Opis	Wartość
restoreSource	Identyfikator przywracalnego konta bazy danych, z którego należy zainicjować przywracanie. Na przykład: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}	struna
restoreTimestampInUtc	Godzina przywrócenia konta (format ISO-8601).	struna
restoreWithTtlDisabled	Określa, czy przywrócone konto będzie mieć czas-To-Live wyłączone po pomyślnym przywróceniu.	Bool

ShardKeys

Nazwa	Opis	Wartość

Tagi

Nazwa	Opis	Wartość

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Szablon	Opis
Tworzenie konta usługi Azure Cosmos dla interfejsu API bazy danych MongoDB wdrażanie	Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API bazy danych MongoDB 4.2 w dwóch regionach przy użyciu udostępnionej i dedykowanej przepływności z dwiema kolekcjami.
Tworzenie konta usługi Azure Cosmos dla interfejsu API bazy danych MongoDB wdrażanie	Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API bazy danych MongoDB 4.2 w dwóch regionach przy użyciu udostępnionej i dedykowanej przepływności autoskalowania.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu databaseAccounts/mongodbDatabases/collections można wdrożyć przy użyciu operacji docelowych:

• grupy zasobów

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/mongodbDatabases/collections, dodaj następujący program Terraform do szablonu.

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

Wartości właściwości

AutoskalowanieUstawienia

Nazwa	Opis	Wartość
maxThroughput	Reprezentuje maksymalną przepływność, zasób może być skalowany w górę do.	Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nazwa	Opis	Wartość

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Nazwa	Opis	Wartość
autoskalowanieUstawienia	Określa ustawienia autoskalu. Uwaga: wymagana jest przepływność lub autoskalowanieUstawienia, ale nie obie.	AutoskalowanieUstawienia
przepustowość	Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000.	Int

ManagedServiceIdentity

Nazwa	Opis	Wartość
typ	Typ tożsamości używany dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi.	"Brak" "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned"
userAssignedIdentities	Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nazwa	Opis	Wartość

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Nazwa	Opis	Wartość
tożsamość	Tożsamość zasobu.	ManagedServiceIdentity
lokalizacja	Lokalizacja grupy zasobów, do której należy zasób.	struna
nazwa	Nazwa zasobu	ciąg (wymagany)
parent_id	Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu.	Identyfikator zasobu typu: databaseAccounts/mongodbDatabases
Właściwości	Właściwości do tworzenia i aktualizowania kolekcji mongoDB usługi Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (wymagane)
Tagi	Tagi zasobów	Słownik nazw tagów i wartości.
typ	Typ zasobu	"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-05-15-preview"

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Nazwa	Opis	Wartość
Opcje	Para klucz-wartość opcji, które mają zostać zastosowane do żądania. Odpowiada to nagłówkom wysyłanym z żądaniem.	CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
zasób	Standardowy format JSON kolekcji mongoDB	MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (wymagane)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Nazwa	Opis	Wartość
analyticalStorageTtl	Analityczny czas wygaśnięcia.	Int
createMode	Wyliczenie wskazujące tryb tworzenia zasobów.	"Wartość domyślna" "Przywracanie"
id	Nazwa kolekcji MongoDB usługi Cosmos DB	ciąg (wymagany)
Indeksy	Lista kluczy indeksu	MongoIndex []
restoreParameters	Parametry wskazujące informacje o przywracaniu	ResourceRestoreParameters
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

ResourceRestoreParameters

Nazwa	Opis	Wartość
restoreSource	Identyfikator przywracalnego konta bazy danych, z którego należy zainicjować przywracanie. Na przykład: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}	struna
restoreTimestampInUtc	Godzina przywrócenia konta (format ISO-8601).	struna
restoreWithTtlDisabled	Określa, czy przywrócone konto będzie mieć czas-To-Live wyłączone po pomyślnym przywróceniu.	Bool

ShardKeys

Nazwa	Opis	Wartość

Tagi

Nazwa	Opis	Wartość