Sdílet prostřednictvím

Microsoft.DocumentDB databaseAccounts/sqlDatabases 2022-08-15

Definice prostředku Bicep

Typ prostředku databaseAccounts/sqlDatabases lze nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/sqlDatabases, přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2022-08-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      id: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Hodnoty vlastností

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

Jméno Popis Hodnota
poloha Umístění skupiny prostředků, do které prostředek patří. řetězec
Jméno Název prostředku string (povinné)
nadřazený objekt V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.		 Symbolický název prostředku typu: databaseAccounts
vlastnosti Vlastnosti pro vytvoření a aktualizaci databáze SQL služby Azure Cosmos DB SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (povinné)
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách

Automatické škálováníSettings

Jméno Popis Hodnota
maxThroughput Představuje maximální propustnost a prostředek se může vertikálně navýšit. Int

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Jméno Popis Hodnota
automatické škálováníSettings Určuje nastavení automatického škálování. automatického škálování
propustnost Jednotky žádostí za sekundu Například propustnost: 1 0000. Int

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

Jméno Popis Hodnota
volby Pár možností klíč-hodnota, které se mají použít pro požadavek. Odpovídá hlavičkám odeslaným s požadavkem. CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
prostředek Standardní formát JSON databáze SQL SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (povinné)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Jméno Popis Hodnota
identifikační číslo Název databáze SQL služby Cosmos DB string (povinné)

Visačky

Jméno Popis Hodnota

Příklady použití

Ukázky rychlého startu Azure

Následující šablony Azure pro rychlý start obsahují ukázky Bicep pro nasazení tohoto typu prostředku.

Soubor Bicep Popis
rozhraní SQL API účtu služby Azure Cosmos DB s analytického úložiště Tato šablona vytvoří účet Služby Azure Cosmos pro rozhraní API core (SQL) s databází a kontejnerem nakonfigurovaným s analytickým úložištěm.
Vytvoření účtu služby Azure Cosmos DB úrovně Free Tato šablona vytvoří účet služby Azure Cosmos DB úrovně Free pro rozhraní SQL API s databází se sdílenou propustností a kontejnerem.
vytvoření účtu služby Azure Cosmos DB pro rozhraní CORE (SQL) API Tato šablona vytvoří účet Azure Cosmos PRO rozhraní API core (SQL) s databází a kontejnerem s propustností s několika dalšími možnostmi.
Vytvoření rozhraní SQL API účtu služby Azure Cosmos DB s automatickým škálováním Tato šablona vytvoří účet Azure Cosmos PRO rozhraní API core (SQL) s databází a kontejnerem s propustností automatického škálování s několika dalšími možnostmi.
vytvoření uložených procedur rozhraní API služby Azure Cosmos DB Core (SQL) Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní CORE (SQL) API a kontejner s uloženou procedurou, triggerem a uživatelem definovanou funkcí.
vytvoří aplikaci mikroslužeb Dapr pomocí služby Container Apps Vytvořte aplikaci mikroslužeb Dapr pomocí Container Apps.
vytvoří aplikaci Dapr pub-sub servicebus pomocí služby Container Apps Vytvořte aplikaci Dapr pub-sub servicebus pomocí Container Apps.
nasazení služby Azure Data Explorer DB s připojením ke službě Cosmos DB Nasaďte databázi Azure Data Exploreru s připojením ke službě Cosmos DB.

Definice prostředku šablony ARM

Typ prostředku databaseAccounts/sqlDatabases lze nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/sqlDatabases, přidejte do šablony následující JSON.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases",
  "apiVersion": "2022-08-15",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "id": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Hodnoty vlastností

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

Jméno Popis Hodnota
Verze rozhraní apiVersion Verze rozhraní API '2022-08-15'
poloha Umístění skupiny prostředků, do které prostředek patří. řetězec
Jméno Název prostředku string (povinné)
vlastnosti Vlastnosti pro vytvoření a aktualizaci databáze SQL služby Azure Cosmos DB SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (povinné)
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách
typ Typ prostředku Microsoft.DocumentDB/databaseAccounts/sqlDatabases

Automatické škálováníSettings

Jméno Popis Hodnota
maxThroughput Představuje maximální propustnost a prostředek se může vertikálně navýšit. Int

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Jméno Popis Hodnota
automatické škálováníSettings Určuje nastavení automatického škálování. automatického škálování
propustnost Jednotky žádostí za sekundu Například propustnost: 1 0000. Int

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

Jméno Popis Hodnota
volby Pár možností klíč-hodnota, které se mají použít pro požadavek. Odpovídá hlavičkám odeslaným s požadavkem. CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
prostředek Standardní formát JSON databáze SQL SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (povinné)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Jméno Popis Hodnota
identifikační číslo Název databáze SQL služby Cosmos DB string (povinné)

Visačky

Jméno Popis Hodnota

Příklady použití

Šablony azure pro rychlý start

Následující šablony Azure Pro rychlý start nasadit tento typ prostředku.

Šablona Popis
rozhraní SQL API účtu služby Azure Cosmos DB s analytického úložiště

nasazení do Azure		 Tato šablona vytvoří účet Služby Azure Cosmos pro rozhraní API core (SQL) s databází a kontejnerem nakonfigurovaným s analytickým úložištěm.
Vytvoření účtu služby Azure Cosmos DB úrovně Free

nasazení do Azure		 Tato šablona vytvoří účet služby Azure Cosmos DB úrovně Free pro rozhraní SQL API s databází se sdílenou propustností a kontejnerem.
vytvoření účtu služby Azure Cosmos DB pro rozhraní CORE (SQL) API

nasazení do Azure		 Tato šablona vytvoří účet Azure Cosmos PRO rozhraní API core (SQL) s databází a kontejnerem s propustností s několika dalšími možnostmi.
Vytvoření rozhraní SQL API účtu služby Azure Cosmos DB s automatickým škálováním

nasazení do Azure		 Tato šablona vytvoří účet Azure Cosmos PRO rozhraní API core (SQL) s databází a kontejnerem s propustností automatického škálování s několika dalšími možnostmi.
vytvoření uložených procedur rozhraní API služby Azure Cosmos DB Core (SQL)

nasazení do Azure		 Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní CORE (SQL) API a kontejner s uloženou procedurou, triggerem a uživatelem definovanou funkcí.
vytvoří aplikaci mikroslužeb Dapr pomocí služby Container Apps

nasazení do Azure		 Vytvořte aplikaci mikroslužeb Dapr pomocí Container Apps.
vytvoří aplikaci Dapr pub-sub servicebus pomocí služby Container Apps

nasazení do Azure		 Vytvořte aplikaci Dapr pub-sub servicebus pomocí Container Apps.
nasazení služby Azure Data Explorer DB s připojením ke službě Cosmos DB

nasazení do Azure		 Nasaďte databázi Azure Data Exploreru s připojením ke službě Cosmos DB.

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku databaseAccounts/sqlDatabases lze nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/sqlDatabases, přidejte do šablony následující Terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2022-08-15"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        id = "string"
      }
    }
  }
}

Hodnoty vlastností

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

Jméno Popis Hodnota
poloha Umístění skupiny prostředků, do které prostředek patří. řetězec
Jméno Název prostředku string (povinné)
ID rodiče ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: databaseAccounts
vlastnosti Vlastnosti pro vytvoření a aktualizaci databáze SQL služby Azure Cosmos DB SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (povinné)
visačky Značky prostředků Slovník názvů a hodnot značek
typ Typ prostředku Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2022-08-15

Automatické škálováníSettings

Jméno Popis Hodnota
maxThroughput Představuje maximální propustnost a prostředek se může vertikálně navýšit. Int

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Jméno Popis Hodnota
automatické škálováníSettings Určuje nastavení automatického škálování. automatického škálování
propustnost Jednotky žádostí za sekundu Například propustnost: 1 0000. Int

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

Jméno Popis Hodnota
volby Pár možností klíč-hodnota, které se mají použít pro požadavek. Odpovídá hlavičkám odeslaným s požadavkem. CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
prostředek Standardní formát JSON databáze SQL SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (povinné)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Jméno Popis Hodnota
identifikační číslo Název databáze SQL služby Cosmos DB string (povinné)

Visačky

Jméno Popis Hodnota

Příklady použití

Ukázky Terraformu

Základní příklad nasazení databáze SQL v rámci účtu Cosmos DB.

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    = ["*"]
}
  • Last updated on