Notatka
Dostęp do tej strony wymaga autoryzacji. Może spróbować zalogować się lub zmienić katalogi.
Dostęp do tej strony wymaga autoryzacji. Możesz spróbować zmienić katalogi.
Definicja zasobu Bicep
Typ zasobu databaseAccounts/sqlDatabases można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Przykłady użycia
Przykłady Bicep
Podstawowy przykład wdrażania SQL Database na koncie Cosmos DB.
param resourceName string = 'acctest0001'
param location string = 'westeurope'
resource databaseAccount 'Microsoft.DocumentDB/databaseAccounts@2021-10-15' = {
name: resourceName
location: location
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: []
}
}
resource sqlDatabase 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-10-15' = {
name: resourceName
parent: databaseAccount
properties: {
options: {
throughput: 400
}
resource: {
id: resourceName
}
}
}
Moduły zweryfikowane na platformie Azure
Następujące moduły zweryfikowane platformy Azure mogą służyć do wdrażania tego typu zasobu.
| Module | Opis |
|---|---|
| Konto bazy danych Cosmos DB - SQL Database | AVM Child Module for Cosmos DB Database Account - SQL Database |
Przykłady szybkiego startu platformy Azure
Poniższe szablony szybkiego startu platformy Azure zawierają przykłady Bicep na potrzeby wdrażania tego typu zasobu.
| Plik Bicep | Opis |
|---|---|
| interfejs API SQL konta usługi Azure Cosmos DB z magazynem analitycznym | Ten szablon tworzy konto usługi Azure Cosmos dla interfejsu API Core (SQL) z bazą danych i kontenerem skonfigurowanym z magazynem analitycznym. |
| Tworzenie konta usługi Azure Cosmos DB w warstwie bezpłatna | Ten szablon tworzy bezpłatne konto usługi Azure Cosmos DB dla interfejsu API SQL z bazą danych z udostępnioną przepływnością i kontenerem. |
| Tworzenie konta usługi Azure Cosmos DB dla interfejsu API Core (SQL) | Ten szablon tworzy konto usługi Azure Cosmos dla interfejsu API Core (SQL) z bazą danych i kontenerem z przepływnością z wieloma innymi opcjami. |
| Tworzenie interfejsu API SQL konta usługi Azure Cosmos DB przy użyciu autoskalowania | Ten szablon tworzy konto usługi Azure Cosmos dla interfejsu API Core (SQL) z bazą danych i kontenerem z przepływnością autoskalowania z wieloma innymi opcjami. |
| tworzenie procedur składowanych interfejsu API Azure Cosmos DB Core (SQL) | Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API Core (SQL) i kontener z procedurą składowaną, wyzwalaczem i funkcją zdefiniowaną przez użytkownika. |
| Tworzy aplikację mikrousług dapr przy użyciu usługi Container Apps | Tworzenie aplikacji mikrousług dapr przy użyciu usługi Container Apps. |
| Tworzy aplikację dapr pub-sub servicebus przy użyciu usługi Container Apps | Utwórz aplikację Dapr pub-sub servicebus przy użyciu usługi Container Apps. |
| wdrażanie usługi Azure Data Explorer DB przy użyciu połączenia usługi Cosmos DB | Wdrażanie bazy danych usługi Azure Data Explorer przy użyciu połączenia usługi Cosmos DB. |
Format zasobu
Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/sqlDatabases, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2026-04-01-preview' = {
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: 'string'
}
}
location: 'string'
name: 'string'
properties: {
options: {
autoscaleSettings: {
maxThroughput: int
}
throughput: int
}
resource: {
createMode: 'string'
id: 'string'
restoreParameters: {
restoreSource: 'string'
restoreTimestampInUtc: 'string'
restoreWithTtlDisabled: bool
}
_colls: 'string'
_users: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Wartości właściwości
Microsoft.DocumentDB/databaseAccounts/sqlDatabases
| Nazwa | Opis | Wartość |
|---|---|---|
| tożsamość | Tożsamość zasobu. | ManagedServiceIdentity (tożsamość usługi) |
| lokalizacja | Lokalizacja grupy zasobów, do której należy zasób. | ciąg |
| nazwa | Nazwa zasobu | ciąg (wymagany) |
| nadrzędny | W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym. Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym. |
Nazwa symboliczna zasobu typu: databaseAccounts |
| Właściwości | Właściwości bazy danych SQL Azure Cosmos DB | SqlDatabaseGetProperties |
| Tagi | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
AutoskalowanieUstawienia
| Nazwa | Opis | Wartość |
|---|---|---|
| maxThroughput (maksymalna przepływność) | Reprezentuje maksymalną przepływność, zasób może być skalowany w górę do. | Int |
ManagedServiceIdentity
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ tożsamości używany dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi. | "Brak" "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| tożsamości przypisane użytkownikom | Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | Rekord |
Nagraj
| Nazwa | Opis | Wartość |
|---|
ResourceRestoreParameters
| Nazwa | Opis | Wartość |
|---|---|---|
| restoreSource (przywróć źródło) | Identyfikator przywracalnego konta bazy danych, z którego należy zainicjować przywracanie. Na przykład: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | ciąg |
| restoreTimestampInUtc | Godzina przywrócenia konta (format ISO-8601). | ciąg |
| restoreWithTtlDisabled (przywracać z TtlDisabled) | Określa, czy przywrócone konto będzie mieć czas-To-Live wyłączone po pomyślnym przywróceniu. | Bool |
SqlDatabaseGetProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| Opcje | SqlDatabaseGetPropertiesOptions | |
| zasób | SqlDatabaseGetPropertiesResource |
SqlDatabaseGetPropertiesOptions
| Nazwa | Opis | Wartość |
|---|---|---|
| autoskalowanieUstawienia | Określa ustawienia autoskalu. | AutoskalowanieUstawienia |
| przepływność | Wartość przepływności zasobu usługi Cosmos DB lub autoskalowaniaUstawienia. Użyj zasobu PrzepływnośćUstawienia podczas pobierania szczegółów oferty. | Int |
SqlDatabaseGetPropertiesResource
| Nazwa | Opis | Wartość |
|---|---|---|
| createMode (tryb tworzenia) | Wyliczenie wskazujące tryb tworzenia konta. | "Wartość domyślna" "Przywracanie" |
| id | Nazwa bazy danych SQL usługi Cosmos DB | ciąg (wymagany) |
| restoreParameters (parametry przywracania) | Parametry wskazujące informacje o przywracaniu | ResourceRestoreParameters |
| _colls | Właściwość wygenerowana przez system, która określiła ścieżkę adresową zasobu kolekcji. | ciąg |
| _users | Właściwość wygenerowana przez system określająca adresową ścieżkę zasobu użytkowników. | ciąg |
Definicja zasobu szablonu usługi ARM
Typ zasobu databaseAccounts/sqlDatabases można wdrożyć przy użyciu operacji docelowych:
- Grupy zasobów – Zobacz polecenia wdrożenia grup zasobów Aby uzyskać listę zmienionych właściwości w każdej wersji API, zobacz log zmian.
Przykłady użycia
Szablony szybkiego startu platformy Azure
Następujące szablony szybkiego startu platformy Azure wdrożyć ten typ zasobu.
| Szablon | Opis |
|---|---|
| interfejs API SQL konta usługi Azure Cosmos DB z magazynem analitycznym wdrażanie |
Ten szablon tworzy konto usługi Azure Cosmos dla interfejsu API Core (SQL) z bazą danych i kontenerem skonfigurowanym z magazynem analitycznym. |
|
Tworzenie konta usługi Azure Cosmos DB w warstwie bezpłatna wdrażanie |
Ten szablon tworzy bezpłatne konto usługi Azure Cosmos DB dla interfejsu API SQL z bazą danych z udostępnioną przepływnością i kontenerem. |
|
Tworzenie konta usługi Azure Cosmos DB dla interfejsu API Core (SQL) wdrażanie |
Ten szablon tworzy konto usługi Azure Cosmos dla interfejsu API Core (SQL) z bazą danych i kontenerem z przepływnością z wieloma innymi opcjami. |
|
Tworzenie interfejsu API SQL konta usługi Azure Cosmos DB przy użyciu autoskalowania wdrażanie |
Ten szablon tworzy konto usługi Azure Cosmos dla interfejsu API Core (SQL) z bazą danych i kontenerem z przepływnością autoskalowania z wieloma innymi opcjami. |
|
tworzenie procedur składowanych interfejsu API Azure Cosmos DB Core (SQL) wdrażanie |
Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API Core (SQL) i kontener z procedurą składowaną, wyzwalaczem i funkcją zdefiniowaną przez użytkownika. |
|
Tworzy aplikację mikrousług dapr przy użyciu usługi Container Apps wdrażanie |
Tworzenie aplikacji mikrousług dapr przy użyciu usługi Container Apps. |
|
Tworzy aplikację dapr pub-sub servicebus przy użyciu usługi Container Apps wdrażanie |
Utwórz aplikację Dapr pub-sub servicebus przy użyciu usługi Container Apps. |
|
wdrażanie usługi Azure Data Explorer DB przy użyciu połączenia usługi Cosmos DB wdrażanie |
Wdrażanie bazy danych usługi Azure Data Explorer przy użyciu połączenia usługi Cosmos DB. |
Format zasobu
Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/sqlDatabases, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases",
"apiVersion": "2026-04-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": "string"
}
},
"location": "string",
"properties": {
"options": {
"autoscaleSettings": {
"maxThroughput": "int"
},
"throughput": "int"
},
"resource": {
"createMode": "string",
"id": "string",
"restoreParameters": {
"restoreSource": "string",
"restoreTimestampInUtc": "string",
"restoreWithTtlDisabled": "bool"
},
"_colls": "string",
"_users": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Wartości właściwości
Microsoft.DocumentDB/databaseAccounts/sqlDatabases
| Nazwa | Opis | Wartość |
|---|---|---|
| apiVersion (wersja interfejsu api) | Wersja interfejsu API | 'Zapowiedź 2026-04-01' |
| tożsamość | Tożsamość zasobu. | ManagedServiceIdentity (tożsamość usługi) |
| lokalizacja | Lokalizacja grupy zasobów, do której należy zasób. | ciąg |
| nazwa | Nazwa zasobu | ciąg (wymagany) |
| Właściwości | Właściwości bazy danych SQL Azure Cosmos DB | SqlDatabaseGetProperties |
| Tagi | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
| typ | Typ zasobu | "Microsoft.DocumentDB/databaseAccounts/sqlDatabases" |
AutoskalowanieUstawienia
| Nazwa | Opis | Wartość |
|---|---|---|
| maxThroughput (maksymalna przepływność) | Reprezentuje maksymalną przepływność, zasób może być skalowany w górę do. | Int |
ManagedServiceIdentity
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ tożsamości używany dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi. | "Brak" "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| tożsamości przypisane użytkownikom | Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | Rekord |
Nagraj
| Nazwa | Opis | Wartość |
|---|
ResourceRestoreParameters
| Nazwa | Opis | Wartość |
|---|---|---|
| restoreSource (przywróć źródło) | Identyfikator przywracalnego konta bazy danych, z którego należy zainicjować przywracanie. Na przykład: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | ciąg |
| restoreTimestampInUtc | Godzina przywrócenia konta (format ISO-8601). | ciąg |
| restoreWithTtlDisabled (przywracać z TtlDisabled) | Określa, czy przywrócone konto będzie mieć czas-To-Live wyłączone po pomyślnym przywróceniu. | Bool |
SqlDatabaseGetProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| Opcje | SqlDatabaseGetPropertiesOptions | |
| zasób | SqlDatabaseGetPropertiesResource |
SqlDatabaseGetPropertiesOptions
| Nazwa | Opis | Wartość |
|---|---|---|
| autoskalowanieUstawienia | Określa ustawienia autoskalu. | AutoskalowanieUstawienia |
| przepływność | Wartość przepływności zasobu usługi Cosmos DB lub autoskalowaniaUstawienia. Użyj zasobu PrzepływnośćUstawienia podczas pobierania szczegółów oferty. | Int |
SqlDatabaseGetPropertiesResource
| Nazwa | Opis | Wartość |
|---|---|---|
| createMode (tryb tworzenia) | Wyliczenie wskazujące tryb tworzenia konta. | "Wartość domyślna" "Przywracanie" |
| id | Nazwa bazy danych SQL usługi Cosmos DB | ciąg (wymagany) |
| restoreParameters (parametry przywracania) | Parametry wskazujące informacje o przywracaniu | ResourceRestoreParameters |
| _colls | Właściwość wygenerowana przez system, która określiła ścieżkę adresową zasobu kolekcji. | ciąg |
| _users | Właściwość wygenerowana przez system określająca adresową ścieżkę zasobu użytkowników. | ciąg |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu databaseAccounts/sqlDatabases można wdrożyć przy użyciu operacji docelowych:
- Grupy zasobów Listę zmienionych właściwości w każdej wersji API można znaleźć w dzienniku zmian.
Przykłady użycia
Przykłady programu Terraform
Podstawowy przykład wdrażania SQL Database na koncie 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 = ["*"]
}
Format zasobu
Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/sqlDatabases, dodaj następujący program Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2026-04-01-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"
restoreWithTtlDisabled = bool
}
_colls = "string"
_users = "string"
}
}
}
}
Wartości właściwości
Microsoft.DocumentDB/databaseAccounts/sqlDatabases
| Nazwa | Opis | Wartość |
|---|---|---|
| tożsamość | Tożsamość zasobu. | ManagedServiceIdentity (tożsamość usługi) |
| lokalizacja | Lokalizacja grupy zasobów, do której należy zasób. | ciąg |
| nazwa | Nazwa zasobu | ciąg (wymagany) |
| parent_id (identyfikator rodzica) | Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. | Identyfikator zasobu typu: databaseAccounts |
| Właściwości | Właściwości bazy danych SQL Azure Cosmos DB | SqlDatabaseGetProperties |
| Tagi | Tagi zasobów | Słownik nazw tagów i wartości. |
| typ | Typ zasobu | "Microsoft. DocumentDB/databaseAccounts/sqlDatabases@2026-04-01-preview" |
AutoskalowanieUstawienia
| Nazwa | Opis | Wartość |
|---|---|---|
| maxThroughput (maksymalna przepływność) | Reprezentuje maksymalną przepływność, zasób może być skalowany w górę do. | Int |
ManagedServiceIdentity
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ tożsamości używany dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi. | "Brak" "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| tożsamości przypisane użytkownikom | Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | Rekord |
Nagraj
| Nazwa | Opis | Wartość |
|---|
ResourceRestoreParameters
| Nazwa | Opis | Wartość |
|---|---|---|
| restoreSource (przywróć źródło) | Identyfikator przywracalnego konta bazy danych, z którego należy zainicjować przywracanie. Na przykład: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | ciąg |
| restoreTimestampInUtc | Godzina przywrócenia konta (format ISO-8601). | ciąg |
| restoreWithTtlDisabled (przywracać z TtlDisabled) | Określa, czy przywrócone konto będzie mieć czas-To-Live wyłączone po pomyślnym przywróceniu. | Bool |
SqlDatabaseGetProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| Opcje | SqlDatabaseGetPropertiesOptions | |
| zasób | SqlDatabaseGetPropertiesResource |
SqlDatabaseGetPropertiesOptions
| Nazwa | Opis | Wartość |
|---|---|---|
| autoskalowanieUstawienia | Określa ustawienia autoskalu. | AutoskalowanieUstawienia |
| przepływność | Wartość przepływności zasobu usługi Cosmos DB lub autoskalowaniaUstawienia. Użyj zasobu PrzepływnośćUstawienia podczas pobierania szczegółów oferty. | Int |
SqlDatabaseGetPropertiesResource
| Nazwa | Opis | Wartość |
|---|---|---|
| createMode (tryb tworzenia) | Wyliczenie wskazujące tryb tworzenia konta. | "Wartość domyślna" "Przywracanie" |
| id | Nazwa bazy danych SQL usługi Cosmos DB | ciąg (wymagany) |
| restoreParameters (parametry przywracania) | Parametry wskazujące informacje o przywracaniu | ResourceRestoreParameters |
| _colls | Właściwość wygenerowana przez system, która określiła ścieżkę adresową zasobu kolekcji. | ciąg |
| _users | Właściwość wygenerowana przez system określająca adresową ścieżkę zasobu użytkowników. | ciąg |