Delen via


Microsoft.DocumentDB-databaseAccounts 2021-04-01-preview

Bicep-resourcedefinitie

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

Zie het wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2021-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'
  }
}

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties-objecten

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

Gebruik voor Standaard:

{
  createMode: 'Default'
}

Gebruik voor Herstellen:

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

BackupPolicy-objecten

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

Gebruik voor Doorlopend:

{
  type: 'Continuous'
}

Gebruik voor periodiek gebruik:

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

Eigenschapswaarden

Microsoft.DocumentDB/databaseAccounts

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

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

Api-eigenschappen

Naam Beschrijving Waarde
serverVersie Beschrijft de ServerVersion van een MongoDB-account. '3.2'
'3.6'
'4.0'

Back-up beleid

Naam Beschrijving Waarde
soort Ingesteld op Doorlopend voor het type ContinuousModeBackupPolicy. Ingesteld op 'Periodiek' voor het type PeriodicModeBackupPolicy. 'Doorlopend'
'Periodiek' (vereist)

Vermogen

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

Componenten1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Naam Beschrijving Waarde

Consistentie Beleid

Naam Beschrijving Waarde
defaultConsistencyLevel Het standaardconsistentieniveau en de configuratie-instellingen van het Cosmos DB-account. 'Begrensde oudheid'
'Consistent voorvoegsel'
'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
maxStalenessVoorvoegsel 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
soort Beschrijft de modus van back-ups. Doorlopend (vereist)

Cors-beleid

Naam Beschrijving Waarde
toegestaneHeaders De aanvraagheaders die het oorspronkelijke domein kan opgeven voor de CORS-aanvraag. touw
toegestaanMethoden De methoden (HTTP-aanvraagwoorden) die het oorspronkelijke domein kan gebruiken voor een CORS-aanvraag. touw
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. touw
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
apiEigenschappen API-specifieke eigenschappen. Momenteel wordt alleen ondersteund voor mongoDB-API. ApiProperties-
back-up beleid Het object dat het beleid vertegenwoordigt voor het maken van back-ups voor een account. BackupPolicy-
Mogelijkheden Lijst met Cosmos DB-mogelijkheden voor het account Mogelijkheid[]
connectorAanbieding De cassandra-connectoraanbiedingstype voor het Cosmos DB-database-C*-account. 'Klein'
consistentieBeleid Het consistentiebeleid voor het Cosmos DB-account. Consistentie Beleid
korset Het CORS-beleid voor het Cosmos DB-databaseaccount. Cors-beleid
createMode Ingesteld op Standaard voor het type DefaultRequestDatabaseAccountCreateUpdateProperties. Ingesteld op Herstellen voor het type RestoreReqeustDatabaseAccountCreateUpdateProperties. 'Standaard'
'Herstellen' (vereist)
databaseAccountOfferType Het aanbiedingstype voor de database 'Standaard' (vereist)
standaardIdentiteit 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. touw
disableKeyBasedMetadataWriteAccess Schrijfbewerkingen uitschakelen voor metagegevensresources (databases, containers, doorvoer) via accountsleutels Bool
enableAnalyticalStorage Vlag om aan te geven of opslaganalyse moet worden ingeschakeld. Bool
Automatische failover inschakelen 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
CassandraConnector inschakelen 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
enableMultipleWriteLocations Hiermee kan het account op meerdere locaties schrijven Bool
ipRegels 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 touw
locaties Een matrix die de georeplicatielocaties bevat die zijn ingeschakeld voor het Cosmos DB-account. Locatie[] (vereist)
netwerkAclBypass Hiermee wordt aangegeven welke services firewallcontroles mogen omzeilen. 'Azure-diensten'
'Geen'
networkAclBypassResourceIds Een matrix die de resource-id's voor netwerk-Acl bypass voor het Cosmos DB-account bevat. tekenreeks[]
toegang tot het openbare netwerk Of aanvragen van openbaar netwerk zijn toegestaan 'Uitgeschakeld'
'Ingeschakeld'
virtualNetworkRules Lijst met ACL-regels voor virtueel netwerk die zijn geconfigureerd voor het Cosmos DB-account. VirtualNetworkRule

DatabaseHerstellen Bron

Naam Beschrijving Waarde
collectieNamen De namen van de verzamelingen die beschikbaar zijn voor herstel. tekenreeks[]
databasenaam De naam van de database die beschikbaar is voor herstel. touw

DefaultRequestDatabaseAccountCreateUpdateProperties

Naam Beschrijving Waarde
createMode Opsomming om de modus voor het maken van accounts aan te geven. 'Standaard' (vereist)

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'. touw

Locatie

Naam Beschrijving Waarde
failoverPrioriteit 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
locatieNaam De naam van de regio. touw

Beheerde ServiceIdentity

Naam Beschrijving Waarde
soort 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'
'Systeem toegewezen'
'SystemAssigned, UserAssigned'
UserAssigned
gebruikers-toegewezen identiteiten 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

PeriodicModeBackupPolicy

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

PeriodicModeEigenschappen

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

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

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

Parameters herstellen

Naam Beschrijving Waarde
databasesToRestore Lijst met specifieke databases die beschikbaar zijn voor herstel. DatabaseRestoreResource
herstelmodus Beschrijft de modus van het herstellen. 'PointInTime'
Bron herstellen De id van het herstelbare databaseaccount van waaruit het herstel moet worden gestart. Bijvoorbeeld: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} touw
herstelTimestampInUtc Tijd waarop het account moet worden hersteld (ISO-8601-indeling). touw

RestoreReqeustDatabaseAccountCreateUpdateProperties

Naam Beschrijving Waarde
createMode Opsomming om de modus voor het maken van accounts aan te geven. 'Herstellen' (vereist)
Parameters herstellen Parameters om de informatie over de herstelbewerking aan te geven. Parameters herstellen

Tags

Naam Beschrijving Waarde

VirtualNetworkRule

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

Gebruiksvoorbeelden

Geverifieerde Azure-modules

De volgende geverifieerde Azure-modules kunnen worden gebruikt om dit resourcetype te implementeren.

Moduul Beschrijving
CosmosDB-databaseaccount AVM-resourcemodule voor CosmosDB-databaseaccount

Azure-snelstartvoorbeelden

De volgende Azure-snelstartsjablonen bevatten Bicep-voorbeelden voor het implementeren van dit resourcetype.

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 Zero Touch Azure Cosmos-account en Azure Web App maken Met deze sjabloon maakt u een Azure Cosmos-account, injecteert u het Cosmos DB-eindpunt en de sleutels in 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 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 voor table-API maken 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 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 gegevensvlak RBAC Met deze sjabloon maakt u een SQL Cosmos-account, een systeemeigen onderhouden roldefinitie en een systeemeigen onderhouden roltoewijzing voor een AAD-identiteit.
Een 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 cassandra-API maken 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) API maken Met deze sjabloon maakt u een Azure Cosmos DB-account voor Core (SQL) API en een container met een opgeslagen procedure, trigger en door de gebruiker gedefinieerde functie.
Hiermee maakt u een Dapr-microservices-app met behulp van Container Apps Een Dapr-microservices-app maken met behulp van Container Apps.
Hiermee maakt u 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 het wijzigingenlogboek voor 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": "2021-04-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "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"
  }
}

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties-objecten

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

Gebruik voor Standaard:

{
  "createMode": "Default"
}

Gebruik voor Herstellen:

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

BackupPolicy-objecten

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

Gebruik voor Doorlopend:

{
  "type": "Continuous"
}

Gebruik voor periodiek gebruik:

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

Eigenschapswaarden

Microsoft.DocumentDB/databaseAccounts

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

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

Api-eigenschappen

Naam Beschrijving Waarde
serverVersie Beschrijft de ServerVersion van een MongoDB-account. '3.2'
'3.6'
'4.0'

Back-up beleid

Naam Beschrijving Waarde
soort Ingesteld op Doorlopend voor het type ContinuousModeBackupPolicy. Ingesteld op 'Periodiek' voor het type PeriodicModeBackupPolicy. 'Doorlopend'
'Periodiek' (vereist)

Vermogen

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

Componenten1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Naam Beschrijving Waarde

Consistentie Beleid

Naam Beschrijving Waarde
defaultConsistencyLevel Het standaardconsistentieniveau en de configuratie-instellingen van het Cosmos DB-account. 'Begrensde oudheid'
'Consistent voorvoegsel'
'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
maxStalenessVoorvoegsel 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
soort Beschrijft de modus van back-ups. Doorlopend (vereist)

Cors-beleid

Naam Beschrijving Waarde
toegestaneHeaders De aanvraagheaders die het oorspronkelijke domein kan opgeven voor de CORS-aanvraag. touw
toegestaanMethoden De methoden (HTTP-aanvraagwoorden) die het oorspronkelijke domein kan gebruiken voor een CORS-aanvraag. touw
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. touw
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
apiEigenschappen API-specifieke eigenschappen. Momenteel wordt alleen ondersteund voor mongoDB-API. ApiProperties-
back-up beleid Het object dat het beleid vertegenwoordigt voor het maken van back-ups voor een account. BackupPolicy-
Mogelijkheden Lijst met Cosmos DB-mogelijkheden voor het account Mogelijkheid[]
connectorAanbieding De cassandra-connectoraanbiedingstype voor het Cosmos DB-database-C*-account. 'Klein'
consistentieBeleid Het consistentiebeleid voor het Cosmos DB-account. Consistentie Beleid
korset Het CORS-beleid voor het Cosmos DB-databaseaccount. Cors-beleid
createMode Ingesteld op Standaard voor het type DefaultRequestDatabaseAccountCreateUpdateProperties. Ingesteld op Herstellen voor het type RestoreReqeustDatabaseAccountCreateUpdateProperties. 'Standaard'
'Herstellen' (vereist)
databaseAccountOfferType Het aanbiedingstype voor de database 'Standaard' (vereist)
standaardIdentiteit 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. touw
disableKeyBasedMetadataWriteAccess Schrijfbewerkingen uitschakelen voor metagegevensresources (databases, containers, doorvoer) via accountsleutels Bool
enableAnalyticalStorage Vlag om aan te geven of opslaganalyse moet worden ingeschakeld. Bool
Automatische failover inschakelen 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
CassandraConnector inschakelen 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
enableMultipleWriteLocations Hiermee kan het account op meerdere locaties schrijven Bool
ipRegels 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 touw
locaties Een matrix die de georeplicatielocaties bevat die zijn ingeschakeld voor het Cosmos DB-account. Locatie[] (vereist)
netwerkAclBypass Hiermee wordt aangegeven welke services firewallcontroles mogen omzeilen. 'Azure-diensten'
'Geen'
networkAclBypassResourceIds Een matrix die de resource-id's voor netwerk-Acl bypass voor het Cosmos DB-account bevat. tekenreeks[]
toegang tot het openbare netwerk Of aanvragen van openbaar netwerk zijn toegestaan 'Uitgeschakeld'
'Ingeschakeld'
virtualNetworkRules Lijst met ACL-regels voor virtueel netwerk die zijn geconfigureerd voor het Cosmos DB-account. VirtualNetworkRule

DatabaseHerstellen Bron

Naam Beschrijving Waarde
collectieNamen De namen van de verzamelingen die beschikbaar zijn voor herstel. tekenreeks[]
databasenaam De naam van de database die beschikbaar is voor herstel. touw

DefaultRequestDatabaseAccountCreateUpdateProperties

Naam Beschrijving Waarde
createMode Opsomming om de modus voor het maken van accounts aan te geven. 'Standaard' (vereist)

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'. touw

Locatie

Naam Beschrijving Waarde
failoverPrioriteit 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
locatieNaam De naam van de regio. touw

Beheerde ServiceIdentity

Naam Beschrijving Waarde
soort 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'
'Systeem toegewezen'
'SystemAssigned, UserAssigned'
UserAssigned
gebruikers-toegewezen identiteiten 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

PeriodicModeBackupPolicy

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

PeriodicModeEigenschappen

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

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

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

Parameters herstellen

Naam Beschrijving Waarde
databasesToRestore Lijst met specifieke databases die beschikbaar zijn voor herstel. DatabaseRestoreResource
herstelmodus Beschrijft de modus van het herstellen. 'PointInTime'
Bron herstellen De id van het herstelbare databaseaccount van waaruit het herstel moet worden gestart. Bijvoorbeeld: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} touw
herstelTimestampInUtc Tijd waarop het account moet worden hersteld (ISO-8601-indeling). touw

RestoreReqeustDatabaseAccountCreateUpdateProperties

Naam Beschrijving Waarde
createMode Opsomming om de modus voor het maken van accounts aan te geven. 'Herstellen' (vereist)
Parameters herstellen Parameters om de informatie over de herstelbewerking aan te geven. Parameters herstellen

Tags

Naam Beschrijving Waarde

VirtualNetworkRule

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

Gebruiksvoorbeelden

Azure-snelstartsjablonen

Met de volgende Azure-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 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 Zero Touch Azure Cosmos-account en Azure Web App 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

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 voor table-API maken 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

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 gegevensvlak 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 cassandra-API maken

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) API 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.
Hiermee maakt u een Dapr-microservices-app met behulp van Container Apps

Implementeren in Azure
Een Dapr-microservices-app maken met behulp van Container Apps.
Hiermee maakt u 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 het wijzigingenlogboek voor 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@2021-04-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    kind = "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
    }
  }
}

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties-objecten

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

Gebruik voor Standaard:

{
  createMode = "Default"
}

Gebruik voor Herstellen:

{
  createMode = "Restore"
  restoreParameters = {
    databasesToRestore = [
      {
        collectionNames = [
          "string"
        ]
        databaseName = "string"
      }
    ]
    restoreMode = "string"
    restoreSource = "string"
    restoreTimestampInUtc = "string"
  }
}

BackupPolicy-objecten

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

Gebruik voor Doorlopend:

{
  type = "Continuous"
}

Gebruik voor periodiek gebruik:

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

Eigenschapswaarden

Microsoft.DocumentDB/databaseAccounts

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

Beperkingen:
Minimale lengte = 3
Maximale lengte = 50
Patroon = ^[a-z0-9]+(-[a-z0-9]+)* (vereist)
eigenschappen Eigenschappen voor het maken en bijwerken van Azure Cosmos DB-databaseaccounts. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (vereist)
etiketten Resourcetags Woordenlijst met tagnamen en -waarden.
soort Het brontype "Microsoft.DocumentDB/databaseAccounts@2021-04-01-preview"

Api-eigenschappen

Naam Beschrijving Waarde
serverVersie Beschrijft de ServerVersion van een MongoDB-account. '3.2'
'3.6'
'4.0'

Back-up beleid

Naam Beschrijving Waarde
soort Ingesteld op Doorlopend voor het type ContinuousModeBackupPolicy. Ingesteld op 'Periodiek' voor het type PeriodicModeBackupPolicy. 'Doorlopend'
'Periodiek' (vereist)

Vermogen

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

Componenten1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Naam Beschrijving Waarde

Consistentie Beleid

Naam Beschrijving Waarde
defaultConsistencyLevel Het standaardconsistentieniveau en de configuratie-instellingen van het Cosmos DB-account. 'Begrensde oudheid'
'Consistent voorvoegsel'
'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
maxStalenessVoorvoegsel 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
soort Beschrijft de modus van back-ups. Doorlopend (vereist)

Cors-beleid

Naam Beschrijving Waarde
toegestaneHeaders De aanvraagheaders die het oorspronkelijke domein kan opgeven voor de CORS-aanvraag. touw
toegestaanMethoden De methoden (HTTP-aanvraagwoorden) die het oorspronkelijke domein kan gebruiken voor een CORS-aanvraag. touw
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. touw
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
apiEigenschappen API-specifieke eigenschappen. Momenteel wordt alleen ondersteund voor mongoDB-API. ApiProperties-
back-up beleid Het object dat het beleid vertegenwoordigt voor het maken van back-ups voor een account. BackupPolicy-
Mogelijkheden Lijst met Cosmos DB-mogelijkheden voor het account Mogelijkheid[]
connectorAanbieding De cassandra-connectoraanbiedingstype voor het Cosmos DB-database-C*-account. 'Klein'
consistentieBeleid Het consistentiebeleid voor het Cosmos DB-account. Consistentie Beleid
korset Het CORS-beleid voor het Cosmos DB-databaseaccount. Cors-beleid
createMode Ingesteld op Standaard voor het type DefaultRequestDatabaseAccountCreateUpdateProperties. Ingesteld op Herstellen voor het type RestoreReqeustDatabaseAccountCreateUpdateProperties. 'Standaard'
'Herstellen' (vereist)
databaseAccountOfferType Het aanbiedingstype voor de database 'Standaard' (vereist)
standaardIdentiteit 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. touw
disableKeyBasedMetadataWriteAccess Schrijfbewerkingen uitschakelen voor metagegevensresources (databases, containers, doorvoer) via accountsleutels Bool
enableAnalyticalStorage Vlag om aan te geven of opslaganalyse moet worden ingeschakeld. Bool
Automatische failover inschakelen 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
CassandraConnector inschakelen 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
enableMultipleWriteLocations Hiermee kan het account op meerdere locaties schrijven Bool
ipRegels 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 touw
locaties Een matrix die de georeplicatielocaties bevat die zijn ingeschakeld voor het Cosmos DB-account. Locatie[] (vereist)
netwerkAclBypass Hiermee wordt aangegeven welke services firewallcontroles mogen omzeilen. 'Azure-diensten'
'Geen'
networkAclBypassResourceIds Een matrix die de resource-id's voor netwerk-Acl bypass voor het Cosmos DB-account bevat. tekenreeks[]
toegang tot het openbare netwerk Of aanvragen van openbaar netwerk zijn toegestaan 'Uitgeschakeld'
'Ingeschakeld'
virtualNetworkRules Lijst met ACL-regels voor virtueel netwerk die zijn geconfigureerd voor het Cosmos DB-account. VirtualNetworkRule

DatabaseHerstellen Bron

Naam Beschrijving Waarde
collectieNamen De namen van de verzamelingen die beschikbaar zijn voor herstel. tekenreeks[]
databasenaam De naam van de database die beschikbaar is voor herstel. touw

DefaultRequestDatabaseAccountCreateUpdateProperties

Naam Beschrijving Waarde
createMode Opsomming om de modus voor het maken van accounts aan te geven. 'Standaard' (vereist)

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'. touw

Locatie

Naam Beschrijving Waarde
failoverPrioriteit 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
locatieNaam De naam van de regio. touw

Beheerde ServiceIdentity

Naam Beschrijving Waarde
soort 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'
'Systeem toegewezen'
'SystemAssigned, UserAssigned'
UserAssigned
gebruikers-toegewezen identiteiten 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

PeriodicModeBackupPolicy

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

PeriodicModeEigenschappen

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

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

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

Parameters herstellen

Naam Beschrijving Waarde
databasesToRestore Lijst met specifieke databases die beschikbaar zijn voor herstel. DatabaseRestoreResource
herstelmodus Beschrijft de modus van het herstellen. 'PointInTime'
Bron herstellen De id van het herstelbare databaseaccount van waaruit het herstel moet worden gestart. Bijvoorbeeld: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} touw
herstelTimestampInUtc Tijd waarop het account moet worden hersteld (ISO-8601-indeling). touw

RestoreReqeustDatabaseAccountCreateUpdateProperties

Naam Beschrijving Waarde
createMode Opsomming om de modus voor het maken van accounts aan te geven. 'Herstellen' (vereist)
Parameters herstellen Parameters om de informatie over de herstelbewerking aan te geven. Parameters herstellen

Tags

Naam Beschrijving Waarde

VirtualNetworkRule

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