Udostępnij za pośrednictwem

Microsoft.DocumentDB databaseAccounts 2023-03-15

  • Artykuł

Definicja zasobu Bicep

Typ zasobu databaseAccounts można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2023-03-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  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: 'Small'
    consistencyPolicy: {
      defaultConsistencyLevel: 'string'
      maxIntervalInSeconds: int
      maxStalenessPrefix: int
    }
    cors: [
      {
        allowedHeaders: 'string'
        allowedMethods: 'string'
        allowedOrigins: 'string'
        exposedHeaders: 'string'
        maxAgeInSeconds: int
      }
    ]
    createMode: 'string'
    databaseAccountOfferType: 'Standard'
    defaultIdentity: 'string'
    disableKeyBasedMetadataWriteAccess: bool
    disableLocalAuth: bool
    enableAnalyticalStorage: bool
    enableAutomaticFailover: bool
    enableCassandraConnector: bool
    enableFreeTier: bool
    enableMultipleWriteLocations: bool
    enablePartitionMerge: 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: 'PointInTime'
      restoreSource: 'string'
      restoreTimestampInUtc: 'string'
      tablesToRestore: [
        'string'
      ]
    }
    virtualNetworkRules: [
      {
        id: 'string'
        ignoreMissingVNetServiceEndpoint: bool
      }
    ]
  }
}

Obiekty BackupPolicy

Ustaw właściwość type , aby określić typ obiektu.

W przypadku ciągłego użycia użyj:

  type: 'Continuous'

W przypadku opcji Okresowe użyj:

  type: 'Periodic'
  periodicModeProperties: {
    backupIntervalInMinutes: int
    backupRetentionIntervalInHours: int
    backupStorageRedundancy: 'string'
  }

Wartości właściwości

databaseAccounts

Nazwa Opis Wartość
name Nazwa zasobu ciąg (wymagany)

Limit znaków: 3–44

Prawidłowe znaki:
Wyłącznie małe litery, cyfry i łączniki.

Zacznij od małej litery lub cyfry.

Nazwa zasobu musi być unikatowa na platformie Azure.
location Lokalizacja grupy zasobów, do której należy zasób. ciąg
tags Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą służyć do wyświetlania i grupowania tego zasobu (między grupami zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawiane z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB". Słownik nazw tagów i wartości. Zobacz Tagi w szablonach
Rodzaju Wskazuje typ konta bazy danych. Można to ustawić tylko podczas tworzenia konta bazy danych. "GlobalDocumentDB"
"MongoDB"
"Analizowanie"
identity Tożsamość zasobu. ManagedServiceIdentity
properties Właściwości do tworzenia i aktualizowania kont bazy danych usługi Azure Cosmos DB. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (wymagane)

ManagedServiceIdentity

Nazwa Opis Wartość
typ Typ tożsamości używanej 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 usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nazwa Opis Wartość
{niestandardowa właściwość} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...

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. Właściwości interfejsu API
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[]
capacity Obiekt reprezentujący wszystkie właściwości związane z wymuszaniem pojemności na koncie. Pojemność
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"
"Przywróć"
databaseAccountOfferType Typ oferty bazy danych "Standardowa" (wymagana)
defaultIdentity Domyślna tożsamość na potrzeby uzyskiwania dostępu do magazynu kluczy używanego 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. ciąg
disableKeyBasedMetadataWriteAccess Wyłączanie operacji zapisu dla zasobów metadanych (baz danych, kontenerów, przepływności) za pomocą kluczy konta bool
disableLocalAuth Rezygnacja z uwierzytelniania lokalnego i upewnienie się, że tylko tożsamość usługi zarządzanej i usługi AAD mogą być używane wyłącznie do uwierzytelniania. bool
enableAnalyticalStorage Flaga wskazująca, czy włączyć analizę magazynu. bool
enableAutomaticFailover Włącza automatyczne przełączanie regionu zapisu w tryb failover w rzadkim przypadku niedostępności regionu 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
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
enableMultipleWriteLocations Umożliwia zapisywanie konta w wielu lokalizacjach bool
enablePartitionMerge Flaga wskazująca włączanie/wyłączanie funkcji Scalanie partycji na koncie bool
adresy IPRules Lista reguł IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Flaga wskazująca, czy włączyć/wyłączyć reguły listy ACL sieci wirtualnej. bool
keyVaultKeyUri Identyfikator URI magazynu kluczy ciąg
locations Tablica zawierająca lokalizacje georeplikacji włączone dla konta usługi Cosmos DB. Lokalizacja[] (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. ciąg[]
publicNetworkAccess Czy żądania z sieci publicznej są dozwolone "Wyłączone"
"Włączone"
restoreParameters Parametry wskazujące informacje o przywracaniu. RestoreParameters
virtualNetworkRules Lista reguł listy ACL sieci wirtualnej skonfigurowanych dla konta usługi Cosmos DB. VirtualNetworkRule[]

AnalizaStorageConfiguration

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 Ustawianie typu obiektu Ciągłe
Okresowe (wymagane)

BackupPolicyMigrationState

Nazwa Opis Wartość
startTime Godzina rozpoczęcia migracji zasad kopii zapasowych (format ISO-8601). ciąg
status Opisuje stan migracji między typami zasad kopii zapasowych. "Ukończono"
"Niepowodzenie"
"InProgress"
"Nieprawidłowy"
Targettype Opisuje docelowy typ zasad kopii zapasowej migracji zasad kopii zapasowych. "Ciągły"
"Okresowe"

ContinuousModeBackupPolicy

Nazwa Opis Wartość
typ Opisuje tryb tworzenia kopii zapasowych. "Ciągłe" (wymagane)

PeriodModeBackupPolicy

Nazwa Opis Wartość
typ Opisuje tryb tworzenia kopii zapasowych. "Okresowe" (wymagane)
periodicModeProperties Wartości konfiguracji dla okresowej kopii zapasowej trybu PeriodModeProperties

PeriodModeProperties

Nazwa Opis Wartość
backupIntervalInMinutes Liczba całkowita reprezentująca interwał w minutach między dwiema kopiami zapasowymi int

Ograniczenia:
Minimalna wartość = 0
backupRetentionIntervalInHours Liczba całkowita reprezentująca czas przechowywania każdej kopii zapasowej (w godzinach) int

Ograniczenia:
Minimalna wartość = 0
backupStorageRedundancy Wyliczenie wskazujące typ miejsca przechowywania kopii zapasowych "Geo"
"Lokalne"
"Strefa"

Możliwość

Nazwa Opis Wartość
name Nazwa możliwości usługi Cosmos DB. Na przykład "name": "EnableCassandra". Bieżące wartości obejmują również "EnableTable" i "EnableGremlin". ciąg

Pojemność

Nazwa Opis Wartość
totalThroughputLimit Łączny limit przepływności nałożony na konto. Łączna wartośćThroughputLimit z 2000 r. nakłada ścisły limit maksymalnej przepływności, który można aprowizować na tym koncie na 2000. TotalThroughputLimit z -1 wskazuje brak limitów aprowizacji przepływności. int

SpójnośćPolicy

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 wartość defaultConsistencyPolicy jest ustawiona na wartość "BoundedStaleness". int

Ograniczenia:
Minimalna wartość = 5
Maksymalna wartość = 86400
maxStalenessPrefix W przypadku użycia z poziomem spójności Powiązana nieaktualność ta wartość reprezentuje liczbę przestarzałych żądań tolerowanych. Zaakceptowany zakres dla tej wartości to 1 – 2147 483 647. Wymagane, gdy wartość defaultConsistencyPolicy jest ustawiona na wartość "BoundedStaleness". int

Ograniczenia:
Minimalna wartość = 1
Maksymalna wartość = 2147483647

CorsPolicy

Nazwa Opis Wartość
allowedHeaders Nagłówki żądań, które domena pochodzenia może określać w żądaniu CORS. ciąg
allowedMethods Metody (czasowniki żądań HTTP), których domena źródłowa może używać do żądania CORS. ciąg
allowedOrigins Domeny pochodzenia, które mogą wysył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. ciąg
maxAgeInSeconds Maksymalny czas buforowania żądania OPCJE wstępne w przeglądarce. int

Ograniczenia:
Minimalna wartość = 1
Maksymalna wartość = 2147483647

IpAddressOrRange

Nazwa Opis Wartość
ipAddressOrRange Pojedynczy adres IPv4 lub pojedynczy zakres adresów IPv4 w formacie CIDR. Podane adresy IP muszą być dobrze 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". ciąg

Location

Nazwa Opis Wartość
failoverPriority Priorytet trybu 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. ciąg

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 konta bazy danych, z którego ma zostać zainicjowane 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
tablesToRestore Lista określonych tabel dostępnych do przywrócenia. ciąg[]

DatabaseRestoreResource

Nazwa Opis Wartość
collectionNames Nazwy kolekcji dostępnych do przywrócenia. ciąg[]
databaseName Nazwa bazy danych dostępnej do przywrócenia. ciąg

GremlinDatabaseRestoreResource

Nazwa Opis Wartość
databaseName Nazwa bazy danych gremlin dostępnej do przywrócenia. ciąg
graphNames Nazwy grafów dostępnych do przywrócenia. ciąg[]

VirtualNetworkRule

Nazwa Opis Wartość
identyfikator Identyfikator zasobu podsieci, na przykład: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. ciąg
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.

Template Opis
Ciągła integracja/ciągłe wdrażanie przy użyciu narzędzia Jenkins w usłudze Azure Container Service (AKS)

Wdróż na platformie Azure		 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żna zwiększyć szybkość i niezawodność wdrożenia.
Aplikacja internetowa z usługą SQL Database, Azure Cosmos DB, Azure Search

Wdróż na platformie Azure		 Ten szablon aprowizuje aplikację internetową, usługę SQL Database, usługę Azure Cosmos DB, usługę Azure Search i usługę Application Insights.
Tworzenie konta usługi Azure Cosmos DB dla interfejsu API Cassandra

Wdróż na platformie Azure		 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 automatycznego skalowania konta usługi Azure Cosmos DB dla interfejsu API Cassandra

Wdróż na platformie Azure		 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 konta usługi Azure CosmosDB

Wdróż na platformie Azure		 Ten szablon usługi ARM ma na celu szybkie utworzenie konta usługi CosmosDB z minimalnymi wymaganymi wartościami
Tworzenie konta usługi Azure Cosmos DB w wielu regionach

Wdróż na platformie Azure		 Ten szablon tworzy konto usługi Azure Cosmos DB dla dowolnego typu interfejsu API bazy danych z regionem podstawowym i pomocniczym z wyborem poziomu spójności i typu trybu failover.
Tworzenie konta usługi Azure Cosmos DB w warstwie Bezpłatna

Wdróż na platformie Azure		 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 języka Gremlin

Wdróż na platformie Azure		 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 dla automatycznego skalowania interfejsu API języka Gremlin

Wdróż na platformie Azure		 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 dla interfejsu API bazy danych MongoDB

Wdróż na platformie Azure		 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 autoskalowania interfejsu API bazy danych MongoDB

Wdróż na platformie Azure		 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 skalowania automatycznego.
Tworzenie konta usługi Azure Cosmos DB z prywatnym punktem końcowym

Wdróż na platformie Azure		 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 usługi Azure Cosmos DB dla interfejsu API Core (SQL)

Wdróż na platformie Azure		 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.
Interfejs API SQL konta usługi Azure Cosmos DB z magazynem analitycznym

Wdróż na platformie Azure		 Ten szablon tworzy konto usługi Azure Cosmos dla interfejsu API Core (SQL) z bazą danych i kontenerem skonfigurowanym z magazynem analitycznym.
Tworzenie interfejsu API SQL konta usługi Azure Cosmos DB przy użyciu autoskalowania

Wdróż na platformie Azure		 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 Core (SQL) usługi Azure Cosmos DB

Wdróż na platformie Azure		 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 minimalnego konta usługi Azure Cosmos DB dla interfejsu API Core (SQL)

Wdróż na platformie Azure		 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 usługi Azure Cosmos przy użyciu interfejsu API SQL i wielu kontenerów

Wdróż na platformie Azure		 Szablon tworzy kontener usługi Cosmos za pomocą interfejsu API SQL i umożliwia dodawanie mulitple kontenerów.
Tworzenie konta SQL usługi Azure Cosmos DB przy użyciu kontroli dostępu opartej na rolach płaszczyzny danych

Wdróż na platformie Azure		 Ten szablon utworzy konto usługi SQL Cosmos, natywnie utrzymywaną definicję roli i natywnie zachowane przypisanie roli dla tożsamości usługi AAD.
Tworzenie bezserwerowego konta usługi Azure Cosmos DB dla interfejsu API SQL

Wdróż na platformie Azure		 Ten szablon tworzy bezserwerowe konto usługi Azure Cosmos DB dla interfejsu API Core (SQL).
Tworzenie konta usługi Azure Cosmos dla interfejsu API tabel

Wdróż na platformie Azure		 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 z autoskalowaniem

Wdróż na platformie Azure		 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 bezdotykowego konta usługi Azure Cosmos i aplikacji internetowej platformy Azure

Wdróż na platformie Azure		 Ten szablon tworzy konto usługi Azure Cosmos, wprowadza punkt końcowy usługi Cosmos DB i klucze do ustawień aplikacji internetowej platformy Azure, a następnie wdraża aplikację internetową ASP MVC z usługi GitHub.
Tworzenie konta usługi Cosmos DB z włączoną usługą Microsoft Defender

Wdróż na platformie Azure		 Korzystając z tego szablonu usługi ARM, można 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 warstwa zabezpieczeń platformy Azure, 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 naruszonych lub złośliwych testerów.
Wdrażanie usługi Azure Data Explorer DB za pomocą połączenia usługi Cosmos DB

Wdróż na platformie Azure		 Wdrażanie usługi Azure Data Explorer DB za pomocą połączenia usługi Cosmos DB.
Konto usługi Azure Cosmos DB z aplikacją internetową

Wdróż na platformie Azure		 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ń.

Definicja zasobu szablonu usługi ARM

Typ zasobu databaseAccounts można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "apiVersion": "2023-03-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "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": "Small",
    "consistencyPolicy": {
      "defaultConsistencyLevel": "string",
      "maxIntervalInSeconds": "int",
      "maxStalenessPrefix": "int"
    },
    "cors": [
      {
        "allowedHeaders": "string",
        "allowedMethods": "string",
        "allowedOrigins": "string",
        "exposedHeaders": "string",
        "maxAgeInSeconds": "int"
      }
    ],
    "createMode": "string",
    "databaseAccountOfferType": "Standard",
    "defaultIdentity": "string",
    "disableKeyBasedMetadataWriteAccess": "bool",
    "disableLocalAuth": "bool",
    "enableAnalyticalStorage": "bool",
    "enableAutomaticFailover": "bool",
    "enableCassandraConnector": "bool",
    "enableFreeTier": "bool",
    "enableMultipleWriteLocations": "bool",
    "enablePartitionMerge": "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": "PointInTime",
      "restoreSource": "string",
      "restoreTimestampInUtc": "string",
      "tablesToRestore": [ "string" ]
    },
    "virtualNetworkRules": [
      {
        "id": "string",
        "ignoreMissingVNetServiceEndpoint": "bool"
      }
    ]
  }
}

Obiekty BackupPolicy

Ustaw właściwość type , aby określić typ obiektu.

W przypadku ciągłego użycia użyj:

  "type": "Continuous"

W przypadku opcji Okresowe użyj:

  "type": "Periodic",
  "periodicModeProperties": {
    "backupIntervalInMinutes": "int",
    "backupRetentionIntervalInHours": "int",
    "backupStorageRedundancy": "string"
  }

Wartości właściwości

databaseAccounts

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts"
apiVersion Wersja interfejsu API zasobów '2023-03-15'
name Nazwa zasobu ciąg (wymagany)

Limit znaków: 3–44

Prawidłowe znaki:
Wyłącznie małe litery, cyfry i łączniki.

Zacznij od małej litery lub cyfry.

Nazwa zasobu musi być unikatowa na platformie Azure.
location Lokalizacja grupy zasobów, do której należy zasób. ciąg
tags Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą być używane w wyświetlaniu i grupowaniu tego zasobu (w grupach zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawione z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB". Słownik nazw tagów i wartości. Zobacz Tagi w szablonach
Rodzaju Wskazuje typ konta bazy danych. Można to ustawić tylko podczas tworzenia konta bazy danych. "GlobalDocumentDB"
"MongoDB"
"Analizowanie"
identity Tożsamość zasobu. Identyfikator usługi zarządzanej
properties Właściwości do tworzenia i aktualizowania kont bazy danych usługi Azure Cosmos DB. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (wymagane)

Identyfikator usługi zarządzanej

Nazwa Opis Wartość
typ Typ tożsamości używanej dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawną utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "None" spowoduje usunięcie 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 usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nazwa Opis Wartość
{niestandardowa właściwość} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...

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. Właściwości interfejsu API
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[]
capacity Obiekt reprezentujący wszystkie właściwości związane z wymuszaniem pojemności na koncie. Pojemność
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"
"Przywróć"
databaseAccountOfferType Typ oferty bazy danych "Standardowa" (wymagana)
defaultIdentity Domyślna tożsamość na potrzeby uzyskiwania dostępu do magazynu kluczy używanego 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. ciąg
disableKeyBasedMetadataWriteAccess Wyłączanie operacji zapisu dla zasobów metadanych (baz danych, kontenerów, przepływności) za pomocą kluczy konta bool
disableLocalAuth Rezygnacja z uwierzytelniania lokalnego i upewnienie się, że tylko tożsamość usługi zarządzanej i usługi AAD mogą być używane wyłącznie do uwierzytelniania. bool
enableAnalyticalStorage Flaga wskazująca, czy włączyć analizę magazynu. bool
enableAutomaticFailover Włącza automatyczne przełączanie regionu zapisu w tryb failover w rzadkim przypadku niedostępności regionu 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
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
enableMultipleWriteLocations Umożliwia zapisywanie konta w wielu lokalizacjach bool
enablePartitionMerge Flaga wskazująca włączanie/wyłączanie funkcji Scalanie partycji na koncie bool
adresy IPRules Lista reguł IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Flaga wskazująca, czy włączyć/wyłączyć reguły listy ACL sieci wirtualnej. bool
keyVaultKeyUri Identyfikator URI magazynu kluczy ciąg
locations Tablica zawierająca lokalizacje georeplikacji włączone dla konta usługi Cosmos DB. Lokalizacja[] (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, które 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. ciąg[]
publicNetworkAccess Czy żądania z sieci publicznej są dozwolone "Wyłączone"
"Włączone"
restoreParameters Parametry wskazujące informacje o przywracaniu. RestoreParameters
virtualNetworkRules Lista reguł listy kontroli dostępu dla sieci wirtualnej skonfigurowanych dla konta usługi Cosmos DB. VirtualNetworkRule[]

AnalyticalStorageConfiguration

Nazwa Opis Wartość
Schematype Opisuje typy schematów 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 Ustawianie typu obiektu Ciągłe
Okresowe (wymagane)

BackupPolicyMigrationState

Nazwa Opis Wartość
startTime Godzina rozpoczęcia migracji zasad kopii zapasowych (format ISO-8601). ciąg
status Opisuje stan migracji między typami zasad kopii zapasowych. "Ukończono"
"Niepowodzenie"
"InProgress"
"Nieprawidłowy"
Targettype Opisuje docelowy typ zasad kopii zapasowych migracji zasad kopii zapasowych. "Ciągły"
"Okresowe"

ContinuousModeBackupPolicy

Nazwa Opis Wartość
typ Opisuje tryb tworzenia kopii zapasowych. "Ciągłe" (wymagane)

PeriodicModeBackupPolicy

Nazwa Opis Wartość
typ Opisuje tryb tworzenia kopii zapasowych. "Okresowe" (wymagane)
periodicModeProperties Wartości konfiguracji dla kopii zapasowej w trybie okresowym Właściwości periodicModeProperties

Właściwości periodicModeProperties

Nazwa Opis Wartość
backupIntervalInMinutes Liczba całkowita reprezentująca interwał w minutach między dwoma kopiami zapasowymi int

Ograniczenia:
Wartość minimalna = 0
backupRetentionIntervalInHours Liczba całkowita reprezentująca czas (w godzinach) zachowywania każdej kopii zapasowej int

Ograniczenia:
Wartość minimalna = 0
backupStorageRedundancy Wyliczenie wskazujące typ miejsca przechowywania kopii zapasowych "Geo"
"Lokalne"
"Strefa"

Możliwość

Nazwa Opis Wartość
name 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". ciąg

Pojemność

Nazwa Opis Wartość
totalThroughputLimit Łączny limit przepływności nałożony na konto. Wartość totalThroughputLimit z 2000 r. nakłada rygorystyczny limit maksymalnej przepływności, którą można aprowizować na tym koncie, aby wynosić 2000. Wartość totalThroughputLimit z -1 nie wskazuje żadnych limitów aprowizacji przepływności. int

ConsistencyPolicy

Nazwa Opis Wartość
defaultConsistencyLevel Domyślny poziom spójności i ustawienia konfiguracji konta usługi Cosmos DB. "BoundedStaleness"
"ConsistentPrefix"
"Ostateczna"
"Sesja"
"Strong" (wymagane)
maxIntervalInSeconds W przypadku użycia z poziomem spójności Powiązana nieaktualność ta wartość reprezentuje czas, w jakim tolerowana jest nieaktualność (w sekundach). Zaakceptowany zakres dla tej wartości to 5– 86400. Wymagane, gdy właściwość defaultConsistencyPolicy jest ustawiona na wartość "BoundedStaleness". int

Ograniczenia:
Minimalna wartość = 5
Maksymalna wartość = 86400
maxStalenessPrefix W przypadku użycia z poziomem spójności Powiązana nieaktualność ta wartość reprezentuje liczbę nieaktywnych żądań tolerowanych. Zaakceptowany zakres dla tej wartości to 1 – 2 147 483 647. Wymagane, gdy właściwość defaultConsistencyPolicy jest ustawiona na wartość "BoundedStaleness". int

Ograniczenia:
Minimalna wartość = 1
Wartość maksymalna = 2147483647

CorsPolicy

Nazwa Opis Wartość
allowedHeaders Nagłówki żądania, które domena źródła może określać w żądaniu CORS. ciąg
allowedMethods Metody (czasowniki żądań HTTP), których domena pochodzenia może używać dla żądania CORS. ciąg
allowedOrigins Domeny pochodzenia, które mogą wysyłać żądania 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. ciąg
maxAgeInSeconds Maksymalny czas buforowania żądania OPTIONS w przeglądarce. int

Ograniczenia:
Minimalna wartość = 1
Wartość maksymalna = 2147483647

IpAddressOrRange

Nazwa Opis Wartość
ipAddressOrRange Pojedynczy adres IPv4 lub jeden 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". ciąg

Location

Nazwa Opis Wartość
tryb failoverPriority Priorytet trybu failover regionu. Priorytet trybu failover 0 wskazuje region zapisu. Maksymalna wartość priorytetu trybu failover = (łączna 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:
Wartość minimalna = 0
isZoneRedundant Flaga wskazująca, czy ten region jest regionem AvailabilityZone bool
locationName Nazwa regionu. ciąg

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 konta bazy danych, z którego ma zostać zainicjowane 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
tablesToRestore Lista określonych tabel dostępnych do przywrócenia. ciąg[]

DatabaseRestoreResource

Nazwa Opis Wartość
collectionNames Nazwy kolekcji dostępnych do przywrócenia. ciąg[]
databaseName Nazwa bazy danych dostępnej do przywrócenia. ciąg

GremlinDatabaseRestoreResource

Nazwa Opis Wartość
databaseName Nazwa bazy danych gremlin dostępnej do przywrócenia. ciąg
graphNames Nazwy grafów dostępnych do przywrócenia. ciąg[]

VirtualNetworkRule

Nazwa Opis Wartość
identyfikator Identyfikator zasobu podsieci, na przykład: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. ciąg
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.

Template Opis
Ciągła integracja/ciągłe wdrażanie przy użyciu narzędzia Jenkins w usłudze Azure Container Service (AKS)

Wdróż na platformie Azure		 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żna zwiększyć szybkość i niezawodność wdrożenia.
Aplikacja internetowa z usługą SQL Database, Azure Cosmos DB, Azure Search

Wdróż na platformie Azure		 Ten szablon aprowizuje aplikację internetową, usługę SQL Database, usługę Azure Cosmos DB, usługę Azure Search i usługę Application Insights.
Tworzenie konta usługi Azure Cosmos DB dla interfejsu API Cassandra

Wdróż na platformie Azure		 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 automatycznego skalowania konta usługi Azure Cosmos DB dla interfejsu API Cassandra

Wdróż na platformie Azure		 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 konta usługi Azure CosmosDB

Wdróż na platformie Azure		 Ten szablon usługi ARM ma na celu szybkie utworzenie konta usługi CosmosDB z minimalnymi wymaganymi wartościami
Tworzenie konta usługi Azure Cosmos DB w wielu regionach

Wdróż na platformie Azure		 Ten szablon tworzy konto usługi Azure Cosmos DB dla dowolnego typu interfejsu API bazy danych z regionem podstawowym i pomocniczym z wyborem poziomu spójności i typu trybu failover.
Tworzenie konta usługi Azure Cosmos DB w warstwie Bezpłatna

Wdróż na platformie Azure		 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 języka Gremlin

Wdróż na platformie Azure		 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 dla automatycznego skalowania interfejsu API języka Gremlin

Wdróż na platformie Azure		 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 dla interfejsu API bazy danych MongoDB

Wdróż na platformie Azure		 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 autoskalowania interfejsu API bazy danych MongoDB

Wdróż na platformie Azure		 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 skalowania automatycznego.
Tworzenie konta usługi Azure Cosmos DB z prywatnym punktem końcowym

Wdróż na platformie Azure		 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 usługi Azure Cosmos DB dla interfejsu API Core (SQL)

Wdróż na platformie Azure		 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.
Interfejs API SQL konta usługi Azure Cosmos DB z magazynem analitycznym

Wdróż na platformie Azure		 Ten szablon tworzy konto usługi Azure Cosmos dla interfejsu API Core (SQL) z bazą danych i kontenerem skonfigurowanym z magazynem analitycznym.
Tworzenie interfejsu API SQL konta usługi Azure Cosmos DB przy użyciu autoskalowania

Wdróż na platformie Azure		 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 Core (SQL) usługi Azure Cosmos DB

Wdróż na platformie Azure		 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 minimalnego konta usługi Azure Cosmos DB dla interfejsu API Core (SQL)

Wdróż na platformie Azure		 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 usługi Azure Cosmos przy użyciu interfejsu API SQL i wielu kontenerów

Wdróż na platformie Azure		 Szablon tworzy kontener usługi Cosmos za pomocą interfejsu API SQL i umożliwia dodawanie mulitple kontenerów.
Tworzenie konta SQL usługi Azure Cosmos DB przy użyciu kontroli dostępu opartej na rolach płaszczyzny danych

Wdróż na platformie Azure		 Ten szablon utworzy konto usługi SQL Cosmos, natywnie utrzymywaną definicję roli i natywnie zachowane przypisanie roli dla tożsamości usługi AAD.
Tworzenie bezserwerowego konta usługi Azure Cosmos DB dla interfejsu API SQL

Wdróż na platformie Azure		 Ten szablon tworzy bezserwerowe konto usługi Azure Cosmos DB dla interfejsu API Core (SQL).
Tworzenie konta usługi Azure Cosmos dla interfejsu API tabel

Wdróż na platformie Azure		 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 z autoskalowaniem

Wdróż na platformie Azure		 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 bezdotykowego konta usługi Azure Cosmos i aplikacji internetowej platformy Azure

Wdróż na platformie Azure		 Ten szablon tworzy konto usługi Azure Cosmos, wprowadza punkt końcowy usługi Cosmos DB i klucze do ustawień aplikacji internetowej platformy Azure, a następnie wdraża aplikację internetową ASP MVC z usługi GitHub.
Tworzenie konta usługi Cosmos DB z włączoną usługą Microsoft Defender

Wdróż na platformie Azure		 Korzystając z tego szablonu usługi ARM, można 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 warstwa zabezpieczeń platformy Azure, 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 naruszonych lub złośliwych testerów.
Wdrażanie usługi Azure Data Explorer DB za pomocą połączenia usługi Cosmos DB

Wdróż na platformie Azure		 Wdrażanie usługi Azure Data Explorer DB za pomocą połączenia usługi Cosmos DB.
Konto usługi Azure Cosmos DB z aplikacją internetową

Wdróż na platformie Azure		 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ń.

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 dziennik 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-03-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  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 = "Small"
      consistencyPolicy = {
        defaultConsistencyLevel = "string"
        maxIntervalInSeconds = int
        maxStalenessPrefix = int
      }
      cors = [
        {
          allowedHeaders = "string"
          allowedMethods = "string"
          allowedOrigins = "string"
          exposedHeaders = "string"
          maxAgeInSeconds = int
        }
      ]
      createMode = "string"
      databaseAccountOfferType = "Standard"
      defaultIdentity = "string"
      disableKeyBasedMetadataWriteAccess = bool
      disableLocalAuth = bool
      enableAnalyticalStorage = bool
      enableAutomaticFailover = bool
      enableCassandraConnector = bool
      enableFreeTier = bool
      enableMultipleWriteLocations = bool
      enablePartitionMerge = 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 = "PointInTime"
        restoreSource = "string"
        restoreTimestampInUtc = "string"
        tablesToRestore = [
          "string"
        ]
      }
      virtualNetworkRules = [
        {
          id = "string"
          ignoreMissingVNetServiceEndpoint = bool
        }
      ]
    }
    kind = "string"
  })
}

Obiekty BackupPolicy

Ustaw właściwość type , aby określić typ obiektu.

W przypadku ciągłego użycia użyj:

  type = "Continuous"

W przypadku opcji Okresowe użyj:

  type = "Periodic"
  periodicModeProperties = {
    backupIntervalInMinutes = int
    backupRetentionIntervalInHours = int
    backupStorageRedundancy = "string"
  }

Wartości właściwości

databaseAccounts

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts@2023-03-15"
name Nazwa zasobu ciąg (wymagany)

Limit znaków: 3–44

Prawidłowe znaki:
Wyłącznie małe litery, cyfry i łączniki.

Zacznij od małej litery lub cyfry.

Nazwa zasobu musi być unikatowa na platformie Azure.
location Lokalizacja grupy zasobów, do której należy zasób. ciąg
parent_id Aby wdrożyć w grupie zasobów, użyj identyfikatora tej grupy zasobów. ciąg (wymagany)
tags Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą być używane w wyświetlaniu i grupowaniu tego zasobu (w grupach zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawione z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB". Słownik nazw tagów i wartości.
Rodzaju Wskazuje typ konta bazy danych. Można to ustawić tylko podczas tworzenia konta bazy danych. "GlobalDocumentDB"
"MongoDB"
"Analizowanie"
identity Tożsamość zasobu. Identyfikator usługi zarządzanej
properties Właściwości do tworzenia i aktualizowania kont bazy danych usługi Azure Cosmos DB. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (wymagane)

Identyfikator usługi zarządzanej

Nazwa Opis Wartość
typ Typ tożsamości używanej dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawną utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "None" spowoduje usunięcie tożsamości z usługi. "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
identity_ids 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 usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". Tablica identyfikatorów tożsamości użytkownika.

ManagedServiceIdentityUserAssignedIdentities

Nazwa Opis Wartość
{niestandardowa właściwość} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...

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. Właściwości interfejsu API
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[]
capacity Obiekt reprezentujący wszystkie właściwości związane z wymuszaniem pojemności na koncie. Pojemność
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"
"Przywróć"
databaseAccountOfferType Typ oferty bazy danych "Standardowa" (wymagane)
defaultIdentity Domyślna tożsamość na potrzeby uzyskiwania dostępu do magazynu kluczy używanego 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. ciąg
disableKeyBasedMetadataWriteAccess Wyłączanie operacji zapisu dla zasobów metadanych (baz danych, kontenerów, przepływności) za pomocą kluczy konta bool
disableLocalAuth Rezygnacja z uwierzytelniania lokalnego i upewnienie się, że tylko tożsamość usługi zarządzanej i usługi AAD mogą być używane wyłącznie do uwierzytelniania. bool
enableAnalyticalStorage Flaga wskazująca, czy włączyć analizę magazynu. bool
enableAutomaticFailover Włącza automatyczne przełączanie regionu zapisu w tryb failover w rzadkim przypadku niedostępności regionu 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
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
enableMultipleWriteLocations Umożliwia zapisywanie konta w wielu lokalizacjach bool
enablePartitionMerge Flaga wskazująca włączanie/wyłączanie funkcji Scalanie partycji na koncie bool
adresy IPRules Lista reguł IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Flaga wskazująca, czy włączyć/wyłączyć reguły listy ACL sieci wirtualnej. bool
keyVaultKeyUri Identyfikator URI magazynu kluczy ciąg
locations Tablica zawierająca lokalizacje georeplikacji włączone dla konta usługi Cosmos DB. Lokalizacja[] (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, które 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. ciąg[]
publicNetworkAccess Czy żądania z sieci publicznej są dozwolone "Wyłączone"
"Włączone"
restoreParameters Parametry wskazujące informacje o przywracaniu. RestoreParameters
virtualNetworkRules Lista reguł listy ACL sieci wirtualnej skonfigurowanych dla konta usługi Cosmos DB. VirtualNetworkRule[]

AnalizaStorageConfiguration

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 Ustawianie typu obiektu Ciągłe
Okresowe (wymagane)

BackupPolicyMigrationState

Nazwa Opis Wartość
startTime Godzina rozpoczęcia migracji zasad kopii zapasowych (format ISO-8601). ciąg
status Opisuje stan migracji między typami zasad kopii zapasowych. "Ukończono"
"Niepowodzenie"
"InProgress"
"Nieprawidłowy"
Targettype Opisuje docelowy typ zasad kopii zapasowej migracji zasad kopii zapasowych. "Ciągłe"
"Okresowe"

ContinuousModeBackupPolicy

Nazwa Opis Wartość
typ Opisuje tryb tworzenia kopii zapasowych. "Ciągłe" (wymagane)

PeriodModeBackupPolicy

Nazwa Opis Wartość
typ Opisuje tryb tworzenia kopii zapasowych. "Okresowe" (wymagane)
periodicModeProperties Wartości konfiguracji dla okresowej kopii zapasowej trybu PeriodModeProperties

PeriodModeProperties

Nazwa Opis Wartość
backupIntervalInMinutes Liczba całkowita reprezentująca interwał w minutach między dwiema kopiami zapasowymi int

Ograniczenia:
Minimalna wartość = 0
backupRetentionIntervalInHours Liczba całkowita reprezentująca czas przechowywania każdej kopii zapasowej (w godzinach) int

Ograniczenia:
Minimalna wartość = 0
backupStorageRedundancy Wyliczenie wskazujące typ miejsca przechowywania kopii zapasowych "Geo"
"Lokalne"
"Strefa"

Możliwość

Nazwa Opis Wartość
name Nazwa możliwości usługi Cosmos DB. Na przykład "name": "EnableCassandra". Bieżące wartości obejmują również "EnableTable" i "EnableGremlin". ciąg

Pojemność

Nazwa Opis Wartość
totalThroughputLimit Łączny limit przepływności nałożony na konto. Łączna wartośćThroughputLimit z 2000 r. nakłada ścisły limit maksymalnej przepływności, który można aprowizować na tym koncie na 2000. TotalThroughputLimit z -1 wskazuje brak limitów aprowizacji przepływności. int

SpójnośćPolicy

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 wartość defaultConsistencyPolicy jest ustawiona na wartość "BoundedStaleness". int

Ograniczenia:
Minimalna wartość = 5
Maksymalna wartość = 86400
maxStalenessPrefix W przypadku użycia z poziomem spójności Powiązana nieaktualność ta wartość reprezentuje liczbę przestarzałych żądań tolerowanych. Zaakceptowany zakres dla tej wartości to 1 – 2147 483 647. Wymagane, gdy wartość defaultConsistencyPolicy jest ustawiona na wartość "BoundedStaleness". int

Ograniczenia:
Minimalna wartość = 1
Maksymalna wartość = 2147483647

CorsPolicy

Nazwa Opis Wartość
allowedHeaders Nagłówki żądań, które domena pochodzenia może określać w żądaniu CORS. ciąg
allowedMethods Metody (czasowniki żądań HTTP), których domena źródłowa może używać do żądania CORS. ciąg
allowedOrigins Domeny pochodzenia, które mogą wysył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. ciąg
maxAgeInSeconds Maksymalny czas buforowania żądania OPCJE wstępne w przeglądarce. int

Ograniczenia:
Minimalna wartość = 1
Maksymalna wartość = 2147483647

IpAddressOrRange

Nazwa Opis Wartość
ipAddressOrRange Pojedynczy adres IPv4 lub pojedynczy zakres adresów IPv4 w formacie CIDR. Podane adresy IP muszą być dobrze 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". ciąg

Location

Nazwa Opis Wartość
failoverPriority Priorytet trybu 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. ciąg

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} ciąg
restoreTimestampInUtc Godzina przywrócenia konta (format ISO-8601). ciąg
tablesToRestore Lista określonych tabel dostępnych do przywrócenia. ciąg[]

DatabaseRestoreResource

Nazwa Opis Wartość
collectionNames Nazwy kolekcji dostępnych do przywrócenia. ciąg[]
databaseName Nazwa bazy danych dostępnej do przywrócenia. ciąg

GremlinDatabaseRestoreResource

Nazwa Opis Wartość
databaseName Nazwa bazy danych gremlin dostępnej do przywrócenia. ciąg
graphNames Nazwy grafów dostępnych do przywrócenia. ciąg[]

VirtualNetworkRule

Nazwa Opis Wartość
identyfikator Identyfikator zasobu podsieci, na przykład: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. ciąg
ignoreMissingVNetServiceEndpoint Utwórz regułę zapory, zanim sieć wirtualna ma włączony punkt końcowy usługi sieci wirtualnej. bool