Partager via

Microsoft.DocumentDB databaseAccounts/tables 2024-05-15

  • Article

Définition de ressource Bicep

Le type de ressource databaseAccounts/tables 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/tables, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/tables@2024-05-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      createMode: 'string'
      id: 'string'
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

Mise à l’échelle automatique

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

CreateUpdateOptionsOrTableGetPropertiesOptions

Nom Description Valeur
autoscaleSettings 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

Microsoft.DocumentDB/databaseAccounts/tables

Nom Description Valeur
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 une table Azure Cosmos DB. TableCreateUpdatePropertiesOrTableGetProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

ResourceRestoreParameters

Nom Description Valeur
restoreSource ID du compte de base de données pouvant être restauré à partir duquel la restauration doit être lancée. Par exemple : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccounts}} corde
restoreTimestampInUtc Heure à laquelle le compte doit être restauré (format ISO-8601). corde

TableCreateUpdatePropertiesOrTableGetProperties

Nom Description Valeur
Options Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête. CreateUpdateOptionsOrTableGetPropertiesOptions
ressource Format JSON standard d’un tableau TableResourceOrTableGetPropertiesResource (obligatoire)

TableResourceOrTableGetPropertiesResource

Nom Description Valeur
createMode Énumération pour indiquer le mode de création de ressources. 'Default'
'Restore'
id Nom de la table Cosmos DB chaîne (obligatoire)
restoreParameters Paramètres pour indiquer les informations relatives à la restauration ResourceRestoreParameters

Étiquettes

Nom Description Valeur

Exemples de démarrage rapide

Les exemples de démarrage rapide suivants déploient ce type de ressource.

Fichier Bicep Description
Créer un compte Azure Cosmos pour l’API Table Ce modèle crée un compte Azure Cosmos DB pour l’API Table dans deux régions et une table unique avec un débit provisionné.
Créer un compte Azure Cosmos pour l’API Table avec mise à l’échelle automatique Ce modèle crée un compte Azure Cosmos DB pour l’API Table dans deux régions et une table unique avec un débit de mise à l’échelle automatique.

Définition de ressource de modèle ARM

Le type de ressource databaseAccounts/tables 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/tables, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/tables",
  "apiVersion": "2024-05-15",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "createMode": "string",
      "id": "string",
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

Mise à l’échelle automatique

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

CreateUpdateOptionsOrTableGetPropertiesOptions

Nom Description Valeur
autoscaleSettings 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

Microsoft.DocumentDB/databaseAccounts/tables

Nom Description Valeur
apiVersion Version de l’API '2024-05-15'
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 une table Azure Cosmos DB. TableCreateUpdatePropertiesOrTableGetProperties (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/tables'

ResourceRestoreParameters

Nom Description Valeur
restoreSource ID du compte de base de données pouvant être restauré à partir duquel la restauration doit être lancée. Par exemple : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccounts}} corde
restoreTimestampInUtc Heure à laquelle le compte doit être restauré (format ISO-8601). corde

TableCreateUpdatePropertiesOrTableGetProperties

Nom Description Valeur
Options Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête. CreateUpdateOptionsOrTableGetPropertiesOptions
ressource Format JSON standard d’un tableau TableResourceOrTableGetPropertiesResource (obligatoire)

TableResourceOrTableGetPropertiesResource

Nom Description Valeur
createMode Énumération pour indiquer le mode de création de ressources. 'Default'
'Restore'
id Nom de la table Cosmos DB chaîne (obligatoire)
restoreParameters Paramètres pour indiquer les informations relatives à la restauration ResourceRestoreParameters

Étiquettes

Nom Description Valeur

Modèles de démarrage rapide

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

Modèle Description
Créer un compte Azure Cosmos pour l’API Table

Déployer sur Azure 		Ce modèle crée un compte Azure Cosmos DB pour l’API Table dans deux régions et une table unique avec un débit provisionné.
Créer un compte Azure Cosmos pour l’API Table avec mise à l’échelle automatique

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

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource databaseAccounts/tables 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/tables, ajoutez le terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/tables@2024-05-15"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        createMode = "string"
        id = "string"
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
        }
      }
    }
  })
}

Valeurs de propriété

Mise à l’échelle automatique

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

CreateUpdateOptionsOrTableGetPropertiesOptions

Nom Description Valeur
autoscaleSettings 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

Microsoft.DocumentDB/databaseAccounts/tables

Nom Description Valeur
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 une table Azure Cosmos DB. TableCreateUpdatePropertiesOrTableGetProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.DocumentDB/databaseAccounts/tables@2024-05-15 »

ResourceRestoreParameters

Nom Description Valeur
restoreSource ID du compte de base de données pouvant être restauré à partir duquel la restauration doit être lancée. Par exemple : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccounts}} corde
restoreTimestampInUtc Heure à laquelle le compte doit être restauré (format ISO-8601). corde

TableCreateUpdatePropertiesOrTableGetProperties

Nom Description Valeur
Options Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête. CreateUpdateOptionsOrTableGetPropertiesOptions
ressource Format JSON standard d’un tableau TableResourceOrTableGetPropertiesResource (obligatoire)

TableResourceOrTableGetPropertiesResource

Nom Description Valeur
createMode Énumération pour indiquer le mode de création de ressources. 'Default'
'Restore'
id Nom de la table Cosmos DB chaîne (obligatoire)
restoreParameters Paramètres pour indiquer les informations relatives à la restauration ResourceRestoreParameters

Étiquettes

Nom Description Valeur