Microsoft.DocumentDB-databaseAccounts/mongodbDatabases 2022-11-15-preview
- Laatste
- 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
- 15-11-2021-preview
- 2021-10-15
- 15-10-2021-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
Bicep-resourcedefinitie
Het resourcetype databaseAccounts/mongodbDatabases kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor resourcegroepimplementatie
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een resource Microsoft.DocumentDB/databaseAccounts/mongodbDatabases wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.
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'
}
}
}
}
Eigenschapswaarden
databaseAccounts/mongodbDatabases
| Naam | Description | Waarde |
|---|---|---|
| naam | De resourcenaam Meer informatie over het instellen van namen en typen voor onderliggende resources in Bicep. |
tekenreeks (vereist) |
| location | De locatie van de resourcegroep waartoe de resource behoort. | tekenreeks |
| tags | Tags zijn een lijst met sleutel-waardeparen die de resource beschrijven. Deze tags kunnen worden gebruikt bij het weergeven en groeperen van deze resource (in resourcegroepen). Er kunnen maximaal 15 tags worden opgegeven voor een resource. Elke tag moet een sleutel hebben die niet groter is dan 128 tekens en een waarde van niet meer dan 256 tekens. De standaardervaring voor een sjabloontype is bijvoorbeeld ingesteld met 'defaultExperience': 'Cassandra'. Huidige waarden voor 'defaultExperience' omvatten ook 'Table', 'Graph', 'DocumentDB' en 'MongoDB'. | Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken |
| Bovenliggende | In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd. Zie Onderliggende resource buiten bovenliggende resource voor meer informatie. |
Symbolische naam voor resource van het type: databaseAccounts |
| identity | Identiteit voor de resource. | ManagedServiceIdentity |
| properties | Eigenschappen voor het maken en bijwerken van een Azure Cosmos DB MongoDB-database. | MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... (vereist) |
ManagedServiceIdentity
| Naam | Description | Waarde |
|---|---|---|
| type | Het type identiteit dat voor de resource wordt gebruikt. Het type 'SystemAssigned,UserAssigned' bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' worden alle identiteiten uit de service verwijderd. | 'Geen' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
| userAssignedIdentities | De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen naar de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. | ManagedServiceIdentityUserAssignedId-entiteiten |
ManagedServiceIdentityUserAssignedId-entiteiten
| Naam | Description | Waarde |
|---|---|---|
| {aangepaste eigenschap} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn Alleen-lezen.
MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...
| Naam | Description | Waarde |
|---|---|---|
| opties | Een sleutel-waardepaar met opties die voor de aanvraag moeten worden toegepast. Dit komt overeen met de headers die met de aanvraag zijn verzonden. | CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt... |
| resource | De standaard-JSON-indeling van een MongoDB-database | MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie... (vereist) |
CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...
| Naam | Description | Waarde |
|---|---|---|
| instellingen voor automatisch schalen | Hiermee geeft u de instellingen voor automatisch schalen. | Instellingen voor automatisch schalen |
| doorvoer | Aanvraageenheden per seconde. Bijvoorbeeld 'doorvoer': 10000. | int |
Instellingen voor automatisch schalen
| Naam | Description | Waarde |
|---|---|---|
| maxThroughput | Staat voor maximale doorvoer, de resource kan omhoog worden geschaald. | int |
MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...
| Naam | Description | Waarde |
|---|---|---|
| createMode | Opsomming om de modus voor het maken van resources aan te geven. | 'Standaard' 'Herstellen' |
| id | Naam van de Cosmos DB MongoDB-database | tekenreeks (vereist) |
| restoreParameters | Parameters om de informatie over de herstelbewerking aan te geven | ResourceRestoreParameters |
ResourceRestoreParameters
| Naam | Description | Waarde |
|---|---|---|
| restoreSource | De id van het herstelbare databaseaccount van waaruit het herstel moet worden gestart. Bijvoorbeeld: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | tekenreeks |
| restoreTimestampInUtc | Het tijdstip waarop het account moet worden hersteld (ISO-8601-indeling). | tekenreeks |
Snelstartsjablonen
Met de volgende snelstartsjablonen wordt dit resourcetype geïmplementeerd.
| Template | Beschrijving |
|---|---|
Een Azure Cosmos-account maken voor MongoDB-API |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor MongoDB API 4.2 in twee regio's met behulp van gedeelde en toegewezen doorvoer met twee verzamelingen. |
| Een Azure Cosmos-account maken voor automatische schaalaanpassing van mongoDB-API |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor MongoDB API 4.2 in twee regio's met behulp van zowel gedeelde als toegewezen doorvoer voor automatisch schalen. |
Resourcedefinitie van ARM-sjabloon
Het resourcetype databaseAccounts/mongodbDatabases kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor resourcegroepimplementatie
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Resource Microsoft.DocumentDB/databaseAccounts/mongodbDatabases wilt maken, voegt u de volgende JSON toe aan uw sjabloon.
{
"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"
}
}
}
}
Eigenschapswaarden
databaseAccounts/mongodbDatabases
| Naam | Description | Waarde |
|---|---|---|
| type | Het resourcetype | 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases' |
| apiVersion | De resource-API-versie | '2022-11-15-preview' |
| naam | De resourcenaam Meer informatie over het instellen van namen en typen voor onderliggende resources in JSON ARM-sjablonen. |
tekenreeks (vereist) |
| location | De locatie van de resourcegroep waartoe de resource behoort. | tekenreeks |
| tags | Tags zijn een lijst met sleutel-waardeparen die de resource beschrijven. Deze tags kunnen worden gebruikt bij het weergeven en groeperen van deze resource (tussen resourcegroepen). Er kunnen maximaal 15 tags worden opgegeven voor een resource. Elke tag moet een sleutel hebben die niet groter is dan 128 tekens en de waarde niet groter is dan 256 tekens. De standaardervaring voor een sjabloontype is bijvoorbeeld ingesteld met 'defaultExperience': 'Cassandra'. Huidige 'defaultExperience'-waarden omvatten ook 'Table', 'Graph', 'DocumentDB' en 'MongoDB'. | Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken |
| identity | Identiteit voor de resource. | ManagedServiceIdentity |
| properties | Eigenschappen voor het maken en bijwerken van een Azure Cosmos DB MongoDB-database. | MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... (vereist) |
ManagedServiceIdentity
| Naam | Description | Waarde |
|---|---|---|
| type | Het type identiteit dat voor de resource wordt gebruikt. Het type 'SystemAssigned,UserAssigned' bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' worden alle identiteiten uit de service verwijderd. | 'Geen' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
| userAssignedIdentities | De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen naar de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. | ManagedServiceIdentityUserAssignedId-entiteiten |
ManagedServiceIdentityUserAssignedId-entiteiten
| Naam | Description | Waarde |
|---|---|---|
| {aangepaste eigenschap} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn ReadOnly.
MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...
| Naam | Description | Waarde |
|---|---|---|
| opties | Een sleutel-waardepaar met opties die moeten worden toegepast op de aanvraag. Dit komt overeen met de headers die met de aanvraag zijn verzonden. | CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt... |
| resource | De standaard JSON-indeling van een MongoDB-database | MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie... (vereist) |
CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...
| Naam | Description | Waarde |
|---|---|---|
| autoscaleSettings | Hiermee geeft u de instellingen voor automatisch schalen op. | Instellingen voor automatisch schalen |
| doorvoer | Aanvraageenheden per seconde. Bijvoorbeeld 'doorvoer': 10000. | int |
Instellingen voor automatisch schalen
| Naam | Description | Waarde |
|---|---|---|
| maxThroughput | Vertegenwoordigt de maximale doorvoer, zodat de resource omhoog kan worden geschaald. | int |
MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...
| Naam | Description | Waarde |
|---|---|---|
| createMode | Opsomming om de modus voor het maken van resources aan te geven. | 'Standaard' 'Herstellen' |
| id | Naam van de Cosmos DB MongoDB-database | tekenreeks (vereist) |
| restoreParameters | Parameters om de informatie over de herstelbewerking aan te geven | ResourceRestoreParameters |
ResourceRestoreParameters
| Naam | Description | Waarde |
|---|---|---|
| restoreSource | De id van het herstelbare databaseaccount van waaruit het herstel moet worden gestart. Bijvoorbeeld: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | tekenreeks |
| restoreTimestampInUtc | Tijd waarop het account moet worden hersteld (ISO-8601-indeling). | tekenreeks |
Snelstartsjablonen
Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.
| Template | Beschrijving |
|---|---|
| Een Azure Cosmos-account maken voor MongoDB-API |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor MongoDB API 4.2 in twee regio's met behulp van gedeelde en toegewezen doorvoer met twee verzamelingen. |
| Een Azure Cosmos-account maken voor automatische schaalaanpassing van MongoDB-API |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor MongoDB API 4.2 in twee regio's met behulp van zowel gedeelde als toegewezen doorvoer voor automatisch schalen. |
Resourcedefinitie van Terraform (AzAPI-provider)
Het resourcetype databaseAccounts/mongodbDatabases kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een resource Microsoft.DocumentDB/databaseAccounts/mongodbDatabases wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
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"
}
}
}
})
}
Eigenschapswaarden
databaseAccounts/mongodbDatabases
| Naam | Description | Waarde |
|---|---|---|
| type | Het resourcetype | "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2022-11-15-preview" |
| naam | De resourcenaam | tekenreeks (vereist) |
| location | De locatie van de resourcegroep waartoe de resource behoort. | tekenreeks |
| parent_id | De id van de resource die het bovenliggende item voor deze resource is. | Id voor resource van het type: databaseAccounts |
| tags | Tags zijn een lijst met sleutel-waardeparen die de resource beschrijven. Deze tags kunnen worden gebruikt bij het weergeven en groeperen van deze resource (in resourcegroepen). Er kunnen maximaal 15 tags worden opgegeven voor een resource. Elke tag moet een sleutel hebben die niet groter is dan 128 tekens en een waarde van niet meer dan 256 tekens. De standaardervaring voor een sjabloontype is bijvoorbeeld ingesteld met 'defaultExperience': 'Cassandra'. Huidige waarden voor 'defaultExperience' omvatten ook 'Table', 'Graph', 'DocumentDB' en 'MongoDB'. | Woordenlijst met tagnamen en -waarden. |
| identity | Identiteit voor de resource. | ManagedServiceIdentity |
| properties | Eigenschappen voor het maken en bijwerken van een Azure Cosmos DB MongoDB-database. | MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... (vereist) |
ManagedServiceIdentity
| Naam | Description | Waarde |
|---|---|---|
| type | Het type identiteit dat voor de resource wordt gebruikt. Het type 'SystemAssigned,UserAssigned' bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' worden alle identiteiten uit de service verwijderd. | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| identity_ids | De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen naar de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. | Matrix met gebruikersidentiteits-id's. |
ManagedServiceIdentityUserAssignedId-entiteiten
| Naam | Description | Waarde |
|---|---|---|
| {aangepaste eigenschap} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn ReadOnly.
MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...
| Naam | Description | Waarde |
|---|---|---|
| opties | Een sleutel-waardepaar met opties die moeten worden toegepast op de aanvraag. Dit komt overeen met de headers die met de aanvraag zijn verzonden. | CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt... |
| resource | De standaard JSON-indeling van een MongoDB-database | MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie... (vereist) |
CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...
| Naam | Description | Waarde |
|---|---|---|
| autoscaleSettings | Hiermee geeft u de instellingen voor automatisch schalen op. | Instellingen voor automatisch schalen |
| doorvoer | Aanvraageenheden per seconde. Bijvoorbeeld 'doorvoer': 10000. | int |
Instellingen voor automatisch schalen
| Naam | Description | Waarde |
|---|---|---|
| maxThroughput | Vertegenwoordigt de maximale doorvoer, zodat de resource omhoog kan worden geschaald. | int |
MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...
| Naam | Description | Waarde |
|---|---|---|
| createMode | Opsomming om de modus voor het maken van resources aan te geven. | "Standaard" "Herstellen" |
| id | Naam van de Cosmos DB MongoDB-database | tekenreeks (vereist) |
| restoreParameters | Parameters om de informatie over de herstelbewerking aan te geven | ResourceRestoreParameters |
ResourceRestoreParameters
| Naam | Description | Waarde |
|---|---|---|
| restoreSource | De id van het herstelbare databaseaccount van waaruit het herstel moet worden gestart. Bijvoorbeeld: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | tekenreeks |
| restoreTimestampInUtc | Tijd waarop het account moet worden hersteld (ISO-8601-indeling). | tekenreeks |