Microsoft.DocumentDB databaseAccounts/mongodbDatabases 2022-11-15-preview
- Neueste
- 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
- 15.03.2023
- 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
- 15.06.2021
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-15
- 2021-03-01-preview
- 15.1.2021
- 2020-09-01
- 2020-06-01-preview
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
Bicep-Ressourcendefinition
Der Ressourcentyp databaseAccounts/mongodbDatabases kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Bereitstellungsbefehle für Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Ressource Microsoft.DocumentDB/databaseAccounts/mongodbDatabases zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2022-11-15-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
options: {
autoscaleSettings: {
maxThroughput: int
}
throughput: int
}
resource: {
createMode: 'string'
id: 'string'
restoreParameters: {
restoreSource: 'string'
restoreTimestampInUtc: 'string'
}
}
}
}
Eigenschaftswerte
databaseAccounts/mongodbDatabases
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Der Ressourcenname Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in Bicep. |
Zeichenfolge (erforderlich) |
| location | Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. | Zeichenfolge |
| tags | Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Beispielsweise ist die Standardumgebung für einen Vorlagentyp auf "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB". | Wörterbuch der Tagnamen und -werte. Weitere Informationen finden Sie unter Tags in Vorlagen. |
| parent | In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird. Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource. |
Symbolischer Name für Ressource vom Typ: databaseAccounts |
| Identität | Identität für die Ressource. | ManagedServiceIdentity |
| properties | Eigenschaften zum Erstellen und Aktualisieren einer MongoDB-Datenbank in Azure Cosmos DB. | MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... (erforderlich) |
ManagedServiceIdentity
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" umfasst sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. | "Keine" "SystemAssigned" 'SystemAssigned,UserAssigned' "UserAssigned" |
| userAssignedIdentities | Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs im Format "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.
MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Optionen | Ein Schlüssel-Wert-Paar von Optionen, die für die Anforderung angewendet werden sollen. Dies entspricht den Headern, die mit der Anforderung gesendet wurden. | CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt... |
| resource | Das JSON-Standardformat einer MongoDB-Datenbank | MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie... (erforderlich) |
CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| autoscaleSettings | Gibt die Einstellungen für die automatische Skalierung an. | AutoscaleSettings |
| throughput | Anforderungseinheiten pro Sekunde. Beispiel: "Durchsatz": 10000. | INT |
AutoscaleSettings
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| maxThroughput | Stellt den maximalen Durchsatz dar, auf den die Ressource hochskaliert werden kann. | INT |
MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| createMode | Enumeration, um den Modus der Ressourcenerstellung anzugeben. | 'Standardwert' "Wiederherstellen" |
| id | Name der Cosmos DB MongoDB-Datenbank | Zeichenfolge (erforderlich) |
| restoreParameters | Parameter zum Angeben der Informationen zur Wiederherstellung | ResourceRestoreParameters |
ResourceRestoreParameters
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| restoreSource | Die ID des wiederherstellbaren Datenbankkontos, von dem aus die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | Zeichenfolge |
| restoreTimestampInUtc | Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format). | Zeichenfolge |
Schnellstartvorlagen
Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.
| Vorlage | BESCHREIBUNG |
|---|---|
Erstellen eines Azure Cosmos-Kontos für die MongoDB-API |
Mit dieser Vorlage wird ein Azure Cosmos DB-Konto für die MongoDB-API 4.2 in zwei Regionen mit freigegebenem und dediziertem Durchsatz mit zwei Sammlungen erstellt. |
| Erstellen eines Azure Cosmos-Kontos für die automatische Skalierung der MongoDB-API |
Mit dieser Vorlage wird ein Azure Cosmos DB-Konto für die MongoDB-API 4.2 in zwei Regionen erstellt, wobei sowohl der freigegebene als auch der dedizierte Durchsatz für die automatische Skalierung verwendet wird. |
Ressourcendefinition mit einer ARM-Vorlage
Der Ressourcentyp databaseAccounts/mongodbDatabases kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen : Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.DocumentDB/databaseAccounts/mongodbDatabases-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases",
"apiVersion": "2022-11-15-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"options": {
"autoscaleSettings": {
"maxThroughput": "int"
},
"throughput": "int"
},
"resource": {
"createMode": "string",
"id": "string",
"restoreParameters": {
"restoreSource": "string",
"restoreTimestampInUtc": "string"
}
}
}
}
Eigenschaftswerte
databaseAccounts/mongodbDatabases
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Ressourcentyp | "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases" |
| apiVersion | Die Ressourcen-API-Version | "15.11.2022" |
| name | Der Ressourcenname Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen festlegen. |
Zeichenfolge (erforderlich) |
| location | Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. | Zeichenfolge |
| tags | Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Die Standardumgebung für einen Vorlagentyp ist beispielsweise mit "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB". | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
| Identität | Identität für die Ressource. | ManagedServiceIdentity |
| properties | Eigenschaften zum Erstellen und Aktualisieren einer MongoDB-Datenbank in Azure Cosmos DB. | MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... (erforderlich) |
ManagedServiceIdentity
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. | "Keine" "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| userAssignedIdentities | Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Bei den Referenzdaten des Benutzeridentitätswörterbuchs handelt es sich um ARM-Ressourcen-IDs in der Form : "/subscriptions/{subscriptionId}/resourceGroupGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.
MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Optionen | Ein Schlüssel-Wert-Paar von Optionen, die für die Anforderung angewendet werden sollen. Dies entspricht den Headern, die mit der Anforderung gesendet wurden. | CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt... |
| resource | Das JSON-Standardformat einer MongoDB-Datenbank | MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie... (erforderlich) |
CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| autoscaleSettings | Gibt die Einstellungen für die automatische Skalierung an. | AutoscaleSettings |
| throughput | Anforderungseinheiten pro Sekunde. Beispiel: "Durchsatz": 10000. | INT |
AutoscaleSettings
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| maxThroughput | Stellt den maximalen Durchsatz dar, auf den die Ressource hochskaliert werden kann. | INT |
MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| createMode | Enumeration, um den Modus der Ressourcenerstellung anzugeben. | 'Standardwert' "Wiederherstellen" |
| id | Name der Cosmos DB MongoDB-Datenbank | Zeichenfolge (erforderlich) |
| restoreParameters | Parameter zum Angeben der Informationen zur Wiederherstellung | ResourceRestoreParameters |
ResourceRestoreParameters
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| restoreSource | Die ID des wiederherstellbaren Datenbankkontos, von dem aus die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | Zeichenfolge |
| restoreTimestampInUtc | Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format). | Zeichenfolge |
Schnellstartvorlagen
Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.
| Vorlage | BESCHREIBUNG |
|---|---|
| Erstellen eines Azure Cosmos-Kontos für die MongoDB-API |
Mit dieser Vorlage wird ein Azure Cosmos DB-Konto für die MongoDB-API 4.2 in zwei Regionen mit freigegebenem und dediziertem Durchsatz mit zwei Sammlungen erstellt. |
| Erstellen eines Azure Cosmos-Kontos für die automatische Skalierung der MongoDB-API |
Mit dieser Vorlage wird ein Azure Cosmos DB-Konto für die MongoDB-API 4.2 in zwei Regionen erstellt, wobei sowohl der freigegebene als auch der dedizierte Durchsatz für die automatische Skalierung verwendet wird. |
Terraform (AzAPI-Anbieter) Ressourcendefinition
Der Ressourcentyp databaseAccounts/mongodbDatabases kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.DocumentDB/databaseAccounts/mongodbDatabases-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2022-11-15-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
options = {
autoscaleSettings = {
maxThroughput = int
}
throughput = int
}
resource = {
createMode = "string"
id = "string"
restoreParameters = {
restoreSource = "string"
restoreTimestampInUtc = "string"
}
}
}
})
}
Eigenschaftswerte
databaseAccounts/mongodbDatabases
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Ressourcentyp | "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2022-11-15-preview" |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| location | Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. | Zeichenfolge |
| parent_id | Die ID der Ressource, die die übergeordnete Ressource für diese Ressource ist. | ID für Ressource vom Typ: databaseAccounts |
| tags | Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Die Standardumgebung für einen Vorlagentyp ist beispielsweise mit "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB". | Wörterbuch der Tagnamen und -werte. |
| Identität | Identität für die Ressource. | ManagedServiceIdentity |
| properties | Eigenschaften zum Erstellen und Aktualisieren einer MongoDB-Datenbank in Azure Cosmos DB. | MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... (erforderlich) |
ManagedServiceIdentity
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| identity_ids | Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Bei den Referenzdaten des Benutzeridentitätswörterbuchs handelt es sich um ARM-Ressourcen-IDs in der Form : "/subscriptions/{subscriptionId}/resourceGroupGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | Array von Benutzeridentitäts-IDs. |
ManagedServiceIdentityUserAssignedIdentities
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.
MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Optionen | Ein Schlüssel-Wert-Paar von Optionen, die für die Anforderung angewendet werden sollen. Dies entspricht den Headern, die mit der Anforderung gesendet wurden. | CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt... |
| resource | Das JSON-Standardformat einer MongoDB-Datenbank | MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie... (erforderlich) |
CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| autoscaleSettings | Gibt die Einstellungen für die automatische Skalierung an. | AutoscaleSettings |
| throughput | Anforderungseinheiten pro Sekunde. Beispiel: "Durchsatz": 10000. | INT |
AutoscaleSettings
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| maxThroughput | Stellt den maximalen Durchsatz dar, auf den die Ressource hochskaliert werden kann. | INT |
MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| createMode | Enumeration, um den Modus der Ressourcenerstellung anzugeben. | "Standard" "Wiederherstellen" |
| id | Name der Cosmos DB MongoDB-Datenbank | Zeichenfolge (erforderlich) |
| restoreParameters | Parameter zum Angeben der Informationen zur Wiederherstellung | ResourceRestoreParameters |
ResourceRestoreParameters
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| restoreSource | Die ID des wiederherstellbaren Datenbankkontos, von dem aus die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | Zeichenfolge |
| restoreTimestampInUtc | Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format). | Zeichenfolge |