Microsoft.DocumentDB databaseAccounts 2021-05-15
- Neueste
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 15.03.2023
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15
- 2021-10-15-preview
- 2021-07-01-preview
- 15.06.2021
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-15
- 2021-03-01-preview
- 15.1.2021
- 2020-09-01
- 2020-06-01-preview
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
- 2016-03-31
- 2016-03-19
- 2015-11-06
- 2015-04-08
- 2015-04-01
Bicep-Ressourcendefinition
Der Ressourcentyp databaseAccounts kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Bereitstellungsbefehle für Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.DocumentDB/databaseAccounts-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2021-05-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: {
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
}
]
databaseAccountOfferType: 'Standard'
defaultIdentity: 'string'
disableKeyBasedMetadataWriteAccess: 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'
virtualNetworkRules: [
{
id: 'string'
ignoreMissingVNetServiceEndpoint: bool
}
]
}
}
BackupPolicy-Objekte
Legen Sie die type-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für Continuous Folgendes:
type: 'Continuous'
Verwenden Sie für Periodisch Folgendes:
type: 'Periodic'
periodicModeProperties: {
backupIntervalInMinutes: int
backupRetentionIntervalInHours: int
}
Eigenschaftswerte
databaseAccounts
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Der Ressourcenname | Zeichenfolge (erforderlich) Zeichenlimit: 3-44 Gültige Zeichen: Kleinbuchstaben, Zahlen und Bindestriche. Beginnen Sie mit einem Kleinbuchstaben oder einer Zahl. Der Ressourcenname muss in Azure eindeutig sein. |
| location | Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. | Zeichenfolge |
| tags | Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Beispielsweise ist die Standardumgebung für einen Vorlagentyp auf "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB". | Wörterbuch der Tagnamen und -werte. Weitere Informationen finden Sie unter Tags in Vorlagen. |
| kind | Gibt den Typ des Datenbankkontos an. Dies kann nur bei der Erstellung eines Datenbankkontos festgelegt werden. | "GlobalDocumentDB" "MongoDB" "Analysieren" |
| Identität | Identität für die Ressource. | ManagedServiceIdentity |
| properties | Eigenschaften zum Erstellen und Aktualisieren von Azure Cosmos DB-Datenbankkonten. | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (erforderlich) |
ManagedServiceIdentity
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" umfasst sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. | "Keine" "SystemAssigned" 'SystemAssigned,UserAssigned' "UserAssigned" |
| userAssignedIdentities | Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs im Format "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| analyticalStorageConfiguration | Spezifische Eigenschaften des Analysespeichers. | AnalyticalStorageConfiguration |
| apiProperties | API-spezifische Eigenschaften. Derzeit wird nur für die MongoDB-API unterstützt. | ApiProperties |
| backupPolicy | Das -Objekt, das die Richtlinie zum Erstellen von Sicherungen für ein Konto darstellt. | BackupPolicy |
| capabilities | Liste der Cosmos DB-Funktionen für das Konto | Funktion[] |
| connectorOffer | Der Angebotstyp des Cassandra-Connectors für das C*-Konto der Cosmos DB-Datenbank. | "Klein" |
| consistencyPolicy | Die Konsistenzrichtlinie für das Cosmos DB-Konto. | ConsistencyPolicy |
| cors | Die CORS-Richtlinie für das Cosmos DB-Datenbankkonto. | CorsPolicy[] |
| databaseAccountOfferType | Der Angebotstyp für die Datenbank | "Standard" (erforderlich) |
| defaultIdentity | Die Standardidentität für den Zugriff auf den Schlüsseltresor, der in Features wie kundenseitig verwalteten Schlüsseln verwendet wird. Die Standardidentität muss von den Benutzern explizit festgelegt werden. Dies kann "FirstPartyIdentity", "SystemAssignedIdentity" und mehr sein. | Zeichenfolge |
| disableKeyBasedMetadataWriteAccess | Deaktivieren von Schreibvorgängen für Metadatenressourcen (Datenbanken, Container, Durchsatz) über Kontoschlüssel | bool |
| enableAnalyticalStorage | Flag, um anzugeben, ob die Speicheranalyse aktiviert werden soll. | bool |
| enableAutomaticFailover | Aktiviert das automatische Failover der Schreibregion in dem seltenen Fall, dass die Region aufgrund eines Ausfalls nicht verfügbar ist. Das automatische Failover führt zu einer neuen Schreibregion für das Konto und wird basierend auf den für das Konto konfigurierten Failoverprioritäten ausgewählt. | bool |
| enableCassandraConnector | Aktiviert den Cassandra-Connector für das Cosmos DB-C*-Konto. | bool |
| enableFreeTier | Flag, um anzugeben, ob der Free-Tarif aktiviert ist. | bool |
| enableMultipleWriteLocations | Ermöglicht dem Konto das Schreiben an mehreren Speicherorten. | bool |
| ipRules | Liste der IpRules. | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | Flag, um anzugeben, ob ACL-Regeln für virtuelle Netzwerke aktiviert/deaktiviert werden sollen. | bool |
| keyVaultKeyUri | Der URI des Schlüsseltresors | Zeichenfolge |
| locations | Ein Array, das die georeplizierungsspeicherorte enthält, die für das Cosmos DB-Konto aktiviert sind. | Location[] (erforderlich) |
| networkAclBypass | Gibt an, welche Dienste Firewallprüfungen umgehen dürfen. | "AzureServices" "Keine" |
| networkAclBypassResourceIds | Ein Array, das die Ressourcen-IDs für die Netzwerk-ACL-Umgehung für das Cosmos DB-Konto enthält. | string[] |
| publicNetworkAccess | Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind | "Deaktiviert" "Aktiviert" |
| virtualNetworkRules | Liste der VNET-ACL-Regeln, die für das Cosmos DB-Konto konfiguriert sind. | VirtualNetworkRule[] |
AnalyticalStorageConfiguration
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Schematype | Beschreibt die Schematypen für den analytischen Speicher. | "FullFidelity" "WellDefined" |
ApiProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| serverVersion | Beschreibt die ServerVersion eines MongoDB-Kontos. | '3.2' '3.6' '4.0' |
BackupPolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Festlegen des Objekttyps | Fortlaufend Periodisch (erforderlich) |
ContinuousModeBackupPolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Beschreibt den Modus von Sicherungen. | "Fortlaufend" (erforderlich) |
PeriodicModeBackupPolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Beschreibt den Modus von Sicherungen. | "Periodisch" (erforderlich) |
| periodicModeProperties | Konfigurationswerte für die sicherung im periodischen Modus | PeriodicModeProperties |
PeriodicModeProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| backupIntervalInMinutes | Eine ganze Zahl, die das Intervall in Minuten zwischen zwei Sicherungen darstellt | INT Einschränkungen: Minimaler Wert = 0 |
| backupRetentionIntervalInHours | Eine ganze Zahl, die die Zeit (in Stunden) darstellt, in der jede Sicherung aufbewahrt wird. | INT Einschränkungen: Minimaler Wert = 0 |
Funktion
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Name der Cosmos DB-Funktion. Beispiel: "name": "EnableCassandra". Zu den aktuellen Werten gehören auch "EnableTable" und "EnableGremlin". | Zeichenfolge |
ConsistencyPolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| defaultConsistencyLevel | Die Standardkonsistenzebene und die Konfigurationseinstellungen des Cosmos DB-Kontos. | "BoundedStaleness" "ConsistentPrefix" "Letztlich" "Sitzung" "Strong" (erforderlich) |
| maxIntervalInSeconds | Bei Verwendung mit der Konsistenzebene "Begrenzte Veraltung" stellt dieser Wert den Zeitraum der Veraltung (in Sekunden) dar, der toleriert wird. Der zulässige Bereich für diesen Wert ist 5 bis 86400. Erforderlich, wenn defaultConsistencyPolicy auf "BoundedStaleness" festgelegt ist. | INT Einschränkungen: Minimaler Wert = 5 Max. Wert = 86400 |
| maxStalenessPrefix | Bei Verwendung mit der Konsistenzebene "Begrenzte Veraltung" stellt dieser Wert die Anzahl veralteter Anforderungen dar, die toleriert werden. Für diesen Wert ist ein Bereich von 1 bis 2.147.483.647 zulässig. Erforderlich, wenn defaultConsistencyPolicy auf "BoundedStaleness" festgelegt ist. | INT Einschränkungen: Minimaler Wert = 1 Max. Wert = 2147483647 |
CorsPolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| allowedHeaders | Die Anforderungsheader, die die Ursprungsdomäne für die CORS-Anforderung angeben kann. | Zeichenfolge |
| allowedMethods | Die Methoden (HTTP-Anforderungsverben), die die Ursprungsdomäne für eine CORS-Anforderung verwenden kann. | Zeichenfolge |
| allowedOrigins | Die Ursprungsdomänen, die über CORS eine Anforderung an den Dienst stellen dürfen. | Zeichenfolge (erforderlich) |
| exposedHeaders | Die Antwortheader, die in der Antwort an die CORS-Anforderung gesendet und vom Browser gegenüber dem Anforderungsaussteller verfügbar gemacht werden können. | Zeichenfolge |
| maxAgeInSeconds | Die maximale Zeit, über die die OPTIONS-Preflight-Anforderung vom Browser zwischengespeichert werden soll. | INT Einschränkungen: Min-Wert = 1 Maximaler Wert = 2147483647 |
IpAddressOrRange
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| ipAddressOrRange | Eine einzelne IPv4-Adresse oder ein einzelner IPv4-Adressbereich im CIDR-Format. Die bereitgestellten IP-Adressen müssen gut formatiert sein und können nicht in einem der folgenden Bereiche enthalten sein: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, da diese durch den IP-Adressfilter nicht erzwingbar sind. Beispiel für gültige Eingaben: "23.40.210.245" oder "23.40.210.0/8". | Zeichenfolge |
Standort
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| failoverPriority | Die Failoverpriorität der Region. Eine Failoverpriorität von 0 gibt einen Schreibbereich an. Der maximale Wert für eine Failoverpriorität = (Gesamtanzahl der Regionen - 1). Failoverprioritätswerte müssen für jede Region, in der das Datenbankkonto vorhanden ist, eindeutig sein. | INT Einschränkungen: Min-Wert = 0 |
| isZoneRedundant | Flag, um anzugeben, ob es sich bei dieser Region um eine AvailabilityZone-Region handelt oder nicht | bool |
| locationName | Der Name der Region. | Zeichenfolge |
VirtualNetworkRule
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| id | Ressourcen-ID eines Subnetzes, z. B. /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. | Zeichenfolge |
| ignoreMissingVNetServiceEndpoint | Erstellen Sie eine Firewallregel, bevor für das virtuelle Netzwerk der VNET-Dienstendpunkt aktiviert ist. | bool |
Schnellstartvorlagen
Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.
| Vorlage | BESCHREIBUNG |
|---|---|
CI/CD mit Jenkins in Azure Container Service (AKS) |
Container vereinfachen sehr die kontinuierliche Erstellung und Bereitstellung Ihrer Anwendungen. Wenn Sie die Bereitstellung dieser Container mithilfe von Kubernetes in Azure Container Service orchestrieren, können Sie replizierbare, verwaltbare Containercluster erreichen. Durch Einrichten eines kontinuierlichen Builds zur Erstellung Ihrer Containerimages und -orchestrierung können Sie die Geschwindigkeit und Zuverlässigkeit Ihrer Bereitstellung erhöhen. |
| Web-App mit einer SQL-Datenbank, Azure Cosmos DB, Azure Search |
Diese Vorlage stellt eine Web-App, eine SQL-Datenbank, Azure Cosmos DB, Azure Search und Application Insights bereit. |
| Erstellen eines Azure Cosmos DB-Kontos für die Cassandra-API |
Mit dieser Vorlage wird ein Azure Cosmos DB-Konto für die Cassandra-API in zwei Regionen mit einem Keyspace und einer Tabelle mit dediziertem Durchsatz erstellt. |
| Erstellen eines Azure Cosmos DB-Kontos für die Cassandra-API |
Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die Cassandra-API in zwei Regionen mit einem Keyspace und einer Tabelle mit automatischem Skalierungsdurchsatz. |
| Erstellen eines Azure CosmosDB-Kontos |
Diese ARM-Vorlage soll schnell ein CosmosDB-Konto mit den minimal erforderlichen Werten erstellen. |
| Erstellen eines Azure Cosmos DB-Kontos in mehreren Regionen |
Diese Vorlage erstellt ein Azure Cosmos DB-Konto für jeden Datenbank-API-Typ mit einer primären und sekundären Region mit Auswahl zwischen Konsistenzebene und Failovertyp. |
| Erstellen eines Azure Cosmos DB-Kontos im Free-Tarif |
Mit dieser Vorlage wird ein Azure Cosmos DB-Konto für die SQL-API mit einer Datenbank mit freigegebenem Durchsatz und Container erstellt. |
| Erstellen eines Azure Cosmos DB-Kontos für die Gremlin-API |
Mit dieser Vorlage wird ein Azure Cosmos DB-Konto für die Gremlin-API in zwei Regionen mit einer Datenbank und einem Graphen mit dediziertem Durchsatz erstellt. |
| Erstellen eines Azure Cosmos DB-Kontos für die automatische Skalierung der Gremlin-API |
Mit dieser Vorlage wird ein Azure Cosmos DB-Konto für die Gremlin-API in zwei Regionen mit einer Datenbank und einem Graphen mithilfe des automatischen Skalierungsdurchsatzes erstellt. |
| Erstellen eines Azure Cosmos-Kontos für die MongoDB-API |
Mit dieser Vorlage wird ein Azure Cosmos DB-Konto für die MongoDB-API 4.2 in zwei Regionen mit freigegebenem und dediziertem Durchsatz mit zwei Sammlungen erstellt. |
| Erstellen eines Azure Cosmos-Kontos für die automatische Skalierung der MongoDB-API |
Mit dieser Vorlage wird ein Azure Cosmos DB-Konto für die MongoDB-API 4.2 in zwei Regionen erstellt, wobei sowohl der freigegebene als auch der dedizierte Durchsatz für die automatische Skalierung verwendet wird. |
| Erstellen eines Azure Cosmos DB-Kontos mit einem privaten Endpunkt |
Mit dieser Vorlage werden ein Cosmos-Konto, ein virtuelles Netzwerk und ein privater Endpunkt erstellt, der das Cosmos-Konto dem virtuellen Netzwerk verfügbar macht. |
| Erstellen eines Azure Cosmos DB-Kontos für die SQL-API (Core) |
Mit dieser Vorlage wird eine SQL-API (Azure Cosmos-Konto für Core) mit einer Datenbank und einem Container mit Durchsatz mit mehreren anderen Optionen erstellt. |
| SQL-API des Azure Cosmos DB-Kontos mit Analysespeicher |
Mit dieser Vorlage wird eine SQL-API (Azure Cosmos-Konto für Core) mit einer Datenbank und einem Container erstellt, die mit dem Analysespeicher konfiguriert sind. |
| Erstellen einer SQL-API für ein Azure Cosmos DB-Konto mit automatischer Skalierung |
Diese Vorlage erstellt eine SQL-API (Azure Cosmos-Konto für Core) mit einer Datenbank und einem Container mit automatischem Skalierungsdurchsatz mit mehreren anderen Optionen. |
| Erstellen gespeicherter Prozeduren der Azure Cosmos DB Core-API (SQL) |
Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die SQL-API (Core) und einen Container mit einer gespeicherten Prozedur, einem Trigger und einer benutzerdefinierten Funktion. |
| Erstellen eines minimalen Azure Cosmos DB-Kontos für die SQL-API (Core) |
Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die Core-API (SQL) und gibt dabei nur die minimal erforderlichen Ressourceneigenschaften an. |
| Erstellen von Azure Cosmos mit SQL-API und mehreren Containern |
Die Vorlage erstellt einen Cosmos-Container mit einer SQL-API und ermöglicht das Hinzufügen von mehreren Containern. |
| Erstellen eines Azure Cosmos DB-SQL-Kontos mit RBAC auf Datenebene |
Mit dieser Vorlage wird ein SQL Cosmos-Konto erstellt, eine nativ gepflegte Rollendefinition und eine nativ gepflegte Rollenzuweisung für eine AAD-Identität. |
| Erstellen eines serverlosen Azure Cosmos DB-Kontos für die SQL-API |
Mit dieser Vorlage wird ein serverloses Azure Cosmos DB-Konto für die Core-API (SQL) erstellt. |
| Erstellen eines Azure Cosmos-Kontos für die Tabellen-API |
Mit dieser Vorlage wird ein Azure Cosmos DB-Konto für die Tabellen-API in zwei Regionen und eine einzelne Tabelle mit bereitgestelltem Durchsatz erstellt. |
| Erstellen eines Azure Cosmos-Kontos für die Tabellen-API mit automatischer Skalierung |
Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die Tabellen-API in zwei Regionen und eine einzelne Tabelle mit automatischem Skalierungsdurchsatz. |
| Erstellen eines Azure Cosmos-Kontos und einer Azure-Web-App |
Diese Vorlage erstellt ein Azure Cosmos-Konto, fügt den Cosmos DB-Endpunkt und die Schlüssel in die Azure-Web-App-Einstellungen ein und stellt dann eine ASP MVC-Web-App von GitHub bereit. |
| Erstellen eines Cosmos DB-Kontos mit aktiviertem Microsoft Defender |
Mit dieser ARM-Vorlage können Sie ein Azure Cosmos DB-Konto bereitstellen, bei dem Microsoft Defender für Azure Cosmos DB aktiviert ist. Microsoft Defender für Azure Cosmos DB ist eine in Azure native Sicherheitsebene, die Versuche erkennt, Datenbanken in Ihren Azure Cosmos DB-Konten auszunutzen. Microsoft Defender für Azure Cosmos DB erkennt potenzielle SQL-Einschleusungen, bekannte schlechte Akteure basierend auf Microsoft Threat Intelligence, verdächtige Zugriffsmuster und potenzielle Ausnutzungen Ihrer Datenbank durch kompromittierte Identitäten oder böswillige Insider. |
| Bereitstellen von Azure Data Explorer DB mit Cosmos DB-Verbindung |
Bereitstellen von Azure Data Explorer DB mit Cosmos DB-Verbindung |
| Azure Cosmos DB-Konto mit Web-App |
Diese Vorlage stellt ein Azure Cosmos DB-Konto und einen App Service-Plan bereit und erstellt eine Web-App im App Service-Plan. Außerdem werden der Web-App zwei Anwendungseinstellungen hinzugefügt, die auf den Azure Cosmos DB-Kontoendpunkt verweisen. Auf diese Weise können lösungen, die in der Web-App bereitgestellt werden, mithilfe dieser Einstellungen eine Verbindung mit dem Azure Cosmos DB-Kontoendpunkt herstellen. |
Ressourcendefinition mit einer ARM-Vorlage
Der Ressourcentyp databaseAccounts kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- Ressourcengruppen : Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.DocumentDB/databaseAccounts-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.DocumentDB/databaseAccounts",
"apiVersion": "2021-05-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": {
"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"
}
],
"databaseAccountOfferType": "Standard",
"defaultIdentity": "string",
"disableKeyBasedMetadataWriteAccess": "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",
"virtualNetworkRules": [
{
"id": "string",
"ignoreMissingVNetServiceEndpoint": "bool"
}
]
}
}
BackupPolicy-Objekte
Legen Sie die type-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für Continuous Folgendes:
"type": "Continuous"
Verwenden Sie für Periodisch Folgendes:
"type": "Periodic",
"periodicModeProperties": {
"backupIntervalInMinutes": "int",
"backupRetentionIntervalInHours": "int"
}
Eigenschaftswerte
databaseAccounts
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Ressourcentyp | "Microsoft.DocumentDB/databaseAccounts" |
| apiVersion | Die Ressourcen-API-Version | '2021-05-15' |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) Zeichenlimit: 3-44 Gültige Zeichen: Kleinbuchstaben, Zahlen und Bindestriche. Beginnen Sie mit einem Kleinbuchstaben oder einer Zahl. Der Ressourcenname muss in Azure eindeutig sein. |
| location | Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. | Zeichenfolge |
| tags | Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Die Standardumgebung für einen Vorlagentyp ist beispielsweise mit "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB". | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
| kind | Gibt den Typ des Datenbankkontos an. Dies kann nur bei der Erstellung eines Datenbankkontos festgelegt werden. | "GlobalDocumentDB" "MongoDB" "Analysieren" |
| Identität | Identität für die Ressource. | ManagedServiceIdentity |
| properties | Eigenschaften zum Erstellen und Aktualisieren von Azure Cosmos DB-Datenbankkonten. | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (erforderlich) |
ManagedServiceIdentity
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. | "Keine" "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| userAssignedIdentities | Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Bei den Referenzdaten des Benutzeridentitätswörterbuchs handelt es sich um ARM-Ressourcen-IDs in der Form : "/subscriptions/{subscriptionId}/resourceGroupGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| analyticalStorageConfiguration | Analysespeicherspezifische Eigenschaften. | AnalyticalStorageConfiguration |
| apiProperties | API-spezifische Eigenschaften. Derzeit nur für die MongoDB-API unterstützt. | ApiProperties |
| backupPolicy | Das Objekt, das die Richtlinie zum Erstellen von Sicherungen für ein Konto darstellt. | BackupPolicy |
| capabilities | Liste der Cosmos DB-Funktionen für das Konto | Funktion[] |
| connectorOffer | Der Cassandra-Connectorangebotstyp für das C*-Konto der Cosmos DB-Datenbank. | "Klein" |
| consistencyPolicy | Die Konsistenzrichtlinie für das Cosmos DB-Konto. | ConsistencyPolicy |
| cors | Die CORS-Richtlinie für das Cosmos DB-Datenbankkonto. | CorsPolicy[] |
| databaseAccountOfferType | Der Angebotstyp für die Datenbank | "Standard" (erforderlich) |
| defaultIdentity | Die Standardidentität für den Zugriff auf Schlüsseltresor, die in Features wie kundenseitig verwalteten Schlüsseln verwendet wird. Die Standardidentität muss explizit von den Benutzern festgelegt werden. Es kann "FirstPartyIdentity", "SystemAssignedIdentity" und mehr sein. | Zeichenfolge |
| disableKeyBasedMetadataWriteAccess | Deaktivieren von Schreibvorgängen für Metadatenressourcen (Datenbanken, Container, Durchsatz) über Kontoschlüssel | bool |
| enableAnalyticalStorage | Flag, um anzugeben, ob Speicheranalysen aktiviert werden sollen. | bool |
| enableAutomaticFailover | Aktiviert das automatische Failover der Schreibregion in dem seltenen Fall, dass die Region aufgrund eines Ausfalls nicht verfügbar ist. Automatisches Failover führt zu einer neuen Schreibregion für das Konto und wird basierend auf den für das Konto konfigurierten Failoverprioritäten ausgewählt. | bool |
| enableCassandraConnector | Aktiviert den Cassandra-Connector für das Cosmos DB C*-Konto | bool |
| enableFreeTier | Flag, um anzugeben, ob der Free-Tarif aktiviert ist. | bool |
| enableMultipleWriteLocations | Ermöglicht dem Konto das Schreiben an mehreren Speicherorten. | bool |
| ipRules | Liste der IpRules. | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | Flag, um anzugeben, ob ACL-Regeln für virtuelle Netzwerke aktiviert/deaktiviert werden sollen. | bool |
| keyVaultKeyUri | Der URI des Schlüsseltresors | Zeichenfolge |
| locations | Ein Array, das die Georeplizierungsstandorte enthält, die für das Cosmos DB-Konto aktiviert sind. | Standort[] (erforderlich) |
| networkAclBypass | Gibt an, welche Dienste Firewallprüfungen umgehen dürfen. | "AzureServices" "Keine" |
| networkAclBypassResourceIds | Ein Array, das die Ressourcen-IDs für die Netzwerk-ACL-Umgehung für das Cosmos DB-Konto enthält. | string[] |
| publicNetworkAccess | Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind | "Deaktiviert" "Aktiviert" |
| virtualNetworkRules | Liste der ACL-Regeln für virtuelle Netzwerke, die für das Cosmos DB-Konto konfiguriert sind. | VirtualNetworkRule[] |
AnalyticalStorageConfiguration
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Schematype | Beschreibt die Schematypen für den analytischen Speicher. | "FullFidelity" "WellDefined" |
ApiProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| serverVersion | Beschreibt die ServerVersion eines MongoDB-Kontos. | '3.2' '3.6' '4.0' |
BackupPolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Festlegen des Objekttyps | Fortlaufend Periodisch (erforderlich) |
ContinuousModeBackupPolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Beschreibt den Modus von Sicherungen. | "Fortlaufend" (erforderlich) |
PeriodicModeBackupPolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Beschreibt den Modus von Sicherungen. | "Periodisch" (erforderlich) |
| periodicModeProperties | Konfigurationswerte für die sicherung im periodischen Modus | PeriodicModeProperties |
PeriodicModeProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| backupIntervalInMinutes | Eine ganze Zahl, die das Intervall in Minuten zwischen zwei Sicherungen darstellt | INT Einschränkungen: Minimaler Wert = 0 |
| backupRetentionIntervalInHours | Eine ganze Zahl, die die Zeit (in Stunden) darstellt, in der jede Sicherung aufbewahrt wird. | INT Einschränkungen: Minimaler Wert = 0 |
Funktion
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Name der Cosmos DB-Funktion. Beispiel: "name": "EnableCassandra". Zu den aktuellen Werten gehören auch "EnableTable" und "EnableGremlin". | Zeichenfolge |
ConsistencyPolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| defaultConsistencyLevel | Die Standardkonsistenzebene und die Konfigurationseinstellungen des Cosmos DB-Kontos. | "BoundedStaleness" "ConsistentPrefix" "Letztlich" "Sitzung" "Strong" (erforderlich) |
| maxIntervalInSeconds | Bei Verwendung mit der Konsistenzebene "Begrenzte Veraltung" stellt dieser Wert den Zeitraum der Veraltung (in Sekunden) dar, der toleriert wird. Der zulässige Bereich für diesen Wert ist 5 bis 86400. Erforderlich, wenn defaultConsistencyPolicy auf "BoundedStaleness" festgelegt ist. | INT Einschränkungen: Minimaler Wert = 5 Max. Wert = 86400 |
| maxStalenessPrefix | Bei Verwendung mit der Konsistenzebene "Begrenzte Veraltung" stellt dieser Wert die Anzahl veralteter Anforderungen dar, die toleriert werden. Für diesen Wert ist ein Bereich von 1 bis 2.147.483.647 zulässig. Erforderlich, wenn defaultConsistencyPolicy auf "BoundedStaleness" festgelegt ist. | INT Einschränkungen: Minimaler Wert = 1 Max. Wert = 2147483647 |
CorsPolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| allowedHeaders | Die Anforderungsheader, die die Ursprungsdomäne für die CORS-Anforderung angeben kann. | Zeichenfolge |
| allowedMethods | Die Methoden (HTTP-Anforderungsverben), die die Ursprungsdomäne für eine CORS-Anforderung verwenden kann. | Zeichenfolge |
| allowedOrigins | Die Ursprungsdomänen, die über CORS eine Anforderung an den Dienst stellen dürfen. | Zeichenfolge (erforderlich) |
| exposedHeaders | Die Antwortheader, die in der Antwort an die CORS-Anforderung gesendet und vom Browser gegenüber dem Anforderungsaussteller verfügbar gemacht werden können. | Zeichenfolge |
| maxAgeInSeconds | Die maximale Zeit, über die die OPTIONS-Preflight-Anforderung vom Browser zwischengespeichert werden soll. | INT Einschränkungen: Min-Wert = 1 Maximaler Wert = 2147483647 |
IpAddressOrRange
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| ipAddressOrRange | Eine einzelne IPv4-Adresse oder ein einzelner IPv4-Adressbereich im CIDR-Format. Die bereitgestellten IP-Adressen müssen gut formatiert sein und können nicht in einem der folgenden Bereiche enthalten sein: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, da diese durch den IP-Adressfilter nicht erzwingbar sind. Beispiel für gültige Eingaben: "23.40.210.245" oder "23.40.210.0/8". | Zeichenfolge |
Standort
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| failoverPriority | Die Failoverpriorität der Region. Eine Failoverpriorität von 0 gibt einen Schreibbereich an. Der maximale Wert für eine Failoverpriorität = (Gesamtanzahl der Regionen - 1). Failoverprioritätswerte müssen für jede Region, in der das Datenbankkonto vorhanden ist, eindeutig sein. | INT Einschränkungen: Min-Wert = 0 |
| isZoneRedundant | Flag, um anzugeben, ob es sich bei dieser Region um eine AvailabilityZone-Region handelt oder nicht | bool |
| locationName | Der Name der Region. | Zeichenfolge |
VirtualNetworkRule
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| id | Ressourcen-ID eines Subnetzes, z. B. /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. | Zeichenfolge |
| ignoreMissingVNetServiceEndpoint | Erstellen Sie eine Firewallregel, bevor für das virtuelle Netzwerk der VNET-Dienstendpunkt aktiviert ist. | bool |
Schnellstartvorlagen
Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.
| Vorlage | BESCHREIBUNG |
|---|---|
| CI/CD mit Jenkins in Azure Container Service (AKS) |
Container vereinfachen sehr die kontinuierliche Erstellung und Bereitstellung Ihrer Anwendungen. Wenn Sie die Bereitstellung dieser Container mithilfe von Kubernetes in Azure Container Service orchestrieren, können Sie replizierbare, verwaltbare Containercluster erreichen. Durch Einrichten eines kontinuierlichen Builds zur Erstellung Ihrer Containerimages und -orchestrierung können Sie die Geschwindigkeit und Zuverlässigkeit Ihrer Bereitstellung erhöhen. |
| Web-App mit einer SQL-Datenbank, Azure Cosmos DB, Azure Search |
Diese Vorlage stellt eine Web-App, eine SQL-Datenbank, Azure Cosmos DB, Azure Search und Application Insights bereit. |
| Erstellen eines Azure Cosmos DB-Kontos für die Cassandra-API |
Mit dieser Vorlage wird ein Azure Cosmos DB-Konto für die Cassandra-API in zwei Regionen mit einem Keyspace und einer Tabelle mit dediziertem Durchsatz erstellt. |
| Erstellen eines Azure Cosmos DB-Kontos für die Cassandra-API |
Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die Cassandra-API in zwei Regionen mit einem Keyspace und einer Tabelle mit automatischem Skalierungsdurchsatz. |
| Erstellen eines Azure CosmosDB-Kontos |
Diese ARM-Vorlage soll schnell ein CosmosDB-Konto mit den minimal erforderlichen Werten erstellen. |
| Erstellen eines Azure Cosmos DB-Kontos in mehreren Regionen |
Diese Vorlage erstellt ein Azure Cosmos DB-Konto für jeden Datenbank-API-Typ mit einer primären und sekundären Region mit Auswahl zwischen Konsistenzebene und Failovertyp. |
| Erstellen eines Azure Cosmos DB-Kontos im Free-Tarif |
Mit dieser Vorlage wird ein Azure Cosmos DB-Konto für die SQL-API mit einer Datenbank mit freigegebenem Durchsatz und Container erstellt. |
| Erstellen eines Azure Cosmos DB-Kontos für die Gremlin-API |
Mit dieser Vorlage wird ein Azure Cosmos DB-Konto für die Gremlin-API in zwei Regionen mit einer Datenbank und einem Graphen mit dediziertem Durchsatz erstellt. |
| Erstellen eines Azure Cosmos DB-Kontos für die automatische Skalierung der Gremlin-API |
Mit dieser Vorlage wird ein Azure Cosmos DB-Konto für die Gremlin-API in zwei Regionen mit einer Datenbank und einem Graphen mithilfe des automatischen Skalierungsdurchsatzes erstellt. |
| Erstellen eines Azure Cosmos-Kontos für die MongoDB-API |
Mit dieser Vorlage wird ein Azure Cosmos DB-Konto für die MongoDB-API 4.2 in zwei Regionen mit freigegebenem und dediziertem Durchsatz mit zwei Sammlungen erstellt. |
| Erstellen eines Azure Cosmos-Kontos für die automatische Skalierung der MongoDB-API |
Mit dieser Vorlage wird ein Azure Cosmos DB-Konto für die MongoDB-API 4.2 in zwei Regionen erstellt, wobei sowohl der freigegebene als auch der dedizierte Durchsatz für die automatische Skalierung verwendet wird. |
| Erstellen eines Azure Cosmos DB-Kontos mit einem privaten Endpunkt |
Mit dieser Vorlage werden ein Cosmos-Konto, ein virtuelles Netzwerk und ein privater Endpunkt erstellt, der das Cosmos-Konto dem virtuellen Netzwerk verfügbar macht. |
| Erstellen eines Azure Cosmos DB-Kontos für die SQL-API (Core) |
Mit dieser Vorlage wird eine SQL-API (Azure Cosmos-Konto für Core) mit einer Datenbank und einem Container mit Durchsatz mit mehreren anderen Optionen erstellt. |
| SQL-API des Azure Cosmos DB-Kontos mit Analysespeicher |
Mit dieser Vorlage wird eine SQL-API (Azure Cosmos-Konto für Core) mit einer Datenbank und einem Container erstellt, die mit dem Analysespeicher konfiguriert sind. |
| Erstellen einer SQL-API für ein Azure Cosmos DB-Konto mit automatischer Skalierung |
Diese Vorlage erstellt eine SQL-API (Azure Cosmos-Konto für Core) mit einer Datenbank und einem Container mit automatischem Skalierungsdurchsatz mit mehreren anderen Optionen. |
| Erstellen gespeicherter Prozeduren der Azure Cosmos DB Core-API (SQL) |
Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die SQL-API (Core) und einen Container mit einer gespeicherten Prozedur, einem Trigger und einer benutzerdefinierten Funktion. |
| Erstellen eines minimalen Azure Cosmos DB-Kontos für die SQL-API (Core) |
Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die Core-API (SQL) und gibt dabei nur die minimal erforderlichen Ressourceneigenschaften an. |
| Erstellen von Azure Cosmos mit der SQL-API und mehreren Containern |
Die Vorlage erstellt einen Cosmos-Container mit einer SQL-API und ermöglicht das Hinzufügen von multiitple Containern. |
| Erstellen eines Azure Cosmos DB-SQL-Kontos mit RBAC auf Datenebene |
Mit dieser Vorlage wird ein SQL Cosmos-Konto erstellt, eine nativ gepflegte Rollendefinition und eine nativ gepflegte Rollenzuweisung für eine AAD-Identität. |
| Erstellen eines serverlosen Azure Cosmos DB-Kontos für die SQL-API |
Mit dieser Vorlage wird ein serverloses Azure Cosmos DB-Konto für die Core-API (SQL) erstellt. |
| Erstellen eines Azure Cosmos-Kontos für die Tabellen-API |
Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die Tabellen-API in zwei Regionen und eine einzelne Tabelle mit bereitgestelltem Durchsatz. |
| Erstellen eines Azure Cosmos-Kontos für die Tabellen-API mit automatischer Skalierung |
Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die Tabellen-API in zwei Regionen und eine einzelne Tabelle mit automatisch skaliertem Durchsatz. |
| Erstellen eines Zero Touch-Azure Cosmos-Kontos und einer Azure-Web-App |
Diese Vorlage erstellt ein Azure Cosmos-Konto, fügt den Cosmos DB-Endpunkt und Schlüssel in die Azure-Web-App-Einstellungen ein und stellt dann eine ASP MVC-Web-App von GitHub bereit. |
| Erstellen eines Cosmos DB-Kontos mit aktiviertem Microsoft Defender |
Mit dieser ARM-Vorlage können Sie ein Azure Cosmos DB-Konto mit aktiviertem Microsoft Defender für Azure Cosmos DB bereitstellen. Microsoft Defender für Azure Cosmos DB ist eine in Azure native Sicherheitsebene, die Versuche erkennt, Datenbanken in Ihren Azure Cosmos DB-Konten auszunutzen. Microsoft Defender für Azure Cosmos DB erkennt potenzielle SQL-Einschleusungen, bekannte böswillige Akteure basierend auf Microsoft Threat Intelligence, verdächtige Zugriffsmuster und potenzielle Nutzungen Ihrer Datenbank durch kompromittierte Identitäten oder böswillige Insider. |
| Bereitstellen von Azure Data Explorer DB mit Cosmos DB-Verbindung |
Bereitstellen von Azure Data Explorer DB mit Cosmos DB-Verbindung |
| Azure Cosmos DB-Konto mit Web-App |
Diese Vorlage stellt ein Azure Cosmos DB-Konto und einen App Service-Plan bereit und erstellt eine Web-App im App Service-Plan. Außerdem werden der Web-App zwei Anwendungseinstellungen hinzugefügt, die auf den Azure Cosmos DB-Kontoendpunkt verweisen. Auf diese Weise können lösungen, die in der Web-App bereitgestellt werden, mithilfe dieser Einstellungen eine Verbindung mit dem Azure Cosmos DB-Kontoendpunkt herstellen. |
Terraform-Ressourcendefinition (AzAPI-Anbieter)
Der Ressourcentyp databaseAccounts kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.DocumentDB/databaseAccounts-Ressource zu erstellen, fügen Sie Der Vorlage die folgende Terraform-Ressource hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts@2021-05-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 = {
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
}
]
databaseAccountOfferType = "Standard"
defaultIdentity = "string"
disableKeyBasedMetadataWriteAccess = 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"
virtualNetworkRules = [
{
id = "string"
ignoreMissingVNetServiceEndpoint = bool
}
]
}
kind = "string"
})
}
BackupPolicy-Objekte
Legen Sie die type-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für Continuous Folgendes:
type = "Continuous"
Verwenden Sie für Periodisch Folgendes:
type = "Periodic"
periodicModeProperties = {
backupIntervalInMinutes = int
backupRetentionIntervalInHours = int
}
Eigenschaftswerte
databaseAccounts
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Ressourcentyp | "Microsoft.DocumentDB/databaseAccounts@2021-05-15" |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) Zeichenlimit: 3-44 Gültige Zeichen: Kleinbuchstaben, Zahlen und Bindestriche. Beginnen Sie mit einem Kleinbuchstaben oder einer Zahl. Der Ressourcenname muss in Azure eindeutig sein. |
| location | Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. | Zeichenfolge |
| parent_id | Verwenden Sie zum Bereitstellen in einer Ressourcengruppe die ID dieser Ressourcengruppe. | Zeichenfolge (erforderlich) |
| tags | Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Beispielsweise ist die Standardumgebung für einen Vorlagentyp auf "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB". | Wörterbuch der Tagnamen und -werte. |
| kind | Gibt den Typ des Datenbankkontos an. Dies kann nur bei der Erstellung eines Datenbankkontos festgelegt werden. | "GlobalDocumentDB" "MongoDB" "Analysieren" |
| Identität | Identität für die Ressource. | ManagedServiceIdentity |
| properties | Eigenschaften zum Erstellen und Aktualisieren von Azure Cosmos DB-Datenbankkonten. | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (erforderlich) |
ManagedServiceIdentity
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" umfasst sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| identity_ids | Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs im Format "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | Array von Benutzeridentitäts-IDs. |
ManagedServiceIdentityUserAssignedIdentities
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| {angepasste Eigenschaft} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| analyticalStorageConfiguration | Analysespeicherspezifische Eigenschaften. | AnalyticalStorageConfiguration |
| apiProperties | API-spezifische Eigenschaften. Derzeit nur für die MongoDB-API unterstützt. | ApiProperties |
| backupPolicy | Das Objekt, das die Richtlinie zum Erstellen von Sicherungen für ein Konto darstellt. | BackupPolicy |
| capabilities | Liste der Cosmos DB-Funktionen für das Konto | Funktion[] |
| connectorOffer | Der Cassandra-Connectorangebotstyp für das C*-Konto der Cosmos DB-Datenbank. | "Klein" |
| consistencyPolicy | Die Konsistenzrichtlinie für das Cosmos DB-Konto. | ConsistencyPolicy |
| cors | Die CORS-Richtlinie für das Cosmos DB-Datenbankkonto. | CorsPolicy[] |
| databaseAccountOfferType | Der Angebotstyp für die Datenbank | "Standard" (erforderlich) |
| defaultIdentity | Die Standardidentität für den Zugriff auf Schlüsseltresor, die in Features wie kundenseitig verwalteten Schlüsseln verwendet wird. Die Standardidentität muss explizit von den Benutzern festgelegt werden. Es kann "FirstPartyIdentity", "SystemAssignedIdentity" und mehr sein. | Zeichenfolge |
| disableKeyBasedMetadataWriteAccess | Deaktivieren von Schreibvorgängen für Metadatenressourcen (Datenbanken, Container, Durchsatz) über Kontoschlüssel | bool |
| enableAnalyticalStorage | Flag, um anzugeben, ob Speicheranalysen aktiviert werden sollen. | bool |
| enableAutomaticFailover | Aktiviert das automatische Failover der Schreibregion in dem seltenen Fall, dass die Region aufgrund eines Ausfalls nicht verfügbar ist. Automatisches Failover führt zu einer neuen Schreibregion für das Konto und wird basierend auf den für das Konto konfigurierten Failoverprioritäten ausgewählt. | bool |
| enableCassandraConnector | Aktiviert den Cassandra-Connector für das Cosmos DB C*-Konto | bool |
| enableFreeTier | Flag, um anzugeben, ob der Free-Tarif aktiviert ist. | bool |
| enableMultipleWriteLocations | Ermöglicht dem Konto das Schreiben an mehreren Speicherorten. | bool |
| ipRules | Liste der IpRules. | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | Flag, um anzugeben, ob ACL-Regeln für virtuelle Netzwerke aktiviert/deaktiviert werden sollen. | bool |
| keyVaultKeyUri | Der URI des Schlüsseltresors | Zeichenfolge |
| locations | Ein Array, das die Georeplizierungsstandorte enthält, die für das Cosmos DB-Konto aktiviert sind. | Standort[] (erforderlich) |
| networkAclBypass | Gibt an, welche Dienste Firewallprüfungen umgehen dürfen. | "AzureServices" "None" |
| networkAclBypassResourceIds | Ein Array, das die Ressourcen-IDs für die Netzwerk-ACL-Umgehung für das Cosmos DB-Konto enthält. | string[] |
| publicNetworkAccess | Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind | "Deaktiviert" "Aktiviert" |
| virtualNetworkRules | Liste der ACL-Regeln für virtuelle Netzwerke, die für das Cosmos DB-Konto konfiguriert sind. | VirtualNetworkRule[] |
AnalyticalStorageConfiguration
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Schematype | Beschreibt die Schematypen für den analytischen Speicher. | "FullFidelity" "WellDefined" |
ApiProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| serverVersion | Beschreibt die ServerVersion eines MongoDB-Kontos. | "3.2" "3.6" "4.0" |
BackupPolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Festlegen des Objekttyps | Fortlaufend Periodisch (erforderlich) |
ContinuousModeBackupPolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Beschreibt den Modus von Sicherungen. | "Kontinuierlich" (erforderlich) |
PeriodicModeBackupPolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Beschreibt den Modus von Sicherungen. | "Periodisch" (erforderlich) |
| periodicModeProperties | Konfigurationswerte für die sicherung im periodischen Modus | PeriodicModeProperties |
PeriodicModeProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| backupIntervalInMinutes | Eine ganze Zahl, die das Intervall in Minuten zwischen zwei Sicherungen darstellt | INT Einschränkungen: Min-Wert = 0 |
| backupRetentionIntervalInHours | Eine ganze Zahl, die die Zeit (in Stunden) darstellt, zu der jede Sicherung beibehalten wird | INT Einschränkungen: Min-Wert = 0 |
Funktion
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Name der Cosmos DB-Funktion. Beispiel: "name": "EnableCassandra". Zu den aktuellen Werten gehören auch "EnableTable" und "EnableGremlin". | Zeichenfolge |
ConsistencyPolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| defaultConsistencyLevel | Die Standardkonsistenzebene und Konfigurationseinstellungen des Cosmos DB-Kontos. | "BoundedStaleness" "ConsistentPrefix" "Eventual" "Sitzung" "Stark" (erforderlich) |
| maxIntervalInSeconds | Bei Verwendung mit der Konsistenzebene der begrenzten Veraltung stellt dieser Wert den Tolerierten Zeitraum der Veraltung (in Sekunden) dar. Der zulässige Bereich für diesen Wert ist 5 bis 86400. Erforderlich, wenn defaultConsistencyPolicy auf "BoundedStaleness" festgelegt ist. | INT Einschränkungen: Min-Wert = 5 Maximaler Wert = 86400 |
| maxStalenessPrefix | Bei Verwendung mit der Konsistenzebene "Bounded Staleness" stellt dieser Wert die Anzahl veralteter Anforderungen dar, die toleriert werden. Für diesen Wert ist ein Bereich von 1 bis 2.147.483.647 zulässig. Erforderlich, wenn defaultConsistencyPolicy auf "BoundedStaleness" festgelegt ist. | INT Einschränkungen: Min-Wert = 1 Maximaler Wert = 2147483647 |
CorsPolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| allowedHeaders | Die Anforderungsheader, die die Ursprungsdomäne für die CORS-Anforderung angeben kann. | Zeichenfolge |
| allowedMethods | Die Methoden (HTTP-Anforderungsverben), die die Ursprungsdomäne für eine CORS-Anforderung verwenden kann. | Zeichenfolge |
| allowedOrigins | Die Ursprungsdomänen, die über CORS eine Anforderung an den Dienst stellen dürfen. | Zeichenfolge (erforderlich) |
| exposedHeaders | Die Antwortheader, die in der Antwort an die CORS-Anforderung gesendet und vom Browser gegenüber dem Anforderungsaussteller verfügbar gemacht werden können. | Zeichenfolge |
| maxAgeInSeconds | Die maximale Zeit, über die die OPTIONS-Preflight-Anforderung vom Browser zwischengespeichert werden soll. | INT Einschränkungen: Min-Wert = 1 Maximaler Wert = 2147483647 |
IpAddressOrRange
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| ipAddressOrRange | Eine einzelne IPv4-Adresse oder ein einzelner IPv4-Adressbereich im CIDR-Format. Bereitgestellte IP-Adressen müssen gut formatiert sein und können nicht in einem der folgenden Bereiche enthalten sein: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, da diese durch den IP-Adressfilter nicht durchsetzbar sind. Beispiel für gültige Eingaben: "23.40.210.245" oder "23.40.210.0/8". | Zeichenfolge |
Standort
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| failoverPriority | Die Failoverpriorität der Region. Eine Failoverpriorität von 0 gibt einen Schreibbereich an. Der maximale Wert für eine Failoverpriorität = (Gesamtanzahl der Regionen - 1). Failoverprioritätswerte müssen für jede Region, in der das Datenbankkonto vorhanden ist, eindeutig sein. | INT Einschränkungen: Minimaler Wert = 0 |
| isZoneRedundant | Flag, um anzugeben, ob es sich bei dieser Region um eine AvailabilityZone-Region handelt | bool |
| locationName | Der Name der Region. | Zeichenfolge |
VirtualNetworkRule
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| id | Ressourcen-ID eines Subnetzes, z. B.: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. | Zeichenfolge |
| ignoreMissingVNetServiceEndpoint | Erstellen Sie eine Firewallregel, bevor der VNET-Dienstendpunkt für das virtuelle Netzwerk aktiviert ist. | bool |