Microsoft.DocumentDB DatabaseAccounts 2023-09-15-preview
- najnowsze
- 2024-12-01-preview
- 2024-11-15
- 2024-09-01-preview
- 2024-08-15
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15
- 2021-10-15-preview
- 2021-07-01-preview
- 2021-06-15
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-15
- 2021-03-01-preview
- 2021-01-15
- 2020-09-01
- 2020-06-01-preview
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
- 2016-03-31
- 2016-03-19
- 2015-11-06
- 2015-04-08
- 2015-04-01
Definicja zasobu Bicep
Typ zasobu databaseAccounts 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.
Format zasobu
Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2023-09-15-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
kind: 'string'
location: 'string'
name: 'string'
properties: {
analyticalStorageConfiguration: {
schemaType: 'string'
}
apiProperties: {
serverVersion: 'string'
}
backupPolicy: {
migrationState: {
startTime: 'string'
status: 'string'
targetType: 'string'
}
type: 'string'
// For remaining properties, see BackupPolicy objects
}
capabilities: [
{
name: 'string'
}
]
capacity: {
totalThroughputLimit: int
}
connectorOffer: 'string'
consistencyPolicy: {
defaultConsistencyLevel: 'string'
maxIntervalInSeconds: int
maxStalenessPrefix: int
}
cors: [
{
allowedHeaders: 'string'
allowedMethods: 'string'
allowedOrigins: 'string'
exposedHeaders: 'string'
maxAgeInSeconds: int
}
]
createMode: 'string'
customerManagedKeyStatus: 'string'
databaseAccountOfferType: 'Standard'
defaultIdentity: 'string'
defaultPriorityLevel: 'string'
diagnosticLogSettings: {
enableFullTextQuery: 'string'
}
disableKeyBasedMetadataWriteAccess: bool
disableLocalAuth: bool
enableAnalyticalStorage: bool
enableAutomaticFailover: bool
enableBurstCapacity: bool
enableCassandraConnector: bool
enableFreeTier: bool
enableMaterializedViews: bool
enableMultipleWriteLocations: bool
enablePartitionMerge: bool
enablePriorityBasedExecution: bool
ipRules: [
{
ipAddressOrRange: 'string'
}
]
isVirtualNetworkFilterEnabled: bool
keyVaultKeyUri: 'string'
locations: [
{
failoverPriority: int
isZoneRedundant: bool
locationName: 'string'
}
]
minimalTlsVersion: 'string'
networkAclBypass: 'string'
networkAclBypassResourceIds: [
'string'
]
publicNetworkAccess: 'string'
restoreParameters: {
databasesToRestore: [
{
collectionNames: [
'string'
]
databaseName: 'string'
}
]
gremlinDatabasesToRestore: [
{
databaseName: 'string'
graphNames: [
'string'
]
}
]
restoreMode: 'string'
restoreSource: 'string'
restoreTimestampInUtc: 'string'
sourceBackupLocation: 'string'
tablesToRestore: [
'string'
]
}
virtualNetworkRules: [
{
id: 'string'
ignoreMissingVNetServiceEndpoint: bool
}
]
}
tags: {
{customized property}: 'string'
}
}
BackupPolicy obiektów
Ustaw właściwość , aby określić typ obiektu.
W przypadku continuousużyj:
{
continuousModeProperties: {
tier: 'string'
}
type: 'Continuous'
}
W przypadku okresowychużyj:
{
periodicModeProperties: {
backupIntervalInMinutes: int
backupRetentionIntervalInHours: int
backupStorageRedundancy: 'string'
}
type: 'Periodic'
}
Wartości właściwości
AnalyticalStorageConfiguration
| Nazwa | Opis | Wartość |
|---|---|---|
| schemaType | Opisuje typy schematu dla magazynu analitycznego. | "FullFidelity" "WellDefined" |
Właściwości interfejsu API
| Nazwa | Opis | Wartość |
|---|---|---|
| serverVersion | Opisuje ServerVersion konta bazy danych MongoDB. | '3.2' '3.6' '4.0' '4.2' |
BackupPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| migrationState | Obiekt reprezentujący stan migracji między zasadami tworzenia kopii zapasowych. | BackupPolicyMigrationState |
| typ | Ustaw wartość "Continuous" dla typu ContinuousModeBackupPolicy. Ustaw wartość "Periodic" dla typu PeriodicModeBackupPolicy. | "Ciągły" "Okresowe" (wymagane) |
BackupPolicyMigrationState
| Nazwa | Opis | Wartość |
|---|---|---|
| startTime | Godzina rozpoczęcia migracji zasad kopii zapasowych (format ISO-8601). | struna |
| stan | Opisuje stan migracji między typami zasad kopii zapasowych. | "Ukończono" "Niepowodzenie" "Ruch przychodzący" "Nieprawidłowy" |
| targetType | Opisuje docelowy typ zasad kopii zapasowych migracji zasad kopii zapasowych. | "Ciągły" "Okresowe" |
Zdolność
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa | Nazwa możliwości usługi Cosmos DB. Na przykład "name": "EnableCassandra". Bieżące wartości obejmują również wartości "EnableTable" i "EnableGremlin". | struna |
Pojemność
| Nazwa | Opis | Wartość |
|---|---|---|
| totalThroughputLimit | Łączny limit przepływności nałożony na konto. SumaThroughputLimit z 2000 r. nakłada ścisły limit maksymalnej przepływności, który można aprowizować na tym koncie na 2000. TotalThroughputLimit -1 wskazuje brak limitów aprowizacji przepływności. | Int Ograniczenia: Minimalna wartość = -1 |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| Nazwa | Opis | Wartość |
|---|
ConsistencyPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| defaultConsistencyLevel | Domyślny poziom spójności i ustawienia konfiguracji konta usługi Cosmos DB. | "BoundedStaleness" "Spójny prefiks" "Ostateczna" "Sesja" "Strong" (wymagane) |
| maxIntervalInSeconds | W przypadku użycia z poziomem spójności Powiązana nieaktualność ta wartość reprezentuje tolerowaną ilość czasu nieaktualności (w sekundach). Zaakceptowany zakres dla tej wartości to 5– 86400. Wymagane, gdy parametr defaultConsistencyPolicy ma ustawioną wartość "BoundedStaleness". | Int Ograniczenia: Minimalna wartość = 5 Wartość maksymalna = 86400 |
| maxStalenessPrefix | W przypadku użycia z poziomem spójności Powiązana nieaktualność ta wartość reprezentuje liczbę nieaktywnych żądań tolerowanych. Akceptowany zakres dla tej wartości to 1 – 2 147 483 647. Wymagane, gdy parametr defaultConsistencyPolicy ma ustawioną wartość "BoundedStaleness". | Int Ograniczenia: Minimalna wartość = 1 Wartość maksymalna = 2147483647 |
ContinuousModeBackupPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| continuousModeProperties | Wartości konfiguracji kopii zapasowej trybu ciągłego | ContinuousModeProperties |
| typ | Opisuje tryb tworzenia kopii zapasowych. | "Continuous" (wymagane) |
ContinuousModeProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| kondygnacja | Wyliczenie wskazujące typ trybu tworzenia kopii zapasowej continuos | "Continuous30Days" "Continuous7Days" |
CorsPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| allowedHeaders | Nagłówki żądań, które domena źródła może określać w żądaniu CORS. | struna |
| allowedMethods | Metody (czasowniki żądań HTTP), których domena pochodzenia może używać dla żądania CORS. | struna |
| allowedOrigins | Domeny pochodzenia, które mogą wysłać żądanie do usługi za pośrednictwem mechanizmu CORS. | ciąg (wymagany) |
| exposedHeaders | Nagłówki odpowiedzi, które mogą być wysyłane w odpowiedzi na żądanie CORS i udostępniane przez przeglądarkę wystawcy żądania. | struna |
| maxAgeInSeconds | Maksymalny czas buforowania żądania OPCJE wstępne w przeglądarce. | Int Ograniczenia: Minimalna wartość = 1 Wartość maksymalna = 2147483647 |
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| analyticalStorageConfiguration | Właściwości specyficzne dla magazynu analitycznego. | AnalyticalStorageConfiguration |
| apiProperties | Właściwości specyficzne dla interfejsu API. Obecnie obsługiwane tylko dla interfejsu API bazy danych MongoDB. | ApiProperties |
| backupPolicy | Obiekt reprezentujący zasady tworzenia kopii zapasowych na koncie. | BackupPolicy |
| Możliwości | Lista możliwości usługi Cosmos DB dla konta | możliwości[] |
| pojemność | Obiekt reprezentujący wszystkie właściwości związane z wymuszaniem pojemności na koncie. | pojemności |
| connectorOffer | Typ oferty łącznika cassandra dla konta bazy danych Cosmos DB C*. | "Mały" |
| consistencyPolicy | Zasady spójności dla konta usługi Cosmos DB. | ConsistencyPolicy |
| cors | Zasady CORS dla konta bazy danych usługi Cosmos DB. | CorsPolicy[] |
| createMode | Wyliczenie wskazujące tryb tworzenia konta. | "Wartość domyślna" "PointInTimeRestore" "Przywracanie" |
| customerManagedKeyStatus | Wskazuje stan funkcji Klucz zarządzany przez klienta na koncie. W przypadku wystąpienia błędów właściwość zawiera wskazówki dotyczące rozwiązywania problemów. | "Potwierdzono dostęp do skonfigurowanego klucza zarządzanego przez klienta". "Dostęp do twojego konta jest obecnie odwołany, ponieważ reguły dostępu blokują żądania wychodzące do usługi Azure Key Vault; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź stronę https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide (4016). "Dostęp do twojego konta jest obecnie odwołany, ponieważ konto usługi Azure Cosmos DB ma niezdefiniowaną tożsamość domyślną; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź stronę https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#invalid-azure-cosmos-db-default-identity (4015). "Dostęp do twojego konta jest obecnie odwołany, ponieważ identyfikator URI klucza magazynu kluczy konta usługi Azure Cosmos DB nie jest zgodne z oczekiwanym formatem; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź stronę https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#improper-syntax-detected-on-the-key-vault-uri-property (4006). "Dostęp do twojego konta jest obecnie odwołany, ponieważ usługa Azure Cosmos DB nie może uzyskać tokenu uwierzytelniania usługi AAD dla tożsamości domyślnej konta; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-active-directory-token-acquisition-error (4000). "Dostęp do twojego konta jest obecnie odwołany, ponieważ usługa Azure Cosmos DB nie może opakowować ani odpakowywać klucza; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź stronę https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#internal-unwrapping-procedure-error (4005). "Dostęp do twojego konta jest obecnie odwołany, ponieważ nie można rozpoznać nazwy DNS usługi Azure Key Vault określonej przez właściwość keyvaultkeyuri konta; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#unable-to-resolve-the-key-vaults-dns (4009). "Dostęp do twojego konta jest obecnie odwołany, ponieważ nie znaleziono korespondenta usługi Azure Key Vault; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź stronę https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-key-vault-resource-not-found (4017). "Dostęp do twojego konta jest obecnie odwołany, ponieważ nie można odnaleźć klucza korespondenta w określonym magazynie kluczy; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź stronę https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-key-vault-resource-not-found (4003). "Dostęp do twojego konta jest obecnie odwołany, ponieważ bieżąca tożsamość domyślna nie ma już uprawnień do skojarzonego klucza usługi Key Vault; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź stronę https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#default-identity-is-unauthorized-to-access-the-azure-key-vault-key (4002). "Dostęp do twojego konta jest obecnie odwołany; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź stronę https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide" |
| databaseAccountOfferType | Typ oferty bazy danych | "Standardowa" (wymagana) |
| defaultIdentity | Domyślna tożsamość na potrzeby uzyskiwania dostępu do magazynu kluczy używanych w funkcjach, takich jak klucze zarządzane przez klienta. Tożsamość domyślna musi być jawnie ustawiona przez użytkowników. Może to być "FirstPartyIdentity", "SystemAssignedIdentity" i nie tylko. | struna |
| defaultPriorityLevel | Wyliczenie wskazujące domyślny poziom priorytetu żądania dla wykonania na podstawie priorytetu. | "Wysoki" "Niski" |
| diagnosticLogSettings | Obiekt reprezentujący różne ustawienia dziennika diagnostycznego dla konta usługi Cosmos DB. | DiagnosticLogSettings |
| disableKeyBasedMetadataWriteAccess | Wyłączanie operacji zapisu na zasobach metadanych (bazach danych, kontenerach, przepływności) za pomocą kluczy konta | Bool |
| disableLocalAuth | Rezygnacja z uwierzytelniania lokalnego i upewnienie się, że do uwierzytelniania można używać tylko tożsamości usługi zarządzanej i usługi AAD. | Bool |
| enableAnalyticalStorage | Flaga wskazująca, czy włączyć analizę magazynu. | Bool |
| enableAutomaticFailover | Włącza automatyczne przełączanie w tryb failover regionu zapisu w rzadkim przypadku, że region jest niedostępny z powodu awarii. Automatyczne przełączanie w tryb failover spowoduje utworzenie nowego regionu zapisu dla konta i zostanie wybrane na podstawie priorytetów trybu failover skonfigurowanych dla konta. | Bool |
| enableBurstCapacity | Flaga wskazująca włączanie/wyłączanie funkcji Burst Capacity Preview na koncie | Bool |
| enableCassandraConnector | Włącza łącznik cassandra na koncie usługi Cosmos DB C* | Bool |
| enableFreeTier | Flaga wskazująca, czy warstwa Bezpłatna jest włączona. | Bool |
| enableMaterializedViews | Flaga wskazująca, czy włączyć materializedViews na koncie usługi Cosmos DB | Bool |
| enableMultipleWriteLocations | Umożliwia zapisanie konta w wielu lokalizacjach | Bool |
| enablePartitionMerge | Flaga wskazująca włączanie/wyłączanie funkcji Scalanie partycji na koncie | Bool |
| enablePriorityBasedExecution | Flaga wskazująca włączanie/wyłączanie funkcji podglądu wykonywania na podstawie priorytetu na koncie | Bool |
| ipRules | Lista adresów IPRules. | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | Flaga wskazująca, czy należy włączyć/wyłączyć reguły listy ACL sieci wirtualnej. | Bool |
| keyVaultKeyUri | Identyfikator URI magazynu kluczy | struna |
| Lokalizacje | Tablica zawierająca lokalizacje georeplikacji włączone dla konta usługi Cosmos DB. | lokalizacji [] (wymagane) |
| minimalTlsVersion | Wskazuje minimalną dozwoloną wersję protokołu Tls. Wartość domyślna to Tls 1.0, z wyjątkiem interfejsów API Cassandra i Mongo, które działają tylko z protokołem Tls 1.2. | "Tls" "Tls11" "Tls12" |
| networkAclBypass | Wskazuje, jakie usługi mogą pomijać kontrole zapory. | "AzureServices" "Brak" |
| networkAclBypassResourceIds | Tablica zawierająca identyfikatory zasobów dla obejścia listy Acl sieci dla konta usługi Cosmos DB. | string[] |
| publicNetworkAccess | Czy żądania z sieci publicznej są dozwolone | "Wyłączone" "Włączone" "SecuredByPerimeter" |
| restoreParameters | Parametry wskazujące informacje o przywracaniu. | RestoreParameters |
| virtualNetworkRules | Lista reguł listy ACL sieci wirtualnej skonfigurowanych dla konta usługi Cosmos DB. | VirtualNetworkRule [] |
DatabaseRestoreResource
| Nazwa | Opis | Wartość |
|---|---|---|
| collectionNames | Nazwy kolekcji dostępnych do przywrócenia. | string[] |
| databaseName | Nazwa bazy danych dostępnej do przywrócenia. | struna |
DiagnosticLogSettings
| Nazwa | Opis | Wartość |
|---|---|---|
| enableFullTextQuery | Opisz poziom szczegółowości, za pomocą którego zapytania mają być rejestrowane. | "Fałsz" "Brak" "True" |
GremlinDatabaseRestoreResource
| Nazwa | Opis | Wartość |
|---|---|---|
| databaseName | Nazwa bazy danych gremlin dostępnej do przywrócenia. | struna |
| graphNames | Nazwy grafów dostępnych do przywrócenia. | string[] |
IpAddressOrRange
| Nazwa | Opis | Wartość |
|---|---|---|
| ipAddressOrRange | Pojedynczy adres IPv4 lub pojedynczy zakres adresów IPv4 w formacie CIDR. Podane adresy IP muszą być poprawnie sformatowane i nie mogą być zawarte w jednym z następujących zakresów: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, ponieważ nie są one wymuszane przez filtr adresu IP. Przykład prawidłowych danych wejściowych: "23.40.210.245" lub "23.40.210.0/8". | struna |
Lokalizacja
| Nazwa | Opis | Wartość |
|---|---|---|
| tryb failoverPriority | Priorytet pracy w trybie failover regionu. Priorytet pracy w trybie failover 0 wskazuje region zapisu. Maksymalna wartość priorytetu trybu failover = (całkowita liczba regionów — 1). Wartości priorytetów trybu failover muszą być unikatowe dla każdego z regionów, w których istnieje konto bazy danych. | Int Ograniczenia: Minimalna wartość = 0 |
| isZoneRedundant | Flaga wskazująca, czy ten region jest regionem AvailabilityZone | Bool |
| locationName | Nazwa regionu. | struna |
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" |
| userAssignedIdentities | 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}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Nazwa | Opis | Wartość |
|---|
Microsoft.DocumentDB/databaseAccounts
| Nazwa | Opis | Wartość |
|---|---|---|
| tożsamość | Tożsamość zasobu. | ManagedServiceIdentity |
| rodzaj | Wskazuje typ konta bazy danych. Można to ustawić tylko podczas tworzenia konta bazy danych. | "GlobalDocumentDB" "MongoDB" "Analizowanie" |
| lokalizacja | Lokalizacja grupy zasobów, do której należy zasób. | struna |
| nazwa | Nazwa zasobu | struna Ograniczenia: Minimalna długość = 3 Maksymalna długość = 3 Wzorzec = ^[a-z0-9]+(-[a-z0-9]+)* (wymagane) |
| Właściwości | Właściwości do tworzenia i aktualizowania kont bazy danych usługi Azure Cosmos DB. | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (wymagane) |
| Tagi | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
PeriodicModeBackupPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| periodicModeProperties | Wartości konfiguracji dla kopii zapasowej w trybie okresowym | periodicModeProperties |
| typ | Opisuje tryb tworzenia kopii zapasowych. | "Okresowe" (wymagane) |
Właściwości periodicModeProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| backupIntervalInMinutes | Liczba całkowita reprezentująca interwał w minutach między dwoma kopiami zapasowymi | Int Ograniczenia: Minimalna wartość = 0 |
| backupRetentionIntervalInHours | Liczba całkowita reprezentująca czas (w godzinach), przez który każda kopia zapasowa jest zachowywana | Int Ograniczenia: Minimalna wartość = 0 |
| backupStorageRedundancy | Wyliczenie wskazujące typ miejsca przechowywania kopii zapasowych | "Geo" "Lokalny" "Strefa" |
RestoreParameters
| Nazwa | Opis | Wartość |
|---|---|---|
| databasesToRestore | Lista określonych baz danych dostępnych do przywrócenia. | DatabaseRestoreResource[] |
| gremlinDatabasesToRestore | Lista określonych baz danych gremlin dostępnych do przywrócenia. | GremlinDatabaseRestoreResource[] |
| restoreMode | Opisuje tryb przywracania. | "PointInTime" |
| restoreSource | Identyfikator przywracalnego konta bazy danych, z którego należy zainicjować przywracanie. Na przykład: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | struna |
| restoreTimestampInUtc | Godzina przywrócenia konta (format ISO-8601). | struna |
| sourceBackupLocation | Źródłowa lokalizacja kopii zapasowej do przywrócenia. | struna |
| tablesToRestore | Lista określonych tabel dostępnych do przywrócenia. | string[] |
Tagi
| Nazwa | Opis | Wartość |
|---|
VirtualNetworkRule
| Nazwa | Opis | Wartość |
|---|---|---|
| id | Identyfikator zasobu podsieci, na przykład: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. | struna |
| ignoreMissingVNetServiceEndpoint | Utwórz regułę zapory, zanim sieć wirtualna ma włączony punkt końcowy usługi sieci wirtualnej. | Bool |
Przykłady z przewodnika Szybki start
W poniższych przykładach szybkiego startu wdrożono ten typ 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. |
| konto usługi Azure Cosmos DB przy użyciu usługi Web App | Ten szablon wdraża konto usługi Azure Cosmos DB, plan usługi App Service i tworzy aplikację internetową w planie usługi App Service. Dodaje również dwa ustawienia aplikacji do aplikacji internetowej odwołującej się do punktu końcowego konta usługi Azure Cosmos DB. Dzięki temu rozwiązania wdrożone w aplikacji internetowej mogą łączyć się z punktem końcowym konta usługi Azure Cosmos DB przy użyciu tych ustawień. |
| Tworzenie konta usługi Cosmos DB z włączoną usługą Microsoft Defender | Korzystając z tego szablonu usługi ARM, możesz wdrożyć konto usługi Azure Cosmos DB z włączoną usługą Microsoft Defender dla usługi Azure Cosmos DB. Usługa Microsoft Defender dla usługi Azure Cosmos DB to natywna dla platformy Azure warstwa zabezpieczeń, która wykrywa próby wykorzystania baz danych na kontach usługi Azure Cosmos DB. Usługa Microsoft Defender dla usługi Azure Cosmos DB wykrywa potencjalne wstrzyknięcia kodu SQL, znane złe podmioty oparte na usłudze Microsoft Threat Intelligence, podejrzane wzorce dostępu i potencjalne wykorzystanie bazy danych za pośrednictwem tożsamości z naruszonymi zagrożeniami lub złośliwych testerów. |
| 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 minimalnego konta usługi Azure Cosmos DB dla interfejsu API Core (SQL) | Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API Core (SQL) przy jednoczesnym określeniu tylko minimalnych wymaganych właściwości zasobów. |
| Tworzenie bezserwerowego konta usługi Azure Cosmos DB dla interfejsu API SQL | Ten szablon tworzy bezserwerowe konto usługi Azure Cosmos DB dla interfejsu API Core (SQL). |
| Tworzenie bezobsługowego konta usługi Azure Cosmos i usługi Azure Web App | Ten szablon tworzy konto usługi Azure Cosmos, wprowadza punkt końcowy i klucze usługi Cosmos DB do ustawień aplikacji internetowej platformy Azure, a następnie wdraża aplikację internetową ASP MVC z usługi GitHub. |
| Tworzenie konta usługi Azure Cosmos dla interfejsu API bazy danych MongoDB | Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API bazy danych MongoDB 4.2 w dwóch regionach przy użyciu udostępnionej i dedykowanej przepływności z dwiema kolekcjami. |
| Tworzenie konta usługi Azure Cosmos dla interfejsu API bazy danych MongoDB | Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API bazy danych MongoDB 4.2 w dwóch regionach przy użyciu udostępnionej i dedykowanej przepływności autoskalowania. |
| Tworzenie konta usługi Azure Cosmos dla interfejsu API tabel | Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API tabel w dwóch regionach i jedną tabelę z aprowizowaną przepływnością. |
| Tworzenie konta usługi Azure Cosmos dla interfejsu API tabel przy użyciu skalowania automatycznego | Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API tabel w dwóch regionach i jedną tabelę z przepływnością autoskalowania. |
| Tworzenie konta usługi Azure Cosmos DB dla interfejsu API Cassandra | Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API Cassandra w dwóch regionach z przestrzenią kluczy i tabelą z dedykowaną przepływnością. |
| 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 konta usługi Azure Cosmos DB dla interfejsu API języka Gremlin | Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API języka Gremlin w dwóch regionach z jedną bazą danych i jednym grafem przy użyciu dedykowanej przepływności. |
| Tworzenie konta usługi Azure Cosmos DB na potrzeby automatycznego skalowania interfejsu API języka Gremlin | Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API języka Gremlin w dwóch regionach z jedną bazą danych i jednym grafem przy użyciu przepływności autoskalowania. |
| Tworzenie konta usługi Azure Cosmos DB w wielu regionach | Ten szablon tworzy konto usługi Azure Cosmos DB dla dowolnego typu interfejsu API bazy danych z regionem podstawowym i pomocniczym z wybranym poziomem spójności i typem trybu failover. |
| 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 konta usługi Azure Cosmos DB z prywatnym punktem końcowym | Ten szablon spowoduje utworzenie konta usługi Cosmos, sieci wirtualnej i prywatnego punktu końcowego uwidaczniającego konto usługi Cosmos w sieci wirtualnej. |
| Tworzenie konta SQL usługi Azure Cosmos DB przy użyciu kontroli dostępu opartej na rolach płaszczyzny danych | Ten szablon utworzy konto usługi SQL Cosmos, natywnie zachowaną definicję roli i natywnie obsługiwane przypisanie roli dla tożsamości usługi AAD. |
| tworzenie konta usługi Azure CosmosDB | Ten szablon usługi ARM ma na celu szybkie utworzenie konta usługi CosmosDB z minimalnymi wymaganymi wartościami |
| Tworzenie automatycznego skalowania konta usługi Azure Cosmos DB dla interfejsu API Cassandra | Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API Cassandra w dwóch regionach z przestrzenią kluczy i tabelą z przepływnością autoskalowania. |
| 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. |
Definicja zasobu szablonu usługi ARM
Typ zasobu databaseAccounts 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.
Format zasobu
Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.DocumentDB/databaseAccounts",
"apiVersion": "2023-09-15-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"kind": "string",
"location": "string",
"properties": {
"analyticalStorageConfiguration": {
"schemaType": "string"
},
"apiProperties": {
"serverVersion": "string"
},
"backupPolicy": {
"migrationState": {
"startTime": "string",
"status": "string",
"targetType": "string"
},
"type": "string"
// For remaining properties, see BackupPolicy objects
},
"capabilities": [
{
"name": "string"
}
],
"capacity": {
"totalThroughputLimit": "int"
},
"connectorOffer": "string",
"consistencyPolicy": {
"defaultConsistencyLevel": "string",
"maxIntervalInSeconds": "int",
"maxStalenessPrefix": "int"
},
"cors": [
{
"allowedHeaders": "string",
"allowedMethods": "string",
"allowedOrigins": "string",
"exposedHeaders": "string",
"maxAgeInSeconds": "int"
}
],
"createMode": "string",
"customerManagedKeyStatus": "string",
"databaseAccountOfferType": "Standard",
"defaultIdentity": "string",
"defaultPriorityLevel": "string",
"diagnosticLogSettings": {
"enableFullTextQuery": "string"
},
"disableKeyBasedMetadataWriteAccess": "bool",
"disableLocalAuth": "bool",
"enableAnalyticalStorage": "bool",
"enableAutomaticFailover": "bool",
"enableBurstCapacity": "bool",
"enableCassandraConnector": "bool",
"enableFreeTier": "bool",
"enableMaterializedViews": "bool",
"enableMultipleWriteLocations": "bool",
"enablePartitionMerge": "bool",
"enablePriorityBasedExecution": "bool",
"ipRules": [
{
"ipAddressOrRange": "string"
}
],
"isVirtualNetworkFilterEnabled": "bool",
"keyVaultKeyUri": "string",
"locations": [
{
"failoverPriority": "int",
"isZoneRedundant": "bool",
"locationName": "string"
}
],
"minimalTlsVersion": "string",
"networkAclBypass": "string",
"networkAclBypassResourceIds": [ "string" ],
"publicNetworkAccess": "string",
"restoreParameters": {
"databasesToRestore": [
{
"collectionNames": [ "string" ],
"databaseName": "string"
}
],
"gremlinDatabasesToRestore": [
{
"databaseName": "string",
"graphNames": [ "string" ]
}
],
"restoreMode": "string",
"restoreSource": "string",
"restoreTimestampInUtc": "string",
"sourceBackupLocation": "string",
"tablesToRestore": [ "string" ]
},
"virtualNetworkRules": [
{
"id": "string",
"ignoreMissingVNetServiceEndpoint": "bool"
}
]
},
"tags": {
"{customized property}": "string"
}
}
BackupPolicy obiektów
Ustaw właściwość , aby określić typ obiektu.
W przypadku continuousużyj:
{
"continuousModeProperties": {
"tier": "string"
},
"type": "Continuous"
}
W przypadku okresowychużyj:
{
"periodicModeProperties": {
"backupIntervalInMinutes": "int",
"backupRetentionIntervalInHours": "int",
"backupStorageRedundancy": "string"
},
"type": "Periodic"
}
Wartości właściwości
AnalyticalStorageConfiguration
| Nazwa | Opis | Wartość |
|---|---|---|
| schemaType | Opisuje typy schematu dla magazynu analitycznego. | "FullFidelity" "WellDefined" |
Właściwości interfejsu API
| Nazwa | Opis | Wartość |
|---|---|---|
| serverVersion | Opisuje ServerVersion konta bazy danych MongoDB. | '3.2' '3.6' '4.0' '4.2' |
BackupPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| migrationState | Obiekt reprezentujący stan migracji między zasadami tworzenia kopii zapasowych. | BackupPolicyMigrationState |
| typ | Ustaw wartość "Continuous" dla typu ContinuousModeBackupPolicy. Ustaw wartość "Periodic" dla typu PeriodicModeBackupPolicy. | "Ciągły" "Okresowe" (wymagane) |
BackupPolicyMigrationState
| Nazwa | Opis | Wartość |
|---|---|---|
| startTime | Godzina rozpoczęcia migracji zasad kopii zapasowych (format ISO-8601). | struna |
| stan | Opisuje stan migracji między typami zasad kopii zapasowych. | "Ukończono" "Niepowodzenie" "Ruch przychodzący" "Nieprawidłowy" |
| targetType | Opisuje docelowy typ zasad kopii zapasowych migracji zasad kopii zapasowych. | "Ciągły" "Okresowe" |
Zdolność
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa | Nazwa możliwości usługi Cosmos DB. Na przykład "name": "EnableCassandra". Bieżące wartości obejmują również wartości "EnableTable" i "EnableGremlin". | struna |
Pojemność
| Nazwa | Opis | Wartość |
|---|---|---|
| totalThroughputLimit | Łączny limit przepływności nałożony na konto. SumaThroughputLimit z 2000 r. nakłada ścisły limit maksymalnej przepływności, który można aprowizować na tym koncie na 2000. TotalThroughputLimit -1 wskazuje brak limitów aprowizacji przepływności. | Int Ograniczenia: Minimalna wartość = -1 |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| Nazwa | Opis | Wartość |
|---|
ConsistencyPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| defaultConsistencyLevel | Domyślny poziom spójności i ustawienia konfiguracji konta usługi Cosmos DB. | "BoundedStaleness" "Spójny prefiks" "Ostateczna" "Sesja" "Strong" (wymagane) |
| maxIntervalInSeconds | W przypadku użycia z poziomem spójności Powiązana nieaktualność ta wartość reprezentuje tolerowaną ilość czasu nieaktualności (w sekundach). Zaakceptowany zakres dla tej wartości to 5– 86400. Wymagane, gdy parametr defaultConsistencyPolicy ma ustawioną wartość "BoundedStaleness". | Int Ograniczenia: Minimalna wartość = 5 Wartość maksymalna = 86400 |
| maxStalenessPrefix | W przypadku użycia z poziomem spójności Powiązana nieaktualność ta wartość reprezentuje liczbę nieaktywnych żądań tolerowanych. Akceptowany zakres dla tej wartości to 1 – 2 147 483 647. Wymagane, gdy parametr defaultConsistencyPolicy ma ustawioną wartość "BoundedStaleness". | Int Ograniczenia: Minimalna wartość = 1 Wartość maksymalna = 2147483647 |
ContinuousModeBackupPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| continuousModeProperties | Wartości konfiguracji kopii zapasowej trybu ciągłego | ContinuousModeProperties |
| typ | Opisuje tryb tworzenia kopii zapasowych. | "Continuous" (wymagane) |
ContinuousModeProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| kondygnacja | Wyliczenie wskazujące typ trybu tworzenia kopii zapasowej continuos | "Continuous30Days" "Continuous7Days" |
CorsPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| allowedHeaders | Nagłówki żądań, które domena źródła może określać w żądaniu CORS. | struna |
| allowedMethods | Metody (czasowniki żądań HTTP), których domena pochodzenia może używać dla żądania CORS. | struna |
| allowedOrigins | Domeny pochodzenia, które mogą wysłać żądanie do usługi za pośrednictwem mechanizmu CORS. | ciąg (wymagany) |
| exposedHeaders | Nagłówki odpowiedzi, które mogą być wysyłane w odpowiedzi na żądanie CORS i udostępniane przez przeglądarkę wystawcy żądania. | struna |
| maxAgeInSeconds | Maksymalny czas buforowania żądania OPCJE wstępne w przeglądarce. | Int Ograniczenia: Minimalna wartość = 1 Wartość maksymalna = 2147483647 |
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| analyticalStorageConfiguration | Właściwości specyficzne dla magazynu analitycznego. | AnalyticalStorageConfiguration |
| apiProperties | Właściwości specyficzne dla interfejsu API. Obecnie obsługiwane tylko dla interfejsu API bazy danych MongoDB. | ApiProperties |
| backupPolicy | Obiekt reprezentujący zasady tworzenia kopii zapasowych na koncie. | BackupPolicy |
| Możliwości | Lista możliwości usługi Cosmos DB dla konta | możliwości[] |
| pojemność | Obiekt reprezentujący wszystkie właściwości związane z wymuszaniem pojemności na koncie. | pojemności |
| connectorOffer | Typ oferty łącznika cassandra dla konta bazy danych Cosmos DB C*. | "Mały" |
| consistencyPolicy | Zasady spójności dla konta usługi Cosmos DB. | ConsistencyPolicy |
| cors | Zasady CORS dla konta bazy danych usługi Cosmos DB. | CorsPolicy[] |
| createMode | Wyliczenie wskazujące tryb tworzenia konta. | "Wartość domyślna" "PointInTimeRestore" "Przywracanie" |
| customerManagedKeyStatus | Wskazuje stan funkcji Klucz zarządzany przez klienta na koncie. W przypadku wystąpienia błędów właściwość zawiera wskazówki dotyczące rozwiązywania problemów. | "Potwierdzono dostęp do skonfigurowanego klucza zarządzanego przez klienta". "Dostęp do twojego konta jest obecnie odwołany, ponieważ reguły dostępu blokują żądania wychodzące do usługi Azure Key Vault; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź stronę https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide (4016). "Dostęp do twojego konta jest obecnie odwołany, ponieważ konto usługi Azure Cosmos DB ma niezdefiniowaną tożsamość domyślną; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź stronę https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#invalid-azure-cosmos-db-default-identity (4015). "Dostęp do twojego konta jest obecnie odwołany, ponieważ identyfikator URI klucza magazynu kluczy konta usługi Azure Cosmos DB nie jest zgodne z oczekiwanym formatem; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź stronę https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#improper-syntax-detected-on-the-key-vault-uri-property (4006). "Dostęp do twojego konta jest obecnie odwołany, ponieważ usługa Azure Cosmos DB nie może uzyskać tokenu uwierzytelniania usługi AAD dla tożsamości domyślnej konta; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-active-directory-token-acquisition-error (4000). "Dostęp do twojego konta jest obecnie odwołany, ponieważ usługa Azure Cosmos DB nie może opakowować ani odpakowywać klucza; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź stronę https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#internal-unwrapping-procedure-error (4005). "Dostęp do twojego konta jest obecnie odwołany, ponieważ nie można rozpoznać nazwy DNS usługi Azure Key Vault określonej przez właściwość keyvaultkeyuri konta; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#unable-to-resolve-the-key-vaults-dns (4009). "Dostęp do twojego konta jest obecnie odwołany, ponieważ nie znaleziono korespondenta usługi Azure Key Vault; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź stronę https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-key-vault-resource-not-found (4017). "Dostęp do twojego konta jest obecnie odwołany, ponieważ nie można odnaleźć klucza korespondenta w określonym magazynie kluczy; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź stronę https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-key-vault-resource-not-found (4003). "Dostęp do twojego konta jest obecnie odwołany, ponieważ bieżąca tożsamość domyślna nie ma już uprawnień do skojarzonego klucza usługi Key Vault; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź stronę https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#default-identity-is-unauthorized-to-access-the-azure-key-vault-key (4002). "Dostęp do twojego konta jest obecnie odwołany; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź stronę https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide" |
| databaseAccountOfferType | Typ oferty bazy danych | "Standardowa" (wymagana) |
| defaultIdentity | Domyślna tożsamość na potrzeby uzyskiwania dostępu do magazynu kluczy używanych w funkcjach, takich jak klucze zarządzane przez klienta. Tożsamość domyślna musi być jawnie ustawiona przez użytkowników. Może to być "FirstPartyIdentity", "SystemAssignedIdentity" i nie tylko. | struna |
| defaultPriorityLevel | Wyliczenie wskazujące domyślny poziom priorytetu żądania dla wykonania na podstawie priorytetu. | "Wysoki" "Niski" |
| diagnosticLogSettings | Obiekt reprezentujący różne ustawienia dziennika diagnostycznego dla konta usługi Cosmos DB. | DiagnosticLogSettings |
| disableKeyBasedMetadataWriteAccess | Wyłączanie operacji zapisu na zasobach metadanych (bazach danych, kontenerach, przepływności) za pomocą kluczy konta | Bool |
| disableLocalAuth | Rezygnacja z uwierzytelniania lokalnego i upewnienie się, że do uwierzytelniania można używać tylko tożsamości usługi zarządzanej i usługi AAD. | Bool |
| enableAnalyticalStorage | Flaga wskazująca, czy włączyć analizę magazynu. | Bool |
| enableAutomaticFailover | Włącza automatyczne przełączanie w tryb failover regionu zapisu w rzadkim przypadku, że region jest niedostępny z powodu awarii. Automatyczne przełączanie w tryb failover spowoduje utworzenie nowego regionu zapisu dla konta i zostanie wybrane na podstawie priorytetów trybu failover skonfigurowanych dla konta. | Bool |
| enableBurstCapacity | Flaga wskazująca włączanie/wyłączanie funkcji Burst Capacity Preview na koncie | Bool |
| enableCassandraConnector | Włącza łącznik cassandra na koncie usługi Cosmos DB C* | Bool |
| enableFreeTier | Flaga wskazująca, czy warstwa Bezpłatna jest włączona. | Bool |
| enableMaterializedViews | Flaga wskazująca, czy włączyć materializedViews na koncie usługi Cosmos DB | Bool |
| enableMultipleWriteLocations | Umożliwia zapisanie konta w wielu lokalizacjach | Bool |
| enablePartitionMerge | Flaga wskazująca włączanie/wyłączanie funkcji Scalanie partycji na koncie | Bool |
| enablePriorityBasedExecution | Flaga wskazująca włączanie/wyłączanie funkcji podglądu wykonywania na podstawie priorytetu na koncie | Bool |
| ipRules | Lista adresów IPRules. | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | Flaga wskazująca, czy należy włączyć/wyłączyć reguły listy ACL sieci wirtualnej. | Bool |
| keyVaultKeyUri | Identyfikator URI magazynu kluczy | struna |
| Lokalizacje | Tablica zawierająca lokalizacje georeplikacji włączone dla konta usługi Cosmos DB. | lokalizacji [] (wymagane) |
| minimalTlsVersion | Wskazuje minimalną dozwoloną wersję protokołu Tls. Wartość domyślna to Tls 1.0, z wyjątkiem interfejsów API Cassandra i Mongo, które działają tylko z protokołem Tls 1.2. | "Tls" "Tls11" "Tls12" |
| networkAclBypass | Wskazuje, jakie usługi mogą pomijać kontrole zapory. | "AzureServices" "Brak" |
| networkAclBypassResourceIds | Tablica zawierająca identyfikatory zasobów dla obejścia listy Acl sieci dla konta usługi Cosmos DB. | string[] |
| publicNetworkAccess | Czy żądania z sieci publicznej są dozwolone | "Wyłączone" "Włączone" "SecuredByPerimeter" |
| restoreParameters | Parametry wskazujące informacje o przywracaniu. | RestoreParameters |
| virtualNetworkRules | Lista reguł listy ACL sieci wirtualnej skonfigurowanych dla konta usługi Cosmos DB. | VirtualNetworkRule [] |
DatabaseRestoreResource
| Nazwa | Opis | Wartość |
|---|---|---|
| collectionNames | Nazwy kolekcji dostępnych do przywrócenia. | string[] |
| databaseName | Nazwa bazy danych dostępnej do przywrócenia. | struna |
DiagnosticLogSettings
| Nazwa | Opis | Wartość |
|---|---|---|
| enableFullTextQuery | Opisz poziom szczegółowości, za pomocą którego zapytania mają być rejestrowane. | "Fałsz" "Brak" "True" |
GremlinDatabaseRestoreResource
| Nazwa | Opis | Wartość |
|---|---|---|
| databaseName | Nazwa bazy danych gremlin dostępnej do przywrócenia. | struna |
| graphNames | Nazwy grafów dostępnych do przywrócenia. | string[] |
IpAddressOrRange
| Nazwa | Opis | Wartość |
|---|---|---|
| ipAddressOrRange | Pojedynczy adres IPv4 lub pojedynczy zakres adresów IPv4 w formacie CIDR. Podane adresy IP muszą być poprawnie sformatowane i nie mogą być zawarte w jednym z następujących zakresów: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, ponieważ nie są one wymuszane przez filtr adresu IP. Przykład prawidłowych danych wejściowych: "23.40.210.245" lub "23.40.210.0/8". | struna |
Lokalizacja
| Nazwa | Opis | Wartość |
|---|---|---|
| tryb failoverPriority | Priorytet pracy w trybie failover regionu. Priorytet pracy w trybie failover 0 wskazuje region zapisu. Maksymalna wartość priorytetu trybu failover = (całkowita liczba regionów — 1). Wartości priorytetów trybu failover muszą być unikatowe dla każdego z regionów, w których istnieje konto bazy danych. | Int Ograniczenia: Minimalna wartość = 0 |
| isZoneRedundant | Flaga wskazująca, czy ten region jest regionem AvailabilityZone | Bool |
| locationName | Nazwa regionu. | struna |
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" |
| userAssignedIdentities | 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}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Nazwa | Opis | Wartość |
|---|
Microsoft.DocumentDB/databaseAccounts
| Nazwa | Opis | Wartość |
|---|---|---|
| apiVersion | Wersja interfejsu API | "2023-09-15-preview" |
| tożsamość | Tożsamość zasobu. | ManagedServiceIdentity |
| rodzaj | Wskazuje typ konta bazy danych. Można to ustawić tylko podczas tworzenia konta bazy danych. | "GlobalDocumentDB" "MongoDB" "Analizowanie" |
| lokalizacja | Lokalizacja grupy zasobów, do której należy zasób. | struna |
| nazwa | Nazwa zasobu | struna Ograniczenia: Minimalna długość = 3 Maksymalna długość = 3 Wzorzec = ^[a-z0-9]+(-[a-z0-9]+)* (wymagane) |
| Właściwości | Właściwości do tworzenia i aktualizowania kont bazy danych usługi Azure Cosmos DB. | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (wymagane) |
| Tagi | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
| typ | Typ zasobu | "Microsoft.DocumentDB/databaseAccounts" |
PeriodicModeBackupPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| periodicModeProperties | Wartości konfiguracji dla kopii zapasowej w trybie okresowym | periodicModeProperties |
| typ | Opisuje tryb tworzenia kopii zapasowych. | "Okresowe" (wymagane) |
Właściwości periodicModeProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| backupIntervalInMinutes | Liczba całkowita reprezentująca interwał w minutach między dwoma kopiami zapasowymi | Int Ograniczenia: Minimalna wartość = 0 |
| backupRetentionIntervalInHours | Liczba całkowita reprezentująca czas (w godzinach), przez który każda kopia zapasowa jest zachowywana | Int Ograniczenia: Minimalna wartość = 0 |
| backupStorageRedundancy | Wyliczenie wskazujące typ miejsca przechowywania kopii zapasowych | "Geo" "Lokalny" "Strefa" |
RestoreParameters
| Nazwa | Opis | Wartość |
|---|---|---|
| databasesToRestore | Lista określonych baz danych dostępnych do przywrócenia. | DatabaseRestoreResource[] |
| gremlinDatabasesToRestore | Lista określonych baz danych gremlin dostępnych do przywrócenia. | GremlinDatabaseRestoreResource[] |
| restoreMode | Opisuje tryb przywracania. | "PointInTime" |
| restoreSource | Identyfikator przywracalnego konta bazy danych, z którego należy zainicjować przywracanie. Na przykład: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | struna |
| restoreTimestampInUtc | Godzina przywrócenia konta (format ISO-8601). | struna |
| sourceBackupLocation | Źródłowa lokalizacja kopii zapasowej do przywrócenia. | struna |
| tablesToRestore | Lista określonych tabel dostępnych do przywrócenia. | string[] |
Tagi
| Nazwa | Opis | Wartość |
|---|
VirtualNetworkRule
| Nazwa | Opis | Wartość |
|---|---|---|
| id | Identyfikator zasobu podsieci, na przykład: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. | struna |
| ignoreMissingVNetServiceEndpoint | Utwórz regułę zapory, zanim sieć wirtualna ma włączony punkt końcowy usługi sieci wirtualnej. | Bool |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają 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. |
|
konto usługi Azure Cosmos DB przy użyciu usługi Web App wdrażanie |
Ten szablon wdraża konto usługi Azure Cosmos DB, plan usługi App Service i tworzy aplikację internetową w planie usługi App Service. Dodaje również dwa ustawienia aplikacji do aplikacji internetowej odwołującej się do punktu końcowego konta usługi Azure Cosmos DB. Dzięki temu rozwiązania wdrożone w aplikacji internetowej mogą łączyć się z punktem końcowym konta usługi Azure Cosmos DB przy użyciu tych ustawień. |
|
ciągłej integracji/ciągłego wdrażania przy użyciu narzędzia Jenkins w usłudze Azure Container Service (AKS) wdrażanie |
Kontenery ułatwiają ciągłe kompilowanie i wdrażanie aplikacji. Organizując wdrażanie tych kontenerów przy użyciu platformy Kubernetes w usłudze Azure Container Service, można osiągnąć replikowalne klastry kontenerów, którymi można zarządzać. Konfigurując ciągłą kompilację w celu tworzenia obrazów kontenerów i aranżacji, możesz zwiększyć szybkość i niezawodność wdrożenia. |
|
Tworzenie konta usługi Cosmos DB z włączoną usługą Microsoft Defender wdrażanie |
Korzystając z tego szablonu usługi ARM, możesz wdrożyć konto usługi Azure Cosmos DB z włączoną usługą Microsoft Defender dla usługi Azure Cosmos DB. Usługa Microsoft Defender dla usługi Azure Cosmos DB to natywna dla platformy Azure warstwa zabezpieczeń, która wykrywa próby wykorzystania baz danych na kontach usługi Azure Cosmos DB. Usługa Microsoft Defender dla usługi Azure Cosmos DB wykrywa potencjalne wstrzyknięcia kodu SQL, znane złe podmioty oparte na usłudze Microsoft Threat Intelligence, podejrzane wzorce dostępu i potencjalne wykorzystanie bazy danych za pośrednictwem tożsamości z naruszonymi zagrożeniami lub złośliwych testerów. |
|
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 minimalnego konta usługi Azure Cosmos DB dla interfejsu API Core (SQL) wdrażanie |
Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API Core (SQL) przy jednoczesnym określeniu tylko minimalnych wymaganych właściwości zasobów. |
|
Tworzenie bezserwerowego konta usługi Azure Cosmos DB dla interfejsu API SQL wdrażanie |
Ten szablon tworzy bezserwerowe konto usługi Azure Cosmos DB dla interfejsu API Core (SQL). |
|
Tworzenie bezobsługowego konta usługi Azure Cosmos i usługi Azure Web App wdrażanie |
Ten szablon tworzy konto usługi Azure Cosmos, wprowadza punkt końcowy i klucze usługi Cosmos DB do ustawień aplikacji internetowej platformy Azure, a następnie wdraża aplikację internetową ASP MVC z usługi GitHub. |
|
Tworzenie konta usługi Azure Cosmos dla interfejsu API bazy danych MongoDB wdrażanie |
Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API bazy danych MongoDB 4.2 w dwóch regionach przy użyciu udostępnionej i dedykowanej przepływności z dwiema kolekcjami. |
|
Tworzenie konta usługi Azure Cosmos dla interfejsu API bazy danych MongoDB wdrażanie |
Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API bazy danych MongoDB 4.2 w dwóch regionach przy użyciu udostępnionej i dedykowanej przepływności autoskalowania. |
|
Tworzenie konta usługi Azure Cosmos dla interfejsu API tabel wdrażanie |
Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API tabel w dwóch regionach i jedną tabelę z aprowizowaną przepływnością. |
|
Tworzenie konta usługi Azure Cosmos dla interfejsu API tabel przy użyciu skalowania automatycznego wdrażanie |
Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API tabel w dwóch regionach i jedną tabelę z przepływnością autoskalowania. |
|
Tworzenie konta usługi Azure Cosmos DB dla interfejsu API Cassandra wdrażanie |
Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API Cassandra w dwóch regionach z przestrzenią kluczy i tabelą z dedykowaną przepływnością. |
|
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 konta usługi Azure Cosmos DB dla interfejsu API języka Gremlin wdrażanie |
Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API języka Gremlin w dwóch regionach z jedną bazą danych i jednym grafem przy użyciu dedykowanej przepływności. |
|
Tworzenie konta usługi Azure Cosmos DB na potrzeby automatycznego skalowania interfejsu API języka Gremlin wdrażanie |
Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API języka Gremlin w dwóch regionach z jedną bazą danych i jednym grafem przy użyciu przepływności autoskalowania. |
|
Tworzenie konta usługi Azure Cosmos DB w wielu regionach wdrażanie |
Ten szablon tworzy konto usługi Azure Cosmos DB dla dowolnego typu interfejsu API bazy danych z regionem podstawowym i pomocniczym z wybranym poziomem spójności i typem trybu failover. |
|
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 konta usługi Azure Cosmos DB z prywatnym punktem końcowym wdrażanie |
Ten szablon spowoduje utworzenie konta usługi Cosmos, sieci wirtualnej i prywatnego punktu końcowego uwidaczniającego konto usługi Cosmos w sieci wirtualnej. |
|
Tworzenie konta SQL usługi Azure Cosmos DB przy użyciu kontroli dostępu opartej na rolach płaszczyzny danych wdrażanie |
Ten szablon utworzy konto usługi SQL Cosmos, natywnie zachowaną definicję roli i natywnie obsługiwane przypisanie roli dla tożsamości usługi AAD. |
|
tworzenie konta usługi Azure CosmosDB wdrażanie |
Ten szablon usługi ARM ma na celu szybkie utworzenie konta usługi CosmosDB z minimalnymi wymaganymi wartościami |
|
Tworzenie automatycznego skalowania konta usługi Azure Cosmos DB dla interfejsu API Cassandra wdrażanie |
Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API Cassandra w dwóch regionach z przestrzenią kluczy i tabelą z przepływnością autoskalowania. |
|
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. |
|
tworzenie usługi Azure Cosmos przy użyciu interfejsu API SQL i wielu kontenerów wdrażanie |
Szablon tworzy kontener usługi Cosmos za pomocą interfejsu API SQL i umożliwia dodawanie kontenerów mulitple. |
|
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. |
|
web app with a SQL Database, Azure Cosmos DB, Azure Search wdrażanie |
Ten szablon aprowizuje aplikację internetową, bazę danych SQL Database, usługę Azure Cosmos DB, usługę Azure Search i usługę Application Insights. |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu databaseAccounts można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts, dodaj następujący program Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts@2023-09-15-preview"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
kind = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
analyticalStorageConfiguration = {
schemaType = "string"
}
apiProperties = {
serverVersion = "string"
}
backupPolicy = {
migrationState = {
startTime = "string"
status = "string"
targetType = "string"
}
type = "string"
// For remaining properties, see BackupPolicy objects
}
capabilities = [
{
name = "string"
}
]
capacity = {
totalThroughputLimit = int
}
connectorOffer = "string"
consistencyPolicy = {
defaultConsistencyLevel = "string"
maxIntervalInSeconds = int
maxStalenessPrefix = int
}
cors = [
{
allowedHeaders = "string"
allowedMethods = "string"
allowedOrigins = "string"
exposedHeaders = "string"
maxAgeInSeconds = int
}
]
createMode = "string"
customerManagedKeyStatus = "string"
databaseAccountOfferType = "Standard"
defaultIdentity = "string"
defaultPriorityLevel = "string"
diagnosticLogSettings = {
enableFullTextQuery = "string"
}
disableKeyBasedMetadataWriteAccess = bool
disableLocalAuth = bool
enableAnalyticalStorage = bool
enableAutomaticFailover = bool
enableBurstCapacity = bool
enableCassandraConnector = bool
enableFreeTier = bool
enableMaterializedViews = bool
enableMultipleWriteLocations = bool
enablePartitionMerge = bool
enablePriorityBasedExecution = bool
ipRules = [
{
ipAddressOrRange = "string"
}
]
isVirtualNetworkFilterEnabled = bool
keyVaultKeyUri = "string"
locations = [
{
failoverPriority = int
isZoneRedundant = bool
locationName = "string"
}
]
minimalTlsVersion = "string"
networkAclBypass = "string"
networkAclBypassResourceIds = [
"string"
]
publicNetworkAccess = "string"
restoreParameters = {
databasesToRestore = [
{
collectionNames = [
"string"
]
databaseName = "string"
}
]
gremlinDatabasesToRestore = [
{
databaseName = "string"
graphNames = [
"string"
]
}
]
restoreMode = "string"
restoreSource = "string"
restoreTimestampInUtc = "string"
sourceBackupLocation = "string"
tablesToRestore = [
"string"
]
}
virtualNetworkRules = [
{
id = "string"
ignoreMissingVNetServiceEndpoint = bool
}
]
}
})
}
BackupPolicy obiektów
Ustaw właściwość , aby określić typ obiektu.
W przypadku continuousużyj:
{
continuousModeProperties = {
tier = "string"
}
type = "Continuous"
}
W przypadku okresowychużyj:
{
periodicModeProperties = {
backupIntervalInMinutes = int
backupRetentionIntervalInHours = int
backupStorageRedundancy = "string"
}
type = "Periodic"
}
Wartości właściwości
AnalyticalStorageConfiguration
| Nazwa | Opis | Wartość |
|---|---|---|
| schemaType | Opisuje typy schematu dla magazynu analitycznego. | "FullFidelity" "WellDefined" |
Właściwości interfejsu API
| Nazwa | Opis | Wartość |
|---|---|---|
| serverVersion | Opisuje ServerVersion konta bazy danych MongoDB. | '3.2' '3.6' '4.0' '4.2' |
BackupPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| migrationState | Obiekt reprezentujący stan migracji między zasadami tworzenia kopii zapasowych. | BackupPolicyMigrationState |
| typ | Ustaw wartość "Continuous" dla typu ContinuousModeBackupPolicy. Ustaw wartość "Periodic" dla typu PeriodicModeBackupPolicy. | "Ciągły" "Okresowe" (wymagane) |
BackupPolicyMigrationState
| Nazwa | Opis | Wartość |
|---|---|---|
| startTime | Godzina rozpoczęcia migracji zasad kopii zapasowych (format ISO-8601). | struna |
| stan | Opisuje stan migracji między typami zasad kopii zapasowych. | "Ukończono" "Niepowodzenie" "Ruch przychodzący" "Nieprawidłowy" |
| targetType | Opisuje docelowy typ zasad kopii zapasowych migracji zasad kopii zapasowych. | "Ciągły" "Okresowe" |
Zdolność
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa | Nazwa możliwości usługi Cosmos DB. Na przykład "name": "EnableCassandra". Bieżące wartości obejmują również wartości "EnableTable" i "EnableGremlin". | struna |
Pojemność
| Nazwa | Opis | Wartość |
|---|---|---|
| totalThroughputLimit | Łączny limit przepływności nałożony na konto. SumaThroughputLimit z 2000 r. nakłada ścisły limit maksymalnej przepływności, który można aprowizować na tym koncie na 2000. TotalThroughputLimit -1 wskazuje brak limitów aprowizacji przepływności. | Int Ograniczenia: Minimalna wartość = -1 |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| Nazwa | Opis | Wartość |
|---|
ConsistencyPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| defaultConsistencyLevel | Domyślny poziom spójności i ustawienia konfiguracji konta usługi Cosmos DB. | "BoundedStaleness" "Spójny prefiks" "Ostateczna" "Sesja" "Strong" (wymagane) |
| maxIntervalInSeconds | W przypadku użycia z poziomem spójności Powiązana nieaktualność ta wartość reprezentuje tolerowaną ilość czasu nieaktualności (w sekundach). Zaakceptowany zakres dla tej wartości to 5– 86400. Wymagane, gdy parametr defaultConsistencyPolicy ma ustawioną wartość "BoundedStaleness". | Int Ograniczenia: Minimalna wartość = 5 Wartość maksymalna = 86400 |
| maxStalenessPrefix | W przypadku użycia z poziomem spójności Powiązana nieaktualność ta wartość reprezentuje liczbę nieaktywnych żądań tolerowanych. Akceptowany zakres dla tej wartości to 1 – 2 147 483 647. Wymagane, gdy parametr defaultConsistencyPolicy ma ustawioną wartość "BoundedStaleness". | Int Ograniczenia: Minimalna wartość = 1 Wartość maksymalna = 2147483647 |
ContinuousModeBackupPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| continuousModeProperties | Wartości konfiguracji kopii zapasowej trybu ciągłego | ContinuousModeProperties |
| typ | Opisuje tryb tworzenia kopii zapasowych. | "Continuous" (wymagane) |
ContinuousModeProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| kondygnacja | Wyliczenie wskazujące typ trybu tworzenia kopii zapasowej continuos | "Continuous30Days" "Continuous7Days" |
CorsPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| allowedHeaders | Nagłówki żądań, które domena źródła może określać w żądaniu CORS. | struna |
| allowedMethods | Metody (czasowniki żądań HTTP), których domena pochodzenia może używać dla żądania CORS. | struna |
| allowedOrigins | Domeny pochodzenia, które mogą wysłać żądanie do usługi za pośrednictwem mechanizmu CORS. | ciąg (wymagany) |
| exposedHeaders | Nagłówki odpowiedzi, które mogą być wysyłane w odpowiedzi na żądanie CORS i udostępniane przez przeglądarkę wystawcy żądania. | struna |
| maxAgeInSeconds | Maksymalny czas buforowania żądania OPCJE wstępne w przeglądarce. | Int Ograniczenia: Minimalna wartość = 1 Wartość maksymalna = 2147483647 |
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| analyticalStorageConfiguration | Właściwości specyficzne dla magazynu analitycznego. | AnalyticalStorageConfiguration |
| apiProperties | Właściwości specyficzne dla interfejsu API. Obecnie obsługiwane tylko dla interfejsu API bazy danych MongoDB. | ApiProperties |
| backupPolicy | Obiekt reprezentujący zasady tworzenia kopii zapasowych na koncie. | BackupPolicy |
| Możliwości | Lista możliwości usługi Cosmos DB dla konta | możliwości[] |
| pojemność | Obiekt reprezentujący wszystkie właściwości związane z wymuszaniem pojemności na koncie. | pojemności |
| connectorOffer | Typ oferty łącznika cassandra dla konta bazy danych Cosmos DB C*. | "Mały" |
| consistencyPolicy | Zasady spójności dla konta usługi Cosmos DB. | ConsistencyPolicy |
| cors | Zasady CORS dla konta bazy danych usługi Cosmos DB. | CorsPolicy[] |
| createMode | Wyliczenie wskazujące tryb tworzenia konta. | "Wartość domyślna" "PointInTimeRestore" "Przywracanie" |
| customerManagedKeyStatus | Wskazuje stan funkcji Klucz zarządzany przez klienta na koncie. W przypadku wystąpienia błędów właściwość zawiera wskazówki dotyczące rozwiązywania problemów. | "Potwierdzono dostęp do skonfigurowanego klucza zarządzanego przez klienta". "Dostęp do twojego konta jest obecnie odwołany, ponieważ reguły dostępu blokują żądania wychodzące do usługi Azure Key Vault; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź stronę https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide (4016). "Dostęp do twojego konta jest obecnie odwołany, ponieważ konto usługi Azure Cosmos DB ma niezdefiniowaną tożsamość domyślną; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź stronę https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#invalid-azure-cosmos-db-default-identity (4015). "Dostęp do twojego konta jest obecnie odwołany, ponieważ identyfikator URI klucza magazynu kluczy konta usługi Azure Cosmos DB nie jest zgodne z oczekiwanym formatem; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź stronę https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#improper-syntax-detected-on-the-key-vault-uri-property (4006). "Dostęp do twojego konta jest obecnie odwołany, ponieważ usługa Azure Cosmos DB nie może uzyskać tokenu uwierzytelniania usługi AAD dla tożsamości domyślnej konta; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-active-directory-token-acquisition-error (4000). "Dostęp do twojego konta jest obecnie odwołany, ponieważ usługa Azure Cosmos DB nie może opakowować ani odpakowywać klucza; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź stronę https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#internal-unwrapping-procedure-error (4005). "Dostęp do twojego konta jest obecnie odwołany, ponieważ nie można rozpoznać nazwy DNS usługi Azure Key Vault określonej przez właściwość keyvaultkeyuri konta; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#unable-to-resolve-the-key-vaults-dns (4009). "Dostęp do twojego konta jest obecnie odwołany, ponieważ nie znaleziono korespondenta usługi Azure Key Vault; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź stronę https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-key-vault-resource-not-found (4017). "Dostęp do twojego konta jest obecnie odwołany, ponieważ nie można odnaleźć klucza korespondenta w określonym magazynie kluczy; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź stronę https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-key-vault-resource-not-found (4003). "Dostęp do twojego konta jest obecnie odwołany, ponieważ bieżąca tożsamość domyślna nie ma już uprawnień do skojarzonego klucza usługi Key Vault; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź stronę https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#default-identity-is-unauthorized-to-access-the-azure-key-vault-key (4002). "Dostęp do twojego konta jest obecnie odwołany; Aby uzyskać więcej informacji na temat tego błędu i sposobu przywracania dostępu do konta, odwiedź stronę https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide" |
| databaseAccountOfferType | Typ oferty bazy danych | "Standardowa" (wymagana) |
| defaultIdentity | Domyślna tożsamość na potrzeby uzyskiwania dostępu do magazynu kluczy używanych w funkcjach, takich jak klucze zarządzane przez klienta. Tożsamość domyślna musi być jawnie ustawiona przez użytkowników. Może to być "FirstPartyIdentity", "SystemAssignedIdentity" i nie tylko. | struna |
| defaultPriorityLevel | Wyliczenie wskazujące domyślny poziom priorytetu żądania dla wykonania na podstawie priorytetu. | "Wysoki" "Niski" |
| diagnosticLogSettings | Obiekt reprezentujący różne ustawienia dziennika diagnostycznego dla konta usługi Cosmos DB. | DiagnosticLogSettings |
| disableKeyBasedMetadataWriteAccess | Wyłączanie operacji zapisu na zasobach metadanych (bazach danych, kontenerach, przepływności) za pomocą kluczy konta | Bool |
| disableLocalAuth | Rezygnacja z uwierzytelniania lokalnego i upewnienie się, że do uwierzytelniania można używać tylko tożsamości usługi zarządzanej i usługi AAD. | Bool |
| enableAnalyticalStorage | Flaga wskazująca, czy włączyć analizę magazynu. | Bool |
| enableAutomaticFailover | Włącza automatyczne przełączanie w tryb failover regionu zapisu w rzadkim przypadku, że region jest niedostępny z powodu awarii. Automatyczne przełączanie w tryb failover spowoduje utworzenie nowego regionu zapisu dla konta i zostanie wybrane na podstawie priorytetów trybu failover skonfigurowanych dla konta. | Bool |
| enableBurstCapacity | Flaga wskazująca włączanie/wyłączanie funkcji Burst Capacity Preview na koncie | Bool |
| enableCassandraConnector | Włącza łącznik cassandra na koncie usługi Cosmos DB C* | Bool |
| enableFreeTier | Flaga wskazująca, czy warstwa Bezpłatna jest włączona. | Bool |
| enableMaterializedViews | Flaga wskazująca, czy włączyć materializedViews na koncie usługi Cosmos DB | Bool |
| enableMultipleWriteLocations | Umożliwia zapisanie konta w wielu lokalizacjach | Bool |
| enablePartitionMerge | Flaga wskazująca włączanie/wyłączanie funkcji Scalanie partycji na koncie | Bool |
| enablePriorityBasedExecution | Flaga wskazująca włączanie/wyłączanie funkcji podglądu wykonywania na podstawie priorytetu na koncie | Bool |
| ipRules | Lista adresów IPRules. | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | Flaga wskazująca, czy należy włączyć/wyłączyć reguły listy ACL sieci wirtualnej. | Bool |
| keyVaultKeyUri | Identyfikator URI magazynu kluczy | struna |
| Lokalizacje | Tablica zawierająca lokalizacje georeplikacji włączone dla konta usługi Cosmos DB. | lokalizacji [] (wymagane) |
| minimalTlsVersion | Wskazuje minimalną dozwoloną wersję protokołu Tls. Wartość domyślna to Tls 1.0, z wyjątkiem interfejsów API Cassandra i Mongo, które działają tylko z protokołem Tls 1.2. | "Tls" "Tls11" "Tls12" |
| networkAclBypass | Wskazuje, jakie usługi mogą pomijać kontrole zapory. | "AzureServices" "Brak" |
| networkAclBypassResourceIds | Tablica zawierająca identyfikatory zasobów dla obejścia listy Acl sieci dla konta usługi Cosmos DB. | string[] |
| publicNetworkAccess | Czy żądania z sieci publicznej są dozwolone | "Wyłączone" "Włączone" "SecuredByPerimeter" |
| restoreParameters | Parametry wskazujące informacje o przywracaniu. | RestoreParameters |
| virtualNetworkRules | Lista reguł listy ACL sieci wirtualnej skonfigurowanych dla konta usługi Cosmos DB. | VirtualNetworkRule [] |
DatabaseRestoreResource
| Nazwa | Opis | Wartość |
|---|---|---|
| collectionNames | Nazwy kolekcji dostępnych do przywrócenia. | string[] |
| databaseName | Nazwa bazy danych dostępnej do przywrócenia. | struna |
DiagnosticLogSettings
| Nazwa | Opis | Wartość |
|---|---|---|
| enableFullTextQuery | Opisz poziom szczegółowości, za pomocą którego zapytania mają być rejestrowane. | "Fałsz" "Brak" "True" |
GremlinDatabaseRestoreResource
| Nazwa | Opis | Wartość |
|---|---|---|
| databaseName | Nazwa bazy danych gremlin dostępnej do przywrócenia. | struna |
| graphNames | Nazwy grafów dostępnych do przywrócenia. | string[] |
IpAddressOrRange
| Nazwa | Opis | Wartość |
|---|---|---|
| ipAddressOrRange | Pojedynczy adres IPv4 lub pojedynczy zakres adresów IPv4 w formacie CIDR. Podane adresy IP muszą być poprawnie sformatowane i nie mogą być zawarte w jednym z następujących zakresów: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, ponieważ nie są one wymuszane przez filtr adresu IP. Przykład prawidłowych danych wejściowych: "23.40.210.245" lub "23.40.210.0/8". | struna |
Lokalizacja
| Nazwa | Opis | Wartość |
|---|---|---|
| tryb failoverPriority | Priorytet pracy w trybie failover regionu. Priorytet pracy w trybie failover 0 wskazuje region zapisu. Maksymalna wartość priorytetu trybu failover = (całkowita liczba regionów — 1). Wartości priorytetów trybu failover muszą być unikatowe dla każdego z regionów, w których istnieje konto bazy danych. | Int Ograniczenia: Minimalna wartość = 0 |
| isZoneRedundant | Flaga wskazująca, czy ten region jest regionem AvailabilityZone | Bool |
| locationName | Nazwa regionu. | struna |
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" |
| userAssignedIdentities | 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}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Nazwa | Opis | Wartość |
|---|
Microsoft.DocumentDB/databaseAccounts
| Nazwa | Opis | Wartość |
|---|---|---|
| tożsamość | Tożsamość zasobu. | ManagedServiceIdentity |
| rodzaj | Wskazuje typ konta bazy danych. Można to ustawić tylko podczas tworzenia konta bazy danych. | "GlobalDocumentDB" "MongoDB" "Analizowanie" |
| lokalizacja | Lokalizacja grupy zasobów, do której należy zasób. | struna |
| nazwa | Nazwa zasobu | struna Ograniczenia: Minimalna długość = 3 Maksymalna długość = 3 Wzorzec = ^[a-z0-9]+(-[a-z0-9]+)* (wymagane) |
| Właściwości | Właściwości do tworzenia i aktualizowania kont bazy danych usługi Azure Cosmos DB. | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (wymagane) |
| Tagi | Tagi zasobów | Słownik nazw tagów i wartości. |
| typ | Typ zasobu | "Microsoft.DocumentDB/databaseAccounts@2023-09-15-preview" |
PeriodicModeBackupPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| periodicModeProperties | Wartości konfiguracji dla kopii zapasowej w trybie okresowym | periodicModeProperties |
| typ | Opisuje tryb tworzenia kopii zapasowych. | "Okresowe" (wymagane) |
Właściwości periodicModeProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| backupIntervalInMinutes | Liczba całkowita reprezentująca interwał w minutach między dwoma kopiami zapasowymi | Int Ograniczenia: Minimalna wartość = 0 |
| backupRetentionIntervalInHours | Liczba całkowita reprezentująca czas (w godzinach), przez który każda kopia zapasowa jest zachowywana | Int Ograniczenia: Minimalna wartość = 0 |
| backupStorageRedundancy | Wyliczenie wskazujące typ miejsca przechowywania kopii zapasowych | "Geo" "Lokalny" "Strefa" |
RestoreParameters
| Nazwa | Opis | Wartość |
|---|---|---|
| databasesToRestore | Lista określonych baz danych dostępnych do przywrócenia. | DatabaseRestoreResource[] |
| gremlinDatabasesToRestore | Lista określonych baz danych gremlin dostępnych do przywrócenia. | GremlinDatabaseRestoreResource[] |
| restoreMode | Opisuje tryb przywracania. | "PointInTime" |
| restoreSource | Identyfikator przywracalnego konta bazy danych, z którego należy zainicjować przywracanie. Na przykład: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | struna |
| restoreTimestampInUtc | Godzina przywrócenia konta (format ISO-8601). | struna |
| sourceBackupLocation | Źródłowa lokalizacja kopii zapasowej do przywrócenia. | struna |
| tablesToRestore | Lista określonych tabel dostępnych do przywrócenia. | string[] |
Tagi
| Nazwa | Opis | Wartość |
|---|
VirtualNetworkRule
| Nazwa | Opis | Wartość |
|---|---|---|
| id | Identyfikator zasobu podsieci, na przykład: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. | struna |
| ignoreMissingVNetServiceEndpoint | Utwórz regułę zapory, zanim sieć wirtualna ma włączony punkt końcowy usługi sieci wirtualnej. | Bool |