Freigeben über

Microsoft.DocumentDB databaseAccounts 2024-05-15

  • Artikel

Bicep-Ressourcendefinition

Der Ressourcentyp "databaseAccounts" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

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 Bicep hinzu.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2024-05-15' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  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'
      }
    ]
    capacity: {
      totalThroughputLimit: int
    }
    connectorOffer: 'string'
    consistencyPolicy: {
      defaultConsistencyLevel: 'string'
      maxIntervalInSeconds: int
      maxStalenessPrefix: int
    }
    cors: [
      {
        allowedHeaders: 'string'
        allowedMethods: 'string'
        allowedOrigins: 'string'
        exposedHeaders: 'string'
        maxAgeInSeconds: int
      }
    ]
    createMode: 'string'
    customerManagedKeyStatus: 'string'
    databaseAccountOfferType: 'Standard'
    defaultIdentity: 'string'
    disableKeyBasedMetadataWriteAccess: bool
    disableLocalAuth: bool
    enableAnalyticalStorage: bool
    enableAutomaticFailover: bool
    enableBurstCapacity: bool
    enableCassandraConnector: bool
    enableFreeTier: bool
    enableMultipleWriteLocations: bool
    enablePartitionMerge: bool
    ipRules: [
      {
        ipAddressOrRange: 'string'
      }
    ]
    isVirtualNetworkFilterEnabled: bool
    keyVaultKeyUri: 'string'
    locations: [
      {
        failoverPriority: int
        isZoneRedundant: bool
        locationName: 'string'
      }
    ]
    minimalTlsVersion: 'string'
    networkAclBypass: 'string'
    networkAclBypassResourceIds: [
      'string'
    ]
    publicNetworkAccess: 'string'
    restoreParameters: {
      databasesToRestore: [
        {
          collectionNames: [
            'string'
          ]
          databaseName: 'string'
        }
      ]
      gremlinDatabasesToRestore: [
        {
          databaseName: 'string'
          graphNames: [
            'string'
          ]
        }
      ]
      restoreMode: 'string'
      restoreSource: 'string'
      restoreTimestampInUtc: 'string'
      tablesToRestore: [
        'string'
      ]
    }
    virtualNetworkRules: [
      {
        id: 'string'
        ignoreMissingVNetServiceEndpoint: bool
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

BackupPolicy-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für fortlaufende:

{
  continuousModeProperties: {
    tier: 'string'
  }
  type: 'Continuous'
}

Verwenden Sie für periodischen:

{
  periodicModeProperties: {
    backupIntervalInMinutes: int
    backupRetentionIntervalInHours: int
    backupStorageRedundancy: 'string'
  }
  type: 'Periodic'
}

Eigenschaftswerte

AnalyticalStorageConfiguration

Name Beschreibung Wert
schemaType Beschreibt die Schematypen für die analytische Speicherung. "FullFidelity"
"WellDefined"

ApiProperties

Name Beschreibung Wert
serverVersion Beschreibt die ServerVersion eines MongoDB-Kontos. '3.2'
'3.6'
'4.0'
'4.2'
'5.0'
'6.0'

BackupPolicy

Name Beschreibung Wert
migrationState Das Objekt, das den Status der Migration zwischen den Sicherungsrichtlinien darstellt. BackupPolicyMigrationState-
Art Legen Sie für den Typ ContinuousModeBackupPolicy-auf "Fortlaufend" fest. Legen Sie für den Typ PeriodischeModeBackupPolicy-auf "Periodisch" fest. "Fortlaufend"
"Periodisch" (erforderlich)

BackupPolicyMigrationState

Name Beschreibung Wert
startTime Zeitpunkt, zu dem die Migration der Sicherungsrichtlinie gestartet wurde (ISO-8601-Format). Schnur
Status Beschreibt den Status der Migration zwischen Sicherungsrichtlinientypen. "Abgeschlossen"
'Fehler'
"InProgress"
'Ungültig'
targetType Beschreibt den Ziel-Sicherungsrichtlinientyp der Migration der Sicherungsrichtlinie. "Fortlaufend"
"Periodisch"

Fähigkeit

Name Beschreibung Wert
Name Name der Cosmos DB-Funktion. Beispiel: "name": "EnableCassandra". Aktuelle Werte enthalten auch "EnableTable" und "EnableGremlin". Schnur

Fassungsvermögen

Name Beschreibung Wert
totalThroughputLimit Die für das Konto auferlegte Gesamtdurchsatzgrenze. Ein TotalThroughputLimit von 2000 legt einen strengen Grenzwert für den maximalen Durchsatz fest, der für dieses Konto auf 2000 bereitgestellt werden kann. Ein totalthroughputLimit von -1 gibt keine Grenzwerte für die Bereitstellung des Durchsatzes an. Int

Zwänge:
Min-Wert = -1

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Name Beschreibung Wert

ConsistencyPolicy

Name Beschreibung Wert
defaultConsistencyLevel Die Standardkonsistenzstufe und Konfigurationseinstellungen des Cosmos DB-Kontos. "BoundedStaleness"
"ConsistentPrefix"
"Eventual"
"Sitzung"
"Stark" (erforderlich)
maxIntervalInSeconds Wenn dieser Wert mit der Konsistenzstufe "Konsistenz" "Bounded Staleness" verwendet wird, stellt dieser Wert den Zeitraum der veralteten (in Sekunden) tolerierten Konsistenz dar. Der zulässige Bereich für diesen Wert beträgt 5 - 86400. Erforderlich, wenn defaultConsistencyPolicy auf "BoundedStaleness" festgelegt ist. Int

Zwänge:
Min.-Wert = 5
Maximalwert = 86400
maxStalenessPrefix Bei Verwendung mit der Konsistenzstufe "Bounded Staleness" stellt dieser Wert die Anzahl veralteter Anforderungen dar, die toleriert werden. Der zulässige Bereich für diesen Wert beträgt 1 – 2.147.483.647. Erforderlich, wenn defaultConsistencyPolicy auf "BoundedStaleness" festgelegt ist. Int

Zwänge:
Min.-Wert = 1
Max. Wert = 2147483647

ContinuousModeBackupPolicy

Name Beschreibung Wert
continuousModeProperties Konfigurationswerte für die Sicherung des fortlaufenden Modus ContinuousModeProperties-
Art Beschreibt den Modus der Sicherungen. "Fortlaufend" (erforderlich)

ContinuousModeProperties

Name Beschreibung Wert
Rang Enumeration zur Angabe des Typs des fortlaufenden Sicherungsmodus "Continuous30Days"
"Continuous7Days"

CorsPolicy

Name Beschreibung Wert
allowedHeaders Die Anforderungsheader, die die Ursprungsdomäne für die CORS-Anforderung angeben kann. Schnur
allowedMethods Die Methoden (HTTP-Anforderungsverben), die die Ursprungsdomäne für eine CORS-Anforderung verwenden kann. Schnur
allowedOrigins Die Ursprungsdomänen, die eine Anforderung an den Dienst über CORS stellen dürfen. Zeichenfolge (erforderlich)
exposedHeaders Die Antwortheader, die möglicherweise in der Antwort auf die CORS-Anforderung gesendet und vom Browser dem Anforderungsherausgeber verfügbar gemacht werden. Schnur
maxAgeInSeconds Die maximale Zeit, die ein Browser zwischenspeichern soll, die Preflight OPTIONS-Anforderung. Int

Zwänge:
Min.-Wert = 1
Max. Wert = 2147483647

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Name Beschreibung Wert
analyticalStorageConfiguration Analytische Speicherspezifische Eigenschaften. 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-
Fähigkeiten Liste der Cosmos DB-Funktionen für das Konto Funktion[]
Fassungsvermögen Das Objekt, das alle Eigenschaften im Zusammenhang mit der Kapazitätserzwingung für ein Konto darstellt. Kapazität
connectorOffer Der Cassandra Connector-Angebotstyp für das Cosmos DB-Datenbank-C*-Konto. "Klein"
consistencyPolicy Die Konsistenzrichtlinie für das Cosmos DB-Konto. ConsistencyPolicy-
Cors Die CORS-Richtlinie für das Cosmos DB-Datenbankkonto. CorsPolicy[]
createMode Aufzählung, um den Modus der Kontoerstellung anzugeben. 'Standard'
"Wiederherstellen"
customerManagedKeyStatus Gibt den Status des Features "Vom Kunden verwalteter Schlüssel" für das Konto an. Falls Fehler auftreten, bietet die Eigenschaft Anleitungen zur Problembehandlung. Schnur
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 vom Kunden verwalteten Schlüsseln verwendet wird. Die Standardidentität muss explizit von den Benutzern festgelegt werden. Dies kann "FirstPartyIdentity", "SystemAssignedIdentity" und mehr sein. Schnur
disableKeyBasedMetadataWriteAccess Deaktivieren von Schreibvorgängen für Metadatenressourcen (Datenbanken, Container, Durchsatz) über Kontoschlüssel Bool
disableLocalAuth Deaktivieren Sie die lokale Authentifizierung, und stellen Sie sicher, dass nur MSI und AAD ausschließlich für die Authentifizierung verwendet werden können. Bool
enableAnalyticalStorage Kennzeichnen, um anzugeben, ob Speicheranalysen aktiviert werden sollen. Bool
enableAutomaticFailover Aktiviert das automatische Failover des Schreibbereichs im seltenen Fall, dass die Region aufgrund eines Ausfalls nicht verfügbar ist. Das automatische Failover führt zu einem neuen Schreibbereich für das Konto und wird basierend auf den für das Konto konfigurierten Failoverprioritäten ausgewählt. Bool
enableBurstCapacity Flag zum Aktivieren/Deaktivieren der Funktion "Burst Capacity" auf dem Konto Bool
enableCassandraConnector Aktiviert den Cassandra Connector auf dem Cosmos DB C*-Konto Bool
enableFreeTier Kennzeichnung, um anzugeben, ob die kostenlose Leiste aktiviert ist. Bool
enableMultipleWriteLocations Ermöglicht das Schreiben des Kontos an mehreren Speicherorten. Bool
enablePartitionMerge Flag zum Aktivieren/Deaktivieren der Partitionszusammenführungsfunktion für das Konto Bool
ipRules Liste der IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Kennzeichnen, um anzugeben, ob ACL-Regeln für virtuelle Netzwerke aktiviert/deaktiviert werden sollen. Bool
keyVaultKeyUri Der URI des Schlüsseltresors Schnur
Orte Ein Array, das die georeplizierten Speicherorte enthält, die für das Cosmos DB-Konto aktiviert sind. Location[] (erforderlich)
minimalTlsVersion Gibt die mindestens zulässige Tls-Version an. Der Standardwert ist Tls 1.2. Cassandra- und Mongo-APIs funktionieren nur mit Tls 1.2. 'Tls'
'Tls11'
'Tls12'
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 Gibt an, ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind. "Deaktiviert"
"Aktiviert"
"SecuredByPerimeter"
restoreParameters Parameter, die die Informationen zur Wiederherstellung angeben sollen. RestoreParameters-
virtualNetworkRules Liste der Virtual Network ACL-Regeln, die für das Cosmos DB-Konto konfiguriert sind. VirtualNetworkRule[]

DatabaseRestoreResource

Name Beschreibung Wert
collectionNames Die Namen der für die Wiederherstellung verfügbaren Auflistungen. string[]
databaseName Der Name der Datenbank, die für die Wiederherstellung verfügbar ist. Schnur

GremlinDatabaseRestoreResource

Name Beschreibung Wert
databaseName Der Name der gremlin-Datenbank, die für die Wiederherstellung verfügbar ist. Schnur
graphNames Die Namen der Diagramme, die für die Wiederherstellung verfügbar sind. string[]

IpAddressOrRange

Name Beschreibung Wert
ipAddressOrRange Eine einzelne IPv4-Adresse oder ein einzelner IPv4-Adressbereich im CIDR-Format. Die bereitgestellten IPs 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.0/12, 192.168.0.0/16, da diese vom IP-Adressfilter nicht erzwingbar sind. Beispiel für gültige Eingaben: "23.40.210.245" oder "23.40.210.0/8". Schnur

Ort

Name Beschreibung Wert
failoverPriority Die Failoverpriorität der Region. Eine Failoverpriorität von 0 gibt einen Schreibbereich an. Der Maximalwert für eine Failoverpriorität = (Gesamtanzahl der Regionen - 1). Failoverprioritätswerte müssen für jede der Regionen eindeutig sein, in denen das Datenbankkonto vorhanden ist. Int

Zwänge:
Min.-Wert = 0
isZoneRedundant Kennzeichnen, um anzugeben, ob es sich bei dieser Region um eine AvailabilityZone-Region handelt. Bool
locationName Der Name der Region. Schnur

ManagedServiceIdentity

Name Beschreibung Wert
Art 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 Gruppe von vom Benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. 'None'
'SystemAssigned'
"SystemAssigned,UserAssigned"
"UserAssigned"
userAssignedIdentities Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities-

ManagedServiceIdentityUserAssignedIdentities

Name Beschreibung Wert

Microsoft.DocumentDB/databaseAccounts

Name Beschreibung Wert
Identität Identität für die Ressource. ManagedServiceIdentity-
Art Gibt den Typ des Datenbankkontos an. Dies kann nur bei der Datenbankkontoerstellung festgelegt werden. "GlobalDocumentDB"
'MongoDB'
'Analysieren'
Ort Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. Schnur
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 3
Max. Länge = 3
Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (erforderlich)
Eigenschaften Eigenschaften zum Erstellen und Aktualisieren von Azure Cosmos DB-Datenbankkonten. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (erforderlich)
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen

PeriodModeBackupPolicy

Name Beschreibung Wert
periodModeProperties Konfigurationswerte für die Sicherung des periodischen Modus PeriodicModeProperties-
Art Beschreibt den Modus der Sicherungen. "Periodisch" (erforderlich)

PeriodicModeProperties

Name Beschreibung Wert
backupIntervalInMinutes Eine ganze Zahl, die das Intervall in Minuten zwischen zwei Sicherungen darstellt Int

Zwänge:
Min.-Wert = 0
backupRetentionIntervalInHours Eine ganze Zahl, die die Zeit (in Stunden) darstellt, die für jede Sicherung aufbewahrt wird Int

Zwänge:
Min.-Wert = 0
backupStorageRedundancy Enumeration zur Angabe des Typs der Sicherungs-Residency "Geo"
"Lokal"
"Zone"

RestoreParameters

Name Beschreibung Wert
databasesToRestore Liste bestimmter Datenbanken, die für die Wiederherstellung verfügbar sind. DatabaseRestoreResource-[]
gremlinDatabasesToRestore Liste der spezifischen Gremlin-Datenbanken, die für die Wiederherstellung verfügbar sind. GremlinDatabaseRestoreResource[]
restoreMode Beschreibt den Modus der Wiederherstellung. 'PointInTime'
restoreSource Die ID des wiederherstellbaren Datenbankkontos, von dem die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} Schnur
restoreTimestampInUtc Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format). Schnur
tablesToRestore Liste der für die Wiederherstellung verfügbaren spezifischen Tabellen. string[]

Schilder

Name Beschreibung Wert

VirtualNetworkRule

Name Beschreibung Wert
id Ressourcen-ID eines Subnetzes, z. B.: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. Schnur
ignoreMissingVNetServiceEndpoint Erstellen Sie Firewallregel, bevor der virtuelle Netzwerk-Dienstendpunkt aktiviert ist. Bool

Schnellstartbeispiele

Die folgenden Schnellstartbeispiele stellen diesen Ressourcentyp bereit.

Bicep-Datei Beschreibung
Azure Cosmos DB-Konto-SQL-API mit analytischem Speicher Diese Vorlage erstellt ein Azure Cosmos-Konto für die Core-API (SQL) mit einer Datenbank und einem Container, der mit dem analytischen Speicher konfiguriert ist.
Azure Cosmos DB-Konto mit Web App- Diese Vorlage stellt ein Azure Cosmos DB-Konto, 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.
Erstellen eines Cosmos DB-Kontos mit aktiviertem Microsoft Defender Mithilfe 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 systemeigene Azure-Sicherheitsebene, die Versuche erkennt, Datenbanken in Ihren Azure Cosmos DB-Konten auszunutzen. Microsoft Defender für Azure Cosmos DB erkennt potenzielle SQL-Einfügungen, bekannte schlechte Akteure basierend auf Microsoft Threat Intelligence, verdächtige Zugriffsmuster und potenzielle Ausbeutung Ihrer Datenbank durch kompromittierte Identitäten oder böswillige Insider.
Erstellen eines kostenlosen Azure Cosmos DB-Kontos Diese Vorlage erstellt ein freistufiges Azure Cosmos DB-Konto für die SQL-API mit einer Datenbank mit freigegebenem Durchsatz und Container.
Erstellen eines minimalen Azure Cosmos DB-Kontos für die SQL-API- Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die Core-API (SQL), wobei nur die minimal erforderlichen Ressourceneigenschaften angegeben werden.
Erstellen eines serverlosen Azure Cosmos DB-Kontos für SQL-API- Diese Vorlage erstellt ein serverloses Azure Cosmos DB-Konto für die Core-API (SQL).
Erstellen eines Azure Cosmos-Kontos ohne Fingereingabe und azure Web App- Diese Vorlage erstellt ein Azure Cosmos-Konto, fügt den Cosmos DB-Endpunkt und Schlüssel in azure Web App-Einstellungen ein und stellt dann eine ASP MVC-Web-App von GitHub bereit.
Erstellen eines Azure Cosmos-Kontos für mongoDB-API- Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die MongoDB-API 4.2 in zwei Regionen, wobei der gemeinsame und dedizierte Durchsatz mit zwei Sammlungen verwendet wird.
Erstellen eines Azure Cosmos-Kontos für die autoskalen der MongoDB-API Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die MongoDB-API 4.2 in zwei Regionen, die sowohl den gemeinsam genutzten als auch den dedizierten Autoskalendurchsatz verwenden.
Erstellen eines Azure Cosmos-Kontos für 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 autoskalen Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die Tabellen-API in zwei Regionen und eine einzelne Tabelle mit autoskalen Durchsatz.
Erstellen eines Azure Cosmos DB-Kontos für 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 dediziertem Durchsatz.
Erstellen eines Azure Cosmos DB-Kontos für die SQL-API- Diese Vorlage erstellt ein Azure Cosmos-Konto für die Core-API (SQL) mit einer Datenbank und einem Container mit Durchsatz mit mehreren anderen Optionen.
Erstellen eines Azure Cosmos DB-Kontos für gremlin-API- Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die Gremlin-API in zwei Regionen mit einer Datenbank und einem Diagramm mit dediziertem Durchsatz.
Erstellen eines Azure Cosmos DB-Kontos für gremlin-API autoscale Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die Gremlin-API in zwei Regionen mit einer Datenbank und einem Diagramm mit autoskalen Durchsatz.
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 der Konsistenzstufe und des Failovertyps.
Erstellen einer SQL-Konto-API für Azure Cosmos DB mit automatischer Skalierung Diese Vorlage erstellt ein Azure Cosmos-Konto für die Core-API (SQL) mit einer Datenbank und einem Container mit automatischem Durchsatz mit mehreren anderen Optionen.
Erstellen eines Azure Cosmos DB-Kontos mit einem privaten Endpunkt Diese Vorlage erstellt ein Cosmos-Konto, ein virtuelles Netzwerk und einen privaten Endpunkt, der das Cosmos-Konto dem virtuellen Netzwerk offen legt.
Erstellen eines Azure Cosmos DB SQL-Kontos mit RBAC- Diese Vorlage erstellt ein SQL Cosmos-Konto, eine systemeigene verwaltete Rollendefinition und eine systemeigene verwaltete Rollenzuweisung für eine AAD-Identität.
Erstellen eines Azure CosmosDB-Kontos Diese ARM-Vorlage soll schnell ein CosmosDB-Konto mit den minimal erforderlichen Werten erstellen.
Erstellen eines Autoskalen-Azure Cosmos DB-Kontos für 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 autoskalen Durchsatz.
Erstellen von gespeicherten Prozeduren der Azure Cosmos DB Core -API (SQL) Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die Core-API (SQL) und einen Container mit einer gespeicherten Prozedur, triggern und benutzerdefinierten Funktion.
Erstellt eine Dapr Microservices-App mit Container-Apps Erstellen Sie eine Dapr Microservices-App mit Container-Apps.
Erstellt eine Dapr pub-sub servicebus-App mit Container-Apps Erstellen Sie eine Dapr pub-sub servicebus-App mit Container-Apps.
Bereitstellen von Azure Data Explorer DB mit Cosmos DB-Verbindung Bereitstellen von Azure Data Explorer DB mit Cosmos DB-Verbindung.

ARM-Vorlagenressourcendefinition

Der Ressourcentyp "databaseAccounts" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

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": "2024-05-15",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "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"
      }
    ],
    "capacity": {
      "totalThroughputLimit": "int"
    },
    "connectorOffer": "string",
    "consistencyPolicy": {
      "defaultConsistencyLevel": "string",
      "maxIntervalInSeconds": "int",
      "maxStalenessPrefix": "int"
    },
    "cors": [
      {
        "allowedHeaders": "string",
        "allowedMethods": "string",
        "allowedOrigins": "string",
        "exposedHeaders": "string",
        "maxAgeInSeconds": "int"
      }
    ],
    "createMode": "string",
    "customerManagedKeyStatus": "string",
    "databaseAccountOfferType": "Standard",
    "defaultIdentity": "string",
    "disableKeyBasedMetadataWriteAccess": "bool",
    "disableLocalAuth": "bool",
    "enableAnalyticalStorage": "bool",
    "enableAutomaticFailover": "bool",
    "enableBurstCapacity": "bool",
    "enableCassandraConnector": "bool",
    "enableFreeTier": "bool",
    "enableMultipleWriteLocations": "bool",
    "enablePartitionMerge": "bool",
    "ipRules": [
      {
        "ipAddressOrRange": "string"
      }
    ],
    "isVirtualNetworkFilterEnabled": "bool",
    "keyVaultKeyUri": "string",
    "locations": [
      {
        "failoverPriority": "int",
        "isZoneRedundant": "bool",
        "locationName": "string"
      }
    ],
    "minimalTlsVersion": "string",
    "networkAclBypass": "string",
    "networkAclBypassResourceIds": [ "string" ],
    "publicNetworkAccess": "string",
    "restoreParameters": {
      "databasesToRestore": [
        {
          "collectionNames": [ "string" ],
          "databaseName": "string"
        }
      ],
      "gremlinDatabasesToRestore": [
        {
          "databaseName": "string",
          "graphNames": [ "string" ]
        }
      ],
      "restoreMode": "string",
      "restoreSource": "string",
      "restoreTimestampInUtc": "string",
      "tablesToRestore": [ "string" ]
    },
    "virtualNetworkRules": [
      {
        "id": "string",
        "ignoreMissingVNetServiceEndpoint": "bool"
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

BackupPolicy-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für fortlaufende:

{
  "continuousModeProperties": {
    "tier": "string"
  },
  "type": "Continuous"
}

Verwenden Sie für periodischen:

{
  "periodicModeProperties": {
    "backupIntervalInMinutes": "int",
    "backupRetentionIntervalInHours": "int",
    "backupStorageRedundancy": "string"
  },
  "type": "Periodic"
}

Eigenschaftswerte

AnalyticalStorageConfiguration

Name Beschreibung Wert
schemaType Beschreibt die Schematypen für die analytische Speicherung. "FullFidelity"
"WellDefined"

ApiProperties

Name Beschreibung Wert
serverVersion Beschreibt die ServerVersion eines MongoDB-Kontos. '3.2'
'3.6'
'4.0'
'4.2'
'5.0'
'6.0'

BackupPolicy

Name Beschreibung Wert
migrationState Das Objekt, das den Status der Migration zwischen den Sicherungsrichtlinien darstellt. BackupPolicyMigrationState-
Art Legen Sie für den Typ ContinuousModeBackupPolicy-auf "Fortlaufend" fest. Legen Sie für den Typ PeriodischeModeBackupPolicy-auf "Periodisch" fest. "Fortlaufend"
"Periodisch" (erforderlich)

BackupPolicyMigrationState

Name Beschreibung Wert
startTime Zeitpunkt, zu dem die Migration der Sicherungsrichtlinie gestartet wurde (ISO-8601-Format). Schnur
Status Beschreibt den Status der Migration zwischen Sicherungsrichtlinientypen. "Abgeschlossen"
'Fehler'
"InProgress"
'Ungültig'
targetType Beschreibt den Ziel-Sicherungsrichtlinientyp der Migration der Sicherungsrichtlinie. "Fortlaufend"
"Periodisch"

Fähigkeit

Name Beschreibung Wert
Name Name der Cosmos DB-Funktion. Beispiel: "name": "EnableCassandra". Aktuelle Werte enthalten auch "EnableTable" und "EnableGremlin". Schnur

Fassungsvermögen

Name Beschreibung Wert
totalThroughputLimit Die für das Konto auferlegte Gesamtdurchsatzgrenze. Ein TotalThroughputLimit von 2000 legt einen strengen Grenzwert für den maximalen Durchsatz fest, der für dieses Konto auf 2000 bereitgestellt werden kann. Ein totalthroughputLimit von -1 gibt keine Grenzwerte für die Bereitstellung des Durchsatzes an. Int

Zwänge:
Min-Wert = -1

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Name Beschreibung Wert

ConsistencyPolicy

Name Beschreibung Wert
defaultConsistencyLevel Die Standardkonsistenzstufe und Konfigurationseinstellungen des Cosmos DB-Kontos. "BoundedStaleness"
"ConsistentPrefix"
"Eventual"
"Sitzung"
"Stark" (erforderlich)
maxIntervalInSeconds Wenn dieser Wert mit der Konsistenzstufe "Konsistenz" "Bounded Staleness" verwendet wird, stellt dieser Wert den Zeitraum der veralteten (in Sekunden) tolerierten Konsistenz dar. Der zulässige Bereich für diesen Wert beträgt 5 - 86400. Erforderlich, wenn defaultConsistencyPolicy auf "BoundedStaleness" festgelegt ist. Int

Zwänge:
Min.-Wert = 5
Maximalwert = 86400
maxStalenessPrefix Bei Verwendung mit der Konsistenzstufe "Bounded Staleness" stellt dieser Wert die Anzahl veralteter Anforderungen dar, die toleriert werden. Der zulässige Bereich für diesen Wert beträgt 1 – 2.147.483.647. Erforderlich, wenn defaultConsistencyPolicy auf "BoundedStaleness" festgelegt ist. Int

Zwänge:
Min.-Wert = 1
Max. Wert = 2147483647

ContinuousModeBackupPolicy

Name Beschreibung Wert
continuousModeProperties Konfigurationswerte für die Sicherung des fortlaufenden Modus ContinuousModeProperties-
Art Beschreibt den Modus der Sicherungen. "Fortlaufend" (erforderlich)

ContinuousModeProperties

Name Beschreibung Wert
Rang Enumeration zur Angabe des Typs des fortlaufenden Sicherungsmodus "Continuous30Days"
"Continuous7Days"

CorsPolicy

Name Beschreibung Wert
allowedHeaders Die Anforderungsheader, die die Ursprungsdomäne für die CORS-Anforderung angeben kann. Schnur
allowedMethods Die Methoden (HTTP-Anforderungsverben), die die Ursprungsdomäne für eine CORS-Anforderung verwenden kann. Schnur
allowedOrigins Die Ursprungsdomänen, die eine Anforderung an den Dienst über CORS stellen dürfen. Zeichenfolge (erforderlich)
exposedHeaders Die Antwortheader, die möglicherweise in der Antwort auf die CORS-Anforderung gesendet und vom Browser dem Anforderungsherausgeber verfügbar gemacht werden. Schnur
maxAgeInSeconds Die maximale Zeit, die ein Browser zwischenspeichern soll, die Preflight OPTIONS-Anforderung. Int

Zwänge:
Min.-Wert = 1
Max. Wert = 2147483647

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Name Beschreibung Wert
analyticalStorageConfiguration Analytische Speicherspezifische Eigenschaften. 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-
Fähigkeiten Liste der Cosmos DB-Funktionen für das Konto Funktion[]
Fassungsvermögen Das Objekt, das alle Eigenschaften im Zusammenhang mit der Kapazitätserzwingung für ein Konto darstellt. Kapazität
connectorOffer Der Cassandra Connector-Angebotstyp für das Cosmos DB-Datenbank-C*-Konto. "Klein"
consistencyPolicy Die Konsistenzrichtlinie für das Cosmos DB-Konto. ConsistencyPolicy-
Cors Die CORS-Richtlinie für das Cosmos DB-Datenbankkonto. CorsPolicy[]
createMode Aufzählung, um den Modus der Kontoerstellung anzugeben. 'Standard'
"Wiederherstellen"
customerManagedKeyStatus Gibt den Status des Features "Vom Kunden verwalteter Schlüssel" für das Konto an. Falls Fehler auftreten, bietet die Eigenschaft Anleitungen zur Problembehandlung. Schnur
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 vom Kunden verwalteten Schlüsseln verwendet wird. Die Standardidentität muss explizit von den Benutzern festgelegt werden. Dies kann "FirstPartyIdentity", "SystemAssignedIdentity" und mehr sein. Schnur
disableKeyBasedMetadataWriteAccess Deaktivieren von Schreibvorgängen für Metadatenressourcen (Datenbanken, Container, Durchsatz) über Kontoschlüssel Bool
disableLocalAuth Deaktivieren Sie die lokale Authentifizierung, und stellen Sie sicher, dass nur MSI und AAD ausschließlich für die Authentifizierung verwendet werden können. Bool
enableAnalyticalStorage Kennzeichnen, um anzugeben, ob Speicheranalysen aktiviert werden sollen. Bool
enableAutomaticFailover Aktiviert das automatische Failover des Schreibbereichs im seltenen Fall, dass die Region aufgrund eines Ausfalls nicht verfügbar ist. Das automatische Failover führt zu einem neuen Schreibbereich für das Konto und wird basierend auf den für das Konto konfigurierten Failoverprioritäten ausgewählt. Bool
enableBurstCapacity Flag zum Aktivieren/Deaktivieren der Funktion "Burst Capacity" auf dem Konto Bool
enableCassandraConnector Aktiviert den Cassandra Connector auf dem Cosmos DB C*-Konto Bool
enableFreeTier Kennzeichnung, um anzugeben, ob die kostenlose Leiste aktiviert ist. Bool
enableMultipleWriteLocations Ermöglicht das Schreiben des Kontos an mehreren Speicherorten. Bool
enablePartitionMerge Flag zum Aktivieren/Deaktivieren der Partitionszusammenführungsfunktion für das Konto Bool
ipRules Liste der IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Kennzeichnen, um anzugeben, ob ACL-Regeln für virtuelle Netzwerke aktiviert/deaktiviert werden sollen. Bool
keyVaultKeyUri Der URI des Schlüsseltresors Schnur
Orte Ein Array, das die georeplizierten Speicherorte enthält, die für das Cosmos DB-Konto aktiviert sind. Location[] (erforderlich)
minimalTlsVersion Gibt die mindestens zulässige Tls-Version an. Der Standardwert ist Tls 1.2. Cassandra- und Mongo-APIs funktionieren nur mit Tls 1.2. 'Tls'
'Tls11'
'Tls12'
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 Gibt an, ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind. "Deaktiviert"
"Aktiviert"
"SecuredByPerimeter"
restoreParameters Parameter, die die Informationen zur Wiederherstellung angeben sollen. RestoreParameters-
virtualNetworkRules Liste der Virtual Network ACL-Regeln, die für das Cosmos DB-Konto konfiguriert sind. VirtualNetworkRule[]

DatabaseRestoreResource

Name Beschreibung Wert
collectionNames Die Namen der für die Wiederherstellung verfügbaren Auflistungen. string[]
databaseName Der Name der Datenbank, die für die Wiederherstellung verfügbar ist. Schnur

GremlinDatabaseRestoreResource

Name Beschreibung Wert
databaseName Der Name der gremlin-Datenbank, die für die Wiederherstellung verfügbar ist. Schnur
graphNames Die Namen der Diagramme, die für die Wiederherstellung verfügbar sind. string[]

IpAddressOrRange

Name Beschreibung Wert
ipAddressOrRange Eine einzelne IPv4-Adresse oder ein einzelner IPv4-Adressbereich im CIDR-Format. Die bereitgestellten IPs 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.0/12, 192.168.0.0/16, da diese vom IP-Adressfilter nicht erzwingbar sind. Beispiel für gültige Eingaben: "23.40.210.245" oder "23.40.210.0/8". Schnur

Ort

Name Beschreibung Wert
failoverPriority Die Failoverpriorität der Region. Eine Failoverpriorität von 0 gibt einen Schreibbereich an. Der Maximalwert für eine Failoverpriorität = (Gesamtanzahl der Regionen - 1). Failoverprioritätswerte müssen für jede der Regionen eindeutig sein, in denen das Datenbankkonto vorhanden ist. Int

Zwänge:
Min.-Wert = 0
isZoneRedundant Kennzeichnen, um anzugeben, ob es sich bei dieser Region um eine AvailabilityZone-Region handelt. Bool
locationName Der Name der Region. Schnur

ManagedServiceIdentity

Name Beschreibung Wert
Art 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 Gruppe von vom Benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. 'None'
'SystemAssigned'
"SystemAssigned,UserAssigned"
"UserAssigned"
userAssignedIdentities Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities-

ManagedServiceIdentityUserAssignedIdentities

Name Beschreibung Wert

Microsoft.DocumentDB/databaseAccounts

Name Beschreibung Wert
apiVersion Die API-Version '2024-05-15'
Identität Identität für die Ressource. ManagedServiceIdentity-
Art Gibt den Typ des Datenbankkontos an. Dies kann nur bei der Datenbankkontoerstellung festgelegt werden. "GlobalDocumentDB"
'MongoDB'
'Analysieren'
Ort Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. Schnur
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 3
Max. Länge = 3
Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (erforderlich)
Eigenschaften Eigenschaften zum Erstellen und Aktualisieren von Azure Cosmos DB-Datenbankkonten. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (erforderlich)
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Art Der Ressourcentyp 'Microsoft.DocumentDB/databaseAccounts'

PeriodModeBackupPolicy

Name Beschreibung Wert
periodModeProperties Konfigurationswerte für die Sicherung des periodischen Modus PeriodicModeProperties-
Art Beschreibt den Modus der Sicherungen. "Periodisch" (erforderlich)

PeriodicModeProperties

Name Beschreibung Wert
backupIntervalInMinutes Eine ganze Zahl, die das Intervall in Minuten zwischen zwei Sicherungen darstellt Int

Zwänge:
Min.-Wert = 0
backupRetentionIntervalInHours Eine ganze Zahl, die die Zeit (in Stunden) darstellt, die für jede Sicherung aufbewahrt wird Int

Zwänge:
Min.-Wert = 0
backupStorageRedundancy Enumeration zur Angabe des Typs der Sicherungs-Residency "Geo"
"Lokal"
"Zone"

RestoreParameters

Name Beschreibung Wert
databasesToRestore Liste bestimmter Datenbanken, die für die Wiederherstellung verfügbar sind. DatabaseRestoreResource-[]
gremlinDatabasesToRestore Liste der spezifischen Gremlin-Datenbanken, die für die Wiederherstellung verfügbar sind. GremlinDatabaseRestoreResource[]
restoreMode Beschreibt den Modus der Wiederherstellung. 'PointInTime'
restoreSource Die ID des wiederherstellbaren Datenbankkontos, von dem die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} Schnur
restoreTimestampInUtc Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format). Schnur
tablesToRestore Liste der für die Wiederherstellung verfügbaren spezifischen Tabellen. string[]

Schilder

Name Beschreibung Wert

VirtualNetworkRule

Name Beschreibung Wert
id Ressourcen-ID eines Subnetzes, z. B.: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. Schnur
ignoreMissingVNetServiceEndpoint Erstellen Sie Firewallregel, bevor der virtuelle Netzwerk-Dienstendpunkt aktiviert ist. Bool

Schnellstartvorlagen

Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.

Schablone Beschreibung
Azure Cosmos DB-Konto-SQL-API mit analytischem Speicher

Bereitstellen in Azure 		Diese Vorlage erstellt ein Azure Cosmos-Konto für die Core-API (SQL) mit einer Datenbank und einem Container, der mit dem analytischen Speicher konfiguriert ist.
Azure Cosmos DB-Konto mit Web App-

Bereitstellen in Azure 		Diese Vorlage stellt ein Azure Cosmos DB-Konto, 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.
CI/CD mit Jenkins im Azure Container Service (AKS)

Bereitstellen in Azure 		Container machen es Ihnen sehr einfach, Ihre Anwendungen kontinuierlich zu erstellen und bereitzustellen. Durch die Orchestrierung der Bereitstellung dieser Container mithilfe von Kubernetes im Azure-Containerdienst können Sie replizierbare, verwaltbare Cluster von Containern erreichen. Indem Sie einen kontinuierlichen Build einrichten, um Ihre Containerimages und -orchestrierung zu erzeugen, können Sie die Geschwindigkeit und Zuverlässigkeit Ihrer Bereitstellung erhöhen.
Erstellen eines Cosmos DB-Kontos mit aktiviertem Microsoft Defender

Bereitstellen in Azure 		Mithilfe 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 systemeigene Azure-Sicherheitsebene, die Versuche erkennt, Datenbanken in Ihren Azure Cosmos DB-Konten auszunutzen. Microsoft Defender für Azure Cosmos DB erkennt potenzielle SQL-Einfügungen, bekannte schlechte Akteure basierend auf Microsoft Threat Intelligence, verdächtige Zugriffsmuster und potenzielle Ausbeutung Ihrer Datenbank durch kompromittierte Identitäten oder böswillige Insider.
Erstellen eines kostenlosen Azure Cosmos DB-Kontos

Bereitstellen in Azure 		Diese Vorlage erstellt ein freistufiges Azure Cosmos DB-Konto für die SQL-API mit einer Datenbank mit freigegebenem Durchsatz und Container.
Erstellen eines minimalen Azure Cosmos DB-Kontos für die SQL-API-

Bereitstellen in Azure 		Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die Core-API (SQL), wobei nur die minimal erforderlichen Ressourceneigenschaften angegeben werden.
Erstellen eines serverlosen Azure Cosmos DB-Kontos für SQL-API-

Bereitstellen in Azure 		Diese Vorlage erstellt ein serverloses Azure Cosmos DB-Konto für die Core-API (SQL).
Erstellen eines Azure Cosmos-Kontos ohne Fingereingabe und azure Web App-

Bereitstellen in Azure 		Diese Vorlage erstellt ein Azure Cosmos-Konto, fügt den Cosmos DB-Endpunkt und Schlüssel in azure Web App-Einstellungen ein und stellt dann eine ASP MVC-Web-App von GitHub bereit.
Erstellen eines Azure Cosmos-Kontos für mongoDB-API-

Bereitstellen in Azure 		Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die MongoDB-API 4.2 in zwei Regionen, wobei der gemeinsame und dedizierte Durchsatz mit zwei Sammlungen verwendet wird.
Erstellen eines Azure Cosmos-Kontos für die autoskalen der MongoDB-API

Bereitstellen in Azure 		Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die MongoDB-API 4.2 in zwei Regionen, die sowohl den gemeinsam genutzten als auch den dedizierten Autoskalendurchsatz verwenden.
Erstellen eines Azure Cosmos-Kontos für tabellen-API-

Bereitstellen in Azure 		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 autoskalen

Bereitstellen in Azure 		Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die Tabellen-API in zwei Regionen und eine einzelne Tabelle mit autoskalen Durchsatz.
Erstellen eines Azure Cosmos DB-Kontos für cassandra-API-

Bereitstellen in Azure 		Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die Cassandra-API in zwei Regionen mit einem Keyspace und einer Tabelle mit dediziertem Durchsatz.
Erstellen eines Azure Cosmos DB-Kontos für die SQL-API-

Bereitstellen in Azure 		Diese Vorlage erstellt ein Azure Cosmos-Konto für die Core-API (SQL) mit einer Datenbank und einem Container mit Durchsatz mit mehreren anderen Optionen.
Erstellen eines Azure Cosmos DB-Kontos für gremlin-API-

Bereitstellen in Azure 		Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die Gremlin-API in zwei Regionen mit einer Datenbank und einem Diagramm mit dediziertem Durchsatz.
Erstellen eines Azure Cosmos DB-Kontos für gremlin-API autoscale

Bereitstellen in Azure 		Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die Gremlin-API in zwei Regionen mit einer Datenbank und einem Diagramm mit autoskalen Durchsatz.
Erstellen eines Azure Cosmos DB-Kontos in mehreren Regionen

Bereitstellen in Azure 		Diese Vorlage erstellt ein Azure Cosmos DB-Konto für jeden Datenbank-API-Typ mit einer primären und sekundären Region mit Auswahl der Konsistenzstufe und des Failovertyps.
Erstellen einer SQL-Konto-API für Azure Cosmos DB mit automatischer Skalierung

Bereitstellen in Azure 		Diese Vorlage erstellt ein Azure Cosmos-Konto für die Core-API (SQL) mit einer Datenbank und einem Container mit automatischem Durchsatz mit mehreren anderen Optionen.
Erstellen eines Azure Cosmos DB-Kontos mit einem privaten Endpunkt

Bereitstellen in Azure 		Diese Vorlage erstellt ein Cosmos-Konto, ein virtuelles Netzwerk und einen privaten Endpunkt, der das Cosmos-Konto dem virtuellen Netzwerk offen legt.
Erstellen eines Azure Cosmos DB SQL-Kontos mit RBAC-

Bereitstellen in Azure 		Diese Vorlage erstellt ein SQL Cosmos-Konto, eine systemeigene verwaltete Rollendefinition und eine systemeigene verwaltete Rollenzuweisung für eine AAD-Identität.
Erstellen eines Azure CosmosDB-Kontos

Bereitstellen in Azure 		Diese ARM-Vorlage soll schnell ein CosmosDB-Konto mit den minimal erforderlichen Werten erstellen.
Erstellen eines Autoskalen-Azure Cosmos DB-Kontos für cassandra-API-

Bereitstellen in Azure 		Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die Cassandra-API in zwei Regionen mit einem Keyspace und einer Tabelle mit autoskalen Durchsatz.
Erstellen von gespeicherten Prozeduren der Azure Cosmos DB Core -API (SQL)

Bereitstellen in Azure 		Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die Core-API (SQL) und einen Container mit einer gespeicherten Prozedur, triggern und benutzerdefinierten Funktion.
Erstellen von Azure Cosmos mit SQL-API und mehreren Containern

Bereitstellen in Azure 		Die Vorlage erstellt einen Cosmos-Container mit einer SQL-API und ermöglicht das Hinzufügen von multiitple Containern.
Erstellt eine Dapr Microservices-App mit Container-Apps

Bereitstellen in Azure 		Erstellen Sie eine Dapr Microservices-App mit Container-Apps.
Erstellt eine Dapr pub-sub servicebus-App mit Container-Apps

Bereitstellen in Azure 		Erstellen Sie eine Dapr pub-sub servicebus-App mit Container-Apps.
Bereitstellen von Azure Data Explorer DB mit Cosmos DB-Verbindung

Bereitstellen in Azure 		Bereitstellen von Azure Data Explorer DB mit Cosmos DB-Verbindung.
Web App mit einer SQL-Datenbank, Azure Cosmos DB, Azure Search

Bereitstellen in Azure 		Diese Vorlage enthält eine Web App, eine SQL-Datenbank, Azure Cosmos DB, Azure Search und Application Insights.

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 unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/databaseAccounts-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts@2024-05-15"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  kind = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  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"
        }
      ]
      capacity = {
        totalThroughputLimit = int
      }
      connectorOffer = "string"
      consistencyPolicy = {
        defaultConsistencyLevel = "string"
        maxIntervalInSeconds = int
        maxStalenessPrefix = int
      }
      cors = [
        {
          allowedHeaders = "string"
          allowedMethods = "string"
          allowedOrigins = "string"
          exposedHeaders = "string"
          maxAgeInSeconds = int
        }
      ]
      createMode = "string"
      customerManagedKeyStatus = "string"
      databaseAccountOfferType = "Standard"
      defaultIdentity = "string"
      disableKeyBasedMetadataWriteAccess = bool
      disableLocalAuth = bool
      enableAnalyticalStorage = bool
      enableAutomaticFailover = bool
      enableBurstCapacity = bool
      enableCassandraConnector = bool
      enableFreeTier = bool
      enableMultipleWriteLocations = bool
      enablePartitionMerge = bool
      ipRules = [
        {
          ipAddressOrRange = "string"
        }
      ]
      isVirtualNetworkFilterEnabled = bool
      keyVaultKeyUri = "string"
      locations = [
        {
          failoverPriority = int
          isZoneRedundant = bool
          locationName = "string"
        }
      ]
      minimalTlsVersion = "string"
      networkAclBypass = "string"
      networkAclBypassResourceIds = [
        "string"
      ]
      publicNetworkAccess = "string"
      restoreParameters = {
        databasesToRestore = [
          {
            collectionNames = [
              "string"
            ]
            databaseName = "string"
          }
        ]
        gremlinDatabasesToRestore = [
          {
            databaseName = "string"
            graphNames = [
              "string"
            ]
          }
        ]
        restoreMode = "string"
        restoreSource = "string"
        restoreTimestampInUtc = "string"
        tablesToRestore = [
          "string"
        ]
      }
      virtualNetworkRules = [
        {
          id = "string"
          ignoreMissingVNetServiceEndpoint = bool
        }
      ]
    }
  })
}

BackupPolicy-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für fortlaufende:

{
  continuousModeProperties = {
    tier = "string"
  }
  type = "Continuous"
}

Verwenden Sie für periodischen:

{
  periodicModeProperties = {
    backupIntervalInMinutes = int
    backupRetentionIntervalInHours = int
    backupStorageRedundancy = "string"
  }
  type = "Periodic"
}

Eigenschaftswerte

AnalyticalStorageConfiguration

Name Beschreibung Wert
schemaType Beschreibt die Schematypen für die analytische Speicherung. "FullFidelity"
"WellDefined"

ApiProperties

Name Beschreibung Wert
serverVersion Beschreibt die ServerVersion eines MongoDB-Kontos. '3.2'
'3.6'
'4.0'
'4.2'
'5.0'
'6.0'

BackupPolicy

Name Beschreibung Wert
migrationState Das Objekt, das den Status der Migration zwischen den Sicherungsrichtlinien darstellt. BackupPolicyMigrationState-
Art Legen Sie für den Typ ContinuousModeBackupPolicy-auf "Fortlaufend" fest. Legen Sie für den Typ PeriodischeModeBackupPolicy-auf "Periodisch" fest. "Fortlaufend"
"Periodisch" (erforderlich)

BackupPolicyMigrationState

Name Beschreibung Wert
startTime Zeitpunkt, zu dem die Migration der Sicherungsrichtlinie gestartet wurde (ISO-8601-Format). Schnur
Status Beschreibt den Status der Migration zwischen Sicherungsrichtlinientypen. "Abgeschlossen"
'Fehler'
"InProgress"
'Ungültig'
targetType Beschreibt den Ziel-Sicherungsrichtlinientyp der Migration der Sicherungsrichtlinie. "Fortlaufend"
"Periodisch"

Fähigkeit

Name Beschreibung Wert
Name Name der Cosmos DB-Funktion. Beispiel: "name": "EnableCassandra". Aktuelle Werte enthalten auch "EnableTable" und "EnableGremlin". Schnur

Fassungsvermögen

Name Beschreibung Wert
totalThroughputLimit Die für das Konto auferlegte Gesamtdurchsatzgrenze. Ein TotalThroughputLimit von 2000 legt einen strengen Grenzwert für den maximalen Durchsatz fest, der für dieses Konto auf 2000 bereitgestellt werden kann. Ein totalthroughputLimit von -1 gibt keine Grenzwerte für die Bereitstellung des Durchsatzes an. Int

Zwänge:
Min-Wert = -1

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Name Beschreibung Wert

ConsistencyPolicy

Name Beschreibung Wert
defaultConsistencyLevel Die Standardkonsistenzstufe und Konfigurationseinstellungen des Cosmos DB-Kontos. "BoundedStaleness"
"ConsistentPrefix"
"Eventual"
"Sitzung"
"Stark" (erforderlich)
maxIntervalInSeconds Wenn dieser Wert mit der Konsistenzstufe "Konsistenz" "Bounded Staleness" verwendet wird, stellt dieser Wert den Zeitraum der veralteten (in Sekunden) tolerierten Konsistenz dar. Der zulässige Bereich für diesen Wert beträgt 5 - 86400. Erforderlich, wenn defaultConsistencyPolicy auf "BoundedStaleness" festgelegt ist. Int

Zwänge:
Min.-Wert = 5
Maximalwert = 86400
maxStalenessPrefix Bei Verwendung mit der Konsistenzstufe "Bounded Staleness" stellt dieser Wert die Anzahl veralteter Anforderungen dar, die toleriert werden. Der zulässige Bereich für diesen Wert beträgt 1 – 2.147.483.647. Erforderlich, wenn defaultConsistencyPolicy auf "BoundedStaleness" festgelegt ist. Int

Zwänge:
Min.-Wert = 1
Max. Wert = 2147483647

ContinuousModeBackupPolicy

Name Beschreibung Wert
continuousModeProperties Konfigurationswerte für die Sicherung des fortlaufenden Modus ContinuousModeProperties-
Art Beschreibt den Modus der Sicherungen. "Fortlaufend" (erforderlich)

ContinuousModeProperties

Name Beschreibung Wert
Rang Enumeration zur Angabe des Typs des fortlaufenden Sicherungsmodus "Continuous30Days"
"Continuous7Days"

CorsPolicy

Name Beschreibung Wert
allowedHeaders Die Anforderungsheader, die die Ursprungsdomäne für die CORS-Anforderung angeben kann. Schnur
allowedMethods Die Methoden (HTTP-Anforderungsverben), die die Ursprungsdomäne für eine CORS-Anforderung verwenden kann. Schnur
allowedOrigins Die Ursprungsdomänen, die eine Anforderung an den Dienst über CORS stellen dürfen. Zeichenfolge (erforderlich)
exposedHeaders Die Antwortheader, die möglicherweise in der Antwort auf die CORS-Anforderung gesendet und vom Browser dem Anforderungsherausgeber verfügbar gemacht werden. Schnur
maxAgeInSeconds Die maximale Zeit, die ein Browser zwischenspeichern soll, die Preflight OPTIONS-Anforderung. Int

Zwänge:
Min.-Wert = 1
Max. Wert = 2147483647

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Name Beschreibung Wert
analyticalStorageConfiguration Analytische Speicherspezifische Eigenschaften. 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-
Fähigkeiten Liste der Cosmos DB-Funktionen für das Konto Funktion[]
Fassungsvermögen Das Objekt, das alle Eigenschaften im Zusammenhang mit der Kapazitätserzwingung für ein Konto darstellt. Kapazität
connectorOffer Der Cassandra Connector-Angebotstyp für das Cosmos DB-Datenbank-C*-Konto. "Klein"
consistencyPolicy Die Konsistenzrichtlinie für das Cosmos DB-Konto. ConsistencyPolicy-
Cors Die CORS-Richtlinie für das Cosmos DB-Datenbankkonto. CorsPolicy[]
createMode Aufzählung, um den Modus der Kontoerstellung anzugeben. 'Standard'
"Wiederherstellen"
customerManagedKeyStatus Gibt den Status des Features "Vom Kunden verwalteter Schlüssel" für das Konto an. Falls Fehler auftreten, bietet die Eigenschaft Anleitungen zur Problembehandlung. Schnur
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 vom Kunden verwalteten Schlüsseln verwendet wird. Die Standardidentität muss explizit von den Benutzern festgelegt werden. Dies kann "FirstPartyIdentity", "SystemAssignedIdentity" und mehr sein. Schnur
disableKeyBasedMetadataWriteAccess Deaktivieren von Schreibvorgängen für Metadatenressourcen (Datenbanken, Container, Durchsatz) über Kontoschlüssel Bool
disableLocalAuth Deaktivieren Sie die lokale Authentifizierung, und stellen Sie sicher, dass nur MSI und AAD ausschließlich für die Authentifizierung verwendet werden können. Bool
enableAnalyticalStorage Kennzeichnen, um anzugeben, ob Speicheranalysen aktiviert werden sollen. Bool
enableAutomaticFailover Aktiviert das automatische Failover des Schreibbereichs im seltenen Fall, dass die Region aufgrund eines Ausfalls nicht verfügbar ist. Das automatische Failover führt zu einem neuen Schreibbereich für das Konto und wird basierend auf den für das Konto konfigurierten Failoverprioritäten ausgewählt. Bool
enableBurstCapacity Flag zum Aktivieren/Deaktivieren der Funktion "Burst Capacity" auf dem Konto Bool
enableCassandraConnector Aktiviert den Cassandra Connector auf dem Cosmos DB C*-Konto Bool
enableFreeTier Kennzeichnung, um anzugeben, ob die kostenlose Leiste aktiviert ist. Bool
enableMultipleWriteLocations Ermöglicht das Schreiben des Kontos an mehreren Speicherorten. Bool
enablePartitionMerge Flag zum Aktivieren/Deaktivieren der Partitionszusammenführungsfunktion für das Konto Bool
ipRules Liste der IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Kennzeichnen, um anzugeben, ob ACL-Regeln für virtuelle Netzwerke aktiviert/deaktiviert werden sollen. Bool
keyVaultKeyUri Der URI des Schlüsseltresors Schnur
Orte Ein Array, das die georeplizierten Speicherorte enthält, die für das Cosmos DB-Konto aktiviert sind. Location[] (erforderlich)
minimalTlsVersion Gibt die mindestens zulässige Tls-Version an. Der Standardwert ist Tls 1.2. Cassandra- und Mongo-APIs funktionieren nur mit Tls 1.2. 'Tls'
'Tls11'
'Tls12'
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 Gibt an, ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind. "Deaktiviert"
"Aktiviert"
"SecuredByPerimeter"
restoreParameters Parameter, die die Informationen zur Wiederherstellung angeben sollen. RestoreParameters-
virtualNetworkRules Liste der Virtual Network ACL-Regeln, die für das Cosmos DB-Konto konfiguriert sind. VirtualNetworkRule[]

DatabaseRestoreResource

Name Beschreibung Wert
collectionNames Die Namen der für die Wiederherstellung verfügbaren Auflistungen. string[]
databaseName Der Name der Datenbank, die für die Wiederherstellung verfügbar ist. Schnur

GremlinDatabaseRestoreResource

Name Beschreibung Wert
databaseName Der Name der gremlin-Datenbank, die für die Wiederherstellung verfügbar ist. Schnur
graphNames Die Namen der Diagramme, die für die Wiederherstellung verfügbar sind. string[]

IpAddressOrRange

Name Beschreibung Wert
ipAddressOrRange Eine einzelne IPv4-Adresse oder ein einzelner IPv4-Adressbereich im CIDR-Format. Die bereitgestellten IPs 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.0/12, 192.168.0.0/16, da diese vom IP-Adressfilter nicht erzwingbar sind. Beispiel für gültige Eingaben: "23.40.210.245" oder "23.40.210.0/8". Schnur

Ort

Name Beschreibung Wert
failoverPriority Die Failoverpriorität der Region. Eine Failoverpriorität von 0 gibt einen Schreibbereich an. Der Maximalwert für eine Failoverpriorität = (Gesamtanzahl der Regionen - 1). Failoverprioritätswerte müssen für jede der Regionen eindeutig sein, in denen das Datenbankkonto vorhanden ist. Int

Zwänge:
Min.-Wert = 0
isZoneRedundant Kennzeichnen, um anzugeben, ob es sich bei dieser Region um eine AvailabilityZone-Region handelt. Bool
locationName Der Name der Region. Schnur

ManagedServiceIdentity

Name Beschreibung Wert
Art 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 Gruppe von vom Benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. 'None'
'SystemAssigned'
"SystemAssigned,UserAssigned"
"UserAssigned"
userAssignedIdentities Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities-

ManagedServiceIdentityUserAssignedIdentities

Name Beschreibung Wert

Microsoft.DocumentDB/databaseAccounts

Name Beschreibung Wert
Identität Identität für die Ressource. ManagedServiceIdentity-
Art Gibt den Typ des Datenbankkontos an. Dies kann nur bei der Datenbankkontoerstellung festgelegt werden. "GlobalDocumentDB"
'MongoDB'
'Analysieren'
Ort Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. Schnur
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 3
Max. Länge = 3
Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (erforderlich)
Eigenschaften Eigenschaften zum Erstellen und Aktualisieren von Azure Cosmos DB-Datenbankkonten. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (erforderlich)
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte.
Art Der Ressourcentyp "Microsoft.DocumentDB/databaseAccounts@2024-05-15"

PeriodModeBackupPolicy

Name Beschreibung Wert
periodModeProperties Konfigurationswerte für die Sicherung des periodischen Modus PeriodicModeProperties-
Art Beschreibt den Modus der Sicherungen. "Periodisch" (erforderlich)

PeriodicModeProperties

Name Beschreibung Wert
backupIntervalInMinutes Eine ganze Zahl, die das Intervall in Minuten zwischen zwei Sicherungen darstellt Int

Zwänge:
Min.-Wert = 0
backupRetentionIntervalInHours Eine ganze Zahl, die die Zeit (in Stunden) darstellt, die für jede Sicherung aufbewahrt wird Int

Zwänge:
Min.-Wert = 0
backupStorageRedundancy Enumeration zur Angabe des Typs der Sicherungs-Residency "Geo"
"Lokal"
"Zone"

RestoreParameters

Name Beschreibung Wert
databasesToRestore Liste bestimmter Datenbanken, die für die Wiederherstellung verfügbar sind. DatabaseRestoreResource-[]
gremlinDatabasesToRestore Liste der spezifischen Gremlin-Datenbanken, die für die Wiederherstellung verfügbar sind. GremlinDatabaseRestoreResource[]
restoreMode Beschreibt den Modus der Wiederherstellung. 'PointInTime'
restoreSource Die ID des wiederherstellbaren Datenbankkontos, von dem die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} Schnur
restoreTimestampInUtc Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format). Schnur
tablesToRestore Liste der für die Wiederherstellung verfügbaren spezifischen Tabellen. string[]

Schilder

Name Beschreibung Wert

VirtualNetworkRule

Name Beschreibung Wert
id Ressourcen-ID eines Subnetzes, z. B.: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. Schnur
ignoreMissingVNetServiceEndpoint Erstellen Sie Firewallregel, bevor der virtuelle Netzwerk-Dienstendpunkt aktiviert ist. Bool