Microsoft.DocumentDB/databaseAccounts/sqlDatabases 2024-05-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 - Voir commandes de déploiement de groupe de ressources

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

Format des ressources

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

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

Valeurs de propriétés

databaseAccounts/sqlDatabases

Nom	Description	Valeur
name	Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep.	string (obligatoire)
location	Emplacement du groupe de ressources auquel appartient la ressource.	string
tags	Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent servir à l’affichage et au regroupement des ressources (parmi tous les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit disposer d’une clé de 128 caractères maximum et d’une valeur de 256 caractères maximum. Par exemple, l’expérience par défaut pour un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ».	Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
parent	Dans Bicep, vous pouvez spécifier la ressource parente pour 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
properties	Propriétés permettant de créer et de mettre à jour une base de données SQL Azure Cosmos DB.	SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro... (obligatoire)

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro...

Nom	Description	Valeur
options	Paire clé-valeur d’options à appliquer pour la demande. Cela correspond aux en-têtes envoyés avec la demande.	CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
resource	Format JSON standard d’une base de données SQL	SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc... (obligatoire)

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Nom	Description	Valeur
autoscaleSettings	Spécifie les paramètres de mise à l’échelle automatique. Remarque : débit ou autoscaleSettings est requis, mais pas les deux.	AutoscaleSettings
throughput	Unités de requête par seconde. Par exemple, « débit » : 10000.	int

AutoscaleSettings

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

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc...

Nom	Description	Valeur
createMode	Énumérez pour indiquer le mode de création des ressources.	'Par défaut' 'Restaurer'
id	Nom de la base de données SQL Cosmos DB	chaîne (obligatoire)
restoreParameters	Paramètres pour indiquer les informations sur la restauration	ResourceRestoreParameters

ResourceRestoreParameters

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

Modèles de démarrage rapide

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

Modèle	Description
Créez 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 et un conteneur partagés.
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.
API SQL de compte Azure Cosmos DB avec 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 un magasin analytique.
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 de l’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.
Déployer Azure Data Explorer DB avec une connexion Cosmos DB	Déployez Azure Data Explorer DB avec une connexion Cosmos DB.

Définition de ressources de modèle ARM

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

Groupes de ressources - Voir 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 des ressources

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

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

Valeurs de propriétés

databaseAccounts/sqlDatabases

Nom	Description	Valeur
type	Type de ressource	« Microsoft.DocumentDB/databaseAccounts/sqlDatabases »
apiVersion	Version de l’API de ressource	'2024-05-15'
name	Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON.	chaîne (obligatoire)
location	Emplacement du groupe de ressources auquel appartient la ressource.	string
tags	Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent servir à l’affichage et au regroupement des ressources (parmi tous les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit disposer d’une clé de 128 caractères maximum et d’une valeur de 256 caractères maximum. Par exemple, l’expérience par défaut pour un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ».	Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
properties	Propriétés permettant de créer et de mettre à jour une base de données SQL Azure Cosmos DB.	SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro... (obligatoire)

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro...

Nom	Description	Valeur
options	Paire clé-valeur d’options à appliquer pour la demande. Cela correspond aux en-têtes envoyés avec la demande.	CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
resource	Format JSON standard d’une base de données SQL	SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc... (obligatoire)

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 sont requis, mais pas les deux.	AutoscaleSettings
throughput	Unités de requête par seconde. Par exemple, « débit » : 10000.	int

Paramètres de mise à l’échelle automatique

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

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc...

Nom	Description	Valeur
createMode	Énumérez pour indiquer le mode de création des ressources.	'Par défaut' 'Restaurer'
id	Nom de la base de données SQL Cosmos DB	chaîne (obligatoire)
restoreParameters	Paramètres pour indiquer les informations sur la restauration	ResourceRestoreParameters

ResourceRestoreParameters

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

Modèles de démarrage rapide

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

Modèle	Description
Créez 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 et un conteneur partagés.
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.
API SQL de compte Azure Cosmos DB avec 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 un magasin analytique.
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 de l’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.
Déployer Azure Data Explorer DB avec une connexion Cosmos DB	Déployez Azure Data Explorer DB avec une 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 des ressources

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

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

Valeurs de propriétés

databaseAccounts/sqlDatabases

Nom	Description	Valeur
type	Type de ressource	« Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-05-15 »
name	Nom de la ressource	chaîne (obligatoire)
location	Emplacement du groupe de ressources auquel appartient la ressource.	string
parent_id	ID de la ressource qui est le parent de cette ressource.	ID pour la ressource de type : databaseAccounts
tags	Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent servir à l’affichage et au regroupement des ressources (parmi tous les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit disposer d’une clé de 128 caractères maximum et d’une valeur de 256 caractères maximum. Par exemple, l’expérience par défaut pour un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ».	Dictionnaire de noms et de valeurs d’étiquettes.
properties	Propriétés permettant de créer et de mettre à jour une base de données SQL Azure Cosmos DB.	SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro... (obligatoire)

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro...

Nom	Description	Valeur
options	Paire clé-valeur d’options à appliquer pour la demande. Cela correspond aux en-têtes envoyés avec la demande.	CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
resource	Format JSON standard d’une base de données SQL	SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc... (obligatoire)

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Nom	Description	Valeur
autoscaleSettings	Spécifie les paramètres de mise à l’échelle automatique. Remarque : débit ou autoscaleSettings est requis, mais pas les deux.	AutoscaleSettings
throughput	Unités de requête par seconde. Par exemple, « débit » : 10000.	int

AutoscaleSettings

Nom	Description	Valeur
maxThroughput	Représente le débit maximal jusqu’à lequel la ressource peut effectuer un scale-up.	int

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc...

Nom	Description	Valeur
createMode	Énumérez pour indiquer le mode de création de ressource.	« Par défaut » « Restaurer »
id	Nom de la base de données SQL Cosmos DB	string (obligatoire)
restoreParameters	Paramètres pour indiquer les informations relatives à la restauration	ResourceRestoreParameters

ResourceRestoreParameters

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

Partager via

Base de données Microsoft.DocumentDBAccounts/sqlDatabases 2024-05-15

Définition de ressource Bicep

Format des ressources

Valeurs de propriétés

databaseAccounts/sqlDatabases

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro...

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

AutoscaleSettings

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc...

ResourceRestoreParameters

Modèles de démarrage rapide

Définition de ressources de modèle ARM

Format des ressources

Valeurs de propriétés

databaseAccounts/sqlDatabases

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro...

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Paramètres de mise à l’échelle automatique

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc...

ResourceRestoreParameters

Modèles de démarrage rapide

Définition de ressource Terraform (fournisseur AzAPI)

Format des ressources

Valeurs de propriétés

databaseAccounts/sqlDatabases

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro...

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

AutoscaleSettings

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc...

ResourceRestoreParameters

Commentaires

Ressources supplémentaires