Microsoft.DocumentDB-databaseAccounts 2021-06-15
- 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
- 2016-03-31
- 2016-03-19
- 2015-11-06
- 2015-04-08
- 2015-04-01
Bicep-resourcedefinitie
Het resourcetype databaseAccounts 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 wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2021-06-15' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
kind: 'string'
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
analyticalStorageConfiguration: {
schemaType: 'string'
}
apiProperties: {
serverVersion: 'string'
}
backupPolicy: {
migrationState: {
startTime: 'string'
status: 'string'
targetType: 'string'
}
type: 'string'
// For remaining properties, see BackupPolicy objects
}
capabilities: [
{
name: 'string'
}
]
connectorOffer: 'Small'
consistencyPolicy: {
defaultConsistencyLevel: 'string'
maxIntervalInSeconds: int
maxStalenessPrefix: int
}
cors: [
{
allowedHeaders: 'string'
allowedMethods: 'string'
allowedOrigins: 'string'
exposedHeaders: 'string'
maxAgeInSeconds: int
}
]
createMode: 'string'
databaseAccountOfferType: 'Standard'
defaultIdentity: 'string'
disableKeyBasedMetadataWriteAccess: bool
disableLocalAuth: bool
enableAnalyticalStorage: bool
enableAutomaticFailover: bool
enableCassandraConnector: bool
enableFreeTier: bool
enableMultipleWriteLocations: bool
ipRules: [
{
ipAddressOrRange: 'string'
}
]
isVirtualNetworkFilterEnabled: bool
keyVaultKeyUri: 'string'
locations: [
{
failoverPriority: int
isZoneRedundant: bool
locationName: 'string'
}
]
networkAclBypass: 'string'
networkAclBypassResourceIds: [
'string'
]
publicNetworkAccess: 'string'
restoreParameters: {
databasesToRestore: [
{
collectionNames: [
'string'
]
databaseName: 'string'
}
]
restoreMode: 'PointInTime'
restoreSource: 'string'
restoreTimestampInUtc: 'string'
}
virtualNetworkRules: [
{
id: 'string'
ignoreMissingVNetServiceEndpoint: bool
}
]
}
}
BackupPolicy-objecten
Stel de eigenschap type in om het type object op te geven.
Voor Doorlopend gebruikt u:
type: 'Continuous'
Voor Periodiek gebruikt u:
type: 'Periodic'
periodicModeProperties: {
backupIntervalInMinutes: int
backupRetentionIntervalInHours: int
}
Eigenschapswaarden
databaseAccounts
| Naam | Description | Waarde |
|---|---|---|
| naam | De resourcenaam | tekenreeks (vereist) Tekenlimiet: 3-44 Geldige tekens: Kleine letters, cijfers en afbreekstreepjes. Begin met kleine letter of cijfer. De resourcenaam moet uniek zijn in Azure. |
| 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 |
| Soort | Geeft het type databaseaccount aan. Dit kan alleen worden ingesteld bij het maken van een databaseaccount. | 'GlobalDocumentDB' 'MongoDB' 'Parseren' |
| identity | Identiteit voor de resource. | ManagedServiceIdentity |
| properties | Eigenschappen voor het maken en bijwerken van Azure Cosmos DB-databaseaccounts. | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (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.
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...
| Naam | Description | Waarde |
|---|---|---|
| analyticalStorageConfiguration | Specifieke eigenschappen van analytische opslag. | AnalyticalStorageConfiguration |
| apiProperties | API-specifieke eigenschappen. Momenteel alleen ondersteund voor MongoDB-API. | ApiProperties |
| backupPolicy | Het object dat het beleid vertegenwoordigt voor het maken van back-ups voor een account. | BackupPolicy |
| mogelijkheden | Lijst met Cosmos DB-mogelijkheden voor het account | Mogelijkheid[] |
| connectorOffer | Het aanbiedingstype cassandra-connector voor het C*-account van de Cosmos DB-database. | 'Klein' |
| consistencyPolicy | Het consistentiebeleid voor het Cosmos DB-account. | ConsistencyPolicy |
| cors | Het CORS-beleid voor het Cosmos DB-databaseaccount. | CorsPolicy[] |
| createMode | Opsomming om de modus voor het maken van een account aan te geven. | 'Standaard' 'Herstellen' |
| databaseAccountOfferType | Het aanbiedingstype voor de database | Standaard (vereist) |
| defaultIdentity | De standaardidentiteit voor toegang tot de sleutelkluis die wordt gebruikt in functies zoals door de klant beheerde sleutels. De standaardidentiteit moet expliciet worden ingesteld door de gebruikers. Dit kan 'FirstPartyIdentity', 'SystemAssignedIdentity' en meer zijn. | tekenreeks |
| disableKeyBasedMetadataWriteAccess | Schrijfbewerkingen uitschakelen voor metagegevensresources (databases, containers, doorvoer) via accountsleutels | booleaans |
| disableLocalAuth | Meld u af voor lokale verificatie en zorg ervoor dat alleen MSI en AAD exclusief kunnen worden gebruikt voor verificatie. | booleaans |
| enableAnalyticalStorage | Vlag om aan te geven of opslaganalyse moet worden ingeschakeld. | booleaans |
| enableAutomaticFailover | Hiermee schakelt u automatische failover van de schrijfregio in de zeldzame gebeurtenis dat de regio niet beschikbaar is vanwege een storing. Automatische failover resulteert in een nieuwe schrijfregio voor het account en wordt gekozen op basis van de failoverprioriteiten die voor het account zijn geconfigureerd. | booleaans |
| enableCassandraConnector | Schakelt de cassandra-connector in op het Cosmos DB C*-account | booleaans |
| enableFreeTier | Vlag om aan te geven of gratis laag is ingeschakeld. | booleaans |
| enableMultipleWriteLocations | Hiermee kan het account op meerdere locaties schrijven | booleaans |
| ipRules | Lijst met IpRules. | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | Vlag om aan te geven of ACL-regels voor virtuele netwerken moeten worden in- of uitgeschakeld. | booleaans |
| keyVaultKeyUri | De URI van de sleutelkluis | tekenreeks |
| locaties | Een matrix die de geo-replicatielocaties bevat die zijn ingeschakeld voor het Cosmos DB-account. | Locatie[] (vereist) |
| networkAclBypass | Geeft aan welke services firewallcontroles mogen omzeilen. | 'AzureServices' 'Geen' |
| networkAclBypassResourceIds | Een matrix die de resource-id's voor network Acl Bypass voor het Cosmos DB-account bevat. | tekenreeks[] |
| publicNetworkAccess | Of aanvragen van het openbare netwerk zijn toegestaan | 'Uitgeschakeld' Ingeschakeld |
| restoreParameters | Parameters om de informatie over de herstelbewerking aan te geven. | RestoreParameters |
| virtualNetworkRules | Lijst met virtuele netwerk-ACL-regels die zijn geconfigureerd voor het Cosmos DB-account. | VirtualNetworkRule[] |
AnalyticalStorageConfiguration
| Naam | Description | Waarde |
|---|---|---|
| schemaType | Hierin worden de typen schema's voor analytische opslag beschreven. | 'FullFidelity' 'WellDefined' |
ApiProperties
| Naam | Description | Waarde |
|---|---|---|
| serverVersion | Beschrijft de ServerVersion van een MongoDB-account. | '3.2' '3.6' '4.0' |
BackupPolicy
| Naam | Description | Waarde |
|---|---|---|
| migrationState | Het object dat de status van de migratie tussen het back-upbeleid vertegenwoordigt. | BackupPolicyMigrationState |
| type | Het objecttype instellen | Continu Periodiek (vereist) |
BackupPolicyMigrationState
| Naam | Description | Waarde |
|---|---|---|
| startTime | Tijdstip waarop de migratie van het back-upbeleid is gestart (ISO-8601-indeling). | tekenreeks |
| status | Beschrijft de status van de migratie tussen typen back-upbeleid. | 'Voltooid' 'Mislukt' 'InProgress' 'Ongeldig' |
| targetType | Beschrijft het type doelback-upbeleid van de migratie van het back-upbeleid. | 'Doorlopend' 'Periodiek' |
ContinuousModeBackupPolicy
| Naam | Description | Waarde |
|---|---|---|
| type | Beschrijft de modus van back-ups. | 'Doorlopend' (vereist) |
PeriodicModeBackupPolicy
| Naam | Description | Waarde |
|---|---|---|
| type | Beschrijft de modus van back-ups. | 'Periodiek' (vereist) |
| periodicModeProperties | Configuratiewaarden voor periodieke back-upmodus | PeriodicModeProperties |
PeriodicModeProperties
| Naam | Description | Waarde |
|---|---|---|
| backupIntervalInMinutes | Een geheel getal dat het interval in minuten tussen twee back-ups aangeeft | int Beperkingen: Minimumwaarde = 0 |
| backupRetentionIntervalInHours | Een geheel getal dat de tijd (in uren) aangeeft dat elke back-up wordt bewaard | int Beperkingen: Minimumwaarde = 0 |
Mogelijkheid
| Naam | Description | Waarde |
|---|---|---|
| naam | Naam van de Cosmos DB-mogelijkheid. Bijvoorbeeld 'name': 'EnableCassandra'. Huidige waarden zijn ook 'EnableTable' en 'EnableGremlin'. | tekenreeks |
ConsistencyPolicy
| Naam | Description | Waarde |
|---|---|---|
| defaultConsistencyLevel | Het standaardconsistentieniveau en de configuratie-instellingen van het Cosmos DB-account. | 'BoundedStaleness' 'ConsistentPrefix' 'Uiteindelijk' Sessie 'Sterk' (vereist) |
| maxIntervalInSeconds | Bij gebruik met het consistentieniveau Gebonden veroudering vertegenwoordigt deze waarde de tijdsduur van veroudering (in seconden) die wordt getolereerd. Geaccepteerd bereik voor deze waarde is 5 - 86400. Vereist wanneer defaultConsistencyPolicy is ingesteld op 'BoundedStaleness'. | int Beperkingen: Minimumwaarde = 5 Maximale waarde = 86400 |
| maxStalenessPrefix | Wanneer deze waarde wordt gebruikt met het consistentieniveau Gebonden veroudering, vertegenwoordigt deze waarde het aantal verlopen aanvragen dat wordt getolereerd. Geaccepteerd bereik voor deze waarde is 1 – 2.147.483.647. Vereist wanneer defaultConsistencyPolicy is ingesteld op 'BoundedStaleness'. | int Beperkingen: Minimumwaarde = 1 Maximumwaarde = 2147483647 |
CorsPolicy
| Naam | Description | Waarde |
|---|---|---|
| allowedHeaders | De aanvraagheaders die het oorspronkelijke domein kan opgeven voor de CORS-aanvraag. | tekenreeks |
| allowedMethods | De methoden (HTTP-aanvraagwoorden) die het oorspronkelijke domein kan gebruiken voor een CORS-aanvraag. | tekenreeks |
| allowedOrigins | De oorspronkelijke domeinen die een aanvraag mogen indienen bij de service via CORS. | tekenreeks (vereist) |
| exposedHeaders | De antwoordheaders die kunnen worden verzonden in het antwoord op de CORS-aanvraag en die door de browser worden weergegeven aan de verlener van de aanvraag. | tekenreeks |
| maxAgeInSeconds | De maximale hoeveelheid tijd die een browser de VOORBEREIDENDE OPTIES-aanvraag in de cache moet opslaan. | int Beperkingen: Minimumwaarde = 1 Maximumwaarde = 2147483647 |
IpAddressOrRange
| Naam | Description | Waarde |
|---|---|---|
| ipAddressOrRange | Eén IPv4-adres of één IPv4-adresbereik in CIDR-indeling. Opgegeven IP-adressen moeten goed zijn opgemaakt en mogen niet in een van de volgende bereiken zijn opgenomen: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, omdat deze niet kunnen worden afgedwongen door het IP-adresfilter. Voorbeeld van geldige invoer: '23.40.210.245' of '23.40.210.0/8'. | tekenreeks |
Locatie
| Naam | Description | Waarde |
|---|---|---|
| failoverPriority | De failoverprioriteit van de regio. Een failoverprioriteit van 0 geeft een schrijfregio aan. De maximumwaarde voor een failoverprioriteit = (totaal aantal regio's - 1). Failoverprioriteitswaarden moeten uniek zijn voor elk van de regio's waarin het databaseaccount bestaat. | int Beperkingen: Minimumwaarde = 0 |
| isZoneRedundant | Vlag om aan te geven of deze regio een Beschikbaarheidszone-regio is | booleaans |
| locationName | De naam van de regio. | tekenreeks |
RestoreParameters
| Naam | Description | Waarde |
|---|---|---|
| databasesToRestore | Lijst met specifieke databases die beschikbaar zijn voor herstel. | DatabaseRestoreResource[] |
| restoreMode | Beschrijft de modus van het herstellen. | PointInTime |
| 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 |
DatabaseRestoreResource
| Naam | Description | Waarde |
|---|---|---|
| collectionNames | De namen van de verzamelingen die beschikbaar zijn voor herstel. | tekenreeks[] |
| databaseName | De naam van de database die beschikbaar is voor herstel. | tekenreeks |
VirtualNetworkRule
| Naam | Description | Waarde |
|---|---|---|
| id | Resource-id van een subnet, bijvoorbeeld: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. | tekenreeks |
| ignoreMissingVNetServiceEndpoint | Maak een firewallregel voordat het vnet-service-eindpunt is ingeschakeld voor het virtuele netwerk. | booleaans |
Snelstartsjablonen
Met de volgende snelstartsjablonen wordt dit resourcetype geïmplementeerd.
| Template | Beschrijving |
|---|---|
CI/CD met Jenkins in Azure Container Service (AKS) |
Containers maken het heel eenvoudig voor u om continu uw toepassingen te bouwen en te implementeren. Door de implementatie van deze containers te organiseren met behulp van Kubernetes in Azure Container Service, kunt u repliceerbare, beheerbare clusters van containers bereiken. Door een continue build in te stellen om uw containerinstallatiekopieën en indeling te produceren, kunt u de snelheid en betrouwbaarheid van uw implementatie verhogen. |
| Web-app met een SQL Database, Azure Cosmos DB, Azure Search |
Met deze sjabloon richt u een web-app, een SQL Database, Azure Cosmos DB, Azure Search en Application Insights in. |
| Een Azure Cosmos DB-account maken voor Cassandra-API |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor Cassandra-API in twee regio's met een keyspace en een tabel met toegewezen doorvoer. |
| Een Azure Cosmos DB-account voor automatische schaalaanpassing maken voor cassandra-API |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor Cassandra-API in twee regio's met een keyspace en een tabel met doorvoer voor automatische schaalaanpassing. |
| Een Azure CosmosDB-account maken |
Deze ARM-sjabloon is bedoeld om snel een CosmosDB-account te maken met de minimale vereiste waarden |
| Een Azure Cosmos DB-account maken in meerdere regio's |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor elk type database-API met een primaire en secundaire regio met keuze uit consistentieniveau en failovertype. |
| Een Gratis Azure Cosmos DB-account maken |
Met deze sjabloon maakt u een Gratis Azure Cosmos DB-account voor SQL API met een database met gedeelde doorvoer en container. |
| Een Azure Cosmos DB-account maken voor Gremlin-API |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor Gremlin-API in twee regio's met één database en één grafiek met behulp van toegewezen doorvoer. |
| Een Azure Cosmos DB-account maken voor automatische schaalaanpassing van gremlin-API's |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor Gremlin-API in twee regio's met één database en één grafiek met behulp van doorvoer voor automatische schaalaanpassing. |
| 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. |
| Een Azure Cosmos DB-account maken met een privé-eindpunt |
Met deze sjabloon maakt u een Cosmos-account, een virtueel netwerk en een privé-eindpunt dat het Cosmos-account beschikbaar maakt voor het virtuele netwerk. |
| Een Azure Cosmos DB-account maken voor Core (SQL) API |
Met deze sjabloon maakt u een Azure Cosmos-account voor Core (SQL) API met een database en een container met doorvoer met meerdere andere opties. |
| SQL-API voor Azure Cosmos DB-account met analytische opslag |
Met deze sjabloon maakt u een Azure Cosmos-account voor Core (SQL) API met een database en container die zijn geconfigureerd met analytische opslag. |
| Een SQL-API voor een Azure Cosmos DB-account maken met automatische schaalaanpassing |
Met deze sjabloon maakt u een Azure Cosmos-account voor Core (SQL) API met een database en een container met doorvoer voor automatische schaalaanpassing met meerdere andere opties. |
| Opgeslagen procedures voor Azure Cosmos DB Core (SQL) API maken |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor Core (SQL) API en een container met een opgeslagen procedure, trigger en door de gebruiker gedefinieerde functie. |
| Een minimaal Azure Cosmos DB-account maken voor Core (SQL) API |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor de Core (SQL) API terwijl alleen de minimaal vereiste resource-eigenschappen worden opgegeven. |
| Azure Cosmos maken met SQL API en meerdere containers |
Met de sjabloon maakt u een Cosmos-container met een SQL-API en kunt u meerdere containers toevoegen. |
| Een Azure Cosmos DB SQL-account maken met gegevensvlak-RBAC |
Met deze sjabloon maakt u een SQL Cosmos-account, een systeemeigen onderhouden roldefinitie en een systeemeigen onderhouden roltoewijzing voor een AAD-identiteit. |
| Een serverloos Azure Cosmos DB-account maken voor SQL API |
Met deze sjabloon maakt u een serverloos Azure Cosmos DB-account voor de Core (SQL) API. |
| Een Azure Cosmos-account maken voor Table-API |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor table-API in twee regio's en één tabel met ingerichte doorvoer. |
| Een Azure Cosmos-account maken voor Table-API met automatische schaalaanpassing |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor table-API in twee regio's en één tabel met doorvoer voor automatische schaalaanpassing. |
| Een zero touch Azure Cosmos-account en Azure-web-app maken |
Met deze sjabloon maakt u een Azure Cosmos-account, injecteert u het Cosmos DB-eindpunt en de sleutels in azure-web-app-instellingen en implementeert u vervolgens een ASP MVC-web-app vanuit GitHub. |
| Een Cosmos DB-account maken met Microsoft Defender ingeschakeld |
Met deze ARM-sjabloon kunt u een Azure Cosmos DB-account implementeren met Microsoft Defender voor Azure Cosmos DB ingeschakeld. Microsoft Defender voor Azure Cosmos DB is een systeemeigen Azure-beveiligingslaag die pogingen detecteert om gebruik te maken van databases in uw Azure Cosmos DB-accounts. Microsoft Defender voor Azure Cosmos DB detecteert potentiële SQL-injecties, bekende slechte actoren op basis van Microsoft Threat Intelligence, verdachte toegangspatronen en mogelijke misbruiken van uw database via gecompromitteerde identiteiten of kwaadwillende insiders. |
| Azure Data Explorer DB implementeren met Cosmos DB-verbinding |
Implementeer Azure Data Explorer DB met Cosmos DB-verbinding. |
| Azure Cosmos DB-account met web-app |
Met deze sjabloon implementeert u een Azure Cosmos DB-account en een App Service-plan en maakt u een web-app in het App Service-plan. Er worden ook twee toepassingsinstellingen toegevoegd aan de web-app die verwijzen naar het Eindpunt van het Azure Cosmos DB-account. Op deze manier kunnen oplossingen die zijn geïmplementeerd in de web-app, verbinding maken met het eindpunt van het Azure Cosmos DB-account met behulp van deze instellingen. |
Resourcedefinitie van ARM-sjabloon
Het resourcetype databaseAccounts 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 wilt maken, voegt u de volgende JSON toe aan uw sjabloon.
{
"type": "Microsoft.DocumentDB/databaseAccounts",
"apiVersion": "2021-06-15",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"kind": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"analyticalStorageConfiguration": {
"schemaType": "string"
},
"apiProperties": {
"serverVersion": "string"
},
"backupPolicy": {
"migrationState": {
"startTime": "string",
"status": "string",
"targetType": "string"
},
"type": "string"
// For remaining properties, see BackupPolicy objects
},
"capabilities": [
{
"name": "string"
}
],
"connectorOffer": "Small",
"consistencyPolicy": {
"defaultConsistencyLevel": "string",
"maxIntervalInSeconds": "int",
"maxStalenessPrefix": "int"
},
"cors": [
{
"allowedHeaders": "string",
"allowedMethods": "string",
"allowedOrigins": "string",
"exposedHeaders": "string",
"maxAgeInSeconds": "int"
}
],
"createMode": "string",
"databaseAccountOfferType": "Standard",
"defaultIdentity": "string",
"disableKeyBasedMetadataWriteAccess": "bool",
"disableLocalAuth": "bool",
"enableAnalyticalStorage": "bool",
"enableAutomaticFailover": "bool",
"enableCassandraConnector": "bool",
"enableFreeTier": "bool",
"enableMultipleWriteLocations": "bool",
"ipRules": [
{
"ipAddressOrRange": "string"
}
],
"isVirtualNetworkFilterEnabled": "bool",
"keyVaultKeyUri": "string",
"locations": [
{
"failoverPriority": "int",
"isZoneRedundant": "bool",
"locationName": "string"
}
],
"networkAclBypass": "string",
"networkAclBypassResourceIds": [ "string" ],
"publicNetworkAccess": "string",
"restoreParameters": {
"databasesToRestore": [
{
"collectionNames": [ "string" ],
"databaseName": "string"
}
],
"restoreMode": "PointInTime",
"restoreSource": "string",
"restoreTimestampInUtc": "string"
},
"virtualNetworkRules": [
{
"id": "string",
"ignoreMissingVNetServiceEndpoint": "bool"
}
]
}
}
BackupPolicy-objecten
Stel de eigenschap type in om het type object op te geven.
Voor Doorlopend gebruikt u:
"type": "Continuous"
Voor Periodiek gebruikt u:
"type": "Periodic",
"periodicModeProperties": {
"backupIntervalInMinutes": "int",
"backupRetentionIntervalInHours": "int"
}
Eigenschapswaarden
databaseAccounts
| Naam | Description | Waarde |
|---|---|---|
| type | Het resourcetype | 'Microsoft.DocumentDB/databaseAccounts' |
| apiVersion | De resource-API-versie | '2021-06-15' |
| naam | De resourcenaam | tekenreeks (vereist) Tekenlimiet: 3-44 Geldige tekens: Kleine letters, cijfers en afbreekstreepjes. Begin met kleine letter of cijfer. De resourcenaam moet uniek zijn in Azure. |
| 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 |
| Soort | Geeft het type databaseaccount aan. Dit kan alleen worden ingesteld bij het maken van een databaseaccount. | 'GlobalDocumentDB' 'MongoDB' 'Parseren' |
| identity | Identiteit voor de resource. | ManagedServiceIdentity |
| properties | Eigenschappen voor het maken en bijwerken van Azure Cosmos DB-databaseaccounts. | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (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.
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...
| Naam | Description | Waarde |
|---|---|---|
| analyticalStorageConfiguration | Specifieke eigenschappen van analytische opslag. | AnalyticalStorageConfiguration |
| apiProperties | API-specifieke eigenschappen. Momenteel alleen ondersteund voor MongoDB-API. | ApiProperties |
| backupPolicy | Het object dat het beleid vertegenwoordigt voor het maken van back-ups voor een account. | BackupPolicy |
| mogelijkheden | Lijst met Cosmos DB-mogelijkheden voor het account | Mogelijkheid[] |
| connectorOffer | Het aanbiedingstype cassandra-connector voor het C*-account van de Cosmos DB-database. | 'Klein' |
| consistencyPolicy | Het consistentiebeleid voor het Cosmos DB-account. | ConsistencyPolicy |
| cors | Het CORS-beleid voor het Cosmos DB-databaseaccount. | CorsPolicy[] |
| createMode | Opsomming om de modus voor het maken van een account aan te geven. | 'Standaard' 'Herstellen' |
| databaseAccountOfferType | Het aanbiedingstype voor de database | 'Standaard' (vereist) |
| defaultIdentity | De standaardidentiteit voor toegang tot de sleutelkluis die wordt gebruikt in functies zoals door de klant beheerde sleutels. De standaardidentiteit moet expliciet worden ingesteld door de gebruikers. Dit kan 'FirstPartyIdentity', 'SystemAssignedIdentity' en meer zijn. | tekenreeks |
| disableKeyBasedMetadataWriteAccess | Schrijfbewerkingen uitschakelen voor metagegevensresources (databases, containers, doorvoer) via accountsleutels | booleaans |
| disableLocalAuth | Meld u af voor lokale verificatie en zorg ervoor dat alleen MSI en AAD exclusief voor verificatie kunnen worden gebruikt. | booleaans |
| enableAnalyticalStorage | Vlag om aan te geven of opslaganalyse moet worden ingeschakeld. | booleaans |
| enableAutomaticFailover | Hiermee wordt automatische failover van de schrijfregio ingeschakeld in de zeldzame gebeurtenis dat de regio niet beschikbaar is vanwege een storing. Automatische failover resulteert in een nieuwe schrijfregio voor het account en wordt gekozen op basis van de failoverprioriteiten die voor het account zijn geconfigureerd. | booleaans |
| enableCassandraConnector | Hiermee schakelt u de cassandra-connector in op het Cosmos DB C*-account | booleaans |
| enableFreeTier | Vlag om aan te geven of gratis laag is ingeschakeld. | booleaans |
| enableMultipleWriteLocations | Hiermee kan het account op meerdere locaties schrijven | booleaans |
| ipRules | Lijst met IpRules. | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | Vlag om aan te geven of ACL-regels voor virtuele netwerken moeten worden in- of uitgeschakeld. | booleaans |
| keyVaultKeyUri | De URI van de sleutelkluis | tekenreeks |
| locaties | Een matrix die de georeplicatielocaties bevat die zijn ingeschakeld voor het Cosmos DB-account. | Locatie[] (vereist) |
| networkAclBypass | Hiermee wordt aangegeven welke services firewallcontroles mogen omzeilen. | 'AzureServices' 'Geen' |
| networkAclBypassResourceIds | Een matrix met de resource-id's voor netwerk-Acl Bypass voor het Cosmos DB-account. | tekenreeks[] |
| publicNetworkAccess | Of aanvragen van het openbare netwerk zijn toegestaan | 'Uitgeschakeld' Ingeschakeld |
| restoreParameters | Parameters om de informatie over de herstelbewerking aan te geven. | RestoreParameters |
| virtualNetworkRules | Lijst met virtuele netwerk-ACL-regels die zijn geconfigureerd voor het Cosmos DB-account. | VirtualNetworkRule[] |
AnalyticalStorageConfiguration
| Naam | Description | Waarde |
|---|---|---|
| schemaType | Hierin worden de typen schema's voor analytische opslag beschreven. | 'FullFidelity' 'WellDefined' |
ApiProperties
| Naam | Description | Waarde |
|---|---|---|
| serverVersion | Beschrijft de ServerVersion van een MongoDB-account. | '3.2' '3.6' '4.0' |
BackupPolicy
| Naam | Description | Waarde |
|---|---|---|
| migrationState | Het object dat de status van de migratie tussen het back-upbeleid vertegenwoordigt. | BackupPolicyMigrationState |
| type | Het objecttype instellen | Continu Periodiek (vereist) |
BackupPolicyMigrationState
| Naam | Description | Waarde |
|---|---|---|
| startTime | Tijdstip waarop de migratie van het back-upbeleid is gestart (ISO-8601-indeling). | tekenreeks |
| status | Beschrijft de status van de migratie tussen typen back-upbeleid. | 'Voltooid' 'Mislukt' 'InProgress' 'Ongeldig' |
| targetType | Beschrijft het type doelback-upbeleid van de migratie van het back-upbeleid. | 'Doorlopend' 'Periodiek' |
ContinuousModeBackupPolicy
| Naam | Description | Waarde |
|---|---|---|
| type | Beschrijft de modus van back-ups. | 'Doorlopend' (vereist) |
PeriodicModeBackupPolicy
| Naam | Description | Waarde |
|---|---|---|
| type | Beschrijft de modus van back-ups. | 'Periodiek' (vereist) |
| periodicModeProperties | Configuratiewaarden voor periodieke back-upmodus | PeriodicModeProperties |
PeriodicModeProperties
| Naam | Description | Waarde |
|---|---|---|
| backupIntervalInMinutes | Een geheel getal dat het interval in minuten tussen twee back-ups aangeeft | int Beperkingen: Minimumwaarde = 0 |
| backupRetentionIntervalInHours | Een geheel getal dat de tijd (in uren) aangeeft dat elke back-up wordt bewaard | int Beperkingen: Minimumwaarde = 0 |
Mogelijkheid
| Naam | Description | Waarde |
|---|---|---|
| naam | Naam van de Cosmos DB-mogelijkheid. Bijvoorbeeld 'name': 'EnableCassandra'. Huidige waarden zijn ook 'EnableTable' en 'EnableGremlin'. | tekenreeks |
ConsistencyPolicy
| Naam | Description | Waarde |
|---|---|---|
| defaultConsistencyLevel | Het standaardconsistentieniveau en de configuratie-instellingen van het Cosmos DB-account. | 'BoundedStaleness' 'ConsistentPrefix' 'Uiteindelijk' Sessie 'Sterk' (vereist) |
| maxIntervalInSeconds | Bij gebruik met het consistentieniveau Gebonden veroudering vertegenwoordigt deze waarde de tijdsduur van veroudering (in seconden) die wordt getolereerd. Geaccepteerd bereik voor deze waarde is 5 - 86400. Vereist wanneer defaultConsistencyPolicy is ingesteld op 'BoundedStaleness'. | int Beperkingen: Minimumwaarde = 5 Maximale waarde = 86400 |
| maxStalenessPrefix | Wanneer deze waarde wordt gebruikt met het consistentieniveau Gebonden veroudering, vertegenwoordigt deze waarde het aantal verlopen aanvragen dat wordt getolereerd. Geaccepteerd bereik voor deze waarde is 1 – 2.147.483.647. Vereist wanneer defaultConsistencyPolicy is ingesteld op 'BoundedStaleness'. | int Beperkingen: Minimumwaarde = 1 Maximumwaarde = 2147483647 |
CorsPolicy
| Naam | Description | Waarde |
|---|---|---|
| allowedHeaders | De aanvraagheaders die het oorspronkelijke domein kan opgeven voor de CORS-aanvraag. | tekenreeks |
| allowedMethods | De methoden (HTTP-aanvraagwoorden) die het oorspronkelijke domein kan gebruiken voor een CORS-aanvraag. | tekenreeks |
| allowedOrigins | De oorspronkelijke domeinen die een aanvraag mogen indienen bij de service via CORS. | tekenreeks (vereist) |
| exposedHeaders | De antwoordheaders die kunnen worden verzonden in het antwoord op de CORS-aanvraag en die door de browser worden weergegeven aan de verlener van de aanvraag. | tekenreeks |
| maxAgeInSeconds | De maximale hoeveelheid tijd die een browser de VOORBEREIDENDE OPTIES-aanvraag in de cache moet opslaan. | int Beperkingen: Minimumwaarde = 1 Maximumwaarde = 2147483647 |
IpAddressOrRange
| Naam | Description | Waarde |
|---|---|---|
| ipAddressOrRange | Eén IPv4-adres of één IPv4-adresbereik in CIDR-indeling. Opgegeven IP-adressen moeten goed zijn opgemaakt en mogen niet in een van de volgende bereiken zijn opgenomen: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, omdat deze niet kunnen worden afgedwongen door het IP-adresfilter. Voorbeeld van geldige invoer: '23.40.210.245' of '23.40.210.0/8'. | tekenreeks |
Locatie
| Naam | Description | Waarde |
|---|---|---|
| failoverPriority | De failoverprioriteit van de regio. Een failoverprioriteit van 0 geeft een schrijfregio aan. De maximumwaarde voor een failoverprioriteit = (totaal aantal regio's - 1). Failoverprioriteitswaarden moeten uniek zijn voor elk van de regio's waarin het databaseaccount bestaat. | int Beperkingen: Minimumwaarde = 0 |
| isZoneRedundant | Vlag om aan te geven of deze regio al dan niet een Beschikbaarheidszone-regio is | booleaans |
| locationName | De naam van de regio. | tekenreeks |
RestoreParameters
| Naam | Description | Waarde |
|---|---|---|
| databasesToRestore | Lijst met specifieke databases die beschikbaar zijn voor herstel. | DatabaseRestoreResource[] |
| restoreMode | Beschrijft de modus van de herstelbewerking. | 'PointInTime' |
| 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 |
DatabaseRestoreResource
| Naam | Description | Waarde |
|---|---|---|
| collectionNames | De namen van de verzamelingen die beschikbaar zijn voor herstel. | tekenreeks[] |
| databaseName | De naam van de database die kan worden hersteld. | tekenreeks |
VirtualNetworkRule
| Naam | Description | Waarde |
|---|---|---|
| id | Resource-id van een subnet, bijvoorbeeld: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. | tekenreeks |
| ignoreMissingVNetServiceEndpoint | Maak een firewallregel voordat het vnet-service-eindpunt is ingeschakeld voor het virtuele netwerk. | booleaans |
Snelstartsjablonen
Met de volgende snelstartsjablonen wordt dit resourcetype geïmplementeerd.
| Template | Beschrijving |
|---|---|
| CI/CD met Jenkins in Azure Container Service (AKS) |
Containers maken het heel eenvoudig voor u om continu uw toepassingen te bouwen en te implementeren. Door de implementatie van deze containers te organiseren met behulp van Kubernetes in Azure Container Service, kunt u repliceerbare, beheerbare clusters van containers bereiken. Door een continue build in te stellen om uw containerinstallatiekopieën en indeling te produceren, kunt u de snelheid en betrouwbaarheid van uw implementatie verhogen. |
| Web-app met een SQL Database, Azure Cosmos DB, Azure Search |
Met deze sjabloon richt u een web-app, een SQL Database, Azure Cosmos DB, Azure Search en Application Insights in. |
| Een Azure Cosmos DB-account maken voor Cassandra-API |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor Cassandra-API in twee regio's met een keyspace en een tabel met toegewezen doorvoer. |
| Een Azure Cosmos DB-account voor automatische schaalaanpassing maken voor cassandra-API |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor Cassandra-API in twee regio's met een keyspace en een tabel met doorvoer voor automatische schaalaanpassing. |
| Een Azure CosmosDB-account maken |
Deze ARM-sjabloon is bedoeld om snel een CosmosDB-account te maken met de minimale vereiste waarden |
| Een Azure Cosmos DB-account maken in meerdere regio's |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor elk type database-API met een primaire en secundaire regio met keuze uit consistentieniveau en failovertype. |
| Een Gratis Azure Cosmos DB-account maken |
Met deze sjabloon maakt u een Gratis Azure Cosmos DB-account voor SQL API met een database met gedeelde doorvoer en container. |
| Een Azure Cosmos DB-account maken voor Gremlin-API |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor Gremlin-API in twee regio's met één database en één grafiek met behulp van toegewezen doorvoer. |
| Een Azure Cosmos DB-account maken voor automatische schaalaanpassing van gremlin-API's |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor Gremlin-API in twee regio's met één database en één grafiek met behulp van doorvoer voor automatische schaalaanpassing. |
| 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. |
| Een Azure Cosmos DB-account maken met een privé-eindpunt |
Met deze sjabloon maakt u een Cosmos-account, een virtueel netwerk en een privé-eindpunt dat het Cosmos-account beschikbaar maakt voor het virtuele netwerk. |
| Een Azure Cosmos DB-account maken voor Core (SQL) API |
Met deze sjabloon maakt u een Azure Cosmos-account voor Core (SQL) API met een database en een container met doorvoer met meerdere andere opties. |
| SQL-API voor Azure Cosmos DB-account met analytische opslag |
Met deze sjabloon maakt u een Azure Cosmos-account voor Core (SQL) API met een database en container die zijn geconfigureerd met analytische opslag. |
| Een SQL-API voor een Azure Cosmos DB-account maken met automatische schaalaanpassing |
Met deze sjabloon maakt u een Azure Cosmos-account voor Core (SQL) API met een database en een container met doorvoer voor automatische schaalaanpassing met meerdere andere opties. |
| Opgeslagen procedures voor Azure Cosmos DB Core (SQL) API maken |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor Core (SQL) API en een container met een opgeslagen procedure, trigger en door de gebruiker gedefinieerde functie. |
| Een minimaal Azure Cosmos DB-account maken voor Core (SQL) API |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor de Core (SQL) API terwijl alleen de minimaal vereiste resource-eigenschappen worden opgegeven. |
| Azure Cosmos maken met SQL API en meerdere containers |
Met de sjabloon maakt u een Cosmos-container met een SQL-API en kunt u meerdere containers toevoegen. |
| Een Azure Cosmos DB SQL-account maken met gegevensvlak-RBAC |
Met deze sjabloon maakt u een SQL Cosmos-account, een systeemeigen onderhouden roldefinitie en een systeemeigen onderhouden roltoewijzing voor een AAD-identiteit. |
| Een serverloos Azure Cosmos DB-account maken voor SQL API |
Met deze sjabloon maakt u een serverloos Azure Cosmos DB-account voor de Core (SQL) API. |
| Een Azure Cosmos-account maken voor Table-API |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor table-API in twee regio's en één tabel met ingerichte doorvoer. |
| Een Azure Cosmos-account maken voor Table-API met automatische schaalaanpassing |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor table-API in twee regio's en één tabel met doorvoer voor automatische schaalaanpassing. |
| Een zero touch Azure Cosmos-account en Azure-web-app maken |
Met deze sjabloon maakt u een Azure Cosmos-account, injecteert u het Cosmos DB-eindpunt en de sleutels in azure-web-app-instellingen en implementeert u vervolgens een ASP MVC-web-app vanuit GitHub. |
| Een Cosmos DB-account maken met Microsoft Defender ingeschakeld |
Met deze ARM-sjabloon kunt u een Azure Cosmos DB-account implementeren met Microsoft Defender voor Azure Cosmos DB ingeschakeld. Microsoft Defender voor Azure Cosmos DB is een systeemeigen Azure-beveiligingslaag die pogingen detecteert om gebruik te maken van databases in uw Azure Cosmos DB-accounts. Microsoft Defender voor Azure Cosmos DB detecteert potentiële SQL-injecties, bekende slechte actoren op basis van Microsoft Threat Intelligence, verdachte toegangspatronen en mogelijke misbruiken van uw database via gecompromitteerde identiteiten of kwaadwillende insiders. |
| Azure Data Explorer DB implementeren met Cosmos DB-verbinding |
Implementeer Azure Data Explorer DB met Cosmos DB-verbinding. |
| Azure Cosmos DB-account met web-app |
Met deze sjabloon implementeert u een Azure Cosmos DB-account en een App Service-plan en maakt u een web-app in het App Service-plan. Er worden ook twee toepassingsinstellingen toegevoegd aan de web-app die verwijzen naar het Eindpunt van het Azure Cosmos DB-account. Op deze manier kunnen oplossingen die zijn geïmplementeerd in de web-app, verbinding maken met het eindpunt van het Azure Cosmos DB-account met behulp van deze instellingen. |
Terraform-resourcedefinitie (AzAPI-provider)
Het resourcetype databaseAccounts 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 wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts@2021-06-15"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
analyticalStorageConfiguration = {
schemaType = "string"
}
apiProperties = {
serverVersion = "string"
}
backupPolicy = {
migrationState = {
startTime = "string"
status = "string"
targetType = "string"
}
type = "string"
// For remaining properties, see BackupPolicy objects
}
capabilities = [
{
name = "string"
}
]
connectorOffer = "Small"
consistencyPolicy = {
defaultConsistencyLevel = "string"
maxIntervalInSeconds = int
maxStalenessPrefix = int
}
cors = [
{
allowedHeaders = "string"
allowedMethods = "string"
allowedOrigins = "string"
exposedHeaders = "string"
maxAgeInSeconds = int
}
]
createMode = "string"
databaseAccountOfferType = "Standard"
defaultIdentity = "string"
disableKeyBasedMetadataWriteAccess = bool
disableLocalAuth = bool
enableAnalyticalStorage = bool
enableAutomaticFailover = bool
enableCassandraConnector = bool
enableFreeTier = bool
enableMultipleWriteLocations = bool
ipRules = [
{
ipAddressOrRange = "string"
}
]
isVirtualNetworkFilterEnabled = bool
keyVaultKeyUri = "string"
locations = [
{
failoverPriority = int
isZoneRedundant = bool
locationName = "string"
}
]
networkAclBypass = "string"
networkAclBypassResourceIds = [
"string"
]
publicNetworkAccess = "string"
restoreParameters = {
databasesToRestore = [
{
collectionNames = [
"string"
]
databaseName = "string"
}
]
restoreMode = "PointInTime"
restoreSource = "string"
restoreTimestampInUtc = "string"
}
virtualNetworkRules = [
{
id = "string"
ignoreMissingVNetServiceEndpoint = bool
}
]
}
kind = "string"
})
}
BackupPolicy-objecten
Stel de eigenschap type in om het type object op te geven.
Voor Doorlopend gebruikt u:
type = "Continuous"
Gebruik voor Periodiek:
type = "Periodic"
periodicModeProperties = {
backupIntervalInMinutes = int
backupRetentionIntervalInHours = int
}
Eigenschapswaarden
databaseAccounts
| Naam | Description | Waarde |
|---|---|---|
| type | Het resourcetype | "Microsoft.DocumentDB/databaseAccounts@2021-06-15" |
| naam | De resourcenaam | tekenreeks (vereist) Tekenlimiet: 3-44 Geldige tekens: Kleine letters, cijfers en afbreekstreepjes. Begin met kleine letter of cijfer. De resourcenaam moet uniek zijn in Azure. |
| location | De locatie van de resourcegroep waartoe de resource behoort. | tekenreeks |
| parent_id | Als u wilt implementeren in een resourcegroep, gebruikt u de id van die resourcegroep. | tekenreeks (vereist) |
| 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. |
| Soort | Geeft het type databaseaccount aan. Dit kan alleen worden ingesteld bij het maken van een databaseaccount. | "GlobalDocumentDB" "MongoDB" "Parseren" |
| identity | Identiteit voor de resource. | ManagedServiceIdentity |
| properties | Eigenschappen voor het maken en bijwerken van Azure Cosmos DB-databaseaccounts. | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (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 Alleen-lezen.
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...
| Naam | Description | Waarde |
|---|---|---|
| analyticalStorageConfiguration | Specifieke eigenschappen van analytische opslag. | AnalyticalStorageConfiguration |
| apiProperties | API-specifieke eigenschappen. Momenteel alleen ondersteund voor MongoDB-API. | ApiProperties |
| backupPolicy | Het object dat het beleid vertegenwoordigt voor het maken van back-ups voor een account. | BackupPolicy |
| mogelijkheden | Lijst met Cosmos DB-mogelijkheden voor het account | Mogelijkheid[] |
| connectorAanbieding | Het aanbiedingstype van de Cassandra-connector voor het C*-account van de Cosmos DB-database. | "Klein" |
| consistencyPolicy | Het consistentiebeleid voor het Cosmos DB-account. | ConsistencyPolicy |
| cors | Het CORS-beleid voor het Cosmos DB-databaseaccount. | CorsPolicy[] |
| createMode | Opsomming om de modus voor het maken van een account aan te geven. | "Standaard" "Herstellen" |
| databaseAccountOfferType | Het aanbiedingstype voor de database | 'Standaard' (vereist) |
| defaultIdentity | De standaardidentiteit voor toegang tot de sleutelkluis die wordt gebruikt in functies zoals door de klant beheerde sleutels. De standaardidentiteit moet expliciet worden ingesteld door de gebruikers. Dit kan 'FirstPartyIdentity', 'SystemAssignedIdentity' en meer zijn. | tekenreeks |
| disableKeyBasedMetadataWriteAccess | Schrijfbewerkingen uitschakelen voor metagegevensresources (databases, containers, doorvoer) via accountsleutels | booleaans |
| disableLocalAuth | Meld u af voor lokale verificatie en zorg ervoor dat alleen MSI en AAD exclusief voor verificatie kunnen worden gebruikt. | booleaans |
| enableAnalyticalStorage | Vlag om aan te geven of opslaganalyse moet worden ingeschakeld. | booleaans |
| enableAutomaticFailover | Hiermee wordt automatische failover van de schrijfregio ingeschakeld in de zeldzame gebeurtenis dat de regio niet beschikbaar is vanwege een storing. Automatische failover resulteert in een nieuwe schrijfregio voor het account en wordt gekozen op basis van de failoverprioriteiten die voor het account zijn geconfigureerd. | booleaans |
| enableCassandraConnector | Hiermee schakelt u de cassandra-connector in op het Cosmos DB C*-account | booleaans |
| enableFreeTier | Vlag om aan te geven of gratis laag is ingeschakeld. | booleaans |
| enableMultipleWriteLocations | Hiermee kan het account op meerdere locaties schrijven | booleaans |
| ipRules | Lijst met IpRules. | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | Vlag om aan te geven of ACL-regels voor virtuele netwerken moeten worden in- of uitgeschakeld. | booleaans |
| keyVaultKeyUri | De URI van de sleutelkluis | tekenreeks |
| locaties | Een matrix die de georeplicatielocaties bevat die zijn ingeschakeld voor het Cosmos DB-account. | Locatie[] (vereist) |
| networkAclBypass | Hiermee wordt aangegeven welke services firewallcontroles mogen omzeilen. | "AzureServices" "Geen" |
| networkAclBypassResourceIds | Een matrix met de resource-id's voor netwerk-Acl Bypass voor het Cosmos DB-account. | tekenreeks[] |
| publicNetworkAccess | Of aanvragen van het openbare netwerk zijn toegestaan | "Uitgeschakeld" "Ingeschakeld" |
| restoreParameters | Parameters om de informatie over het herstel aan te geven. | RestoreParameters |
| virtualNetworkRules | Lijst met ACL-regels voor virtuele netwerken die zijn geconfigureerd voor het Cosmos DB-account. | VirtualNetworkRule[] |
AnalyticalStorageConfiguration
| Naam | Description | Waarde |
|---|---|---|
| schemaType | Hierin worden de typen schema's voor analytische opslag beschreven. | "FullFidelity" "Goed Gedefinieerd" |
ApiProperties
| Naam | Description | Waarde |
|---|---|---|
| serverVersion | Beschrijft de ServerVersion van een MongoDB-account. | "3.2" "3.6" "4.0" |
BackupPolicy
| Naam | Description | Waarde |
|---|---|---|
| migrationState | Het object dat de status van de migratie tussen het back-upbeleid vertegenwoordigt. | BackupPolicyMigrationState |
| type | Het objecttype instellen | Continu Periodiek (vereist) |
BackupPolicyMigrationState
| Naam | Description | Waarde |
|---|---|---|
| startTime | Tijdstip waarop de migratie van het back-upbeleid is gestart (ISO-8601-indeling). | tekenreeks |
| status | Beschrijft de status van de migratie tussen back-upbeleidstypen. | "Voltooid" "Mislukt" "InProgress" "Ongeldig" |
| targetType | Beschrijft het type doelback-upbeleid van de migratie van het back-upbeleid. | "Doorlopend" "Periodiek" |
ContinuousModeBackupPolicy
| Naam | Description | Waarde |
|---|---|---|
| type | Beschrijft de modus van back-ups. | 'Doorlopend' (vereist) |
PeriodicModeBackupPolicy
| Naam | Description | Waarde |
|---|---|---|
| type | Beschrijft de modus van back-ups. | "Periodiek" (vereist) |
| periodicModeProperties | Configuratiewaarden voor periodieke back-upmodus | PeriodicModeProperties |
PeriodicModeProperties
| Naam | Description | Waarde |
|---|---|---|
| backupIntervalInMinutes | Een geheel getal dat het interval in minuten tussen twee back-ups aangeeft | int Beperkingen: Minimumwaarde = 0 |
| backupRetentionIntervalInHours | Een geheel getal dat de tijd (in uren) aangeeft dat elke back-up wordt bewaard | int Beperkingen: Minimumwaarde = 0 |
Mogelijkheid
| Naam | Description | Waarde |
|---|---|---|
| naam | Naam van de Cosmos DB-mogelijkheid. Bijvoorbeeld 'name': 'EnableCassandra'. Huidige waarden zijn ook 'EnableTable' en 'EnableGremlin'. | tekenreeks |
ConsistencyPolicy
| Naam | Description | Waarde |
|---|---|---|
| defaultConsistencyLevel | Het standaardconsistentieniveau en de configuratie-instellingen van het Cosmos DB-account. | "GebondenheidStaleness" "ConsistentPrefix" "Uiteindelijk" "Sessie" "Sterk" (vereist) |
| maxIntervalInSeconds | Bij gebruik met het consistentieniveau Gebonden veroudering vertegenwoordigt deze waarde de tijdsduur van veroudering (in seconden) die wordt getolereerd. Geaccepteerd bereik voor deze waarde is 5 - 86400. Vereist wanneer defaultConsistencyPolicy is ingesteld op 'BoundedStaleness'. | int Beperkingen: Minimumwaarde = 5 Maximale waarde = 86400 |
| maxStalenessPrefix | Wanneer deze waarde wordt gebruikt met het consistentieniveau Gebonden veroudering, vertegenwoordigt deze waarde het aantal verlopen aanvragen dat wordt getolereerd. Geaccepteerd bereik voor deze waarde is 1 – 2.147.483.647. Vereist wanneer defaultConsistencyPolicy is ingesteld op 'BoundedStaleness'. | int Beperkingen: Minimumwaarde = 1 Maximumwaarde = 2147483647 |
CorsPolicy
| Naam | Description | Waarde |
|---|---|---|
| allowedHeaders | De aanvraagheaders die het oorspronkelijke domein kan opgeven voor de CORS-aanvraag. | tekenreeks |
| allowedMethods | De methoden (HTTP-aanvraagwoorden) die het oorspronkelijke domein kan gebruiken voor een CORS-aanvraag. | tekenreeks |
| allowedOrigins | De oorspronkelijke domeinen die een aanvraag mogen indienen bij de service via CORS. | tekenreeks (vereist) |
| exposedHeaders | De antwoordheaders die kunnen worden verzonden in het antwoord op de CORS-aanvraag en die door de browser worden weergegeven aan de verlener van de aanvraag. | tekenreeks |
| maxAgeInSeconds | De maximale hoeveelheid tijd die een browser de VOORBEREIDENDE OPTIES-aanvraag in de cache moet opslaan. | int Beperkingen: Minimumwaarde = 1 Maximumwaarde = 2147483647 |
IpAddressOrRange
| Naam | Description | Waarde |
|---|---|---|
| ipAddressOrRange | Eén IPv4-adres of één IPv4-adresbereik in CIDR-indeling. Opgegeven IP-adressen moeten goed zijn opgemaakt en mogen niet in een van de volgende bereiken zijn opgenomen: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, omdat deze niet kunnen worden afgedwongen door het IP-adresfilter. Voorbeeld van geldige invoer: '23.40.210.245' of '23.40.210.0/8'. | tekenreeks |
Locatie
| Naam | Description | Waarde |
|---|---|---|
| failoverPriority | De failoverprioriteit van de regio. Een failoverprioriteit van 0 geeft een schrijfregio aan. De maximumwaarde voor een failoverprioriteit = (totaal aantal regio's - 1). Failoverprioriteitswaarden moeten uniek zijn voor elk van de regio's waarin het databaseaccount bestaat. | int Beperkingen: Minimumwaarde = 0 |
| isZoneRedundant | Vlag om aan te geven of deze regio een Beschikbaarheidszone-regio is | booleaans |
| locationName | De naam van de regio. | tekenreeks |
RestoreParameters
| Naam | Description | Waarde |
|---|---|---|
| databasesToRestore | Lijst met specifieke databases die beschikbaar zijn voor herstel. | DatabaseRestoreResource[] |
| restoreMode | Beschrijft de modus van het herstellen. | "PointInTime" |
| 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 |
DatabaseRestoreResource
| Naam | Description | Waarde |
|---|---|---|
| collectionNames | De namen van de verzamelingen die beschikbaar zijn voor herstel. | tekenreeks[] |
| databaseName | De naam van de database die beschikbaar is voor herstel. | tekenreeks |
VirtualNetworkRule
| Naam | Description | Waarde |
|---|---|---|
| id | Resource-id van een subnet, bijvoorbeeld: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. | tekenreeks |
| ignoreMissingVNetServiceEndpoint | Maak een firewallregel voordat het vnet-service-eindpunt is ingeschakeld voor het virtuele netwerk. | booleaans |