Partager via


Serveurs/bases de données Microsoft.Sql

Définition de ressource Bicep

Le type de ressource serveurs/bases de données 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.Sql/servers/databases, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.Sql/servers/databases@2024-05-01-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    autoPauseDelay: int
    availabilityZone: 'string'
    catalogCollation: 'string'
    collation: 'string'
    createMode: 'string'
    elasticPoolId: 'string'
    encryptionProtector: 'string'
    encryptionProtectorAutoRotation: bool
    federatedClientId: 'string'
    freeLimitExhaustionBehavior: 'string'
    highAvailabilityReplicaCount: int
    isLedgerOn: bool
    keys: {
      {customized property}: {}
    }
    licenseType: 'string'
    longTermRetentionBackupResourceId: 'string'
    maintenanceConfigurationId: 'string'
    manualCutover: bool
    maxSizeBytes: int
    minCapacity: int
    performCutover: bool
    preferredEnclaveType: 'string'
    readScale: 'string'
    recoverableDatabaseId: 'string'
    recoveryServicesRecoveryPointId: 'string'
    requestedBackupStorageRedundancy: 'string'
    restorableDroppedDatabaseId: 'string'
    restorePointInTime: 'string'
    sampleName: 'string'
    secondaryType: 'string'
    sourceDatabaseDeletionDate: 'string'
    sourceDatabaseId: 'string'
    sourceResourceId: 'string'
    useFreeLimit: bool
    zoneRedundant: bool
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

DatabaseIdentity

Nom Description Valeur
type Type d’identité 'None'
'UserAssigned'
userAssignedIdentities ID de ressource des identités affectées par l’utilisateur à utiliser DatabaseIdentityUserAssignedIdentities

DatabaseIdentityUserAssignedIdentities

Nom Description Valeur

DatabaseKey

Nom Description Valeur

DatabaseProperties

Nom Description Valeur
autoPauseDelay Durée en minutes après laquelle la base de données est automatiquement suspendue. Une valeur de -1 signifie que la pause automatique est désactivée Int
availabilityZone Spécifie la zone de disponibilité à laquelle la base de données est épinglée. '1'
'2'
'3'
'NoPreference'
catalogCollation Classement du catalogue de métadonnées. 'DATABASE_DEFAULT'
'SQL_Latin1_General_CP1_CI_AS'
Classement Classement de la base de données. corde
createMode Spécifie le mode de création de base de données.

Valeur par défaut : création régulière de la base de données.

Copie : crée une base de données en tant que copie d’une base de données existante. sourceDatabaseId doit être spécifié comme ID de ressource de la base de données source.

Secondaire : crée une base de données en tant que réplica secondaire d’une base de données existante. sourceDatabaseId doit être spécifié comme ID de ressource de la base de données primaire existante.

PointInTimeRestore : crée une base de données en restaurant une sauvegarde à un point dans le temps d’une base de données existante. sourceDatabaseId doit être spécifié comme ID de ressource de la base de données existante, et restorePointInTime doit être spécifié.

Récupération : crée une base de données en restaurant une sauvegarde géorépliquée. sourceDatabaseId doit être spécifié comme ID de ressource de base de données récupérable à restaurer.

Restauration : crée une base de données en restaurant une sauvegarde d’une base de données supprimée. sourceDatabaseId doit être spécifié. Si sourceDatabaseId est l’ID de ressource d’origine de la base de données, sourceDatabaseDeletionDate doit être spécifié. Sinon, sourceDatabaseId doit être l’ID de ressource de base de données supprimé pouvant être restauré et sourceDatabaseDeletionDate est ignoré. restorePointInTime peut également être spécifié pour effectuer une restauration à partir d’un point antérieur dans le temps.

RestoreLongTermRetentionBackup : crée une base de données en effectuant une restauration à partir d’un coffre de rétention à long terme. recoveryServicesRecoveryPointResourceId doit être spécifié comme ID de ressource de point de récupération.

Copy, Secondary et RestoreLongTermRetentionBackup ne sont pas pris en charge pour l’édition DataWarehouse.
'Copy'
'Default'
'OnlineSecondary'
'PointInTimeRestore'
'Recovery'
'Restore'
'RestoreExternalBackup'
'RestoreExternalBackupSecondary'
'RestoreLongTermRetentionBackup'
'Secondaire'
elasticPoolId Identificateur de ressource du pool élastique contenant cette base de données. corde
encryptionProtector URI du coffre de clés Azure de la base de données s’il est configuré avec les clés gérées par le client de base de données. corde
encryptionProtectorAutoRotation Indicateur permettant d’activer ou de désactiver la rotation automatique de la clé AKV du protecteur de chiffrement de base de données. Bool
federatedClientId ID client utilisé pour le scénario CMK entre locataires par base de données corde

Contraintes:
Longueur minimale = 36
Longueur maximale = 36
Modèle = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
freeLimitExhaustionBehavior Spécifie le comportement lorsque les limites gratuites mensuelles sont épuisées pour la base de données gratuite.

AutoPause : la base de données sera automatiquement suspendue lors de l’épuisement des limites gratuites pour le reste du mois.

BillForUsage : La base de données continuera d’être en ligne en cas d’épuisement des limites gratuites et toute dépassement sera facturée.
'AutoPause'
'BillOverUsage'
highAvailabilityReplicaCount Nombre de réplicas secondaires associés à la base de données Critique pour l’entreprise, Premium ou Hyperscale qui sont utilisés pour fournir une haute disponibilité. Non applicable à une base de données Hyperscale au sein d’un pool élastique. Int
isLedgerOn Indique si cette base de données est une base de données de registre, ce qui signifie que toutes les tables de la base de données sont des tables de registre. Remarque : la valeur de cette propriété ne peut pas être modifiée une fois la base de données créée. Bool
Clés ID de ressource des identités affectées par l’utilisateur à utiliser DatabasePropertiesKeys
licenseType Type de licence à appliquer pour cette base de données. LicenseIncluded si vous avez besoin d’une licence, ou BasePrice si vous disposez d’une licence et que vous êtes éligible à Azure Hybrid Benefit. 'BasePrice'
'LicenseIncluded'
longTermRetentionBackupResourceId Identificateur de ressource de la sauvegarde de rétention à long terme associée à l’opération de création de cette base de données. corde
maintenanceConfigurationId ID de configuration de maintenance affecté à la base de données. Cette configuration définit la période pendant laquelle les mises à jour de maintenance se produisent. corde
manualCutover Indique si le basculement manuel contrôlé par le client doit être effectué pendant l’opération de mise à jour de la base de données vers le niveau Hyperscale.

Cette propriété s’applique uniquement lors de la mise à l’échelle de la base de données du niveau Critique pour l’entreprise/Usage général/Premium/Standard vers le niveau Hyperscale.

Lorsque manualCutover est spécifié, l’opération de mise à l’échelle attend que l’entrée utilisateur déclenche le basculement vers la base de données Hyperscale.

Pour déclencher le basculement, indiquez le paramètre « performCutover » lorsque l’opération de mise à l’échelle est en état d’attente.
Bool
maxSizeBytes Taille maximale de la base de données exprimée en octets. Int
minCapacity Capacité minimale que la base de données aura toujours allouée, si elle n’est pas suspendue Int
performCutover Pour déclencher le basculement manuel contrôlé par le client pendant l’état d’attente pendant que l’opération de mise à l’échelle est en cours.

Ce paramètre de propriété s’applique uniquement aux opérations de mise à l’échelle lancées avec le paramètre « manualCutover ».

Cette propriété s’applique uniquement lorsque la mise à l’échelle de la base de données du niveau Critique pour l’entreprise/Usage général/Premium/Standard vers le niveau Hyperscale est déjà en cours.

Lorsque performCutover est spécifié, l’opération de mise à l’échelle déclenche le basculement et effectue une modification de rôle vers la base de données Hyperscale.
Bool
preferredEnclaveType Type d’enclave demandé sur la base de données, c’est-à-dire les enclaves par défaut ou VBS. 'Default'
'VBS'
readScale État du routage en lecture seule. Si cette option est activée, les connexions dont l’intention d’application est définie de manière readonly dans leur chaîne de connexion peuvent être routées vers un réplica secondaire en lecture seule dans la même région. Non applicable à une base de données Hyperscale au sein d’un pool élastique. 'Désactivé'
'Activé'
recoverableDatabaseId Identificateur de ressource de la base de données récupérable associée à l’opération de création de cette base de données. corde
recoveryServicesRecoveryPointId Identificateur de ressource du point de récupération associé à l’opération de création de cette base de données. corde
requestedBackupStorageRedundancy Type de compte de stockage à utiliser pour stocker des sauvegardes pour cette base de données. 'Geo'
'GeoZone'
'Local'
'Zone'
restorableDroppedDatabaseId Identificateur de ressource de la base de données supprimée pouvant être restaurée associée à l’opération de création de cette base de données. corde
restorePointInTime Spécifie le point dans le temps (format ISO8601) de la base de données source qui sera restauré pour créer la nouvelle base de données. corde
sampleName Nom de l’exemple de schéma à appliquer lors de la création de cette base de données. 'AdventureWorksLT'
'WideWorldImportersFull'
'WideWorldImportersStd'
secondaryType Type secondaire de la base de données s’il s’agit d’une base de données secondaire. Les valeurs valides sont geo, nommées et de secours. 'Geo'
'Nommé'
'Veille'
sourceDatabaseDeletionDate Spécifie l’heure à laquelle la base de données a été supprimée. corde
sourceDatabaseId Identificateur de ressource de la base de données source associée à l’opération de création de cette base de données. corde
sourceResourceId Identificateur de ressource de la source associée à l’opération de création de cette base de données.

Cette propriété est uniquement prise en charge pour l’édition DataWarehouse et permet la restauration entre les abonnements.

Lorsque sourceResourceId est spécifié, sourceDatabaseId, recoverableDatabaseId, restoreableDroppedDatabaseId et sourceDatabaseDeletionDate ne doivent pas être spécifiés et CreateMode doit être PointInTimeRestore, Restore ou Recover.

Lorsque createMode est PointInTimeRestore, sourceResourceId doit être l’ID de ressource de la base de données existante ou du pool sql existant, et restorePointInTime doit être spécifié.

Lorsque createMode est Restore, sourceResourceId doit être l’ID de ressource de la base de données supprimée pouvant être restaurée ou du pool sql supprimé pouvant être restauré.

Lorsque createMode est Recover, sourceResourceId doit être l’ID de ressource d’une base de données récupérable ou d’un pool sql récupérable.

Lorsque l’abonnement source appartient à un locataire différent de l’abonnement cible, l’en-tête « x-ms-authorization-auxiliaire » doit contenir un jeton d’authentification pour le locataire source. Pour plus d’informations sur l’en-tête « x-ms-authorization-auxiliaire », consultez /azure/azure-resource-manager/management/authenticate-multi-tenant
corde
useFreeLimit Indique si la base de données utilise des limites mensuelles gratuites ou non. Autorisé sur une base de données dans un abonnement. Bool
zoneRedundant Indique si cette base de données est redondante interzone, ce qui signifie que les réplicas de cette base de données seront répartis entre plusieurs zones de disponibilité. Bool

DatabasePropertiesKeys

Nom Description Valeur

DatabaseUserIdentity

Nom Description Valeur

Microsoft.Sql/servers/databases

Nom Description Valeur
identité Identité Azure Active Directory de la base de données. databaseIdentity
emplacement Emplacement des ressources. chaîne (obligatoire)
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 : serveurs
Propriétés Propriétés de ressource. DatabaseProperties
Sku Référence SKU de base de données.

La liste des références SKU peut varier selon la région et l’offre de support. Pour déterminer les références SKU (y compris le nom de la référence SKU, le niveau/édition, la famille et la capacité) disponibles pour votre abonnement dans une région Azure, utilisez l’API REST Capabilities_ListByLocation ou l’une des commandes suivantes :

azurecli<br />az sql db list-editions -l &lt;location&gt; -o table<br />````<br /><br />powershell
Get-AzSqlServerServiceObjective -Location <emplacement>
````
référence SKU
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

Sku

Nom Description Valeur
capacité Capacité de la référence SKU particulière. Int
Famille Si le service a différentes générations de matériel, pour la même référence SKU, vous pouvez le capturer ici. corde
nom Nom de la référence SKU, généralement une lettre + code numérique, par exemple P3. chaîne (obligatoire)
taille Taille de la référence SKU particulière corde
niveau Niveau ou édition de la référence SKU particulière, par exemple De base, Premium. corde

TrackedResourceTags

Nom Description Valeur

Exemples de démarrage rapide

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

Fichier Bicep Description
Azure SQL Server avec l’audit écrit dans log Analytics Ce modèle vous permet de déployer un serveur SQL Azure avec l’audit activé pour écrire des journaux d’audit dans Log Analytics (espace de travail OMS)
créer un sql Server et de base de données Ce modèle vous permet de créer SQL Database et Server.
pool SQL dédié avec transparent encryption Crée un serveur SQL Server et un pool SQL dédié (anciennement SQL DW) avec Transparent Data Encryption.
Déployer sports Analytics sur l’architecture Azure Crée un compte de stockage Azure avec ADLS Gen2 activé, une instance Azure Data Factory avec des services liés pour le compte de stockage (une base de données Azure SQL si déployée) et une instance Azure Databricks. L’identité AAD pour l’utilisateur qui déploie le modèle et l’identité managée pour l’instance ADF reçoivent le rôle Contributeur aux données blob de stockage sur le compte de stockage. Il existe également des options pour déployer une instance Azure Key Vault, une base de données Azure SQL et un Hub d’événements Azure (pour les cas d’utilisation de streaming). Lorsqu’un coffre de clés Azure est déployé, l’identité managée de la fabrique de données et l’identité AAD pour l’utilisateur qui déploie le modèle reçoivent le rôle Utilisateur des secrets Key Vault.
exemple de point de terminaison privé Ce modèle montre comment créer un point de terminaison privé pointant vers Azure SQL Server
provisionner une application web avec un SQL Database Ce modèle provisionne une application web, une base de données SQL, des paramètres de mise à l’échelle automatique, des règles d’alerte et App Insights. Il configure une chaîne de connexion dans l’application web pour la base de données.
Sonarqube Docker Web App sur Linux avec Azure SQL Ce modèle déploie Sonarqube dans un conteneur Linux d’application web Azure App Service à l’aide de l’image Sonarqube officielle et soutenue par un serveur Azure SQL Server.
Web App avec Managed Identity, SQL Server et ΑΙ Exemple simple pour déployer l’infrastructure Azure pour l’application + données + identité managée + surveillance

Définition de ressource de modèle ARM

Le type de ressource serveurs/bases de données 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.Sql/servers/databases, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.Sql/servers/databases",
  "apiVersion": "2024-05-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "autoPauseDelay": "int",
    "availabilityZone": "string",
    "catalogCollation": "string",
    "collation": "string",
    "createMode": "string",
    "elasticPoolId": "string",
    "encryptionProtector": "string",
    "encryptionProtectorAutoRotation": "bool",
    "federatedClientId": "string",
    "freeLimitExhaustionBehavior": "string",
    "highAvailabilityReplicaCount": "int",
    "isLedgerOn": "bool",
    "keys": {
      "{customized property}": {
      }
    },
    "licenseType": "string",
    "longTermRetentionBackupResourceId": "string",
    "maintenanceConfigurationId": "string",
    "manualCutover": "bool",
    "maxSizeBytes": "int",
    "minCapacity": "int",
    "performCutover": "bool",
    "preferredEnclaveType": "string",
    "readScale": "string",
    "recoverableDatabaseId": "string",
    "recoveryServicesRecoveryPointId": "string",
    "requestedBackupStorageRedundancy": "string",
    "restorableDroppedDatabaseId": "string",
    "restorePointInTime": "string",
    "sampleName": "string",
    "secondaryType": "string",
    "sourceDatabaseDeletionDate": "string",
    "sourceDatabaseId": "string",
    "sourceResourceId": "string",
    "useFreeLimit": "bool",
    "zoneRedundant": "bool"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

DatabaseIdentity

Nom Description Valeur
type Type d’identité 'None'
'UserAssigned'
userAssignedIdentities ID de ressource des identités affectées par l’utilisateur à utiliser DatabaseIdentityUserAssignedIdentities

DatabaseIdentityUserAssignedIdentities

Nom Description Valeur

DatabaseKey

Nom Description Valeur

DatabaseProperties

Nom Description Valeur
autoPauseDelay Durée en minutes après laquelle la base de données est automatiquement suspendue. Une valeur de -1 signifie que la pause automatique est désactivée Int
availabilityZone Spécifie la zone de disponibilité à laquelle la base de données est épinglée. '1'
'2'
'3'
'NoPreference'
catalogCollation Classement du catalogue de métadonnées. 'DATABASE_DEFAULT'
'SQL_Latin1_General_CP1_CI_AS'
Classement Classement de la base de données. corde
createMode Spécifie le mode de création de base de données.

Valeur par défaut : création régulière de la base de données.

Copie : crée une base de données en tant que copie d’une base de données existante. sourceDatabaseId doit être spécifié comme ID de ressource de la base de données source.

Secondaire : crée une base de données en tant que réplica secondaire d’une base de données existante. sourceDatabaseId doit être spécifié comme ID de ressource de la base de données primaire existante.

PointInTimeRestore : crée une base de données en restaurant une sauvegarde à un point dans le temps d’une base de données existante. sourceDatabaseId doit être spécifié comme ID de ressource de la base de données existante, et restorePointInTime doit être spécifié.

Récupération : crée une base de données en restaurant une sauvegarde géorépliquée. sourceDatabaseId doit être spécifié comme ID de ressource de base de données récupérable à restaurer.

Restauration : crée une base de données en restaurant une sauvegarde d’une base de données supprimée. sourceDatabaseId doit être spécifié. Si sourceDatabaseId est l’ID de ressource d’origine de la base de données, sourceDatabaseDeletionDate doit être spécifié. Sinon, sourceDatabaseId doit être l’ID de ressource de base de données supprimé pouvant être restauré et sourceDatabaseDeletionDate est ignoré. restorePointInTime peut également être spécifié pour effectuer une restauration à partir d’un point antérieur dans le temps.

RestoreLongTermRetentionBackup : crée une base de données en effectuant une restauration à partir d’un coffre de rétention à long terme. recoveryServicesRecoveryPointResourceId doit être spécifié comme ID de ressource de point de récupération.

Copy, Secondary et RestoreLongTermRetentionBackup ne sont pas pris en charge pour l’édition DataWarehouse.
'Copy'
'Default'
'OnlineSecondary'
'PointInTimeRestore'
'Recovery'
'Restore'
'RestoreExternalBackup'
'RestoreExternalBackupSecondary'
'RestoreLongTermRetentionBackup'
'Secondaire'
elasticPoolId Identificateur de ressource du pool élastique contenant cette base de données. corde
encryptionProtector URI du coffre de clés Azure de la base de données s’il est configuré avec les clés gérées par le client de base de données. corde
encryptionProtectorAutoRotation Indicateur permettant d’activer ou de désactiver la rotation automatique de la clé AKV du protecteur de chiffrement de base de données. Bool
federatedClientId ID client utilisé pour le scénario CMK entre locataires par base de données corde

Contraintes:
Longueur minimale = 36
Longueur maximale = 36
Modèle = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
freeLimitExhaustionBehavior Spécifie le comportement lorsque les limites gratuites mensuelles sont épuisées pour la base de données gratuite.

AutoPause : la base de données sera automatiquement suspendue lors de l’épuisement des limites gratuites pour le reste du mois.

BillForUsage : La base de données continuera d’être en ligne en cas d’épuisement des limites gratuites et toute dépassement sera facturée.
'AutoPause'
'BillOverUsage'
highAvailabilityReplicaCount Nombre de réplicas secondaires associés à la base de données Critique pour l’entreprise, Premium ou Hyperscale qui sont utilisés pour fournir une haute disponibilité. Non applicable à une base de données Hyperscale au sein d’un pool élastique. Int
isLedgerOn Indique si cette base de données est une base de données de registre, ce qui signifie que toutes les tables de la base de données sont des tables de registre. Remarque : la valeur de cette propriété ne peut pas être modifiée une fois la base de données créée. Bool
Clés ID de ressource des identités affectées par l’utilisateur à utiliser DatabasePropertiesKeys
licenseType Type de licence à appliquer pour cette base de données. LicenseIncluded si vous avez besoin d’une licence, ou BasePrice si vous disposez d’une licence et que vous êtes éligible à Azure Hybrid Benefit. 'BasePrice'
'LicenseIncluded'
longTermRetentionBackupResourceId Identificateur de ressource de la sauvegarde de rétention à long terme associée à l’opération de création de cette base de données. corde
maintenanceConfigurationId ID de configuration de maintenance affecté à la base de données. Cette configuration définit la période pendant laquelle les mises à jour de maintenance se produisent. corde
manualCutover Indique si le basculement manuel contrôlé par le client doit être effectué pendant l’opération de mise à jour de la base de données vers le niveau Hyperscale.

Cette propriété s’applique uniquement lors de la mise à l’échelle de la base de données du niveau Critique pour l’entreprise/Usage général/Premium/Standard vers le niveau Hyperscale.

Lorsque manualCutover est spécifié, l’opération de mise à l’échelle attend que l’entrée utilisateur déclenche le basculement vers la base de données Hyperscale.

Pour déclencher le basculement, indiquez le paramètre « performCutover » lorsque l’opération de mise à l’échelle est en état d’attente.
Bool
maxSizeBytes Taille maximale de la base de données exprimée en octets. Int
minCapacity Capacité minimale que la base de données aura toujours allouée, si elle n’est pas suspendue Int
performCutover Pour déclencher le basculement manuel contrôlé par le client pendant l’état d’attente pendant que l’opération de mise à l’échelle est en cours.

Ce paramètre de propriété s’applique uniquement aux opérations de mise à l’échelle lancées avec le paramètre « manualCutover ».

Cette propriété s’applique uniquement lorsque la mise à l’échelle de la base de données du niveau Critique pour l’entreprise/Usage général/Premium/Standard vers le niveau Hyperscale est déjà en cours.

Lorsque performCutover est spécifié, l’opération de mise à l’échelle déclenche le basculement et effectue une modification de rôle vers la base de données Hyperscale.
Bool
preferredEnclaveType Type d’enclave demandé sur la base de données, c’est-à-dire les enclaves par défaut ou VBS. 'Default'
'VBS'
readScale État du routage en lecture seule. Si cette option est activée, les connexions dont l’intention d’application est définie de manière readonly dans leur chaîne de connexion peuvent être routées vers un réplica secondaire en lecture seule dans la même région. Non applicable à une base de données Hyperscale au sein d’un pool élastique. 'Désactivé'
'Activé'
recoverableDatabaseId Identificateur de ressource de la base de données récupérable associée à l’opération de création de cette base de données. corde
recoveryServicesRecoveryPointId Identificateur de ressource du point de récupération associé à l’opération de création de cette base de données. corde
requestedBackupStorageRedundancy Type de compte de stockage à utiliser pour stocker des sauvegardes pour cette base de données. 'Geo'
'GeoZone'
'Local'
'Zone'
restorableDroppedDatabaseId Identificateur de ressource de la base de données supprimée pouvant être restaurée associée à l’opération de création de cette base de données. corde
restorePointInTime Spécifie le point dans le temps (format ISO8601) de la base de données source qui sera restauré pour créer la nouvelle base de données. corde
sampleName Nom de l’exemple de schéma à appliquer lors de la création de cette base de données. 'AdventureWorksLT'
'WideWorldImportersFull'
'WideWorldImportersStd'
secondaryType Type secondaire de la base de données s’il s’agit d’une base de données secondaire. Les valeurs valides sont geo, nommées et de secours. 'Geo'
'Nommé'
'Veille'
sourceDatabaseDeletionDate Spécifie l’heure à laquelle la base de données a été supprimée. corde
sourceDatabaseId Identificateur de ressource de la base de données source associée à l’opération de création de cette base de données. corde
sourceResourceId Identificateur de ressource de la source associée à l’opération de création de cette base de données.

Cette propriété est uniquement prise en charge pour l’édition DataWarehouse et permet la restauration entre les abonnements.

Lorsque sourceResourceId est spécifié, sourceDatabaseId, recoverableDatabaseId, restoreableDroppedDatabaseId et sourceDatabaseDeletionDate ne doivent pas être spécifiés et CreateMode doit être PointInTimeRestore, Restore ou Recover.

Lorsque createMode est PointInTimeRestore, sourceResourceId doit être l’ID de ressource de la base de données existante ou du pool sql existant, et restorePointInTime doit être spécifié.

Lorsque createMode est Restore, sourceResourceId doit être l’ID de ressource de la base de données supprimée pouvant être restaurée ou du pool sql supprimé pouvant être restauré.

Lorsque createMode est Recover, sourceResourceId doit être l’ID de ressource d’une base de données récupérable ou d’un pool sql récupérable.

Lorsque l’abonnement source appartient à un locataire différent de l’abonnement cible, l’en-tête « x-ms-authorization-auxiliaire » doit contenir un jeton d’authentification pour le locataire source. Pour plus d’informations sur l’en-tête « x-ms-authorization-auxiliaire », consultez /azure/azure-resource-manager/management/authenticate-multi-tenant
corde
useFreeLimit Indique si la base de données utilise des limites mensuelles gratuites ou non. Autorisé sur une base de données dans un abonnement. Bool
zoneRedundant Indique si cette base de données est redondante interzone, ce qui signifie que les réplicas de cette base de données seront répartis entre plusieurs zones de disponibilité. Bool

DatabasePropertiesKeys

Nom Description Valeur

DatabaseUserIdentity

Nom Description Valeur

Microsoft.Sql/servers/databases

Nom Description Valeur
apiVersion Version de l’API '2024-05-01-preview'
identité Identité Azure Active Directory de la base de données. databaseIdentity
emplacement Emplacement des ressources. chaîne (obligatoire)
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés de ressource. DatabaseProperties
Sku Référence SKU de base de données.

La liste des références SKU peut varier selon la région et l’offre de support. Pour déterminer les références SKU (y compris le nom de la référence SKU, le niveau/édition, la famille et la capacité) disponibles pour votre abonnement dans une région Azure, utilisez l’API REST Capabilities_ListByLocation ou l’une des commandes suivantes :

azurecli<br />az sql db list-editions -l &lt;location&gt; -o table<br />````<br /><br />powershell
Get-AzSqlServerServiceObjective -Location <emplacement>
````
référence SKU
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.Sql/servers/databases'

Sku

Nom Description Valeur
capacité Capacité de la référence SKU particulière. Int
Famille Si le service a différentes générations de matériel, pour la même référence SKU, vous pouvez le capturer ici. corde
nom Nom de la référence SKU, généralement une lettre + code numérique, par exemple P3. chaîne (obligatoire)
taille Taille de la référence SKU particulière corde
niveau Niveau ou édition de la référence SKU particulière, par exemple De base, Premium. corde

TrackedResourceTags

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
Azure SQL Server avec l’audit écrit dans log Analytics

Déployer sur Azure
Ce modèle vous permet de déployer un serveur SQL Azure avec l’audit activé pour écrire des journaux d’audit dans Log Analytics (espace de travail OMS)
créer un sql Server et de base de données

Déployer sur Azure
Ce modèle vous permet de créer SQL Database et Server.
pool SQL dédié avec transparent encryption

Déployer sur Azure
Crée un serveur SQL Server et un pool SQL dédié (anciennement SQL DW) avec Transparent Data Encryption.
Déployer un nouveau pool élastique SQL

Déployer sur Azure
Ce modèle vous permet de déployer un nouveau pool élastique SQL avec son nouveau serveur SQL Server associé et les nouvelles bases de données SQL à lui attribuer.
Déployer sports Analytics sur l’architecture Azure

Déployer sur Azure
Crée un compte de stockage Azure avec ADLS Gen2 activé, une instance Azure Data Factory avec des services liés pour le compte de stockage (une base de données Azure SQL si déployée) et une instance Azure Databricks. L’identité AAD pour l’utilisateur qui déploie le modèle et l’identité managée pour l’instance ADF reçoivent le rôle Contributeur aux données blob de stockage sur le compte de stockage. Il existe également des options pour déployer une instance Azure Key Vault, une base de données Azure SQL et un Hub d’événements Azure (pour les cas d’utilisation de streaming). Lorsqu’un coffre de clés Azure est déployé, l’identité managée de la fabrique de données et l’identité AAD pour l’utilisateur qui déploie le modèle reçoivent le rôle Utilisateur des secrets Key Vault.
HDInsight avec une base de données Ambari + Hive Metastore personnalisée dans le réseau virtuel

Déployer sur Azure
Ce modèle vous permet de créer un cluster HDInsight dans un réseau virtuel existant avec une nouvelle base de données SQL qui sert à la fois de base de données Ambari personnalisée et de metastore Hive. Vous devez disposer d’un serveur SQL, d’un compte de stockage et d’un réseau virtuel existants.
exemple de point de terminaison privé

Déployer sur Azure
Ce modèle montre comment créer un point de terminaison privé pointant vers Azure SQL Server
provisionner une application web avec un SQL Database

Déployer sur Azure
Ce modèle provisionne une application web, une base de données SQL, des paramètres de mise à l’échelle automatique, des règles d’alerte et App Insights. Il configure une chaîne de connexion dans l’application web pour la base de données.
Services Bureau à distance avec haute disponibilité

Déployer sur Azure
Cet exemple de code de modèle ARM déploie un collection de sessions des services Bureau à distance 2019 labo avec une haute disponibilité. L’objectif est de déployer une solution entièrement redondante et hautement disponible pour les services Bureau à distance à l’aide de Windows Server 2019.
Sonarqube Docker Web App sur Linux avec Azure SQL

Déployer sur Azure
Ce modèle déploie Sonarqube dans un conteneur Linux d’application web Azure App Service à l’aide de l’image Sonarqube officielle et soutenue par un serveur Azure SQL Server.
Web App avec Managed Identity, SQL Server et ΑΙ

Déployer sur Azure
Exemple simple pour déployer l’infrastructure Azure pour l’application + données + identité managée + surveillance
WebApp consommant un point de terminaison privé Azure SQL

Déployer sur Azure
Ce modèle montre comment créer une application web qui consomme un point de terminaison privé pointant vers Azure SQL Server

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource serveurs/bases de données 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.Sql/servers/databases, ajoutez terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/databases@2024-05-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  sku = {
    capacity = int
    family = "string"
    name = "string"
    size = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      autoPauseDelay = int
      availabilityZone = "string"
      catalogCollation = "string"
      collation = "string"
      createMode = "string"
      elasticPoolId = "string"
      encryptionProtector = "string"
      encryptionProtectorAutoRotation = bool
      federatedClientId = "string"
      freeLimitExhaustionBehavior = "string"
      highAvailabilityReplicaCount = int
      isLedgerOn = bool
      keys = {
        {customized property} = {
        }
      }
      licenseType = "string"
      longTermRetentionBackupResourceId = "string"
      maintenanceConfigurationId = "string"
      manualCutover = bool
      maxSizeBytes = int
      minCapacity = int
      performCutover = bool
      preferredEnclaveType = "string"
      readScale = "string"
      recoverableDatabaseId = "string"
      recoveryServicesRecoveryPointId = "string"
      requestedBackupStorageRedundancy = "string"
      restorableDroppedDatabaseId = "string"
      restorePointInTime = "string"
      sampleName = "string"
      secondaryType = "string"
      sourceDatabaseDeletionDate = "string"
      sourceDatabaseId = "string"
      sourceResourceId = "string"
      useFreeLimit = bool
      zoneRedundant = bool
    }
  })
}

Valeurs de propriété

DatabaseIdentity

Nom Description Valeur
type Type d’identité 'None'
'UserAssigned'
userAssignedIdentities ID de ressource des identités affectées par l’utilisateur à utiliser DatabaseIdentityUserAssignedIdentities

DatabaseIdentityUserAssignedIdentities

Nom Description Valeur

DatabaseKey

Nom Description Valeur

DatabaseProperties

Nom Description Valeur
autoPauseDelay Durée en minutes après laquelle la base de données est automatiquement suspendue. Une valeur de -1 signifie que la pause automatique est désactivée Int
availabilityZone Spécifie la zone de disponibilité à laquelle la base de données est épinglée. '1'
'2'
'3'
'NoPreference'
catalogCollation Classement du catalogue de métadonnées. 'DATABASE_DEFAULT'
'SQL_Latin1_General_CP1_CI_AS'
Classement Classement de la base de données. corde
createMode Spécifie le mode de création de base de données.

Valeur par défaut : création régulière de la base de données.

Copie : crée une base de données en tant que copie d’une base de données existante. sourceDatabaseId doit être spécifié comme ID de ressource de la base de données source.

Secondaire : crée une base de données en tant que réplica secondaire d’une base de données existante. sourceDatabaseId doit être spécifié comme ID de ressource de la base de données primaire existante.

PointInTimeRestore : crée une base de données en restaurant une sauvegarde à un point dans le temps d’une base de données existante. sourceDatabaseId doit être spécifié comme ID de ressource de la base de données existante, et restorePointInTime doit être spécifié.

Récupération : crée une base de données en restaurant une sauvegarde géorépliquée. sourceDatabaseId doit être spécifié comme ID de ressource de base de données récupérable à restaurer.

Restauration : crée une base de données en restaurant une sauvegarde d’une base de données supprimée. sourceDatabaseId doit être spécifié. Si sourceDatabaseId est l’ID de ressource d’origine de la base de données, sourceDatabaseDeletionDate doit être spécifié. Sinon, sourceDatabaseId doit être l’ID de ressource de base de données supprimé pouvant être restauré et sourceDatabaseDeletionDate est ignoré. restorePointInTime peut également être spécifié pour effectuer une restauration à partir d’un point antérieur dans le temps.

RestoreLongTermRetentionBackup : crée une base de données en effectuant une restauration à partir d’un coffre de rétention à long terme. recoveryServicesRecoveryPointResourceId doit être spécifié comme ID de ressource de point de récupération.

Copy, Secondary et RestoreLongTermRetentionBackup ne sont pas pris en charge pour l’édition DataWarehouse.
'Copy'
'Default'
'OnlineSecondary'
'PointInTimeRestore'
'Recovery'
'Restore'
'RestoreExternalBackup'
'RestoreExternalBackupSecondary'
'RestoreLongTermRetentionBackup'
'Secondaire'
elasticPoolId Identificateur de ressource du pool élastique contenant cette base de données. corde
encryptionProtector URI du coffre de clés Azure de la base de données s’il est configuré avec les clés gérées par le client de base de données. corde
encryptionProtectorAutoRotation Indicateur permettant d’activer ou de désactiver la rotation automatique de la clé AKV du protecteur de chiffrement de base de données. Bool
federatedClientId ID client utilisé pour le scénario CMK entre locataires par base de données corde

Contraintes:
Longueur minimale = 36
Longueur maximale = 36
Modèle = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
freeLimitExhaustionBehavior Spécifie le comportement lorsque les limites gratuites mensuelles sont épuisées pour la base de données gratuite.

AutoPause : la base de données sera automatiquement suspendue lors de l’épuisement des limites gratuites pour le reste du mois.

BillForUsage : La base de données continuera d’être en ligne en cas d’épuisement des limites gratuites et toute dépassement sera facturée.
'AutoPause'
'BillOverUsage'
highAvailabilityReplicaCount Nombre de réplicas secondaires associés à la base de données Critique pour l’entreprise, Premium ou Hyperscale qui sont utilisés pour fournir une haute disponibilité. Non applicable à une base de données Hyperscale au sein d’un pool élastique. Int
isLedgerOn Indique si cette base de données est une base de données de registre, ce qui signifie que toutes les tables de la base de données sont des tables de registre. Remarque : la valeur de cette propriété ne peut pas être modifiée une fois la base de données créée. Bool
Clés ID de ressource des identités affectées par l’utilisateur à utiliser DatabasePropertiesKeys
licenseType Type de licence à appliquer pour cette base de données. LicenseIncluded si vous avez besoin d’une licence, ou BasePrice si vous disposez d’une licence et que vous êtes éligible à Azure Hybrid Benefit. 'BasePrice'
'LicenseIncluded'
longTermRetentionBackupResourceId Identificateur de ressource de la sauvegarde de rétention à long terme associée à l’opération de création de cette base de données. corde
maintenanceConfigurationId ID de configuration de maintenance affecté à la base de données. Cette configuration définit la période pendant laquelle les mises à jour de maintenance se produisent. corde
manualCutover Indique si le basculement manuel contrôlé par le client doit être effectué pendant l’opération de mise à jour de la base de données vers le niveau Hyperscale.

Cette propriété s’applique uniquement lors de la mise à l’échelle de la base de données du niveau Critique pour l’entreprise/Usage général/Premium/Standard vers le niveau Hyperscale.

Lorsque manualCutover est spécifié, l’opération de mise à l’échelle attend que l’entrée utilisateur déclenche le basculement vers la base de données Hyperscale.

Pour déclencher le basculement, indiquez le paramètre « performCutover » lorsque l’opération de mise à l’échelle est en état d’attente.
Bool
maxSizeBytes Taille maximale de la base de données exprimée en octets. Int
minCapacity Capacité minimale que la base de données aura toujours allouée, si elle n’est pas suspendue Int
performCutover Pour déclencher le basculement manuel contrôlé par le client pendant l’état d’attente pendant que l’opération de mise à l’échelle est en cours.

Ce paramètre de propriété s’applique uniquement aux opérations de mise à l’échelle lancées avec le paramètre « manualCutover ».

Cette propriété s’applique uniquement lorsque la mise à l’échelle de la base de données du niveau Critique pour l’entreprise/Usage général/Premium/Standard vers le niveau Hyperscale est déjà en cours.

Lorsque performCutover est spécifié, l’opération de mise à l’échelle déclenche le basculement et effectue une modification de rôle vers la base de données Hyperscale.
Bool
preferredEnclaveType Type d’enclave demandé sur la base de données, c’est-à-dire les enclaves par défaut ou VBS. 'Default'
'VBS'
readScale État du routage en lecture seule. Si cette option est activée, les connexions dont l’intention d’application est définie de manière readonly dans leur chaîne de connexion peuvent être routées vers un réplica secondaire en lecture seule dans la même région. Non applicable à une base de données Hyperscale au sein d’un pool élastique. 'Désactivé'
'Activé'
recoverableDatabaseId Identificateur de ressource de la base de données récupérable associée à l’opération de création de cette base de données. corde
recoveryServicesRecoveryPointId Identificateur de ressource du point de récupération associé à l’opération de création de cette base de données. corde
requestedBackupStorageRedundancy Type de compte de stockage à utiliser pour stocker des sauvegardes pour cette base de données. 'Geo'
'GeoZone'
'Local'
'Zone'
restorableDroppedDatabaseId Identificateur de ressource de la base de données supprimée pouvant être restaurée associée à l’opération de création de cette base de données. corde
restorePointInTime Spécifie le point dans le temps (format ISO8601) de la base de données source qui sera restauré pour créer la nouvelle base de données. corde
sampleName Nom de l’exemple de schéma à appliquer lors de la création de cette base de données. 'AdventureWorksLT'
'WideWorldImportersFull'
'WideWorldImportersStd'
secondaryType Type secondaire de la base de données s’il s’agit d’une base de données secondaire. Les valeurs valides sont geo, nommées et de secours. 'Geo'
'Nommé'
'Veille'
sourceDatabaseDeletionDate Spécifie l’heure à laquelle la base de données a été supprimée. corde
sourceDatabaseId Identificateur de ressource de la base de données source associée à l’opération de création de cette base de données. corde
sourceResourceId Identificateur de ressource de la source associée à l’opération de création de cette base de données.

Cette propriété est uniquement prise en charge pour l’édition DataWarehouse et permet la restauration entre les abonnements.

Lorsque sourceResourceId est spécifié, sourceDatabaseId, recoverableDatabaseId, restoreableDroppedDatabaseId et sourceDatabaseDeletionDate ne doivent pas être spécifiés et CreateMode doit être PointInTimeRestore, Restore ou Recover.

Lorsque createMode est PointInTimeRestore, sourceResourceId doit être l’ID de ressource de la base de données existante ou du pool sql existant, et restorePointInTime doit être spécifié.

Lorsque createMode est Restore, sourceResourceId doit être l’ID de ressource de la base de données supprimée pouvant être restaurée ou du pool sql supprimé pouvant être restauré.

Lorsque createMode est Recover, sourceResourceId doit être l’ID de ressource d’une base de données récupérable ou d’un pool sql récupérable.

Lorsque l’abonnement source appartient à un locataire différent de l’abonnement cible, l’en-tête « x-ms-authorization-auxiliaire » doit contenir un jeton d’authentification pour le locataire source. Pour plus d’informations sur l’en-tête « x-ms-authorization-auxiliaire », consultez /azure/azure-resource-manager/management/authenticate-multi-tenant
corde
useFreeLimit Indique si la base de données utilise des limites mensuelles gratuites ou non. Autorisé sur une base de données dans un abonnement. Bool
zoneRedundant Indique si cette base de données est redondante interzone, ce qui signifie que les réplicas de cette base de données seront répartis entre plusieurs zones de disponibilité. Bool

DatabasePropertiesKeys

Nom Description Valeur

DatabaseUserIdentity

Nom Description Valeur

Microsoft.Sql/servers/databases

Nom Description Valeur
identité Identité Azure Active Directory de la base de données. databaseIdentity
emplacement Emplacement des ressources. chaîne (obligatoire)
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 : serveurs
Propriétés Propriétés de ressource. DatabaseProperties
Sku Référence SKU de base de données.

La liste des références SKU peut varier selon la région et l’offre de support. Pour déterminer les références SKU (y compris le nom de la référence SKU, le niveau/édition, la famille et la capacité) disponibles pour votre abonnement dans une région Azure, utilisez l’API REST Capabilities_ListByLocation ou l’une des commandes suivantes :

azurecli<br />az sql db list-editions -l &lt;location&gt; -o table<br />````<br /><br />powershell
Get-AzSqlServerServiceObjective -Location <emplacement>
````
référence SKU
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.Sql/servers/databases@2024-05-01-preview »

Sku

Nom Description Valeur
capacité Capacité de la référence SKU particulière. Int
Famille Si le service a différentes générations de matériel, pour la même référence SKU, vous pouvez le capturer ici. corde
nom Nom de la référence SKU, généralement une lettre + code numérique, par exemple P3. chaîne (obligatoire)
taille Taille de la référence SKU particulière corde
niveau Niveau ou édition de la référence SKU particulière, par exemple De base, Premium. corde

TrackedResourceTags

Nom Description Valeur