Freigeben über


Microsoft.DocumentDB databaseAccounts/sqlDatabases

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.

Ressourcenformat

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-12-01-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'
        restoreWithTtlDisabled: bool
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Eigenschaftswerte

AutoscaleSettings

Name Beschreibung Wert
maxThroughput Stellt den maximalen Durchsatz dar, auf den die Ressource skaliert werden kann. Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Name Beschreibung Wert

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Name Beschreibung Wert
autoscaleSettings 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

ManagedServiceIdentity

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. 'None'
'SystemAssigned'
"SystemAssigned,UserAssigned"
"UserAssigned"
userAssignedIdentities 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

Name Beschreibung Wert

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)
Elternteil 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 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. Siehe Tags in Vorlagen

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
restoreWithTtlDisabled Gibt an, ob das wiederhergestellte Konto zeit-To-Live bei der erfolgreichen Wiederherstellung deaktiviert ist. Bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

Name Beschreibung Wert
Optionen Ein Schlüssel-Wert-Optionspaar, das für die Anforderung angewendet werden soll. Dies entspricht den Kopfzeilen, die mit der Anforderung gesendet werden. CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
Ressource Das standardmäßige JSON-Format einer SQL-Datenbank SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource- (erforderlich)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Name Beschreibung Wert
createMode Aufzählung, um den Modus der Ressourcenerstellung anzugeben. 'Standard'
"Wiederherstellen"
id Name der Cosmos DB SQL-Datenbank Zeichenfolge (erforderlich)
restoreParameters Parameter, die die Informationen zur Wiederherstellung angeben sollen ResourceRestoreParameters-

Schilder

Name Beschreibung Wert

Schnellstartbeispiele

Die folgenden Schnellstartbeispiele stellen diesen Ressourcentyp bereit.

Bicep-Datei Beschreibung
Azure Cosmos DB-Konto-SQL-API mit analytischem Speicher Diese Vorlage erstellt ein Azure Cosmos-Konto für die Core-API (SQL) mit einer Datenbank und einem Container, der mit dem analytischen Speicher konfiguriert ist.
Erstellen eines kostenlosen Azure Cosmos DB-Kontos Diese Vorlage erstellt ein freistufiges Azure Cosmos DB-Konto für die SQL-API mit einer Datenbank mit freigegebenem Durchsatz und Container.
Erstellen eines Azure Cosmos DB-Kontos für die SQL-API- Diese Vorlage erstellt ein Azure Cosmos-Konto für die Core-API (SQL) mit einer Datenbank und einem Container mit Durchsatz mit mehreren anderen Optionen.
Erstellen einer SQL-Konto-API für Azure Cosmos DB mit automatischer Skalierung Diese Vorlage erstellt ein Azure Cosmos-Konto für die Core-API (SQL) mit einer Datenbank und einem Container mit automatischem Durchsatz mit mehreren anderen Optionen.
Erstellen von gespeicherten Prozeduren der Azure Cosmos DB Core -API (SQL) Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die Core-API (SQL) und einen Container mit einer gespeicherten Prozedur, triggern und benutzerdefinierten Funktion.
Erstellt eine Dapr Microservices-App mit Container-Apps Erstellen Sie eine Dapr Microservices-App mit Container-Apps.
Erstellt eine Dapr pub-sub servicebus-App mit Container-Apps Erstellen Sie eine Dapr pub-sub servicebus-App mit Container-Apps.
Bereitstellen von Azure Data Explorer DB mit Cosmos DB-Verbindung Bereitstellen von Azure Data Explorer DB mit Cosmos DB-Verbindung.

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.

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-12-01-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",
        "restoreWithTtlDisabled": "bool"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Eigenschaftswerte

AutoscaleSettings

Name Beschreibung Wert
maxThroughput Stellt den maximalen Durchsatz dar, auf den die Ressource skaliert werden kann. Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Name Beschreibung Wert

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Name Beschreibung Wert
autoscaleSettings 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

ManagedServiceIdentity

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. 'None'
'SystemAssigned'
"SystemAssigned,UserAssigned"
"UserAssigned"
userAssignedIdentities 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

Name Beschreibung Wert

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

Name Beschreibung Wert
apiVersion Die API-Version "2024-12-01-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'

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
restoreWithTtlDisabled Gibt an, ob das wiederhergestellte Konto zeit-To-Live bei der erfolgreichen Wiederherstellung deaktiviert ist. Bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

Name Beschreibung Wert
Optionen Ein Schlüssel-Wert-Optionspaar, das für die Anforderung angewendet werden soll. Dies entspricht den Kopfzeilen, die mit der Anforderung gesendet werden. CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
Ressource Das standardmäßige JSON-Format einer SQL-Datenbank SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource- (erforderlich)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Name Beschreibung Wert
createMode Aufzählung, um den Modus der Ressourcenerstellung anzugeben. 'Standard'
"Wiederherstellen"
id Name der Cosmos DB SQL-Datenbank Zeichenfolge (erforderlich)
restoreParameters Parameter, die die Informationen zur Wiederherstellung angeben sollen ResourceRestoreParameters-

Schilder

Name Beschreibung Wert

Schnellstartvorlagen

Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.

Schablone Beschreibung
Azure Cosmos DB-Konto-SQL-API mit analytischem Speicher

Bereitstellen in Azure
Diese Vorlage erstellt ein Azure Cosmos-Konto für die Core-API (SQL) mit einer Datenbank und einem Container, der mit dem analytischen Speicher konfiguriert ist.
Erstellen eines kostenlosen Azure Cosmos DB-Kontos

Bereitstellen in Azure
Diese Vorlage erstellt ein freistufiges Azure Cosmos DB-Konto für die SQL-API mit einer Datenbank mit freigegebenem Durchsatz und Container.
Erstellen eines Azure Cosmos DB-Kontos für die SQL-API-

Bereitstellen in Azure
Diese Vorlage erstellt ein Azure Cosmos-Konto für die Core-API (SQL) mit einer Datenbank und einem Container mit Durchsatz mit mehreren anderen Optionen.
Erstellen einer SQL-Konto-API für Azure Cosmos DB mit automatischer Skalierung

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

Bereitstellen in Azure
Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die Core-API (SQL) und einen Container mit einer gespeicherten Prozedur, triggern und benutzerdefinierten Funktion.
Erstellt eine Dapr Microservices-App mit Container-Apps

Bereitstellen in Azure
Erstellen Sie eine Dapr Microservices-App mit Container-Apps.
Erstellt eine Dapr pub-sub servicebus-App mit Container-Apps

Bereitstellen in Azure
Erstellen Sie eine Dapr pub-sub servicebus-App mit Container-Apps.
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 unter Änderungsprotokoll.

Ressourcenformat

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@2024-12-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        createMode = "string"
        id = "string"
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
          restoreWithTtlDisabled = bool
        }
      }
    }
  })
}

Eigenschaftswerte

AutoscaleSettings

Name Beschreibung Wert
maxThroughput Stellt den maximalen Durchsatz dar, auf den die Ressource skaliert werden kann. Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Name Beschreibung Wert

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Name Beschreibung Wert
autoscaleSettings 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

ManagedServiceIdentity

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. 'None'
'SystemAssigned'
"SystemAssigned,UserAssigned"
"UserAssigned"
userAssignedIdentities 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

Name Beschreibung Wert

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)
parent_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@2024-12-01-preview"

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
restoreWithTtlDisabled Gibt an, ob das wiederhergestellte Konto zeit-To-Live bei der erfolgreichen Wiederherstellung deaktiviert ist. Bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

Name Beschreibung Wert
Optionen Ein Schlüssel-Wert-Optionspaar, das für die Anforderung angewendet werden soll. Dies entspricht den Kopfzeilen, die mit der Anforderung gesendet werden. CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
Ressource Das standardmäßige JSON-Format einer SQL-Datenbank SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource- (erforderlich)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Name Beschreibung Wert
createMode Aufzählung, um den Modus der Ressourcenerstellung anzugeben. 'Standard'
"Wiederherstellen"
id Name der Cosmos DB SQL-Datenbank Zeichenfolge (erforderlich)
restoreParameters Parameter, die die Informationen zur Wiederherstellung angeben sollen ResourceRestoreParameters-

Schilder

Name Beschreibung Wert