Microsoft.DocumentDB databaseAccounts 2021-04-01-preview

Artikel
12/16/2024

Bicep-Ressourcendefinition

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

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2021-04-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    apiProperties: {
      serverVersion: 'string'
    }
    backupPolicy: {
      type: 'string'
      // For remaining properties, see BackupPolicy objects
    }
    capabilities: [
      {
        name: 'string'
      }
    ]
    connectorOffer: 'string'
    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
      }
    ]
    createMode: 'string'
    // For remaining properties, see DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties objects
  }
  tags: {
    {customized property}: 'string'
  }
}

BackupPolicy-Objekte

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

Verwenden Sie für fortlaufende:

{
  type: 'Continuous'
}

Verwenden Sie für periodischen:

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

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties-Objekte

Legen Sie die createMode--Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für Standard-:

{
  createMode: 'Default'
}

Verwenden Sie für Wiederherstellen:

{
  createMode: 'Restore'
  restoreParameters: {
    databasesToRestore: [
      {
        collectionNames: [
          'string'
        ]
        databaseName: 'string'
      }
    ]
    restoreMode: 'string'
    restoreSource: 'string'
    restoreTimestampInUtc: 'string'
  }
}

Eigenschaftswerte

ApiProperties

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

BackupPolicy

Name	Beschreibung	Wert
Art	Legen Sie für den Typ ContinuousModeBackupPolicy-auf "Fortlaufend" fest. Legen Sie für den Typ PeriodischeModeBackupPolicy-auf "Periodisch" fest.	"Fortlaufend" "Periodisch" (erforderlich)

Fähigkeit

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

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
Art	Beschreibt den Modus der Sicherungen.	"Fortlaufend" (erforderlich)

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
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[]
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	Legen Sie für den Typ DefaultRequestDatabaseAccountCreateUpdatePropertiesauf "Standard" fest. Set to 'Restore' for type RestoreReqeustDatabaseAccountCreateUpdateProperties.	'Standard' "Wiederherstellen" (erforderlich)
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
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
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
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)
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"
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

DefaultRequestDatabaseAccountCreateUpdateProperties

Name	Beschreibung	Wert
createMode	Aufzählung, um den Modus der Kontoerstellung anzugeben.	'Standard' (erforderlich)

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