Microsoft.DocumentDB databaseAccounts 2021-04-01-preview

Article
12/16/2024

Définition de ressource Bicep

Le type de ressource databaseAccounts peut être déployé avec des opérations qui ciblent :

groupes de ressources - Consultez commandes de déploiement de groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts, ajoutez le bicep suivant à votre modèle.

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'
  }
}

Objets BackupPolicy

Définissez le type propriété pour spécifier le type d’objet.

Pour continu, utilisez :

{
  type: 'Continuous'
}

Pour périodique, utilisez :

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

Objets DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Définissez la propriété createMode pour spécifier le type d’objet.

Pour par défaut, utilisez :

{
  createMode: 'Default'
}

Pour de restauration, utilisez :

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

Valeurs de propriété

ApiProperties

Nom	Description	Valeur
serverVersion	Décrit serverVersion d’un compte MongoDB.	'3.2' '3.6' '4.0'

BackupPolicy

Nom	Description	Valeur
type	Défini sur « Continuous » pour le type ContinuousModeBackupPolicy. Défini sur « Periodic » pour le type PeriodicModeBackupPolicy.	'Continu' 'Périodique' (obligatoire)

Capacité

Nom	Description	Valeur
nom	Nom de la fonctionnalité Cosmos DB. Par exemple, « name » : « EnableCassandra ». Les valeurs actuelles incluent également « EnableTable » et « EnableGremlin ».	corde

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nom	Description	Valeur

ConsistencyPolicy

Nom	Description	Valeur
defaultConsistencyLevel	Niveau de cohérence et paramètres de configuration par défaut du compte Cosmos DB.	'BoundedStaleness' 'ConsistentPrefix' 'Final' 'Session' 'Strong' (obligatoire)
maxIntervalInSeconds	Lorsqu’elle est utilisée avec le niveau de cohérence de l’obsolescence limitée, cette valeur représente la durée d’obsolescence (en secondes) tolérée. La plage acceptée pour cette valeur est 5 à 86400. Obligatoire lorsque defaultConsistencyPolicy est défini sur « BoundedStaleness ».	Int Contraintes: Valeur minimale = 5 Valeur maximale = 86400
maxStalenessPrefix	Lorsqu’elle est utilisée avec le niveau de cohérence de l’obsolescence limitée, cette valeur représente le nombre de demandes obsolètes tolérées. La plage acceptée pour cette valeur est de 1 à 2 147 483 647. Obligatoire lorsque defaultConsistencyPolicy est défini sur « BoundedStaleness ».	Int Contraintes: Valeur minimale = 1 Valeur maximale = 2147483647

ContinuousModeBackupPolicy

Nom	Description	Valeur
type	Décrit le mode de sauvegarde.	'Continu' (obligatoire)

CorsPolicy

Nom	Description	Valeur
allowedHeaders	En-têtes de requête que le domaine d’origine peut spécifier sur la requête CORS.	corde
allowedMethods	Méthodes (verbes de requête HTTP) que le domaine d’origine peut utiliser pour une requête CORS.	corde
allowedOrigins	Domaines d’origine autorisés à effectuer une demande auprès du service via CORS.	chaîne (obligatoire)
exposedHeaders	En-têtes de réponse qui peuvent être envoyés dans la réponse à la demande CORS et exposés par le navigateur à l’émetteur de la requête.	corde
maxAgeInSeconds	Durée maximale pendant laquelle un navigateur doit mettre en cache la requête OPTIONS préliminaire.	Int Contraintes: Valeur minimale = 1 Valeur maximale = 2147483647

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Nom	Description	Valeur
apiProperties	Propriétés spécifiques de l’API. Actuellement, pris en charge uniquement pour l’API MongoDB.	ApiProperties
backupPolicy	Objet représentant la stratégie pour effectuer des sauvegardes sur un compte.	BackupPolicy
Capacités	Liste des fonctionnalités de Cosmos DB pour le compte	fonctionnalité[]
connectorOffer	Type d’offre du connecteur cassandra pour le compte C* de base de données Cosmos DB.	'Small'
consistencyPolicy	Stratégie de cohérence pour le compte Cosmos DB.	ConsistencyPolicy
cors	Stratégie CORS pour le compte de base de données Cosmos DB.	CorsPolicy[]
createMode	Défini sur « Default » pour le type DefaultRequestDatabaseAccountCreateUpdateProperties. Défini sur « Restore » pour le type RestoreReqeustDatabaseAccountCreateUpdateProperties.	'Default' 'Restore' (obligatoire)
databaseAccountOfferType	Type d’offre pour la base de données	'Standard' (obligatoire)
defaultIdentity	Identité par défaut pour accéder au coffre de clés utilisé dans les fonctionnalités telles que les clés gérées par le client. L’identité par défaut doit être définie explicitement par les utilisateurs. Il peut s’agir de « FirstPartyIdentity », « SystemAssignedIdentity » et bien plus encore.	corde
disableKeyBasedMetadataWriteAccess	Désactiver les opérations d’écriture sur les ressources de métadonnées (bases de données, conteneurs, débit) via des clés de compte	Bool
enableAnalyticalStorage	Indicateur pour indiquer s’il faut activer l’analytique de stockage.	Bool
enableAutomaticFailover	Active le basculement automatique de la région d’écriture dans le cas rare où la région n’est pas disponible en raison d’une panne. Le basculement automatique entraîne une nouvelle région d’écriture pour le compte et est choisi en fonction des priorités de basculement configurées pour le compte.	Bool
enableCassandraConnector	Active le connecteur cassandra sur le compte C* Cosmos DB	Bool
enableFreeTier	Indicateur pour indiquer si le niveau gratuit est activé.	Bool
enableMultipleWriteLocations	Permet au compte d’écrire dans plusieurs emplacements	Bool
ipRules	Liste d’IpRules.	IpAddressOrRange[]
isVirtualNetworkFilterEnabled	Indicateur pour indiquer s’il faut activer/désactiver des règles de liste de contrôle d’accès de réseau virtuel.	Bool
keyVaultKeyUri	URI du coffre de clés	corde
Lieux	Tableau qui contient les emplacements de géoréplication activés pour le compte Cosmos DB.	Emplacement[] (obligatoire)
networkAclBypass	Indique quels services sont autorisés à contourner les vérifications de pare-feu.	'AzureServices' 'None'
networkAclBypassResourceIds	Tableau qui contient les ID de ressource pour le contournement Acl réseau pour le compte Cosmos DB.	string[]
publicNetworkAccess	Indique si les demandes du réseau public sont autorisées	'Désactivé' 'Activé'
virtualNetworkRules	Liste des règles de liste de contrôle d’accès de réseau virtuel configurées pour le compte Cosmos DB.	VirtualNetworkRule[]

DatabaseRestoreResource

Nom	Description	Valeur
collectionNames	Noms des collections disponibles pour la restauration.	string[]
databaseName	Nom de la base de données disponible pour la restauration.	corde

DefaultRequestDatabaseAccountCreateUpdateProperties

Nom	Description	Valeur
createMode	Énumération pour indiquer le mode de création de compte.	'Default' (obligatoire)

IpAddressOrRange

Nom	Description	Valeur
ipAddressOrRange	Une seule adresse IPv4 ou une seule plage d’adresses IPv4 au format CIDR. Les adresses IP fournies doivent être bien mises en forme et ne peuvent pas être contenues dans l’une des plages suivantes : 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, car elles ne peuvent pas être appliquées par le filtre d’adresse IP. Exemple d’entrées valides : « 23.40.210.245 » ou « 23.40.210.0/8 ».	corde

Emplacement

Nom	Description	Valeur
failoverPriority	Priorité de basculement de la région. Une priorité de basculement de 0 indique une région d’écriture. Valeur maximale d’une priorité de basculement = (nombre total de régions - 1). Les valeurs de priorité de basculement doivent être uniques pour chacune des régions dans lesquelles le compte de base de données existe.	Int Contraintes: Valeur minimale = 0
isZoneRedundant	Indicateur pour indiquer si cette région est une région AvailabilityZone	Bool
locationName	Nom de la région.	corde

ManagedServiceIdentity

Nom	Description	Valeur
type	Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service.	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned'
userAssignedIdentities	Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nom	Description	Valeur