Microsoft.DocumentDB/databaseAccounts/sqlDatabases 2024-11-15 - Bicep, ARM template & Terraform AzAPI reference

Définition de ressource Bicep

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-11-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      createMode: 'string'
      id: 'string'
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
        restoreWithTtlDisabled: bool
      }
    }
  }
  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

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

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/sqlDatabases

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 base de données SQL Azure Cosmos DB.	SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (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
restoreWithTtlDisabled	Spécifie si le compte restauré aura le délai d'To-Live désactivé lors de la restauration réussie.	Bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

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.	CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
ressource	Format JSON standard d’une base de données SQL	SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (obligatoire)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Nom	Description	Valeur
createMode	Énumération pour indiquer le mode de création de ressources.	'Default' 'Restore'
id	Nom de la base de données SQL 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
API SQL du compte Azure Cosmos DB avec de magasin analytique	Ce modèle crée un compte Azure Cosmos pour l’API Core (SQL) avec une base de données et un conteneur configurés avec le magasin analytique.
Créer un compte Azure Cosmos DB de niveau gratuit	Ce modèle crée un compte Azure Cosmos DB de niveau gratuit pour l’API SQL avec une base de données avec un débit partagé et un conteneur.
Créer un compte Azure Cosmos DB pour l’API Core (SQL)	Ce modèle crée un compte Azure Cosmos pour l’API Core (SQL) avec une base de données et un conteneur avec un débit avec plusieurs autres options.
Créer une API SQL de compte Azure Cosmos DB avec mise à l’échelle automatique	Ce modèle crée un compte Azure Cosmos pour l’API Core (SQL) avec une base de données et un conteneur avec un débit de mise à l’échelle automatique avec plusieurs autres options.
Créer des procédures stockées d’API Azure Cosmos DB Core (SQL)	Ce modèle crée un compte Azure Cosmos DB pour l’API Core (SQL) et un conteneur avec une procédure stockée, un déclencheur et une fonction définie par l’utilisateur.
crée une application de microservices Dapr à l’aide de Container Apps	Créez une application de microservices Dapr à l’aide de Container Apps.
Crée une application Dapr pub-sub servicebus à l’aide de Container Apps	Créez une application Dapr pub-sub servicebus à l’aide de Container Apps.
Déployer Azure Data Explorer DB avec de connexion Cosmos DB	Déployez Azure Data Explorer DB avec la connexion Cosmos DB.

Définition de ressource de modèle ARM

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases",
  "apiVersion": "2024-11-15",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "createMode": "string",
      "id": "string",
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string",
        "restoreWithTtlDisabled": "bool"
      }
    }
  },
  "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

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

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/sqlDatabases

Nom	Description	Valeur
apiVersion	Version de l’API	'2024-11-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 base de données SQL Azure Cosmos DB.	SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (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/sqlDatabases'

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
restoreWithTtlDisabled	Spécifie si le compte restauré aura le délai d'To-Live désactivé lors de la restauration réussie.	Bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

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.	CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
ressource	Format JSON standard d’une base de données SQL	SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (obligatoire)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Nom	Description	Valeur
createMode	Énumération pour indiquer le mode de création de ressources.	'Default' 'Restore'
id	Nom de la base de données SQL 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
API SQL du compte Azure Cosmos DB avec de magasin analytique	Ce modèle crée un compte Azure Cosmos pour l’API Core (SQL) avec une base de données et un conteneur configurés avec le magasin analytique.
Créer un compte Azure Cosmos DB de niveau gratuit	Ce modèle crée un compte Azure Cosmos DB de niveau gratuit pour l’API SQL avec une base de données avec un débit partagé et un conteneur.
Créer un compte Azure Cosmos DB pour l’API Core (SQL)	Ce modèle crée un compte Azure Cosmos pour l’API Core (SQL) avec une base de données et un conteneur avec un débit avec plusieurs autres options.
Créer une API SQL de compte Azure Cosmos DB avec mise à l’échelle automatique	Ce modèle crée un compte Azure Cosmos pour l’API Core (SQL) avec une base de données et un conteneur avec un débit de mise à l’échelle automatique avec plusieurs autres options.
Créer des procédures stockées d’API Azure Cosmos DB Core (SQL)	Ce modèle crée un compte Azure Cosmos DB pour l’API Core (SQL) et un conteneur avec une procédure stockée, un déclencheur et une fonction définie par l’utilisateur.
crée une application de microservices Dapr à l’aide de Container Apps	Créez une application de microservices Dapr à l’aide de Container Apps.
Crée une application Dapr pub-sub servicebus à l’aide de Container Apps	Créez une application Dapr pub-sub servicebus à l’aide de Container Apps.
Déployer Azure Data Explorer DB avec de connexion Cosmos DB	Déployez Azure Data Explorer DB avec la connexion Cosmos DB.

Définition de ressource Terraform (fournisseur AzAPI)

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-11-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"
          restoreWithTtlDisabled = bool
        }
      }
    }
  })
}

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

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

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/sqlDatabases

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 base de données SQL Azure Cosmos DB.	SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (obligatoire)
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes.
type	Type de ressource	« Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-11-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
restoreWithTtlDisabled	Spécifie si le compte restauré aura le délai d'To-Live désactivé lors de la restauration réussie.	Bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

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.	CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
ressource	Format JSON standard d’une base de données SQL	SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (obligatoire)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

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

Étiquettes

Nom	Description	Valeur

Partager via

Microsoft.DocumentDB databaseAccounts/sqlDatabases 2024-11-15

Définition de ressource Bicep

Format de ressource

Valeurs de propriété

Mise à l’échelle automatique

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

ResourceRestoreParameters

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Étiquettes

Exemples de démarrage rapide

Définition de ressource de modèle ARM

Format de ressource

Valeurs de propriété

Mise à l’échelle automatique

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

ResourceRestoreParameters

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Étiquettes

Modèles de démarrage rapide

Définition de ressource Terraform (fournisseur AzAPI)

Format de ressource

Valeurs de propriété

Mise à l’échelle automatique

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

ResourceRestoreParameters

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Étiquettes

Commentaires

Ressources supplémentaires