Microsoft.DocumentDB databaseAccounts/sqlDatabases 2023-11-15

  • Artikel

Bicep-resursdefinition

Resurstypen databaseAccounts/sqlDatabases kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/sqlDatabases-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2023-11-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'
      }
    }
  }
}

Egenskapsvärden

databaseAccounts/sqlDatabases

Name Beskrivning Värde
name Resursnamnet

Se hur du anger namn och typer för underordnade resurser i Bicep.		 sträng (krävs)
location Platsen för resursgruppen som resursen tillhör. sträng
tags Taggar är en lista över nyckel/värde-par som beskriver resursen. De här taggarna kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB". Ordlista med taggnamn och värden. Se Taggar i mallar
parent I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen.

Mer information finns i Underordnad resurs utanför överordnad resurs.		 Symboliskt namn för resurs av typen: databaseAccounts
properties Egenskaper för att skapa och uppdatera Azure Cosmos DB SQL-databas. SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro... (krävs)

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro...

Name Beskrivning Värde
alternativ Ett nyckel/värde-par med alternativ som ska tillämpas för begäran. Detta motsvarar de huvuden som skickas med begäran. CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
resource JSON-standardformatet för en SQL-databas SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc... (krävs)

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Name Beskrivning Värde
autoscaleSettings Anger inställningarna för autoskalning. Obs! Antingen dataflöde eller autoscaleSettings krävs, men inte båda. AutoscaleSettings
dataflöde Enheter för programbegäran per sekund. Till exempel "dataflöde": 10000. int

AutoscaleSettings

Name Beskrivning Värde
maxThroughput Representerar maximalt dataflöde, resursen kan skalas upp till. int

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc...

Name Beskrivning Värde
createMode Räkna upp för att ange läget för resursskapande. "Standard"
"Återställ"
id Namnet på Cosmos DB SQL-databasen sträng (krävs)
restoreParameters Parametrar som anger information om återställningen ResourceRestoreParameters

ResourceRestoreParameters

Name Beskrivning Värde
restoreSource ID:t för det återställningsbara databaskonto som återställningen måste initieras från. Exempel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} sträng
restoreTimestampInUtc Tid då kontot måste återställas (ISO-8601-format). sträng

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Description
Skapa ett Azure Cosmos DB-konto på kostnadsfri nivå

Distribuera till Azure		 Den här mallen skapar ett Azure Cosmos DB-konto på kostnadsfri nivå för SQL API med en databas med delat dataflöde och container.
Skapa ett Azure Cosmos DB-konto för Core -API (SQL)

Distribuera till Azure		 Den här mallen skapar ett Azure Cosmos-konto för Core -API (SQL) med en databas och container med dataflöde med flera andra alternativ.
SQL API för Azure Cosmos DB-konto med analysarkiv

Distribuera till Azure		 Den här mallen skapar ett Azure Cosmos-konto för Core -API (SQL) med en databas och container som konfigurerats med analysarkivet.
Skapa ett SQL-API för Azure Cosmos DB-konto med autoskalning

Distribuera till Azure		 Den här mallen skapar ett Azure Cosmos-konto för Core -API (SQL) med en databas och container med dataflöde för automatisk skalning med flera andra alternativ.
Skapa lagrade PROCEDUREr för Azure Cosmos DB Core (SQL)-API:et

Distribuera till Azure		 Den här mallen skapar ett Azure Cosmos DB-konto för Core -API (SQL) och en container med en lagrad procedur, utlösare och användardefinierad funktion.
Distribuera Azure Data Explorer DB med Cosmos DB-anslutning

Distribuera till Azure		 Distribuera Azure Data Explorer DB med Cosmos DB-anslutning.

Resursdefinition för ARM-mall

Resurstypen databaseAccounts/sqlDatabases kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/sqlDatabases-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases",
  "apiVersion": "2023-11-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"
      }
    }
  }
}

Egenskapsvärden

databaseAccounts/sqlDatabases

Name Beskrivning Värde
typ Resurstypen "Microsoft.DocumentDB/databaseAccounts/sqlDatabases"
apiVersion Resurs-API-versionen '2023-11-15'
name Resursnamnet

Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar.		 sträng (krävs)
location Platsen för den resursgrupp som resursen tillhör. sträng
tags Taggar är en lista över nyckel/värde-par som beskriver resursen. De här taggarna kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB". Ordlista med taggnamn och värden. Se Taggar i mallar
properties Egenskaper för att skapa och uppdatera Azure Cosmos DB SQL-databas. SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro... (krävs)

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro...

Name Beskrivning Värde
alternativ Ett nyckel/värde-par med alternativ som ska användas för begäran. Detta motsvarar rubrikerna som skickas med begäran. CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
resource JSON-standardformatet för en SQL-databas SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc... (krävs)

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Name Beskrivning Värde
autoscaleSettings Anger inställningarna för autoskalning. Obs! Antingen dataflöde eller autoscaleSettings krävs, men inte båda. AutoscaleSettings
dataflöde Enheter för programbegäran per sekund. Till exempel "dataflöde": 10000. int

AutoscaleSettings

Name Beskrivning Värde
maxThroughput Representerar maximalt dataflöde, resursen kan skalas upp till. int

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc...

Name Beskrivning Värde
createMode Uppräkning för att ange läget för resursskapande. "Standard"
"Återställ"
id Namnet på Cosmos DB SQL-databasen sträng (krävs)
restoreParameters Parametrar för att ange information om återställningen ResourceRestoreParameters

ResourceRestoreParameters

Name Beskrivning Värde
restoreSource ID:t för det återställningsbara databaskonto som återställningen måste initieras från. Exempel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} sträng
restoreTimestampInUtc Tid till vilken kontot måste återställas (ISO-8601-format). sträng

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Description
Skapa ett Azure Cosmos DB-konto på kostnadsfri nivå

Distribuera till Azure		 Den här mallen skapar ett Azure Cosmos DB-konto på kostnadsfri nivå för SQL API med en databas med delat dataflöde och en container.
Skapa ett Azure Cosmos DB-konto för Core (SQL) API

Distribuera till Azure		 Den här mallen skapar ett Azure Cosmos-konto för Core (SQL) API med en databas och container med dataflöde med flera andra alternativ.
SQL-API för Azure Cosmos DB-konto med analysarkiv

Distribuera till Azure		 Den här mallen skapar ett Azure Cosmos-konto för Core (SQL) API med en databas och container som konfigurerats med analysarkiv.
Skapa ett SQL-API för Azure Cosmos DB-konto med autoskalning

Distribuera till Azure		 Den här mallen skapar ett Azure Cosmos-konto för Core (SQL) API med en databas och container med dataflöde för automatisk skalning med flera andra alternativ.
Skapa lagrade PROCEDUREr för Azure Cosmos DB Core (SQL) API

Distribuera till Azure		 Den här mallen skapar ett Azure Cosmos DB-konto för Core (SQL) API och en container med en lagrad procedur, utlösare och användardefinierad funktion.
Distribuera Azure Data Explorer DB med Cosmos DB-anslutning

Distribuera till Azure		 Distribuera Azure Data Explorer DB med Cosmos DB-anslutning.

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen databaseAccounts/sqlDatabases kan distribueras med åtgärder som mål:

  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/sqlDatabases-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2023-11-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"
        }
      }
    }
  })
}

Egenskapsvärden

databaseAccounts/sqlDatabases

Name Beskrivning Värde
typ Resurstypen "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2023-11-15"
name Resursnamnet sträng (krävs)
location Platsen för resursgruppen som resursen tillhör. sträng
parent_id ID för resursen som är överordnad för den här resursen. ID för resurs av typen: databaseAccounts
tags Taggar är en lista över nyckel/värde-par som beskriver resursen. De här taggarna kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB". Ordlista med taggnamn och värden.
properties Egenskaper för att skapa och uppdatera Azure Cosmos DB SQL-databas. SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro... (krävs)

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro...

Name Beskrivning Värde
alternativ Ett nyckel/värde-par med alternativ som ska tillämpas för begäran. Detta motsvarar de huvuden som skickas med begäran. CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
resource JSON-standardformatet för en SQL-databas SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc... (krävs)

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Name Beskrivning Värde
autoscaleSettings Anger inställningarna för autoskalning. Obs! Antingen dataflöde eller autoscaleSettings krävs, men inte båda. AutoscaleSettings
dataflöde Enheter för programbegäran per sekund. Till exempel "dataflöde": 10000. int

AutoscaleSettings

Name Beskrivning Värde
maxThroughput Representerar maximalt dataflöde, resursen kan skalas upp till. int

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc...

Name Beskrivning Värde
createMode Uppräkning för att ange läget för resursskapande. "Standard"
"Återställ"
id Namnet på Cosmos DB SQL-databasen sträng (krävs)
restoreParameters Parametrar för att ange information om återställningen ResourceRestoreParameters

ResourceRestoreParameters

Name Beskrivning Värde
restoreSource ID:t för det återställningsbara databaskonto som återställningen måste initieras från. Exempel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} sträng
restoreTimestampInUtc Tid till vilken kontot måste återställas (ISO-8601-format). sträng