Partager via


Microsoft.DocumentDB base de donnéesAccounts/cassandraKeyspaces

Définition de ressource Bicep

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

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/cassandraKeyspaces, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2025-11-01-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      id: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces

Nom Descriptif Valeur
identité Identité de la ressource. ManagedServiceIdentity
emplacement Emplacement du groupe de ressources auquel appartient la ressource. corde
nom Nom de la ressource chaîne (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente d’une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez ressource enfant en dehors de la ressource parente.
Nom symbolique de la ressource de type : databaseAccounts
Propriétés Propriétés permettant de créer et de mettre à jour l’espace de clés Cassandra Azure Cosmos DB. CassandraKeyspaceCreateUpdatePropertiesOrCassandraKeyspaceGetProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

ARMResourcePropriétéTags

Nom Descriptif Valeur

Mise à l’échelle automatique

Nom Descriptif Valeur
maxThroughput Représente le débit maximal, la ressource peut effectuer un scale-up. Int

CassandraKeyspaceCreateUpdatePropertiesOrCassandraKeyspaceGetProperties

Nom Descriptif Valeur
Options Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête. CreateUpdateOptionsOrCassandraKeyspaceGetPropertiesOptions
ressource Format JSON standard d’un espace de clés Cassandra CassandraKeyspaceResourceOrCassandraKeyspaceGetPropertiesResource (obligatoire)

CassandraKeyspaceResourceOrCassandraKeyspaceGetPropertiesResource

Nom Descriptif Valeur
pièce d'identité Nom de l’espace de clés Cassandra Cosmos DB chaîne (obligatoire)

CreateUpdateOptionsOrCassandraKeyspaceGetPropertiesOptions

Nom Descriptif Valeur
autoscaleParamètres Spécifie les paramètres de mise à l’échelle automatique. Remarque : Le débit ou la mise à l’échelle automatiqueSettings est requis, mais pas les deux. de mise à l’échelle automatique
débit Unités de requête par seconde. Par exemple, « débit » : 1 0000. Int

Identité de Service Gérée (ManagedServiceIdentity)

Nom Descriptif 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. « Aucun »
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
Identités attribuées par l'utilisateur 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 Descriptif Valeur

ManagedServiceIdentityUserAssignedIdentities

Nom Descriptif Valeur

Exemples d’utilisation

Exemples Bicep

Exemple de base de déploiement de Cassandra KeySpace au sein d’un compte Cosmos DB.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource databaseAccount 'Microsoft.DocumentDB/databaseAccounts@2021-10-15' = {
  name: resourceName
  location: location
  kind: 'GlobalDocumentDB'
  properties: {
    capabilities: [
      {
        name: 'EnableCassandra'
      }
    ]
    consistencyPolicy: {
      defaultConsistencyLevel: 'Strong'
      maxIntervalInSeconds: 5
      maxStalenessPrefix: 100
    }
    databaseAccountOfferType: 'Standard'
    defaultIdentity: 'FirstPartyIdentity'
    disableKeyBasedMetadataWriteAccess: false
    disableLocalAuth: false
    enableAnalyticalStorage: false
    enableAutomaticFailover: false
    enableFreeTier: false
    enableMultipleWriteLocations: false
    ipRules: []
    isVirtualNetworkFilterEnabled: false
    locations: [
      {
        failoverPriority: 0
        isZoneRedundant: false
        locationName: 'West Europe'
      }
    ]
    networkAclBypass: 'None'
    networkAclBypassResourceIds: []
    publicNetworkAccess: 'Enabled'
    virtualNetworkRules: []
  }
}

resource cassandraKeyspace 'Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-10-15' = {
  parent: databaseAccount
  name: resourceName
  properties: {
    options: {}
    resource: {
      id: 'acctest0001'
    }
  }
}

Exemples de démarrage rapide Azure

Les modèles de démarrage rapide Azure suivants contiennent des exemples Bicep pour le déploiement de ce type de ressource.

Fichier Bicep Descriptif
Créer un compte Azure Cosmos DB pour l' de l’API Cassandra Ce modèle crée un compte Azure Cosmos DB pour l’API Cassandra dans deux régions avec un espace de clés et une table avec un débit dédié.
Créer un compte Azure Cosmos DB de mise à l’échelle automatique pour les de l’API Cassandra Ce modèle crée un compte Azure Cosmos DB pour l’API Cassandra dans deux régions avec un espace de clés et une table avec un débit de mise à l’échelle automatique.

Définition de ressource de modèle ARM

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

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/cassandraKeyspaces, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces",
  "apiVersion": "2025-11-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "id": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces

Nom Descriptif Valeur
apiVersion Version de l’API '2025-11-01-preview'
identité Identité de la ressource. ManagedServiceIdentity
emplacement Emplacement du groupe de ressources auquel appartient la ressource. corde
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés permettant de créer et de mettre à jour l’espace de clés Cassandra Azure Cosmos DB. CassandraKeyspaceCreateUpdatePropertiesOrCassandraKeyspaceGetProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces'

ARMResourcePropriétéTags

Nom Descriptif Valeur

Mise à l’échelle automatique

Nom Descriptif Valeur
maxThroughput Représente le débit maximal, la ressource peut effectuer un scale-up. Int

CassandraKeyspaceCreateUpdatePropertiesOrCassandraKeyspaceGetProperties

Nom Descriptif Valeur
Options Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête. CreateUpdateOptionsOrCassandraKeyspaceGetPropertiesOptions
ressource Format JSON standard d’un espace de clés Cassandra CassandraKeyspaceResourceOrCassandraKeyspaceGetPropertiesResource (obligatoire)

CassandraKeyspaceResourceOrCassandraKeyspaceGetPropertiesResource

Nom Descriptif Valeur
pièce d'identité Nom de l’espace de clés Cassandra Cosmos DB chaîne (obligatoire)

CreateUpdateOptionsOrCassandraKeyspaceGetPropertiesOptions

Nom Descriptif Valeur
autoscaleParamètres Spécifie les paramètres de mise à l’échelle automatique. Remarque : Le débit ou la mise à l’échelle automatiqueSettings est requis, mais pas les deux. de mise à l’échelle automatique
débit Unités de requête par seconde. Par exemple, « débit » : 1 0000. Int

Identité de Service Gérée (ManagedServiceIdentity)

Nom Descriptif 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. « Aucun »
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
Identités attribuées par l'utilisateur 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 Descriptif Valeur

ManagedServiceIdentityUserAssignedIdentities

Nom Descriptif Valeur

Exemples d’utilisation

Modèles de démarrage rapide Microsoft Azure

Les modèles de démarrage rapide Azure suivants déployer ce type de ressource.

Modèle Descriptif
Créer un compte Azure Cosmos DB pour l' de l’API Cassandra

Déployer sur Azure
Ce modèle crée un compte Azure Cosmos DB pour l’API Cassandra dans deux régions avec un espace de clés et une table avec un débit dédié.
Créer un compte Azure Cosmos DB de mise à l’échelle automatique pour les de l’API Cassandra

Déployer sur Azure
Ce modèle crée un compte Azure Cosmos DB pour l’API Cassandra dans deux régions avec un espace de clés et une table avec un débit de mise à l’échelle automatique.

Définition de ressource Terraform (fournisseur AzAPI)

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

  • 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/cassandraKeyspaces, ajoutez terraform suivante à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2025-11-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        id = "string"
      }
    }
  }
}

Valeurs de propriété

Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces

Nom Descriptif Valeur
identité Identité de la ressource. ManagedServiceIdentity
emplacement Emplacement du groupe de ressources auquel appartient la ressource. corde
nom Nom de la ressource chaîne (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : databaseAccounts
Propriétés Propriétés permettant de créer et de mettre à jour l’espace de clés Cassandra Azure Cosmos DB. CassandraKeyspaceCreateUpdatePropertiesOrCassandraKeyspaceGetProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2025-11-01-preview »

ARMResourcePropriétéTags

Nom Descriptif Valeur

Mise à l’échelle automatique

Nom Descriptif Valeur
maxThroughput Représente le débit maximal, la ressource peut effectuer un scale-up. Int

CassandraKeyspaceCreateUpdatePropertiesOrCassandraKeyspaceGetProperties

Nom Descriptif Valeur
Options Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête. CreateUpdateOptionsOrCassandraKeyspaceGetPropertiesOptions
ressource Format JSON standard d’un espace de clés Cassandra CassandraKeyspaceResourceOrCassandraKeyspaceGetPropertiesResource (obligatoire)

CassandraKeyspaceResourceOrCassandraKeyspaceGetPropertiesResource

Nom Descriptif Valeur
pièce d'identité Nom de l’espace de clés Cassandra Cosmos DB chaîne (obligatoire)

CreateUpdateOptionsOrCassandraKeyspaceGetPropertiesOptions

Nom Descriptif Valeur
autoscaleParamètres Spécifie les paramètres de mise à l’échelle automatique. Remarque : Le débit ou la mise à l’échelle automatiqueSettings est requis, mais pas les deux. de mise à l’échelle automatique
débit Unités de requête par seconde. Par exemple, « débit » : 1 0000. Int

Identité de Service Gérée (ManagedServiceIdentity)

Nom Descriptif 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. « Aucun »
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
Identités attribuées par l'utilisateur 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 Descriptif Valeur

ManagedServiceIdentityUserAssignedIdentities

Nom Descriptif Valeur

Exemples d’utilisation

Échantillons Terraform

Exemple de base de déploiement de Cassandra KeySpace au sein d’un compte Cosmos DB.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "databaseAccount" {
  type      = "Microsoft.DocumentDB/databaseAccounts@2021-10-15"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "GlobalDocumentDB"
    properties = {
      capabilities = [
        {
          name = "EnableCassandra"
        },
      ]
      consistencyPolicy = {
        defaultConsistencyLevel = "Strong"
        maxIntervalInSeconds    = 5
        maxStalenessPrefix      = 100
      }
      databaseAccountOfferType           = "Standard"
      defaultIdentity                    = "FirstPartyIdentity"
      disableKeyBasedMetadataWriteAccess = false
      disableLocalAuth                   = false
      enableAnalyticalStorage            = false
      enableAutomaticFailover            = false
      enableFreeTier                     = false
      enableMultipleWriteLocations       = false
      ipRules = [
      ]
      isVirtualNetworkFilterEnabled = false
      locations = [
        {
          failoverPriority = 0
          isZoneRedundant  = false
          locationName     = "West Europe"
        },
      ]
      networkAclBypass = "None"
      networkAclBypassResourceIds = [
      ]
      publicNetworkAccess = "Enabled"
      virtualNetworkRules = [
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "cassandraKeyspace" {
  type      = "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-10-15"
  parent_id = azapi_resource.databaseAccount.id
  name      = var.resource_name
  body = {
    properties = {
      options = {
      }
      resource = {
        id = var.resource_name
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}