Delen via

Microsoft.DocumentDB databaseAccounts 2024-12-01-preview

  • Artikel

Bicep-resourcedefinitie

Het resourcetype databaseAccounts kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource Microsoft.DocumentDB/databaseAccounts wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2024-12-01-preview' = {
  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
    }
    capacityMode: 'string'
    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'
    defaultPriorityLevel: 'string'
    diagnosticLogSettings: {
      enableFullTextQuery: 'string'
    }
    disableKeyBasedMetadataWriteAccess: bool
    disableLocalAuth: bool
    enableAnalyticalStorage: bool
    enableAutomaticFailover: bool
    enableBurstCapacity: bool
    enableCassandraConnector: bool
    enableFreeTier: bool
    enableMaterializedViews: bool
    enableMultipleWriteLocations: bool
    enablePartitionMerge: bool
    enablePerRegionPerPartitionAutoscale: bool
    enablePriorityBasedExecution: 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'
      restoreWithTtlDisabled: bool
      sourceBackupLocation: 'string'
      tablesToRestore: [
        'string'
      ]
    }
    virtualNetworkRules: [
      {
        id: 'string'
        ignoreMissingVNetServiceEndpoint: bool
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

BackupPolicy-objecten

Stel de eigenschap type in om het type object op te geven.

Gebruik voor Continue:

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

Gebruik voor periodieke:

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

Eigenschapswaarden

AnalyticalStorageConfiguration

Naam Beschrijving Waarde
schemaType Beschrijft de typen schema's voor analytische opslag. 'FullFidelity'
'WellDefined'

ApiProperties

Naam Beschrijving Waarde
serverVersion Beschrijft de versie van het MongoDB-account. '3.2'
'3.6'
'4.0'
'4.2'
'5.0'
'6.0'
'7.0'

BackupPolicy

Naam Beschrijving Waarde
migrationState Het object dat de status van de migratie tussen het back-upbeleid weergeeft. BackupPolicyMigrationState
type Ingesteld op Doorlopend voor type ContinuousModeBackupPolicy. Ingesteld op 'Periodiek' voor het type PeriodicModeBackupPolicy. 'Doorlopend'
'Periodiek' (vereist)

BackupPolicyMigrationState

Naam Beschrijving Waarde
startTime Tijdstip waarop de migratie van het back-upbeleid is gestart (ISO-8601-indeling). snaar
status Beschrijft de status van de migratie tussen back-upbeleidstypen. 'Voltooid'
'Mislukt'
'InProgress'
'Ongeldig'
targetType Beschrijft het doelback-upbeleidstype van de migratie van het back-upbeleid. 'Doorlopend'
'Periodiek'

Vermogen

Naam Beschrijving Waarde
naam Naam van de Cosmos DB-functie. Bijvoorbeeld 'name': 'EnableCassandra'. De huidige waarden omvatten ook 'EnableTable' en 'EnableGremlin'. snaar

Capaciteit

Naam Beschrijving Waarde
totalThroughputLimit De totale doorvoerlimiet die voor het account is ingesteld. Een totalThroughputLimit van 2000 legt een strikte limiet op voor maximale doorvoer die voor dat account kan worden ingericht voor 2000. Een totalThroughputLimit van -1 geeft geen limieten aan voor het inrichten van doorvoer. Int

Beperkingen:
Minimumwaarde = -1

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Naam Beschrijving Waarde

ConsistencyPolicy

Naam Beschrijving Waarde
defaultConsistencyLevel Het standaardconsistentieniveau en de configuratie-instellingen van het Cosmos DB-account. 'BoundedStaleness'
'ConsistentPrefix'
'Uiteindelijk'
'Sessie'
'Sterk' (vereist)
maxIntervalInSeconds Bij gebruik met het consistentieniveau Gebonden veroudering vertegenwoordigt deze waarde de tijdsduur van veroudering (in seconden) die wordt getolereerd. Geaccepteerd bereik voor deze waarde is 5 - 86400. Vereist wanneer defaultConsistencyPolicy is ingesteld op 'BoundedStaleness'. Int

Beperkingen:
Minimumwaarde = 5
Maximumwaarde = 86400
maxStalenessPrefix Wanneer deze waarde wordt gebruikt met het consistentieniveau Gebonden veroudering, vertegenwoordigt deze waarde het aantal verlopen aanvragen dat wordt getolereerd. Geaccepteerd bereik voor deze waarde is 1 – 2.147.483.647. Vereist wanneer defaultConsistencyPolicy is ingesteld op 'BoundedStaleness'. Int

Beperkingen:
Minimumwaarde = 1
Maximumwaarde = 2147483647

ContinuousModeBackupPolicy

Naam Beschrijving Waarde
continuousModeProperties Configuratiewaarden voor back-up van continue modus ContinuousModeProperties-
type Beschrijft de modus van back-ups. Doorlopend (vereist)

ContinuousModeProperties

Naam Beschrijving Waarde
rang Enum om het type back-upmodus van Continuos aan te geven 'Continuous30Days'
'Continuous7Days'

CorsPolicy

Naam Beschrijving Waarde
allowedHeaders De aanvraagheaders die het oorspronkelijke domein kan opgeven voor de CORS-aanvraag. snaar
allowedMethods De methoden (HTTP-aanvraagwoorden) die het oorspronkelijke domein kan gebruiken voor een CORS-aanvraag. snaar
allowedOrigins De oorspronkelijke domeinen die via CORS een aanvraag voor de service mogen indienen. tekenreeks (vereist)
exposedHeaders De antwoordheaders die kunnen worden verzonden in het antwoord op de CORS-aanvraag en die door de browser worden weergegeven aan de verlener van de aanvraag. snaar
maxAgeInSeconds De maximale hoeveelheid tijd die een browser moet opslaan in de cache van de preflight OPTIONS-aanvraag. Int

Beperkingen:
Minimumwaarde = 1
Maximumwaarde = 2147483647

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Naam Beschrijving Waarde
analyticalStorageConfiguration Specifieke eigenschappen voor analytische opslag. AnalyticalStorageConfiguration-
apiProperties API-specifieke eigenschappen. Momenteel wordt alleen ondersteund voor mongoDB-API. ApiProperties-
backupPolicy Het object dat het beleid vertegenwoordigt voor het maken van back-ups voor een account. BackupPolicy-
Mogelijkheden Lijst met Cosmos DB-mogelijkheden voor het account Mogelijkheid[]
capaciteit Het object dat alle eigenschappen vertegenwoordigt die betrekking hebben op het afdwingen van capaciteit voor een account. Capaciteit
capacityMode Geeft de capacityMode van het Cosmos DB-account aan. 'Geen'
'Ingericht'
'Serverloos'
connectorOffer De cassandra-connectoraanbiedingstype voor het Cosmos DB-database-C*-account. 'Klein'
consistencyPolicy Het consistentiebeleid voor het Cosmos DB-account. ConsistencyPolicy-
cors Het CORS-beleid voor het Cosmos DB-databaseaccount. CorsPolicy[]
createMode Opsomming om de modus voor het maken van accounts aan te geven. 'Standaard'
'Herstellen'
customerManagedKeyStatus Geeft de status aan van de functie Door klant beheerde sleutel in het account. Als er fouten zijn, biedt de eigenschap richtlijnen voor probleemoplossing. snaar
databaseAccountOfferType Het aanbiedingstype voor de database 'Standaard' (vereist)
defaultIdentity De standaardidentiteit voor toegang tot de sleutelkluis die wordt gebruikt in functies zoals door de klant beheerde sleutels. De standaardidentiteit moet expliciet worden ingesteld door de gebruikers. Het kan FirstPartyIdentity, SystemAssignedIdentity en meer zijn. snaar
defaultPriorityLevel Opsomming om het standaardprioriteitsniveau van de aanvraag voor uitvoering op basis van prioriteit aan te geven. 'Hoog'
'Laag'
diagnosticLogSettings Het object dat de verschillende diagnostische logboekinstellingen voor het Cosmos DB-account vertegenwoordigt. DiagnosticLogSettings
disableKeyBasedMetadataWriteAccess Schrijfbewerkingen uitschakelen voor metagegevensresources (databases, containers, doorvoer) via accountsleutels Bool
disableLocalAuth Meld u af voor lokale verificatie en zorg ervoor dat alleen MSI en AAD uitsluitend voor verificatie kunnen worden gebruikt. Bool
enableAnalyticalStorage Vlag om aan te geven of opslaganalyse moet worden ingeschakeld. Bool
enableAutomaticFailover Maakt automatische failover van de schrijfregio mogelijk in de zeldzame gebeurtenis dat de regio niet beschikbaar is vanwege een storing. Automatische failover resulteert in een nieuwe schrijfregio voor het account en wordt gekozen op basis van de failoverprioriteiten die voor het account zijn geconfigureerd. Bool
enableBurstCapacity Vlag om aan te geven dat de functie Burst Capacity Preview voor het account is ingeschakeld/uitgeschakeld Bool
enableCassandraConnector Hiermee schakelt u de Cassandra-connector in het Cosmos DB C*-account in Bool
enableFreeTier Vlag om aan te geven of de gratis laag is ingeschakeld. Bool
enableMaterializedViews Vlag om aan te geven of MaterializedViews moet worden ingeschakeld in het Cosmos DB-account Bool
enableMultipleWriteLocations Hiermee kan het account op meerdere locaties schrijven Bool
enablePartitionMerge Vlag om aan te geven dat de functie Partition Merge voor het account is ingeschakeld/uitgeschakeld Bool
enablePerRegionPerPartitionAutoscale Vlag om aan te geven dat Per-Region functie voor automatisch schalen per partitie in het account wordt ingeschakeld/uitgeschakeld Bool
enablePriorityBasedExecution Vlag om aan te geven dat de functie Op basis van uitvoering op basis van prioriteit wordt ingeschakeld/uitgeschakeld voor het account Bool
ipRules Lijst met IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Vlag om aan te geven of virtuele netwerk-ACL-regels moeten worden ingeschakeld/uitgeschakeld. Bool
keyVaultKeyUri De URI van de sleutelkluis snaar
Locaties Een matrix die de georeplicatielocaties bevat die zijn ingeschakeld voor het Cosmos DB-account. Locatie[] (vereist)
minimalTlsVersion Geeft de minimaal toegestane Tls-versie aan. De standaardwaarde is Tls 1.0, met uitzondering van Cassandra- en Mongo-API's, die alleen werken met Tls 1.2. 'Tls'
'Tls11'
Tls12
networkAclBypass Hiermee wordt aangegeven welke services firewallcontroles mogen omzeilen. 'AzureServices'
'Geen'
networkAclBypassResourceIds Een matrix die de resource-id's voor netwerk-Acl bypass voor het Cosmos DB-account bevat. tekenreeks[]
publicNetworkAccess Of aanvragen van openbaar netwerk zijn toegestaan 'Uitgeschakeld'
'Ingeschakeld'
'SecuredByPerimeter'
restoreParameters Parameters om de informatie over de herstelbewerking aan te geven. RestoreParameters
virtualNetworkRules Lijst met ACL-regels voor virtueel netwerk die zijn geconfigureerd voor het Cosmos DB-account. VirtualNetworkRule[]

DatabaseRestoreResource

Naam Beschrijving Waarde
collectionNames De namen van de verzamelingen die beschikbaar zijn voor herstel. tekenreeks[]
databaseName De naam van de database die beschikbaar is voor herstel. snaar

DiagnosticLogSettings

Naam Beschrijving Waarde
enableFullTextQuery Beschrijf het detailniveau waarmee query's moeten worden vastgelegd. 'Onwaar'
'Geen'
'Waar'

GremlinDatabaseRestoreResource

Naam Beschrijving Waarde
databaseName De naam van de gremlin-database die beschikbaar is voor herstel. snaar
graphNames De namen van de grafieken die beschikbaar zijn voor herstel. tekenreeks[]

IpAddressOrRange

Naam Beschrijving Waarde
ipAddressOrRange Eén IPv4-adres of één IPv4-adresbereik in CIDR-indeling. Opgegeven IP-adressen moeten goed zijn opgemaakt en kunnen niet worden opgenomen in een van de volgende bereiken: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, omdat deze niet kunnen worden afgedwongen door het IP-adresfilter. Voorbeeld van geldige invoer: '23.40.210.245' of '23.40.210.0/8'. snaar

Plaats

Naam Beschrijving Waarde
failoverPriority De failoverprioriteit van de regio. Een failoverprioriteit van 0 geeft een schrijfregio aan. De maximumwaarde voor een failoverprioriteit = (totaal aantal regio's - 1). Failoverprioriteitswaarden moeten uniek zijn voor elk van de regio's waarin het databaseaccount bestaat. Int

Beperkingen:
Minimumwaarde = 0
isZoneRedundant Vlag om aan te geven of deze regio een AvailabilityZone-regio is Bool
locationName De naam van de regio. snaar

ManagedServiceIdentity

Naam Beschrijving Waarde
type Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd. 'Geen'
'SystemAssigned'
'SystemAssigned, UserAssigned'
UserAssigned
userAssignedIdentities De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen voor de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Naam Beschrijving Waarde

Microsoft.DocumentDB/databaseAccounts

Naam Beschrijving Waarde
identiteit Identiteit voor de resource. ManagedServiceIdentity-
soort Geeft het type databaseaccount aan. Dit kan alleen worden ingesteld bij het maken van een databaseaccount. 'GlobalDocumentDB'
'MongoDB'
'Parseren'
plaats De locatie van de resourcegroep waartoe de resource behoort. snaar
naam De resourcenaam snaar

Beperkingen:
Minimale lengte = 3
Maximale lengte = 3
Patroon = ^[a-z0-9]+(-[a-z0-9]+)* (vereist)
Eigenschappen Eigenschappen voor het maken en bijwerken van Azure Cosmos DB-databaseaccounts. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (vereist)
Tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen

PeriodicModeBackupPolicy

Naam Beschrijving Waarde
periodicModeProperties Configuratiewaarden voor periodieke back-upmodus PeriodicModeProperties-
type Beschrijft de modus van back-ups. 'Periodiek' (vereist)

PeriodicModeProperties

Naam Beschrijving Waarde
backupIntervalInMinutes Een geheel getal dat het interval in minuten tussen twee back-ups aangeeft Int

Beperkingen:
Minimumwaarde = 0
backupRetentionIntervalInHours Een geheel getal dat de tijd (in uren) aangeeft dat elke back-up wordt bewaard Int

Beperkingen:
Minimumwaarde = 0
backupStorageRedundancy Opsomming om het type back-uplocatie aan te geven 'Geo'
'Lokaal'
'Zone'

RestoreParameters

Naam Beschrijving Waarde
databasesToRestore Lijst met specifieke databases die beschikbaar zijn voor herstel. DatabaseRestoreResource[]
gremlinDatabasesToRestore Lijst met specifieke Gremlin-databases die beschikbaar zijn voor herstel. GremlinDatabaseRestoreResource[]
restoreMode Beschrijft de modus van het herstellen. 'PointInTime'
restoreSource De id van het herstelbare databaseaccount van waaruit het herstel moet worden gestart. Bijvoorbeeld: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} snaar
restoreTimestampInUtc Tijd waarop het account moet worden hersteld (ISO-8601-indeling). snaar
restoreWithTtlDisabled Hiermee geeft u op of het herstelde account tijd-To-Live uitgeschakeld bij het herstellen. Bool
sourceBackupLocation De bronback-uplocatie voor herstel. snaar
tablesToRestore Lijst met specifieke tabellen die beschikbaar zijn voor herstel. tekenreeks[]

Tags

Naam Beschrijving Waarde

VirtualNetworkRule

Naam Beschrijving Waarde
legitimatiebewijs Resource-id van een subnet, bijvoorbeeld: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnetten/{subnetName}. snaar
ignoreMissingVNetServiceEndpoint Maak een firewallregel voordat vnet-service-eindpunt is ingeschakeld voor het virtuele netwerk. Bool

Quickstart-voorbeelden

In de volgende quickstartvoorbeelden wordt dit resourcetype geïmplementeerd.

Bicep-bestand Beschrijving
SQL API voor Azure Cosmos DB-account met analytische opslag Met deze sjabloon maakt u een Azure Cosmos-account voor Core (SQL) API met een database en container die is geconfigureerd met analytische opslag.
Azure Cosmos DB-account met web-app- Met deze sjabloon implementeert u een Azure Cosmos DB-account, een App Service-plan en maakt u een web-app in het App Service-plan. Er worden ook twee toepassingsinstellingen toegevoegd aan de web-app die verwijst naar het Azure Cosmos DB-accounteindpunt. Op deze manier kunnen oplossingen die zijn geïmplementeerd in de web-app verbinding maken met het Eindpunt van het Azure Cosmos DB-account met behulp van deze instellingen.
Een Cosmos DB-account maken waarvoor Microsoft Defender is ingeschakeld Met deze ARM-sjabloon kunt u een Azure Cosmos DB-account implementeren waarvoor Microsoft Defender voor Azure Cosmos DB is ingeschakeld. Microsoft Defender voor Azure Cosmos DB is een systeemeigen Azure-beveiligingslaag die pogingen detecteert om databases in uw Azure Cosmos DB-accounts te misbruiken. Microsoft Defender voor Azure Cosmos DB detecteert mogelijke SQL-injecties, bekende slechte actoren op basis van Microsoft Threat Intelligence, verdachte toegangspatronen en mogelijke exploitatie van uw database via verdachte identiteiten of kwaadwillende insiders.
Een Gratis Azure Cosmos DB-account maken Met deze sjabloon maakt u een Gratis Azure Cosmos DB-account voor SQL API met een database met gedeelde doorvoer en container.
een minimaal Azure Cosmos DB-account maken voor Core (SQL) API- Met deze sjabloon maakt u een Azure Cosmos DB-account voor de Core (SQL)-API, terwijl u alleen de minimaal vereiste resource-eigenschappen opgeeft.
Een serverloos Azure Cosmos DB-account maken voor SQL API- Met deze sjabloon maakt u een serverloos Azure Cosmos DB-account voor de Core (SQL) API.
Een Azure Cosmos-account en Azure Web App- met nul aanraken maken Met deze sjabloon maakt u een Azure Cosmos-account, injecteert u het Cosmos DB-eindpunt en de sleutels in de Azure Web App-instellingen en implementeert u vervolgens een ASP MVC-web-app vanuit GitHub.
Een Azure Cosmos-account maken voor mongoDB-API- Met deze sjabloon maakt u een Azure Cosmos DB-account voor MongoDB API 4.2 in twee regio's met behulp van gedeelde en toegewezen doorvoer met twee verzamelingen.
Een Azure Cosmos-account maken voor automatische schaalaanpassing van MongoDB-API's Met deze sjabloon maakt u een Azure Cosmos DB-account voor MongoDB API 4.2 in twee regio's met behulp van zowel gedeelde als toegewezen doorvoer voor automatische schaalaanpassing.
Een Azure Cosmos-account maken voor table-API- Met deze sjabloon maakt u een Azure Cosmos DB-account voor table-API in twee regio's en één tabel met ingerichte doorvoer.
Een Azure Cosmos-account maken voor table-API met automatische schaalaanpassing Met deze sjabloon maakt u een Azure Cosmos DB-account voor table-API in twee regio's en één tabel met doorvoer voor automatische schaalaanpassing.
Een Azure Cosmos DB-account maken voor cassandra-API- Met deze sjabloon maakt u een Azure Cosmos DB-account voor cassandra-API in twee regio's met een keyspace en tabel met toegewezen doorvoer.
Een Azure Cosmos DB-account maken voor Core (SQL) API- Met deze sjabloon maakt u een Azure Cosmos-account voor Core (SQL) API met een database en container met doorvoer met meerdere andere opties.
Een Azure Cosmos DB-account maken voor Gremlin-API- Met deze sjabloon maakt u een Azure Cosmos DB-account voor Gremlin-API in twee regio's met één database en één grafiek met behulp van toegewezen doorvoer.
Een Azure Cosmos DB-account maken voor automatische schaalaanpassing van Gremlin-API's Met deze sjabloon maakt u een Azure Cosmos DB-account voor Gremlin-API in twee regio's met één database en één grafiek met automatische schaalaanpassing van doorvoer.
Een Azure Cosmos DB-account maken in meerdere regio's Met deze sjabloon maakt u een Azure Cosmos DB-account voor elk database-API-type met een primaire en secundaire regio met de keuze van het consistentieniveau en het failovertype.
Een SQL API voor een Azure Cosmos DB-account maken met automatische schaalaanpassing Met deze sjabloon maakt u een Azure Cosmos-account voor Core (SQL) API met een database en container met doorvoer voor automatische schaalaanpassing met meerdere andere opties.
Een Azure Cosmos DB-account maken met een privé-eindpunt Met deze sjabloon maakt u een Cosmos-account, een virtueel netwerk en een privé-eindpunt dat het Cosmos-account beschikbaar maakt voor het virtuele netwerk.
Een Azure Cosmos DB SQL-account maken met RBAC- Met deze sjabloon maakt u een SQL Cosmos-account, een systeemeigen onderhouden roldefinitie en een systeemeigen onderhouden roltoewijzing voor een AAD-identiteit.
Een Azure CosmosDB-account maken Deze ARM-sjabloon is bedoeld om snel een CosmosDB-account te maken met de minimale vereiste waarden
Een Azure Cosmos DB-account voor automatische schaalaanpassing maken voor cassandra-API- Met deze sjabloon maakt u een Azure Cosmos DB-account voor Cassandra-API in twee regio's met een keyspace en tabel met doorvoer voor automatische schaalaanpassing.
Opgeslagen procedures voor azure Cosmos DB Core (SQL) MAKEN Met deze sjabloon maakt u een Azure Cosmos DB-account voor Core (SQL) API en een container met een opgeslagen procedure, trigger en door de gebruiker gedefinieerde functie.
Maakt een Dapr-microservices-app met container-apps Een Dapr-microservices-app maken met behulp van Container Apps.
Maakt een Dapr pub-sub servicebus-app met behulp van Container Apps Maak een Dapr pub-sub servicebus-app met behulp van Container Apps.
Azure Data Explorer DB implementeren met Cosmos DB-verbinding Azure Data Explorer DB implementeren met Cosmos DB-verbinding.

Resourcedefinitie van ARM-sjabloon

Het resourcetype databaseAccounts kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.DocumentDB-/databaseAccounts-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "apiVersion": "2024-12-01-preview",
  "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"
    },
    "capacityMode": "string",
    "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",
    "defaultPriorityLevel": "string",
    "diagnosticLogSettings": {
      "enableFullTextQuery": "string"
    },
    "disableKeyBasedMetadataWriteAccess": "bool",
    "disableLocalAuth": "bool",
    "enableAnalyticalStorage": "bool",
    "enableAutomaticFailover": "bool",
    "enableBurstCapacity": "bool",
    "enableCassandraConnector": "bool",
    "enableFreeTier": "bool",
    "enableMaterializedViews": "bool",
    "enableMultipleWriteLocations": "bool",
    "enablePartitionMerge": "bool",
    "enablePerRegionPerPartitionAutoscale": "bool",
    "enablePriorityBasedExecution": "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",
      "restoreWithTtlDisabled": "bool",
      "sourceBackupLocation": "string",
      "tablesToRestore": [ "string" ]
    },
    "virtualNetworkRules": [
      {
        "id": "string",
        "ignoreMissingVNetServiceEndpoint": "bool"
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

BackupPolicy-objecten

Stel de eigenschap type in om het type object op te geven.

Gebruik voor Continue:

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

Gebruik voor periodieke:

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

Eigenschapswaarden

AnalyticalStorageConfiguration

Naam Beschrijving Waarde
schemaType Beschrijft de typen schema's voor analytische opslag. 'FullFidelity'
'WellDefined'

ApiProperties

Naam Beschrijving Waarde
serverVersion Beschrijft de versie van het MongoDB-account. '3.2'
'3.6'
'4.0'
'4.2'
'5.0'
'6.0'
'7.0'

BackupPolicy

Naam Beschrijving Waarde
migrationState Het object dat de status van de migratie tussen het back-upbeleid weergeeft. BackupPolicyMigrationState
type Ingesteld op Doorlopend voor type ContinuousModeBackupPolicy. Ingesteld op 'Periodiek' voor het type PeriodicModeBackupPolicy. 'Doorlopend'
'Periodiek' (vereist)

BackupPolicyMigrationState

Naam Beschrijving Waarde
startTime Tijdstip waarop de migratie van het back-upbeleid is gestart (ISO-8601-indeling). snaar
status Beschrijft de status van de migratie tussen back-upbeleidstypen. 'Voltooid'
'Mislukt'
'InProgress'
'Ongeldig'
targetType Beschrijft het doelback-upbeleidstype van de migratie van het back-upbeleid. 'Doorlopend'
'Periodiek'

Vermogen

Naam Beschrijving Waarde
naam Naam van de Cosmos DB-functie. Bijvoorbeeld 'name': 'EnableCassandra'. De huidige waarden omvatten ook 'EnableTable' en 'EnableGremlin'. snaar

Capaciteit

Naam Beschrijving Waarde
totalThroughputLimit De totale doorvoerlimiet die voor het account is ingesteld. Een totalThroughputLimit van 2000 legt een strikte limiet op voor maximale doorvoer die voor dat account kan worden ingericht voor 2000. Een totalThroughputLimit van -1 geeft geen limieten aan voor het inrichten van doorvoer. Int

Beperkingen:
Minimumwaarde = -1

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Naam Beschrijving Waarde

ConsistencyPolicy

Naam Beschrijving Waarde
defaultConsistencyLevel Het standaardconsistentieniveau en de configuratie-instellingen van het Cosmos DB-account. 'BoundedStaleness'
'ConsistentPrefix'
'Uiteindelijk'
'Sessie'
'Sterk' (vereist)
maxIntervalInSeconds Bij gebruik met het consistentieniveau Gebonden veroudering vertegenwoordigt deze waarde de tijdsduur van veroudering (in seconden) die wordt getolereerd. Geaccepteerd bereik voor deze waarde is 5 - 86400. Vereist wanneer defaultConsistencyPolicy is ingesteld op 'BoundedStaleness'. Int

Beperkingen:
Minimumwaarde = 5
Maximumwaarde = 86400
maxStalenessPrefix Wanneer deze waarde wordt gebruikt met het consistentieniveau Gebonden veroudering, vertegenwoordigt deze waarde het aantal verlopen aanvragen dat wordt getolereerd. Geaccepteerd bereik voor deze waarde is 1 – 2.147.483.647. Vereist wanneer defaultConsistencyPolicy is ingesteld op 'BoundedStaleness'. Int

Beperkingen:
Minimumwaarde = 1
Maximumwaarde = 2147483647

ContinuousModeBackupPolicy

Naam Beschrijving Waarde
continuousModeProperties Configuratiewaarden voor back-up van continue modus ContinuousModeProperties-
type Beschrijft de modus van back-ups. Doorlopend (vereist)

ContinuousModeProperties

Naam Beschrijving Waarde
rang Enum om het type back-upmodus van Continuos aan te geven 'Continuous30Days'
'Continuous7Days'

CorsPolicy

Naam Beschrijving Waarde
allowedHeaders De aanvraagheaders die het oorspronkelijke domein kan opgeven voor de CORS-aanvraag. snaar
allowedMethods De methoden (HTTP-aanvraagwoorden) die het oorspronkelijke domein kan gebruiken voor een CORS-aanvraag. snaar
allowedOrigins De oorspronkelijke domeinen die via CORS een aanvraag voor de service mogen indienen. tekenreeks (vereist)
exposedHeaders De antwoordheaders die kunnen worden verzonden in het antwoord op de CORS-aanvraag en die door de browser worden weergegeven aan de verlener van de aanvraag. snaar
maxAgeInSeconds De maximale hoeveelheid tijd die een browser moet opslaan in de cache van de preflight OPTIONS-aanvraag. Int

Beperkingen:
Minimumwaarde = 1
Maximumwaarde = 2147483647

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Naam Beschrijving Waarde
analyticalStorageConfiguration Specifieke eigenschappen voor analytische opslag. AnalyticalStorageConfiguration-
apiProperties API-specifieke eigenschappen. Momenteel wordt alleen ondersteund voor mongoDB-API. ApiProperties-
backupPolicy Het object dat het beleid vertegenwoordigt voor het maken van back-ups voor een account. BackupPolicy-
Mogelijkheden Lijst met Cosmos DB-mogelijkheden voor het account Mogelijkheid[]
capaciteit Het object dat alle eigenschappen vertegenwoordigt die betrekking hebben op het afdwingen van capaciteit voor een account. Capaciteit
capacityMode Geeft de capacityMode van het Cosmos DB-account aan. 'Geen'
'Ingericht'
'Serverloos'
connectorOffer De cassandra-connectoraanbiedingstype voor het Cosmos DB-database-C*-account. 'Klein'
consistencyPolicy Het consistentiebeleid voor het Cosmos DB-account. ConsistencyPolicy-
cors Het CORS-beleid voor het Cosmos DB-databaseaccount. CorsPolicy[]
createMode Opsomming om de modus voor het maken van accounts aan te geven. 'Standaard'
'Herstellen'
customerManagedKeyStatus Geeft de status aan van de functie Door klant beheerde sleutel in het account. Als er fouten zijn, biedt de eigenschap richtlijnen voor probleemoplossing. snaar
databaseAccountOfferType Het aanbiedingstype voor de database 'Standaard' (vereist)
defaultIdentity De standaardidentiteit voor toegang tot de sleutelkluis die wordt gebruikt in functies zoals door de klant beheerde sleutels. De standaardidentiteit moet expliciet worden ingesteld door de gebruikers. Het kan FirstPartyIdentity, SystemAssignedIdentity en meer zijn. snaar
defaultPriorityLevel Opsomming om het standaardprioriteitsniveau van de aanvraag voor uitvoering op basis van prioriteit aan te geven. 'Hoog'
'Laag'
diagnosticLogSettings Het object dat de verschillende diagnostische logboekinstellingen voor het Cosmos DB-account vertegenwoordigt. DiagnosticLogSettings
disableKeyBasedMetadataWriteAccess Schrijfbewerkingen uitschakelen voor metagegevensresources (databases, containers, doorvoer) via accountsleutels Bool
disableLocalAuth Meld u af voor lokale verificatie en zorg ervoor dat alleen MSI en AAD uitsluitend voor verificatie kunnen worden gebruikt. Bool
enableAnalyticalStorage Vlag om aan te geven of opslaganalyse moet worden ingeschakeld. Bool
enableAutomaticFailover Maakt automatische failover van de schrijfregio mogelijk in de zeldzame gebeurtenis dat de regio niet beschikbaar is vanwege een storing. Automatische failover resulteert in een nieuwe schrijfregio voor het account en wordt gekozen op basis van de failoverprioriteiten die voor het account zijn geconfigureerd. Bool
enableBurstCapacity Vlag om aan te geven dat de functie Burst Capacity Preview voor het account is ingeschakeld/uitgeschakeld Bool
enableCassandraConnector Hiermee schakelt u de Cassandra-connector in het Cosmos DB C*-account in Bool
enableFreeTier Vlag om aan te geven of de gratis laag is ingeschakeld. Bool
enableMaterializedViews Vlag om aan te geven of MaterializedViews moet worden ingeschakeld in het Cosmos DB-account Bool
enableMultipleWriteLocations Hiermee kan het account op meerdere locaties schrijven Bool
enablePartitionMerge Vlag om aan te geven dat de functie Partition Merge voor het account is ingeschakeld/uitgeschakeld Bool
enablePerRegionPerPartitionAutoscale Vlag om aan te geven dat Per-Region functie voor automatisch schalen per partitie in het account wordt ingeschakeld/uitgeschakeld Bool
enablePriorityBasedExecution Vlag om aan te geven dat de functie Op basis van uitvoering op basis van prioriteit wordt ingeschakeld/uitgeschakeld voor het account Bool
ipRules Lijst met IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Vlag om aan te geven of virtuele netwerk-ACL-regels moeten worden ingeschakeld/uitgeschakeld. Bool
keyVaultKeyUri De URI van de sleutelkluis snaar
Locaties Een matrix die de georeplicatielocaties bevat die zijn ingeschakeld voor het Cosmos DB-account. Locatie[] (vereist)
minimalTlsVersion Geeft de minimaal toegestane Tls-versie aan. De standaardwaarde is Tls 1.0, met uitzondering van Cassandra- en Mongo-API's, die alleen werken met Tls 1.2. 'Tls'
'Tls11'
Tls12
networkAclBypass Hiermee wordt aangegeven welke services firewallcontroles mogen omzeilen. 'AzureServices'
'Geen'
networkAclBypassResourceIds Een matrix die de resource-id's voor netwerk-Acl bypass voor het Cosmos DB-account bevat. tekenreeks[]
publicNetworkAccess Of aanvragen van openbaar netwerk zijn toegestaan 'Uitgeschakeld'
'Ingeschakeld'
'SecuredByPerimeter'
restoreParameters Parameters om de informatie over de herstelbewerking aan te geven. RestoreParameters
virtualNetworkRules Lijst met ACL-regels voor virtueel netwerk die zijn geconfigureerd voor het Cosmos DB-account. VirtualNetworkRule[]

DatabaseRestoreResource

Naam Beschrijving Waarde
collectionNames De namen van de verzamelingen die beschikbaar zijn voor herstel. tekenreeks[]
databaseName De naam van de database die beschikbaar is voor herstel. snaar

DiagnosticLogSettings

Naam Beschrijving Waarde
enableFullTextQuery Beschrijf het detailniveau waarmee query's moeten worden vastgelegd. 'Onwaar'
'Geen'
'Waar'

GremlinDatabaseRestoreResource

Naam Beschrijving Waarde
databaseName De naam van de gremlin-database die beschikbaar is voor herstel. snaar
graphNames De namen van de grafieken die beschikbaar zijn voor herstel. tekenreeks[]

IpAddressOrRange

Naam Beschrijving Waarde
ipAddressOrRange Eén IPv4-adres of één IPv4-adresbereik in CIDR-indeling. Opgegeven IP-adressen moeten goed zijn opgemaakt en kunnen niet worden opgenomen in een van de volgende bereiken: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, omdat deze niet kunnen worden afgedwongen door het IP-adresfilter. Voorbeeld van geldige invoer: '23.40.210.245' of '23.40.210.0/8'. snaar

Plaats

Naam Beschrijving Waarde
failoverPriority De failoverprioriteit van de regio. Een failoverprioriteit van 0 geeft een schrijfregio aan. De maximumwaarde voor een failoverprioriteit = (totaal aantal regio's - 1). Failoverprioriteitswaarden moeten uniek zijn voor elk van de regio's waarin het databaseaccount bestaat. Int

Beperkingen:
Minimumwaarde = 0
isZoneRedundant Vlag om aan te geven of deze regio een AvailabilityZone-regio is Bool
locationName De naam van de regio. snaar

ManagedServiceIdentity

Naam Beschrijving Waarde
type Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd. 'Geen'
'SystemAssigned'
'SystemAssigned, UserAssigned'
UserAssigned
userAssignedIdentities De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen voor de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Naam Beschrijving Waarde

Microsoft.DocumentDB/databaseAccounts

Naam Beschrijving Waarde
apiVersion De API-versie '2024-12-01-preview'
identiteit Identiteit voor de resource. ManagedServiceIdentity-
soort Geeft het type databaseaccount aan. Dit kan alleen worden ingesteld bij het maken van een databaseaccount. 'GlobalDocumentDB'
'MongoDB'
'Parseren'
plaats De locatie van de resourcegroep waartoe de resource behoort. snaar
naam De resourcenaam snaar

Beperkingen:
Minimale lengte = 3
Maximale lengte = 3
Patroon = ^[a-z0-9]+(-[a-z0-9]+)* (vereist)
Eigenschappen Eigenschappen voor het maken en bijwerken van Azure Cosmos DB-databaseaccounts. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (vereist)
Tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen
type Het resourcetype 'Microsoft.DocumentDB/databaseAccounts'

PeriodicModeBackupPolicy

Naam Beschrijving Waarde
periodicModeProperties Configuratiewaarden voor periodieke back-upmodus PeriodicModeProperties-
type Beschrijft de modus van back-ups. 'Periodiek' (vereist)

PeriodicModeProperties

Naam Beschrijving Waarde
backupIntervalInMinutes Een geheel getal dat het interval in minuten tussen twee back-ups aangeeft Int

Beperkingen:
Minimumwaarde = 0
backupRetentionIntervalInHours Een geheel getal dat de tijd (in uren) aangeeft dat elke back-up wordt bewaard Int

Beperkingen:
Minimumwaarde = 0
backupStorageRedundancy Opsomming om het type back-uplocatie aan te geven 'Geo'
'Lokaal'
'Zone'

RestoreParameters

Naam Beschrijving Waarde
databasesToRestore Lijst met specifieke databases die beschikbaar zijn voor herstel. DatabaseRestoreResource[]
gremlinDatabasesToRestore Lijst met specifieke Gremlin-databases die beschikbaar zijn voor herstel. GremlinDatabaseRestoreResource[]
restoreMode Beschrijft de modus van het herstellen. 'PointInTime'
restoreSource De id van het herstelbare databaseaccount van waaruit het herstel moet worden gestart. Bijvoorbeeld: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} snaar
restoreTimestampInUtc Tijd waarop het account moet worden hersteld (ISO-8601-indeling). snaar
restoreWithTtlDisabled Hiermee geeft u op of het herstelde account tijd-To-Live uitgeschakeld bij het herstellen. Bool
sourceBackupLocation De bronback-uplocatie voor herstel. snaar
tablesToRestore Lijst met specifieke tabellen die beschikbaar zijn voor herstel. tekenreeks[]

Tags

Naam Beschrijving Waarde

VirtualNetworkRule

Naam Beschrijving Waarde
legitimatiebewijs Resource-id van een subnet, bijvoorbeeld: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnetten/{subnetName}. snaar
ignoreMissingVNetServiceEndpoint Maak een firewallregel voordat vnet-service-eindpunt is ingeschakeld voor het virtuele netwerk. Bool

Quickstart-sjablonen

Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.

Sjabloon Beschrijving
SQL API voor Azure Cosmos DB-account met analytische opslag

implementeren in Azure 		Met deze sjabloon maakt u een Azure Cosmos-account voor Core (SQL) API met een database en container die is geconfigureerd met analytische opslag.
Azure Cosmos DB-account met web-app-

implementeren in Azure 		Met deze sjabloon implementeert u een Azure Cosmos DB-account, een App Service-plan en maakt u een web-app in het App Service-plan. Er worden ook twee toepassingsinstellingen toegevoegd aan de web-app die verwijst naar het Azure Cosmos DB-accounteindpunt. Op deze manier kunnen oplossingen die zijn geïmplementeerd in de web-app verbinding maken met het Eindpunt van het Azure Cosmos DB-account met behulp van deze instellingen.
CI/CD met Behulp van Jenkins in Azure Container Service (AKS)

implementeren in Azure 		Met containers kunt u eenvoudig uw toepassingen continu bouwen en implementeren. Door de implementatie van deze containers te organiseren met behulp van Kubernetes in Azure Container Service, kunt u repliceerbare, beheerbare clusters van containers bereiken. Door een continue build in te stellen om uw containerinstallatiekopieën en indeling te produceren, kunt u de snelheid en betrouwbaarheid van uw implementatie verhogen.
Een Cosmos DB-account maken waarvoor Microsoft Defender is ingeschakeld

implementeren in Azure 		Met deze ARM-sjabloon kunt u een Azure Cosmos DB-account implementeren waarvoor Microsoft Defender voor Azure Cosmos DB is ingeschakeld. Microsoft Defender voor Azure Cosmos DB is een systeemeigen Azure-beveiligingslaag die pogingen detecteert om databases in uw Azure Cosmos DB-accounts te misbruiken. Microsoft Defender voor Azure Cosmos DB detecteert mogelijke SQL-injecties, bekende slechte actoren op basis van Microsoft Threat Intelligence, verdachte toegangspatronen en mogelijke exploitatie van uw database via verdachte identiteiten of kwaadwillende insiders.
Een Gratis Azure Cosmos DB-account maken

implementeren in Azure 		Met deze sjabloon maakt u een Gratis Azure Cosmos DB-account voor SQL API met een database met gedeelde doorvoer en container.
een minimaal Azure Cosmos DB-account maken voor Core (SQL) API-

implementeren in Azure 		Met deze sjabloon maakt u een Azure Cosmos DB-account voor de Core (SQL)-API, terwijl u alleen de minimaal vereiste resource-eigenschappen opgeeft.
Een serverloos Azure Cosmos DB-account maken voor SQL API-

implementeren in Azure 		Met deze sjabloon maakt u een serverloos Azure Cosmos DB-account voor de Core (SQL) API.
Een Azure Cosmos-account en Azure Web App- met nul aanraken maken

implementeren in Azure 		Met deze sjabloon maakt u een Azure Cosmos-account, injecteert u het Cosmos DB-eindpunt en de sleutels in de Azure Web App-instellingen en implementeert u vervolgens een ASP MVC-web-app vanuit GitHub.
Een Azure Cosmos-account maken voor mongoDB-API-

implementeren in Azure 		Met deze sjabloon maakt u een Azure Cosmos DB-account voor MongoDB API 4.2 in twee regio's met behulp van gedeelde en toegewezen doorvoer met twee verzamelingen.
Een Azure Cosmos-account maken voor automatische schaalaanpassing van MongoDB-API's

implementeren in Azure 		Met deze sjabloon maakt u een Azure Cosmos DB-account voor MongoDB API 4.2 in twee regio's met behulp van zowel gedeelde als toegewezen doorvoer voor automatische schaalaanpassing.
Een Azure Cosmos-account maken voor table-API-

implementeren in Azure 		Met deze sjabloon maakt u een Azure Cosmos DB-account voor table-API in twee regio's en één tabel met ingerichte doorvoer.
Een Azure Cosmos-account maken voor table-API met automatische schaalaanpassing

implementeren in Azure 		Met deze sjabloon maakt u een Azure Cosmos DB-account voor table-API in twee regio's en één tabel met doorvoer voor automatische schaalaanpassing.
Een Azure Cosmos DB-account maken voor cassandra-API-

implementeren in Azure 		Met deze sjabloon maakt u een Azure Cosmos DB-account voor cassandra-API in twee regio's met een keyspace en tabel met toegewezen doorvoer.
Een Azure Cosmos DB-account maken voor Core (SQL) API-

implementeren in Azure 		Met deze sjabloon maakt u een Azure Cosmos-account voor Core (SQL) API met een database en container met doorvoer met meerdere andere opties.
Een Azure Cosmos DB-account maken voor Gremlin-API-

implementeren in Azure 		Met deze sjabloon maakt u een Azure Cosmos DB-account voor Gremlin-API in twee regio's met één database en één grafiek met behulp van toegewezen doorvoer.
Een Azure Cosmos DB-account maken voor automatische schaalaanpassing van Gremlin-API's

implementeren in Azure 		Met deze sjabloon maakt u een Azure Cosmos DB-account voor Gremlin-API in twee regio's met één database en één grafiek met automatische schaalaanpassing van doorvoer.
Een Azure Cosmos DB-account maken in meerdere regio's

implementeren in Azure 		Met deze sjabloon maakt u een Azure Cosmos DB-account voor elk database-API-type met een primaire en secundaire regio met de keuze van het consistentieniveau en het failovertype.
Een SQL API voor een Azure Cosmos DB-account maken met automatische schaalaanpassing

implementeren in Azure 		Met deze sjabloon maakt u een Azure Cosmos-account voor Core (SQL) API met een database en container met doorvoer voor automatische schaalaanpassing met meerdere andere opties.
Een Azure Cosmos DB-account maken met een privé-eindpunt

implementeren in Azure 		Met deze sjabloon maakt u een Cosmos-account, een virtueel netwerk en een privé-eindpunt dat het Cosmos-account beschikbaar maakt voor het virtuele netwerk.
Een Azure Cosmos DB SQL-account maken met RBAC-

implementeren in Azure 		Met deze sjabloon maakt u een SQL Cosmos-account, een systeemeigen onderhouden roldefinitie en een systeemeigen onderhouden roltoewijzing voor een AAD-identiteit.
Een Azure CosmosDB-account maken

implementeren in Azure 		Deze ARM-sjabloon is bedoeld om snel een CosmosDB-account te maken met de minimale vereiste waarden
Een Azure Cosmos DB-account voor automatische schaalaanpassing maken voor cassandra-API-

implementeren in Azure 		Met deze sjabloon maakt u een Azure Cosmos DB-account voor Cassandra-API in twee regio's met een keyspace en tabel met doorvoer voor automatische schaalaanpassing.
Opgeslagen procedures voor azure Cosmos DB Core (SQL) MAKEN

implementeren in Azure 		Met deze sjabloon maakt u een Azure Cosmos DB-account voor Core (SQL) API en een container met een opgeslagen procedure, trigger en door de gebruiker gedefinieerde functie.
Azure Cosmos maken met SQL API en meerdere containers

implementeren in Azure 		De sjabloon maakt een Cosmos-container met een SQL-API en maakt het toevoegen van meerdere containers mogelijk.
Maakt een Dapr-microservices-app met container-apps

implementeren in Azure 		Een Dapr-microservices-app maken met behulp van Container Apps.
Maakt een Dapr pub-sub servicebus-app met behulp van Container Apps

implementeren in Azure 		Maak een Dapr pub-sub servicebus-app met behulp van Container Apps.
Azure Data Explorer DB implementeren met Cosmos DB-verbinding

implementeren in Azure 		Azure Data Explorer DB implementeren met Cosmos DB-verbinding.
web-app met een SQL Database, Azure Cosmos DB, Azure Search-

implementeren in Azure 		Deze sjabloon richt een web-app, een SQL Database, Azure Cosmos DB, Azure Search en Application Insights in.

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype databaseAccounts kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.DocumentDB/databaseAccounts-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts@2024-12-01-preview"
  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
      }
      capacityMode = "string"
      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"
      defaultPriorityLevel = "string"
      diagnosticLogSettings = {
        enableFullTextQuery = "string"
      }
      disableKeyBasedMetadataWriteAccess = bool
      disableLocalAuth = bool
      enableAnalyticalStorage = bool
      enableAutomaticFailover = bool
      enableBurstCapacity = bool
      enableCassandraConnector = bool
      enableFreeTier = bool
      enableMaterializedViews = bool
      enableMultipleWriteLocations = bool
      enablePartitionMerge = bool
      enablePerRegionPerPartitionAutoscale = bool
      enablePriorityBasedExecution = 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"
        restoreWithTtlDisabled = bool
        sourceBackupLocation = "string"
        tablesToRestore = [
          "string"
        ]
      }
      virtualNetworkRules = [
        {
          id = "string"
          ignoreMissingVNetServiceEndpoint = bool
        }
      ]
    }
  })
}

BackupPolicy-objecten

Stel de eigenschap type in om het type object op te geven.

Gebruik voor Continue:

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

Gebruik voor periodieke:

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

Eigenschapswaarden

AnalyticalStorageConfiguration

Naam Beschrijving Waarde
schemaType Beschrijft de typen schema's voor analytische opslag. 'FullFidelity'
'WellDefined'

ApiProperties

Naam Beschrijving Waarde
serverVersion Beschrijft de versie van het MongoDB-account. '3.2'
'3.6'
'4.0'
'4.2'
'5.0'
'6.0'
'7.0'

BackupPolicy

Naam Beschrijving Waarde
migrationState Het object dat de status van de migratie tussen het back-upbeleid weergeeft. BackupPolicyMigrationState
type Ingesteld op Doorlopend voor type ContinuousModeBackupPolicy. Ingesteld op 'Periodiek' voor het type PeriodicModeBackupPolicy. 'Doorlopend'
'Periodiek' (vereist)

BackupPolicyMigrationState

Naam Beschrijving Waarde
startTime Tijdstip waarop de migratie van het back-upbeleid is gestart (ISO-8601-indeling). snaar
status Beschrijft de status van de migratie tussen back-upbeleidstypen. 'Voltooid'
'Mislukt'
'InProgress'
'Ongeldig'
targetType Beschrijft het doelback-upbeleidstype van de migratie van het back-upbeleid. 'Doorlopend'
'Periodiek'

Vermogen

Naam Beschrijving Waarde
naam Naam van de Cosmos DB-functie. Bijvoorbeeld 'name': 'EnableCassandra'. De huidige waarden omvatten ook 'EnableTable' en 'EnableGremlin'. snaar

Capaciteit

Naam Beschrijving Waarde
totalThroughputLimit De totale doorvoerlimiet die voor het account is ingesteld. Een totalThroughputLimit van 2000 legt een strikte limiet op voor maximale doorvoer die voor dat account kan worden ingericht voor 2000. Een totalThroughputLimit van -1 geeft geen limieten aan voor het inrichten van doorvoer. Int

Beperkingen:
Minimumwaarde = -1

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Naam Beschrijving Waarde

ConsistencyPolicy

Naam Beschrijving Waarde
defaultConsistencyLevel Het standaardconsistentieniveau en de configuratie-instellingen van het Cosmos DB-account. 'BoundedStaleness'
'ConsistentPrefix'
'Uiteindelijk'
'Sessie'
'Sterk' (vereist)
maxIntervalInSeconds Bij gebruik met het consistentieniveau Gebonden veroudering vertegenwoordigt deze waarde de tijdsduur van veroudering (in seconden) die wordt getolereerd. Geaccepteerd bereik voor deze waarde is 5 - 86400. Vereist wanneer defaultConsistencyPolicy is ingesteld op 'BoundedStaleness'. Int

Beperkingen:
Minimumwaarde = 5
Maximumwaarde = 86400
maxStalenessPrefix Wanneer deze waarde wordt gebruikt met het consistentieniveau Gebonden veroudering, vertegenwoordigt deze waarde het aantal verlopen aanvragen dat wordt getolereerd. Geaccepteerd bereik voor deze waarde is 1 – 2.147.483.647. Vereist wanneer defaultConsistencyPolicy is ingesteld op 'BoundedStaleness'. Int

Beperkingen:
Minimumwaarde = 1
Maximumwaarde = 2147483647

ContinuousModeBackupPolicy

Naam Beschrijving Waarde
continuousModeProperties Configuratiewaarden voor back-up van continue modus ContinuousModeProperties-
type Beschrijft de modus van back-ups. Doorlopend (vereist)

ContinuousModeProperties

Naam Beschrijving Waarde
rang Enum om het type back-upmodus van Continuos aan te geven 'Continuous30Days'
'Continuous7Days'

CorsPolicy

Naam Beschrijving Waarde
allowedHeaders De aanvraagheaders die het oorspronkelijke domein kan opgeven voor de CORS-aanvraag. snaar
allowedMethods De methoden (HTTP-aanvraagwoorden) die het oorspronkelijke domein kan gebruiken voor een CORS-aanvraag. snaar
allowedOrigins De oorspronkelijke domeinen die via CORS een aanvraag voor de service mogen indienen. tekenreeks (vereist)
exposedHeaders De antwoordheaders die kunnen worden verzonden in het antwoord op de CORS-aanvraag en die door de browser worden weergegeven aan de verlener van de aanvraag. snaar
maxAgeInSeconds De maximale hoeveelheid tijd die een browser moet opslaan in de cache van de preflight OPTIONS-aanvraag. Int

Beperkingen:
Minimumwaarde = 1
Maximumwaarde = 2147483647

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Naam Beschrijving Waarde
analyticalStorageConfiguration Specifieke eigenschappen voor analytische opslag. AnalyticalStorageConfiguration-
apiProperties API-specifieke eigenschappen. Momenteel wordt alleen ondersteund voor mongoDB-API. ApiProperties-
backupPolicy Het object dat het beleid vertegenwoordigt voor het maken van back-ups voor een account. BackupPolicy-
Mogelijkheden Lijst met Cosmos DB-mogelijkheden voor het account Mogelijkheid[]
capaciteit Het object dat alle eigenschappen vertegenwoordigt die betrekking hebben op het afdwingen van capaciteit voor een account. Capaciteit
capacityMode Geeft de capacityMode van het Cosmos DB-account aan. 'Geen'
'Ingericht'
'Serverloos'
connectorOffer De cassandra-connectoraanbiedingstype voor het Cosmos DB-database-C*-account. 'Klein'
consistencyPolicy Het consistentiebeleid voor het Cosmos DB-account. ConsistencyPolicy-
cors Het CORS-beleid voor het Cosmos DB-databaseaccount. CorsPolicy[]
createMode Opsomming om de modus voor het maken van accounts aan te geven. 'Standaard'
'Herstellen'
customerManagedKeyStatus Geeft de status aan van de functie Door klant beheerde sleutel in het account. Als er fouten zijn, biedt de eigenschap richtlijnen voor probleemoplossing. snaar
databaseAccountOfferType Het aanbiedingstype voor de database 'Standaard' (vereist)
defaultIdentity De standaardidentiteit voor toegang tot de sleutelkluis die wordt gebruikt in functies zoals door de klant beheerde sleutels. De standaardidentiteit moet expliciet worden ingesteld door de gebruikers. Het kan FirstPartyIdentity, SystemAssignedIdentity en meer zijn. snaar
defaultPriorityLevel Opsomming om het standaardprioriteitsniveau van de aanvraag voor uitvoering op basis van prioriteit aan te geven. 'Hoog'
'Laag'
diagnosticLogSettings Het object dat de verschillende diagnostische logboekinstellingen voor het Cosmos DB-account vertegenwoordigt. DiagnosticLogSettings
disableKeyBasedMetadataWriteAccess Schrijfbewerkingen uitschakelen voor metagegevensresources (databases, containers, doorvoer) via accountsleutels Bool
disableLocalAuth Meld u af voor lokale verificatie en zorg ervoor dat alleen MSI en AAD uitsluitend voor verificatie kunnen worden gebruikt. Bool
enableAnalyticalStorage Vlag om aan te geven of opslaganalyse moet worden ingeschakeld. Bool
enableAutomaticFailover Maakt automatische failover van de schrijfregio mogelijk in de zeldzame gebeurtenis dat de regio niet beschikbaar is vanwege een storing. Automatische failover resulteert in een nieuwe schrijfregio voor het account en wordt gekozen op basis van de failoverprioriteiten die voor het account zijn geconfigureerd. Bool
enableBurstCapacity Vlag om aan te geven dat de functie Burst Capacity Preview voor het account is ingeschakeld/uitgeschakeld Bool
enableCassandraConnector Hiermee schakelt u de Cassandra-connector in het Cosmos DB C*-account in Bool
enableFreeTier Vlag om aan te geven of de gratis laag is ingeschakeld. Bool
enableMaterializedViews Vlag om aan te geven of MaterializedViews moet worden ingeschakeld in het Cosmos DB-account Bool
enableMultipleWriteLocations Hiermee kan het account op meerdere locaties schrijven Bool
enablePartitionMerge Vlag om aan te geven dat de functie Partition Merge voor het account is ingeschakeld/uitgeschakeld Bool
enablePerRegionPerPartitionAutoscale Vlag om aan te geven dat Per-Region functie voor automatisch schalen per partitie in het account wordt ingeschakeld/uitgeschakeld Bool
enablePriorityBasedExecution Vlag om aan te geven dat de functie Op basis van uitvoering op basis van prioriteit wordt ingeschakeld/uitgeschakeld voor het account Bool
ipRules Lijst met IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Vlag om aan te geven of virtuele netwerk-ACL-regels moeten worden ingeschakeld/uitgeschakeld. Bool
keyVaultKeyUri De URI van de sleutelkluis snaar
Locaties Een matrix die de georeplicatielocaties bevat die zijn ingeschakeld voor het Cosmos DB-account. Locatie[] (vereist)
minimalTlsVersion Geeft de minimaal toegestane Tls-versie aan. De standaardwaarde is Tls 1.0, met uitzondering van Cassandra- en Mongo-API's, die alleen werken met Tls 1.2. 'Tls'
'Tls11'
Tls12
networkAclBypass Hiermee wordt aangegeven welke services firewallcontroles mogen omzeilen. 'AzureServices'
'Geen'
networkAclBypassResourceIds Een matrix die de resource-id's voor netwerk-Acl bypass voor het Cosmos DB-account bevat. tekenreeks[]
publicNetworkAccess Of aanvragen van openbaar netwerk zijn toegestaan 'Uitgeschakeld'
'Ingeschakeld'
'SecuredByPerimeter'
restoreParameters Parameters om de informatie over de herstelbewerking aan te geven. RestoreParameters
virtualNetworkRules Lijst met ACL-regels voor virtueel netwerk die zijn geconfigureerd voor het Cosmos DB-account. VirtualNetworkRule[]

DatabaseRestoreResource

Naam Beschrijving Waarde
collectionNames De namen van de verzamelingen die beschikbaar zijn voor herstel. tekenreeks[]
databaseName De naam van de database die beschikbaar is voor herstel. snaar

DiagnosticLogSettings

Naam Beschrijving Waarde
enableFullTextQuery Beschrijf het detailniveau waarmee query's moeten worden vastgelegd. 'Onwaar'
'Geen'
'Waar'

GremlinDatabaseRestoreResource

Naam Beschrijving Waarde
databaseName De naam van de gremlin-database die beschikbaar is voor herstel. snaar
graphNames De namen van de grafieken die beschikbaar zijn voor herstel. tekenreeks[]

IpAddressOrRange

Naam Beschrijving Waarde
ipAddressOrRange Eén IPv4-adres of één IPv4-adresbereik in CIDR-indeling. Opgegeven IP-adressen moeten goed zijn opgemaakt en kunnen niet worden opgenomen in een van de volgende bereiken: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, omdat deze niet kunnen worden afgedwongen door het IP-adresfilter. Voorbeeld van geldige invoer: '23.40.210.245' of '23.40.210.0/8'. snaar

Plaats

Naam Beschrijving Waarde
failoverPriority De failoverprioriteit van de regio. Een failoverprioriteit van 0 geeft een schrijfregio aan. De maximumwaarde voor een failoverprioriteit = (totaal aantal regio's - 1). Failoverprioriteitswaarden moeten uniek zijn voor elk van de regio's waarin het databaseaccount bestaat. Int

Beperkingen:
Minimumwaarde = 0
isZoneRedundant Vlag om aan te geven of deze regio een AvailabilityZone-regio is Bool
locationName De naam van de regio. snaar

ManagedServiceIdentity

Naam Beschrijving Waarde
type Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd. 'Geen'
'SystemAssigned'
'SystemAssigned, UserAssigned'
UserAssigned
userAssignedIdentities De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen voor de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Naam Beschrijving Waarde

Microsoft.DocumentDB/databaseAccounts

Naam Beschrijving Waarde
identiteit Identiteit voor de resource. ManagedServiceIdentity-
soort Geeft het type databaseaccount aan. Dit kan alleen worden ingesteld bij het maken van een databaseaccount. 'GlobalDocumentDB'
'MongoDB'
'Parseren'
plaats De locatie van de resourcegroep waartoe de resource behoort. snaar
naam De resourcenaam snaar

Beperkingen:
Minimale lengte = 3
Maximale lengte = 3
Patroon = ^[a-z0-9]+(-[a-z0-9]+)* (vereist)
Eigenschappen Eigenschappen voor het maken en bijwerken van Azure Cosmos DB-databaseaccounts. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (vereist)
Tags Resourcetags Woordenlijst met tagnamen en -waarden.
type Het resourcetype "Microsoft.DocumentDB/databaseAccounts@2024-12-01-preview"

PeriodicModeBackupPolicy

Naam Beschrijving Waarde
periodicModeProperties Configuratiewaarden voor periodieke back-upmodus PeriodicModeProperties-
type Beschrijft de modus van back-ups. 'Periodiek' (vereist)

PeriodicModeProperties

Naam Beschrijving Waarde
backupIntervalInMinutes Een geheel getal dat het interval in minuten tussen twee back-ups aangeeft Int

Beperkingen:
Minimumwaarde = 0
backupRetentionIntervalInHours Een geheel getal dat de tijd (in uren) aangeeft dat elke back-up wordt bewaard Int

Beperkingen:
Minimumwaarde = 0
backupStorageRedundancy Opsomming om het type back-uplocatie aan te geven 'Geo'
'Lokaal'
'Zone'

RestoreParameters

Naam Beschrijving Waarde
databasesToRestore Lijst met specifieke databases die beschikbaar zijn voor herstel. DatabaseRestoreResource[]
gremlinDatabasesToRestore Lijst met specifieke Gremlin-databases die beschikbaar zijn voor herstel. GremlinDatabaseRestoreResource[]
restoreMode Beschrijft de modus van het herstellen. 'PointInTime'
restoreSource De id van het herstelbare databaseaccount van waaruit het herstel moet worden gestart. Bijvoorbeeld: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} snaar
restoreTimestampInUtc Tijd waarop het account moet worden hersteld (ISO-8601-indeling). snaar
restoreWithTtlDisabled Hiermee geeft u op of het herstelde account tijd-To-Live uitgeschakeld bij het herstellen. Bool
sourceBackupLocation De bronback-uplocatie voor herstel. snaar
tablesToRestore Lijst met specifieke tabellen die beschikbaar zijn voor herstel. tekenreeks[]

Tags

Naam Beschrijving Waarde

VirtualNetworkRule

Naam Beschrijving Waarde
legitimatiebewijs Resource-id van een subnet, bijvoorbeeld: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnetten/{subnetName}. snaar
ignoreMissingVNetServiceEndpoint Maak een firewallregel voordat vnet-service-eindpunt is ingeschakeld voor het virtuele netwerk. Bool