Freigeben über


Microsoft.DocumentDB-DatenbankAccounts/sqlDatabases

Bicep-Ressourcendefinition

Der Ressourcentyp databaseAccounts/sqlDatabases kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/databaseAccounts/sqlDatabases-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.

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'
      }
    }
  }
}

Eigenschaftswerte

databaseAccounts/sqlDatabases

Name BESCHREIBUNG Wert
name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in Bicep festlegen.
Zeichenfolge (erforderlich)
location Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. Zeichenfolge
tags Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Die Standardumgebung für einen Vorlagentyp ist beispielsweise mit "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB". Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
parent In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird.

Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.
Symbolischer Name für ressource vom Typ: databaseAccounts
properties Eigenschaften zum Erstellen und Aktualisieren einer Azure Cosmos DB-SQL-Datenbank. SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro... (erforderlich)

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro...

Name BESCHREIBUNG Wert
Optionen Ein Schlüssel-Wert-Paar von Optionen, die für die Anforderung angewendet werden sollen. Dies entspricht den Headern, die mit der Anforderung gesendet wurden. CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
resource Das JSON-Standardformat einer SQL-Datenbank SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc... (erforderlich)

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Name BESCHREIBUNG Wert
autoscaleSettings Gibt die Einstellungen für die automatische Skalierung an. Hinweis: Entweder durchsatz oder autoscaleSettings ist erforderlich, aber nicht beides. AutoscaleSettings
throughput Anforderungseinheiten pro Sekunde. Beispiel: "Durchsatz": 10000. INT

AutoscaleSettings

Name BESCHREIBUNG Wert
maxThroughput Stellt den maximalen Durchsatz dar, auf den die Ressource hochskaliert werden kann. INT

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc...

Name BESCHREIBUNG Wert
createMode Enumeration, um den Modus der Ressourcenerstellung anzugeben. 'Standardwert'
"Wiederherstellen"
id Name der Cosmos DB SQL-Datenbank Zeichenfolge (erforderlich)
restoreParameters Parameter zum Angeben der Informationen zur Wiederherstellung ResourceRestoreParameters

ResourceRestoreParameters

Name BESCHREIBUNG Wert
restoreSource Die ID des wiederherstellbaren Datenbankkontos, von dem aus die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} Zeichenfolge
restoreTimestampInUtc Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format). Zeichenfolge

Schnellstartvorlagen

Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.

Vorlage BESCHREIBUNG
Erstellen eines Azure Cosmos DB-Kontos im Free-Tarif

Bereitstellen in Azure
Mit dieser Vorlage wird ein Azure Cosmos DB-Konto für die SQL-API mit einer Datenbank mit freigegebenem Durchsatz und Container erstellt.
Erstellen eines Azure Cosmos DB-Kontos für die SQL-API (Core)

Bereitstellen in Azure
Mit dieser Vorlage wird eine SQL-API (Azure Cosmos-Konto für Core) mit einer Datenbank und einem Container mit Durchsatz mit mehreren anderen Optionen erstellt.
SQL-API des Azure Cosmos DB-Kontos mit Analysespeicher

Bereitstellen in Azure
Mit dieser Vorlage wird eine SQL-API (Azure Cosmos-Konto für Core) mit einer Datenbank und einem Container erstellt, die mit dem Analysespeicher konfiguriert sind.
Erstellen einer SQL-API für ein Azure Cosmos DB-Konto mit automatischer Skalierung

Bereitstellen in Azure
Diese Vorlage erstellt eine SQL-API (Azure Cosmos-Konto für Core) mit einer Datenbank und einem Container mit automatischem Skalierungsdurchsatz mit mehreren anderen Optionen.
Erstellen gespeicherter Prozeduren der Azure Cosmos DB Core-API (SQL)

Bereitstellen in Azure
Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die SQL-API (Core) und einen Container mit einer gespeicherten Prozedur, einem Trigger und einer benutzerdefinierten Funktion.
Bereitstellen von Azure Data Explorer DB mit Cosmos DB-Verbindung

Bereitstellen in Azure
Bereitstellen von Azure Data Explorer DB mit Cosmos DB-Verbindung

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp databaseAccounts/sqlDatabases kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

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": "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"
      }
    }
  }
}

Eigenschaftswerte

databaseAccounts/sqlDatabases

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/sqlDatabases"
apiVersion Die Ressourcen-API-Version '2024-05-15'
name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen festlegen.
Zeichenfolge (erforderlich)
location Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. Zeichenfolge
tags Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Die Standardumgebung für einen Vorlagentyp ist beispielsweise mit "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB". Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
properties Eigenschaften zum Erstellen und Aktualisieren einer Azure Cosmos DB-SQL-Datenbank. SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro... (erforderlich)

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro...

Name BESCHREIBUNG Wert
Optionen Ein Schlüssel-Wert-Paar von Optionen, die für die Anforderung angewendet werden sollen. Dies entspricht den Headern, die mit der Anforderung gesendet wurden. CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
resource Das JSON-Standardformat einer SQL-Datenbank SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc... (erforderlich)

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Name BESCHREIBUNG Wert
autoscaleSettings Gibt die Einstellungen für die automatische Skalierung an. Hinweis: Es ist entweder "throughput" oder "autoscaleSettings" erforderlich, aber nicht beides. AutoscaleSettings
throughput Anforderungseinheiten pro Sekunde. Beispiel: "Durchsatz": 10000. INT

AutoscaleSettings

Name BESCHREIBUNG Wert
maxThroughput Stellt den maximalen Durchsatz dar, auf den die Ressource hochskaliert werden kann. INT

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc...

Name BESCHREIBUNG Wert
createMode Enumeration, um den Modus der Ressourcenerstellung anzugeben. 'Standardwert'
"Wiederherstellen"
id Name der Cosmos DB-SQL-Datenbank Zeichenfolge (erforderlich)
restoreParameters Parameter zum Angeben der Informationen zur Wiederherstellung ResourceRestoreParameters

ResourceRestoreParameters

Name BESCHREIBUNG Wert
restoreSource Die ID des wiederherstellbaren Datenbankkontos, von dem aus die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccounts/{restorableDatabaseAccountName} Zeichenfolge
restoreTimestampInUtc Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format). Zeichenfolge

Schnellstartvorlagen

In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.

Vorlage BESCHREIBUNG
Erstellen eines Azure Cosmos DB-Kontos im Free-Tarif

Bereitstellen in Azure
Mit dieser Vorlage wird ein Azure Cosmos DB-Konto im freien Tarif für die SQL-API mit einer Datenbank mit freigegebenem Durchsatz und Container erstellt.
Erstellen eines Azure Cosmos DB-Kontos für die Core-API (SQL)

Bereitstellen in Azure
Mit dieser Vorlage wird ein Azure Cosmos-Konto für die Core-API (SQL) mit einer Datenbank und einem Container mit Durchsatz mit mehreren anderen Optionen erstellt.
SQL-API für Azure Cosmos DB-Konten mit Analysespeicher

Bereitstellen in Azure
Mit dieser Vorlage wird ein Azure Cosmos-Konto für die CORE-API (SQL) mit einer Datenbank und einem Container erstellt, die mit einem Analysespeicher konfiguriert sind.
Erstellen einer SQL-API für ein Azure Cosmos DB-Konto mit Autoskalierung

Bereitstellen in Azure
Mit dieser Vorlage wird ein Azure Cosmos-Konto für die Core-API (SQL) mit einer Datenbank und einem Container mit automatisch skaliertem Durchsatz mit mehreren anderen Optionen erstellt.
Erstellen gespeicherter Prozeduren der Azure Cosmos DB Core-API (SQL)

Bereitstellen in Azure
Mit dieser Vorlage werden ein Azure Cosmos DB-Konto für die Core-API (SQL) und ein Container mit einer gespeicherten Prozedur, einem Trigger und einer benutzerdefinierten Funktion erstellt.
Bereitstellen von Azure Data Explorer DB mit Cosmos DB-Verbindung

Bereitstellen in Azure
Bereitstellen von Azure Data Explorer DB mit Cosmos DB-Verbindung

Terraform-Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp databaseAccounts/sqlDatabases kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/databaseAccounts/sqlDatabases-Ressource zu erstellen, fügen Sie Der Vorlage den folgenden Terraform hinzu.

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"
        }
      }
    }
  })
}

Eigenschaftswerte

databaseAccounts/sqlDatabases

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-05-15"
name Der Ressourcenname Zeichenfolge (erforderlich)
location Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. Zeichenfolge
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource vom Typ: databaseAccounts
tags Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Beispielsweise ist die Standardumgebung für einen Vorlagentyp auf "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB". Wörterbuch der Tagnamen und -werte.
properties Eigenschaften zum Erstellen und Aktualisieren einer Azure Cosmos DB-SQL-Datenbank. SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro... (erforderlich)

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro...

Name BESCHREIBUNG Wert
Optionen Ein Schlüssel-Wert-Paar von Optionen, die für die Anforderung angewendet werden sollen. Dies entspricht den Headern, die mit der Anforderung gesendet wurden. CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
resource Das JSON-Standardformat einer SQL-Datenbank SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc... (erforderlich)

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Name BESCHREIBUNG Wert
autoscaleSettings Gibt die Einstellungen für die automatische Skalierung an. Hinweis: Entweder durchsatz oder autoscaleSettings ist erforderlich, aber nicht beides. AutoscaleSettings
throughput Anforderungseinheiten pro Sekunde. Beispiel: "Durchsatz": 10000. INT

AutoscaleSettings

Name BESCHREIBUNG Wert
maxThroughput Stellt den maximalen Durchsatz dar, auf den die Ressource hochskaliert werden kann. INT

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc...

Name BESCHREIBUNG Wert
createMode Enumeration, um den Modus der Ressourcenerstellung anzugeben. "Standard"
"Wiederherstellen"
id Name der Cosmos DB SQL-Datenbank Zeichenfolge (erforderlich)
restoreParameters Parameter zum Angeben der Informationen zur Wiederherstellung ResourceRestoreParameters

ResourceRestoreParameters

Name BESCHREIBUNG Wert
restoreSource Die ID des wiederherstellbaren Datenbankkontos, von dem aus die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} Zeichenfolge
restoreTimestampInUtc Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format). Zeichenfolge