Bicep-Ressourcendefinition
Der Ressourcentyp "databaseAccounts/sqlDatabases" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Um eine Microsoft.DocumentDB/databaseAccounts/sqlDatabases-Ressource zu erstellen, fügen Sie der Vorlage die folgende Bicep hinzu.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2023-11-15-preview' = {
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
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'
}
}
Eigenschaftswerte
Microsoft.DocumentDB/databaseAccounts/sqlDatabases
Einstellungen für die automatische Skalierung
| Name |
Beschreibung |
Wert |
| max. Durchsatz |
Stellt den maximalen Durchsatz dar, auf den die Ressource skaliert werden kann. |
Int |
Komponenten1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
| Name |
Beschreibung |
Wert |
| autoscaleEinstellungen |
Gibt die Einstellungen für die Autoskalen an. Hinweis: Entweder Durchsatz oder AutoscaleSettings ist erforderlich, aber nicht beides. |
AutoscaleSettings- |
| Durchsatz |
Anforderungseinheiten pro Sekunde. Beispiel: "Durchsatz": 10000. |
Int |
Verwaltete Dienstidentität
| Name |
Beschreibung |
Wert |
| Art |
Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Gruppe von vom Benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. |
"Keine" 'SystemZugewiesen' "SystemAssigned,UserAssigned" "UserAssigned" |
| vom Benutzer zugewiesene Identitäten |
Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". |
ManagedServiceIdentityUserAssignedIdentities- |
ManagedServiceIdentityUserAssignedIdentities
ResourceRestoreParameters
| Name |
Beschreibung |
Wert |
| restoreSource |
Die ID des wiederherstellbaren Datenbankkontos, von dem die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
Schnur |
| restoreTimestampInUtc |
Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format). |
Schnur |
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties
SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource
| Name |
Beschreibung |
Wert |
| createMode |
Aufzählung, um den Modus der Ressourcenerstellung anzugeben. |
'Standard' 'PointInTimeRestore' "Wiederherstellen" |
| id |
Name der Cosmos DB SQL-Datenbank |
Zeichenfolge (erforderlich) |
| restore-Parameter |
Parameter, die die Informationen zur Wiederherstellung angeben sollen |
ResourceRestoreParameters- |
Verwendungsbeispiele
Azure-Schnellstartbeispiele
Die folgenden Azure-Schnellstartvorlagen Bicep-Beispiele für die Bereitstellung dieses Ressourcentyps enthalten.
ARM-Vorlagenressourcendefinition
Der Ressourcentyp "databaseAccounts/sqlDatabases" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Um eine Microsoft.DocumentDB/databaseAccounts/sqlDatabases-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases",
"apiVersion": "2023-11-15-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"options": {
"autoscaleSettings": {
"maxThroughput": "int"
},
"throughput": "int"
},
"resource": {
"createMode": "string",
"id": "string",
"restoreParameters": {
"restoreSource": "string",
"restoreTimestampInUtc": "string"
}
}
},
"tags": {
"{customized property}": "string"
}
}
Eigenschaftswerte
Microsoft.DocumentDB/databaseAccounts/sqlDatabases
| Name |
Beschreibung |
Wert |
| apiVersion (Englisch) |
Die API-Version |
"2023-11-15-preview" |
| Identität |
Identität für die Ressource. |
ManagedServiceIdentity- |
| Ort |
Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. |
Schnur |
| Name |
Der Ressourcenname |
Zeichenfolge (erforderlich) |
| Eigenschaften |
Eigenschaften zum Erstellen und Aktualisieren der SQL-Datenbank von Azure Cosmos DB. |
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (erforderlich) |
| Schilder |
Ressourcentags |
Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
| Art |
Der Ressourcentyp |
'Microsoft.DocumentDB/databaseAccounts/sqlDatabases' |
Einstellungen für die automatische Skalierung
| Name |
Beschreibung |
Wert |
| max. Durchsatz |
Stellt den maximalen Durchsatz dar, auf den die Ressource skaliert werden kann. |
Int |
Komponenten1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
| Name |
Beschreibung |
Wert |
| autoscaleEinstellungen |
Gibt die Einstellungen für die Autoskalen an. Hinweis: Entweder Durchsatz oder AutoscaleSettings ist erforderlich, aber nicht beides. |
AutoscaleSettings- |
| Durchsatz |
Anforderungseinheiten pro Sekunde. Beispiel: "Durchsatz": 10000. |
Int |
Verwaltete Dienstidentität
| Name |
Beschreibung |
Wert |
| Art |
Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Gruppe von vom Benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. |
"Keine" 'SystemZugewiesen' "SystemAssigned,UserAssigned" "UserAssigned" |
| vom Benutzer zugewiesene Identitäten |
Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". |
ManagedServiceIdentityUserAssignedIdentities- |
ManagedServiceIdentityUserAssignedIdentities
ResourceRestoreParameters
| Name |
Beschreibung |
Wert |
| restoreSource |
Die ID des wiederherstellbaren Datenbankkontos, von dem die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
Schnur |
| restoreTimestampInUtc |
Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format). |
Schnur |
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties
SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource
| Name |
Beschreibung |
Wert |
| createMode |
Aufzählung, um den Modus der Ressourcenerstellung anzugeben. |
'Standard' 'PointInTimeRestore' "Wiederherstellen" |
| id |
Name der Cosmos DB SQL-Datenbank |
Zeichenfolge (erforderlich) |
| restore-Parameter |
Parameter, die die Informationen zur Wiederherstellung angeben sollen |
ResourceRestoreParameters- |
Verwendungsbeispiele
Azure-Schnellstartvorlagen
Die folgenden Azure-Schnellstartvorlagen diesen Ressourcentyp bereitstellen.
Der Ressourcentyp "databaseAccounts/sqlDatabases" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Um eine Microsoft.DocumentDB/databaseAccounts/sqlDatabases-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2023-11-15-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 = {
createMode = "string"
id = "string"
restoreParameters = {
restoreSource = "string"
restoreTimestampInUtc = "string"
}
}
}
}
}
Eigenschaftswerte
Microsoft.DocumentDB/databaseAccounts/sqlDatabases
| Name |
Beschreibung |
Wert |
| Identität |
Identität für die Ressource. |
ManagedServiceIdentity- |
| Ort |
Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. |
Schnur |
| Name |
Der Ressourcenname |
Zeichenfolge (erforderlich) |
| Eltern-ID |
Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. |
ID für Ressource des Typs: databaseAccounts |
| Eigenschaften |
Eigenschaften zum Erstellen und Aktualisieren der SQL-Datenbank von Azure Cosmos DB. |
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (erforderlich) |
| Schilder |
Ressourcentags |
Wörterbuch der Tagnamen und -werte. |
| Art |
Der Ressourcentyp |
"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2023-11-15-preview" |
Einstellungen für die automatische Skalierung
| Name |
Beschreibung |
Wert |
| max. Durchsatz |
Stellt den maximalen Durchsatz dar, auf den die Ressource skaliert werden kann. |
Int |
Komponenten1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
| Name |
Beschreibung |
Wert |
| autoscaleEinstellungen |
Gibt die Einstellungen für die Autoskalen an. Hinweis: Entweder Durchsatz oder AutoscaleSettings ist erforderlich, aber nicht beides. |
AutoscaleSettings- |
| Durchsatz |
Anforderungseinheiten pro Sekunde. Beispiel: "Durchsatz": 10000. |
Int |
Verwaltete Dienstidentität
| Name |
Beschreibung |
Wert |
| Art |
Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Gruppe von vom Benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. |
"Keine" 'SystemZugewiesen' "SystemAssigned,UserAssigned" "UserAssigned" |
| vom Benutzer zugewiesene Identitäten |
Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". |
ManagedServiceIdentityUserAssignedIdentities- |
ManagedServiceIdentityUserAssignedIdentities
ResourceRestoreParameters
| Name |
Beschreibung |
Wert |
| restoreSource |
Die ID des wiederherstellbaren Datenbankkontos, von dem die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
Schnur |
| restoreTimestampInUtc |
Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format). |
Schnur |
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties
SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource
| Name |
Beschreibung |
Wert |
| createMode |
Aufzählung, um den Modus der Ressourcenerstellung anzugeben. |
'Standard' 'PointInTimeRestore' "Wiederherstellen" |
| id |
Name der Cosmos DB SQL-Datenbank |
Zeichenfolge (erforderlich) |
| restore-Parameter |
Parameter, die die Informationen zur Wiederherstellung angeben sollen |
ResourceRestoreParameters- |
Verwendungsbeispiele
Ein grundlegendes Beispiel für die Bereitstellung von SQL-Datenbank in einem Cosmos DB-Konto.
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 = [
]
consistencyPolicy = {
defaultConsistencyLevel = "BoundedStaleness"
maxIntervalInSeconds = 10
maxStalenessPrefix = 200
}
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" "sqlDatabase" {
type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-10-15"
parent_id = azapi_resource.databaseAccount.id
name = var.resource_name
body = {
properties = {
options = {
throughput = 400
}
resource = {
id = var.resource_name
}
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}