Database Microsoft.DocumentDBAccounts/mongodbDatabases 2023-03-15-preview
- Più recente
- 2024-05-15
- Anteprima 2024-05-15
- Anteprima 2024-02-15
- 2023-11-15
- Anteprima 2023-11-15
- 2023-09-15
- Anteprima 2023-09-15
- 2023-04-15
- 2023-03-15
- Anteprima 2023-03-15
- 2023-03-01-preview
- 2022-11-15
- Anteprima 2022-11-15
- 2022-08-15
- Anteprima 2022-08-15
- 2022-05-15
- Anteprima 2022-05-15
- Anteprima 2022-02-15
- Anteprima 2021-11-15
- 2021-10-15
- Anteprima 2021-10-15
- Anteprima 2021-07-01
- 2021-06-15
- 2021-05-15
- 2021-04-15
- Anteprima 2021-04-01
- 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
Definizione di risorsa Bicep
Il tipo di risorsa databaseAccounts/mongodbDatabases può essere distribuito con operazioni destinate:
- Gruppi di risorse - Vedere i comandi di distribuzione dei gruppi di risorse
Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.
Formato di risorsa
Per creare una risorsa Microsoft.DocumentDB/databaseAccounts/mongodbDatabases, aggiungere il bicep seguente al modello.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2023-03-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'
}
}
}
}
Valori delle proprietà
databaseAccounts/mongodbDatabases
| Nome | Descrizione | valore |
|---|---|---|
| name | Nome della risorsa Vedere come impostare nomi e tipi per le risorse figlio in Bicep. |
stringa (obbligatorio) |
| posizione | Posizione del gruppo di risorse a cui appartiene la risorsa. | string |
| tags | I tag sono un elenco di coppie chiave-valore che descrivono la risorsa. Questi tag possono essere utilizzati nella visualizzazione e nel raggruppamento di questa risorsa (tra gruppi di risorse). È possibile specificare un massimo di 15 tag per una risorsa. Ogni tag deve avere una chiave non superiore a 128 caratteri con un valore che non superi i 256 caratteri. Ad esempio, l'esperienza predefinita per un tipo di modello è impostata con "defaultExperience": "Cassandra". I valori correnti "defaultExperience" includono anche "Table", "Graph", "DocumentDB" e "MongoDB". | Dizionario di nomi e valori di tag. Vedere Tag nei modelli |
| padre | In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre. Per altre informazioni, vedere Risorsa figlio esterna alla risorsa padre. |
Nome simbolico per la risorsa di tipo: databaseAccounts |
| identity | Identità per la risorsa. | ManagedServiceIdentity |
| properties | Proprietà per creare e aggiornare il database MongoDB di Azure Cosmos DB. | MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... (obbligatorio) |
ManagedServiceIdentity
| Nome | Descrizione | Valore |
|---|---|---|
| tipo | Tipo di identità usata per la risorsa. Il tipo 'SystemAssigned,UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo "Nessuno" rimuoverà le identità dal servizio. | 'Nessuno' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
| userAssignedIdentities | Elenco di identità utente associate alla risorsa. I riferimenti alla chiave del dizionario identità utente saranno ID risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Nome | Descrizione | Valore |
|---|---|---|
| {proprietà personalizzata} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.
MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...
| Nome | Descrizione | Valore |
|---|---|---|
| opzioni | Coppia chiave-valore di opzioni da applicare per la richiesta. Corrisponde alle intestazioni inviate con la richiesta. | CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt... |
| Risorsa | Formato JSON standard di un database MongoDB | MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie... (obbligatorio) |
CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...
| Nome | Descrizione | Valore |
|---|---|---|
| autoscaleSettings | Specifica le impostazioni di scalabilità automatica. | Impostazioni di scalabilità automatica |
| throughput | Unità richiesta al secondo. Ad esempio, "velocità effettiva": 10000. | INT |
Impostazioni di scalabilità automatica
| Nome | Descrizione | Valore |
|---|---|---|
| maxThroughput | Rappresenta la velocità effettiva massima, la risorsa può aumentare le prestazioni. | INT |
MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...
| Nome | Descrizione | Valore |
|---|---|---|
| createMode | Enumerazione per indicare la modalità di creazione delle risorse. | Impostazione predefinita 'PointInTimeRestore' 'Restore' |
| id | Nome del database MongoDB di Cosmos DB | stringa (obbligatorio) |
| restoreParameters | Parametri per indicare le informazioni sul ripristino | ResourceRestoreParameters |
ResourceRestoreParameters
| Nome | Descrizione | Valore |
|---|---|---|
| restoreSource | ID dell'account del database ripristinabile da cui deve essere avviato il ripristino. Ad esempio: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | string |
| restoreTimestampInUtc | Ora in cui è necessario ripristinare l'account (formato ISO-8601). | string |
Modelli di avvio rapido
I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.
| Modello | Descrizione |
|---|---|
Creare un account Azure Cosmos per l'API MongoDB |
Questo modello crea un account Azure Cosmos DB per l'API MongoDB 4.2 in due aree usando la velocità effettiva condivisa e dedicata con due raccolte. |
| Creare un account Azure Cosmos per la scalabilità automatica dell'API MongoDB |
Questo modello crea un account Azure Cosmos DB per l'API MongoDB 4.2 in due aree usando la velocità effettiva di scalabilità automatica condivisa e dedicata. |
Definizione di risorsa del modello di Resource Manager
Il tipo di risorsa databaseAccounts/mongodbDatabases può essere distribuito con operazioni destinate:
- Gruppi di risorse - Vedere i comandi di distribuzione dei gruppi di risorse
Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.
Formato di risorsa
Per creare una risorsa Microsoft.DocumentDB/databaseAccounts/mongodbDatabases, aggiungere il codice JSON seguente al modello.
{
"type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases",
"apiVersion": "2023-03-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"
}
}
}
}
Valori delle proprietà
databaseAccounts/mongodbDatabases
| Nome | Descrizione | Valore |
|---|---|---|
| tipo | Tipo di risorsa | 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases' |
| apiVersion | Versione dell'API della risorsa | '2023-03-15-preview' |
| name | Nome della risorsa Informazioni su come impostare nomi e tipi per le risorse figlio nei modelli di Resource Manager JSON. |
stringa (obbligatorio) |
| posizione | Posizione del gruppo di risorse a cui appartiene la risorsa. | string |
| tags | I tag sono un elenco di coppie chiave-valore che descrivono la risorsa. Questi tag possono essere utilizzati nella visualizzazione e nel raggruppamento di questa risorsa (tra gruppi di risorse). È possibile specificare un massimo di 15 tag per una risorsa. Ogni tag deve avere una chiave non superiore a 128 caratteri con un valore che non superi i 256 caratteri. Ad esempio, l'esperienza predefinita per un tipo di modello è impostata con "defaultExperience": "Cassandra". I valori correnti "defaultExperience" includono anche "Table", "Graph", "DocumentDB" e "MongoDB". | Dizionario di nomi e valori di tag. Vedere Tag nei modelli |
| identity | Identità per la risorsa. | ManagedServiceIdentity |
| properties | Proprietà per creare e aggiornare il database MongoDB di Azure Cosmos DB. | MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... (obbligatorio) |
ManagedServiceIdentity
| Nome | Descrizione | Valore |
|---|---|---|
| tipo | Tipo di identità utilizzata per la risorsa. Il tipo 'SystemAssigned,UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo 'Nessuno' rimuoverà le identità dal servizio. | 'Nessuno' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
| userAssignedIdentities | Elenco delle identità utente associate alla risorsa. I riferimenti alla chiave del dizionario delle identità utente saranno id risorsa ARM nel modulo: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Nome | Descrizione | Valore |
|---|---|---|
| {proprietà personalizzata} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.
MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...
| Nome | Descrizione | Valore |
|---|---|---|
| opzioni | Coppia chiave-valore delle opzioni da applicare per la richiesta. Corrisponde alle intestazioni inviate con la richiesta. | CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt... |
| Risorsa | Formato JSON standard di un database MongoDB | MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie... (obbligatorio) |
CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...
| Nome | Descrizione | Valore |
|---|---|---|
| autoscaleSettings | Specifica le impostazioni di scalabilità automatica. | Scalabilità automaticaSettings |
| throughput | Unità richiesta al secondo. Ad esempio, "velocità effettiva": 10000. | INT |
Scalabilità automaticaSettings
| Nome | Descrizione | Valore |
|---|---|---|
| maxThroughput | Rappresenta la velocità effettiva massima, la risorsa può aumentare fino a. | INT |
MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...
| Nome | Descrizione | Valore |
|---|---|---|
| createMode | Enumerazione per indicare la modalità di creazione delle risorse. | Impostazione predefinita 'PointInTimeRestore' 'Restore' |
| id | Nome del database MongoDB di Cosmos DB | stringa (obbligatoria) |
| restoreParameters | Parametri per indicare le informazioni sul ripristino | ResourceRestoreParameters |
ResourceRestoreParameters
| Nome | Descrizione | Valore |
|---|---|---|
| restoreSource | ID dell'account del database ripristinabile da cui deve essere avviato il ripristino. Ad esempio: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | string |
| restoreTimestampInUtc | Ora in cui l'account deve essere ripristinato (formato ISO-8601). | string |
Modelli di avvio rapido
I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.
| Modello | Descrizione |
|---|---|
| Creare un account Azure Cosmos per l'API MongoDB |
Questo modello crea un account Azure Cosmos DB per l'API MongoDB 4.2 in due aree usando velocità effettiva condivisa e dedicata con due raccolte. |
| Creare un account Azure Cosmos per la scalabilità automatica dell'API MongoDB |
Questo modello crea un account Azure Cosmos DB per l'API MongoDB 4.2 in due aree usando la velocità effettiva di scalabilità automatica condivisa e dedicata. |
Definizione della risorsa Terraform (provider AzAPI)
Il tipo di risorsa databaseAccounts/mongodbDatabases può essere distribuito con operazioni destinate:
- Gruppi di risorse
Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.
Formato di risorsa
Per creare una risorsa Microsoft.DocumentDB/databaseAccounts/mongodbDatabases, aggiungere il codice Terraform seguente al modello.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2023-03-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"
}
}
}
})
}
Valori delle proprietà
databaseAccounts/mongodbDatabases
| Nome | Descrizione | Valore |
|---|---|---|
| tipo | Tipo di risorsa | "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2023-03-15-preview" |
| name | Nome della risorsa | stringa (obbligatorio) |
| posizione | Posizione del gruppo di risorse a cui appartiene la risorsa. | string |
| parent_id | ID della risorsa padre per questa risorsa. | ID per la risorsa di tipo: databaseAccounts |
| tags | I tag sono un elenco di coppie chiave-valore che descrivono la risorsa. Questi tag possono essere utilizzati nella visualizzazione e nel raggruppamento di questa risorsa (tra gruppi di risorse). È possibile specificare un massimo di 15 tag per una risorsa. Ogni tag deve avere una chiave non superiore a 128 caratteri con un valore che non superi i 256 caratteri. Ad esempio, l'esperienza predefinita per un tipo di modello è impostata con "defaultExperience": "Cassandra". I valori correnti "defaultExperience" includono anche "Table", "Graph", "DocumentDB" e "MongoDB". | Dizionario di nomi e valori di tag. |
| identity | Identità per la risorsa. | ManagedServiceIdentity |
| properties | Proprietà per creare e aggiornare il database MongoDB di Azure Cosmos DB. | MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... (obbligatorio) |
ManagedServiceIdentity
| Nome | Descrizione | Valore |
|---|---|---|
| tipo | Tipo di identità usata per la risorsa. Il tipo 'SystemAssigned,UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo "Nessuno" rimuoverà le identità dal servizio. | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| identity_ids | Elenco di identità utente associate alla risorsa. I riferimenti alla chiave del dizionario identità utente saranno ID risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | Matrice di ID identità utente. |
ManagedServiceIdentityUserAssignedIdentities
| Nome | Descrizione | Valore |
|---|---|---|
| {proprietà personalizzata} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.
MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...
| Nome | Descrizione | Valore |
|---|---|---|
| opzioni | Coppia chiave-valore di opzioni da applicare per la richiesta. Corrisponde alle intestazioni inviate con la richiesta. | CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt... |
| Risorsa | Formato JSON standard di un database MongoDB | MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie... (obbligatorio) |
CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...
| Nome | Descrizione | Valore |
|---|---|---|
| autoscaleSettings | Specifica le impostazioni di scalabilità automatica. | Impostazioni di scalabilità automatica |
| throughput | Unità richiesta al secondo. Ad esempio, "velocità effettiva": 10000. | INT |
Impostazioni di scalabilità automatica
| Nome | Descrizione | Valore |
|---|---|---|
| maxThroughput | Rappresenta la velocità effettiva massima, la risorsa può aumentare le prestazioni. | INT |
MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...
| Nome | Descrizione | Valore |
|---|---|---|
| createMode | Enumerazione per indicare la modalità di creazione delle risorse. | "Default" "PointInTimeRestore" "Ripristina" |
| id | Nome del database MongoDB di Cosmos DB | stringa (obbligatorio) |
| restoreParameters | Parametri per indicare le informazioni sul ripristino | ResourceRestoreParameters |
ResourceRestoreParameters
| Nome | Descrizione | Valore |
|---|---|---|
| restoreSource | ID dell'account del database ripristinabile da cui deve essere avviato il ripristino. Ad esempio: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | string |
| restoreTimestampInUtc | Ora in cui è necessario ripristinare l'account (formato ISO-8601). | string |