Database Accounts - List

Listy wszystkie konta bazy danych usługi Azure Cosmos DB dostępne w ramach subskrypcji.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/databaseAccounts?api-version=2023-11-15

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
subscriptionId
path True

string

Identyfikator subskrypcji docelowej.

api-version
query True

string

Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa Typ Opis
200 OK

DatabaseAccountsListResult

Operacja została ukończona pomyślnie.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa Opis
user_impersonation Personifikuj konto użytkownika

Przykłady

CosmosDBDatabaseAccountList

Sample Request

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.DocumentDB/databaseAccounts?api-version=2023-11-15

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1",
      "name": "ddb1",
      "location": "West US",
      "type": "Microsoft.DocumentDB/databaseAccounts",
      "kind": "GlobalDocumentDB",
      "tags": {},
      "properties": {
        "provisioningState": "Succeeded",
        "documentEndpoint": "https://ddb1.documents.azure.com:443/",
        "ipRules": [],
        "databaseAccountOfferType": "Standard",
        "disableKeyBasedMetadataWriteAccess": false,
        "consistencyPolicy": {
          "defaultConsistencyLevel": "Session",
          "maxIntervalInSeconds": 5,
          "maxStalenessPrefix": 100
        },
        "writeLocations": [
          {
            "id": "ddb1-eastus",
            "locationName": "East US",
            "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/",
            "provisioningState": "Succeeded",
            "failoverPriority": 0
          }
        ],
        "readLocations": [
          {
            "id": "ddb1-eastus",
            "locationName": "East US",
            "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/",
            "provisioningState": "Succeeded",
            "failoverPriority": 0
          }
        ],
        "locations": [
          {
            "id": "ddb1-eastus",
            "locationName": "East US",
            "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/",
            "provisioningState": "Succeeded",
            "failoverPriority": 0
          }
        ],
        "failoverPolicies": [
          {
            "id": "ddb1-eastus",
            "locationName": "East US",
            "failoverPriority": 0
          }
        ],
        "privateEndpointConnections": [
          {
            "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.DocumentDB/databaseAccounts/account1/privateEndpointConnections/pe1",
            "properties": {
              "privateEndpoint": {
                "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/pe1"
              },
              "privateLinkServiceConnectionState": {
                "status": "Approved",
                "actionsRequired": "None"
              }
            }
          }
        ],
        "cors": [],
        "defaultIdentity": "FirstPartyIdentity",
        "enableFreeTier": false,
        "apiProperties": {},
        "enableAnalyticalStorage": true,
        "enableBurstCapacity": true,
        "analyticalStorageConfiguration": {
          "schemaType": "WellDefined"
        },
        "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d",
        "createMode": "Default",
        "backupPolicy": {
          "type": "Periodic",
          "periodicModeProperties": {
            "backupIntervalInMinutes": 240,
            "backupRetentionIntervalInHours": 720,
            "backupStorageRedundancy": "Geo"
          }
        },
        "networkAclBypass": "None",
        "networkAclBypassResourceIds": [],
        "keysMetadata": {
          "primaryMasterKey": {
            "generationTime": "2022-02-25T20:30:11Z"
          },
          "secondaryMasterKey": {
            "generationTime": "2022-02-25T20:30:11Z"
          },
          "primaryReadonlyMasterKey": {
            "generationTime": "2022-02-25T20:30:11Z"
          },
          "secondaryReadonlyMasterKey": {
            "generationTime": "2022-02-25T20:30:11Z"
          }
        },
        "enablePartitionMerge": true,
        "minimalTlsVersion": "Tls"
      },
      "systemData": {
        "createdAt": "2021-03-12T22:05:09Z"
      },
      "identity": {
        "type": "SystemAssigned,UserAssigned",
        "principalId": "52f4fef3-3c3f-4ff3-b52e-b5c9eeb68656",
        "tenantId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d",
        "userAssignedIdentities": {
          "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
            "clientId": "fbe75b66-01c5-4f87-a220-233af3270436",
            "principalId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d"
          }
        }
      }
    }
  ]
}

Definicje

Nazwa Opis
AccountKeyMetadata

Metadane związane z kluczem dostępu dla danego konta bazy danych.

AnalyticalStorageConfiguration

Właściwości specyficzne dla magazynu analitycznego.

AnalyticalStorageSchemaType

Opisuje typy schematów magazynu analitycznego.

ApiProperties
BackupPolicyMigrationState

Obiekt reprezentujący stan migracji między zasadami tworzenia kopii zapasowych.

BackupPolicyMigrationStatus

Opisuje stan migracji między typami zasad kopii zapasowych.

BackupPolicyType

Opisuje tryb tworzenia kopii zapasowych.

BackupStorageRedundancy

Wyliczenie wskazujące typ nadmiarowości magazynu kopii zapasowych.

Capability

Obiekt możliwości usługi Cosmos DB

Capacity

Obiekt reprezentujący wszystkie właściwości związane z wymuszaniem pojemności na koncie.

ConnectorOffer

Typ oferty łącznika cassandra dla konta bazy danych Cosmos DB C*.

ConsistencyPolicy

Zasady spójności dla konta bazy danych usługi Cosmos DB.

ContinuousModeBackupPolicy

Obiekt reprezentujący zasady tworzenia kopii zapasowych trybu ciągłego.

ContinuousModeProperties

Wartości konfiguracji dla okresowej kopii zapasowej trybu

ContinuousTier

Wyliczenie wskazujące typ warstwy ciągłej kopii zapasowej.

CorsPolicy

Zasady CORS dla konta bazy danych usługi Cosmos DB.

createdByType

Typ tożsamości, która utworzyła zasób.

CreateMode

Wyliczenie wskazujące tryb tworzenia konta.

DatabaseAccountGetResults

Konto bazy danych usługi Azure Cosmos DB.

DatabaseAccountKeysMetadata

Metadane związane z każdym kluczem dostępu dla danego konta bazy danych usługi Cosmos DB.

DatabaseAccountKind

Wskazuje typ konta bazy danych. Można to ustawić tylko podczas tworzenia konta bazy danych.

DatabaseAccountOfferType

Typ oferty dla konta bazy danych usługi Cosmos DB.

DatabaseAccountsListResult

Odpowiedź operacji Lista zawierająca konta bazy danych i ich właściwości.

DatabaseRestoreResource

Określone bazy danych do przywrócenia.

DefaultConsistencyLevel

Domyślny poziom spójności i ustawienia konfiguracji konta usługi Cosmos DB.

FailoverPolicy

Zasady trybu failover dla danego regionu konta bazy danych.

GremlinDatabaseRestoreResource

Określone bazy danych Języka Gremlin do przywrócenia.

IpAddressOrRange

IpAddressOrRange, obiekt

Location

Region, w którym wdrożono konto bazy danych usługi Azure Cosmos DB.

ManagedServiceIdentity

Tożsamość zasobu.

MinimalTlsVersion

Wskazuje minimalną dozwoloną wersję protokołu Tls. Wartość domyślna to Tls 1.2. Interfejsy API Cassandra i Mongo działają tylko z protokołem Tls 1.2.

NetworkAclBypass

Wskazuje, które usługi mogą pomijać kontrole zapory.

PeriodicModeBackupPolicy

Obiekt reprezentujący zasady tworzenia kopii zapasowych trybu okresowego.

PeriodicModeProperties

Wartości konfiguracji dla okresowej kopii zapasowej trybu

PrivateEndpointConnection

Połączenie prywatnego punktu końcowego

PrivateEndpointProperty

Prywatny punkt końcowy, do którego należy połączenie.

PrivateLinkServiceConnectionStateProperty

Stan połączenia prywatnego punktu końcowego.

PublicNetworkAccess

Czy żądania z sieci publicznej są dozwolone

ResourceIdentityType

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.

RestoreMode

Opisuje tryb przywracania.

RestoreParameters

Parametry wskazujące informacje o przywracaniu.

ServerVersion

Opisuje serverVersion konta bazy danych MongoDB.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

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}".

VirtualNetworkRule

obiekt reguły listy ACL Virtual Network

AccountKeyMetadata

Metadane związane z kluczem dostępu dla danego konta bazy danych.

Nazwa Typ Opis
generationTime

string

Czas generowania w formacie UTC klucza w formacie ISO-8601. Jeśli w obiekcie brakuje wartości, oznacza to, że ostatnia regeneracja klucza została wyzwolona przed 2022-06-18.

AnalyticalStorageConfiguration

Właściwości specyficzne dla magazynu analitycznego.

Nazwa Typ Opis
schemaType

AnalyticalStorageSchemaType

Opisuje typy schematów magazynu analitycznego.

AnalyticalStorageSchemaType

Opisuje typy schematów magazynu analitycznego.

Nazwa Typ Opis
FullFidelity

string

WellDefined

string

ApiProperties

Nazwa Typ Opis
serverVersion

ServerVersion

Opisuje serverVersion konta bazy danych MongoDB.

BackupPolicyMigrationState

Obiekt reprezentujący stan migracji między zasadami tworzenia kopii zapasowych.

Nazwa Typ Opis
startTime

string

Godzina rozpoczęcia migracji zasad kopii zapasowych (format ISO-8601).

status

BackupPolicyMigrationStatus

Opisuje stan migracji między typami zasad kopii zapasowych.

targetType

BackupPolicyType

Opisuje docelowy typ zasad kopii zapasowej migracji zasad kopii zapasowych.

BackupPolicyMigrationStatus

Opisuje stan migracji między typami zasad kopii zapasowych.

Nazwa Typ Opis
Completed

string

Failed

string

InProgress

string

Invalid

string

BackupPolicyType

Opisuje tryb tworzenia kopii zapasowych.

Nazwa Typ Opis
Continuous

string

Periodic

string

BackupStorageRedundancy

Wyliczenie wskazujące typ nadmiarowości magazynu kopii zapasowych.

Nazwa Typ Opis
Geo

string

Local

string

Zone

string

Capability

Obiekt możliwości usługi Cosmos DB

Nazwa Typ Opis
name

string

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".

Capacity

Obiekt reprezentujący wszystkie właściwości związane z wymuszaniem pojemności na koncie.

Nazwa Typ Opis
totalThroughputLimit

integer

Łą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.

ConnectorOffer

Typ oferty łącznika cassandra dla konta bazy danych Cosmos DB C*.

Nazwa Typ Opis
Small

string

ConsistencyPolicy

Zasady spójności dla konta bazy danych usługi Cosmos DB.

Nazwa Typ Opis
defaultConsistencyLevel

DefaultConsistencyLevel

Domyślny poziom spójności i ustawienia konfiguracji konta usługi Cosmos DB.

maxIntervalInSeconds

integer

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".

maxStalenessPrefix

integer

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".

ContinuousModeBackupPolicy

Obiekt reprezentujący zasady tworzenia kopii zapasowych trybu ciągłego.

Nazwa Typ Opis
continuousModeProperties

ContinuousModeProperties

Wartości konfiguracji kopii zapasowej trybu ciągłego

migrationState

BackupPolicyMigrationState

Obiekt reprezentujący stan migracji między zasadami tworzenia kopii zapasowych.

type string:

Continuous

Opisuje tryb tworzenia kopii zapasowych.

ContinuousModeProperties

Wartości konfiguracji dla okresowej kopii zapasowej trybu

Nazwa Typ Opis
tier

ContinuousTier

Wyliczenie wskazujące typ trybu ciągłej kopii zapasowej

ContinuousTier

Wyliczenie wskazujące typ warstwy ciągłej kopii zapasowej.

Nazwa Typ Opis
Continuous30Days

string

Continuous7Days

string

CorsPolicy

Zasady CORS dla konta bazy danych usługi Cosmos DB.

Nazwa Typ Opis
allowedHeaders

string

Nagłówki żądania, które domena źródła może określać w żądaniu CORS.

allowedMethods

string

Metody (czasowniki żądań HTTP), których domena pochodzenia może używać dla żądania CORS.

allowedOrigins

string

Domeny pochodzenia, które mogą wysyłać żądania do usługi za pośrednictwem mechanizmu CORS.

exposedHeaders

string

Nagłówki odpowiedzi, które mogą być wysyłane w odpowiedzi na żądanie CORS i udostępniane przez przeglądarkę wystawcy żądania.

maxAgeInSeconds

integer

Maksymalny czas buforowania żądania OPTIONS w przeglądarce.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa Typ Opis
Application

string

Key

string

ManagedIdentity

string

User

string

CreateMode

Wyliczenie wskazujące tryb tworzenia konta.

Nazwa Typ Opis
Default

string

Restore

string

DatabaseAccountGetResults

Konto bazy danych usługi Azure Cosmos DB.

Nazwa Typ Wartość domyślna Opis
id

string

Unikatowy identyfikator zasobu usługi ARM.

identity

ManagedServiceIdentity

Tożsamość zasobu.

kind

DatabaseAccountKind

GlobalDocumentDB

Wskazuje typ konta bazy danych. Można to ustawić tylko podczas tworzenia konta bazy danych.

location

string

Lokalizacja grupy zasobów, do której należy zasób.

name

string

Nazwa zasobu usługi ARM.

properties.analyticalStorageConfiguration

AnalyticalStorageConfiguration

Właściwości specyficzne dla magazynu analitycznego.

properties.apiProperties

ApiProperties

Właściwości specyficzne dla interfejsu API.

properties.backupPolicy BackupPolicy:

Obiekt reprezentujący zasady tworzenia kopii zapasowych na koncie.

properties.capabilities

Capability[]

Lista możliwości usługi Cosmos DB dla konta

properties.capacity

Capacity

Obiekt reprezentujący wszystkie właściwości związane z wymuszaniem pojemności na koncie.

properties.connectorOffer

ConnectorOffer

Typ oferty łącznika cassandra dla konta bazy danych Cosmos DB C*.

properties.consistencyPolicy

ConsistencyPolicy

Zasady spójności dla konta bazy danych usługi Cosmos DB.

properties.cors

CorsPolicy[]

Zasady CORS dla konta bazy danych usługi Cosmos DB.

properties.createMode

CreateMode

Default

Wyliczenie wskazujące tryb tworzenia konta.

properties.customerManagedKeyStatus

string

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.

properties.databaseAccountOfferType

DatabaseAccountOfferType

Typ oferty dla konta bazy danych usługi Cosmos DB. Wartość domyślna: Standardowa.

properties.defaultIdentity

string

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.

properties.disableKeyBasedMetadataWriteAccess

boolean

Wyłączanie operacji zapisu dla zasobów metadanych (baz danych, kontenerów, przepływności) za pomocą kluczy konta

properties.disableLocalAuth

boolean

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.

properties.documentEndpoint

string

Punkt końcowy połączenia dla konta bazy danych usługi Cosmos DB.

properties.enableAnalyticalStorage

boolean

Flaga wskazująca, czy włączyć analizę magazynu.

properties.enableAutomaticFailover

boolean

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.

properties.enableBurstCapacity

boolean

Flaga wskazująca włączanie/wyłączanie funkcji Burst Capacity Preview na koncie

properties.enableCassandraConnector

boolean

Włącza łącznik cassandra na koncie usługi Cosmos DB C*

properties.enableFreeTier

boolean

Flaga wskazująca, czy warstwa Bezpłatna jest włączona.

properties.enableMultipleWriteLocations

boolean

Umożliwia zapisywanie konta w wielu lokalizacjach

properties.enablePartitionMerge

boolean

Flaga wskazująca włączanie/wyłączanie funkcji Scalanie partycji na koncie

properties.failoverPolicies

FailoverPolicy[]

Tablica zawierająca regiony uporządkowane według priorytetów trybu failover.

properties.instanceId

string

Unikatowy identyfikator przypisany do konta bazy danych

properties.ipRules

IpAddressOrRange[]

Lista reguł IpRules.

properties.isVirtualNetworkFilterEnabled

boolean

Flaga wskazująca, czy włączyć/wyłączyć reguły listy ACL Virtual Network.

properties.keyVaultKeyUri

string

Identyfikator URI magazynu kluczy

properties.keysMetadata

DatabaseAccountKeysMetadata

Obiekt reprezentujący metadane kluczy konta usługi Cosmos DB.

properties.locations

Location[]

Tablica zawierająca wszystkie lokalizacje włączone dla konta usługi Cosmos DB.

properties.minimalTlsVersion

MinimalTlsVersion

Wskazuje minimalną dozwoloną wersję protokołu Tls. Wartość domyślna to Tls 1.2. Interfejsy API Cassandra i Mongo działają tylko z protokołem Tls 1.2.

properties.networkAclBypass

NetworkAclBypass

Wskazuje, które usługi mogą pomijać kontrole zapory.

properties.networkAclBypassResourceIds

string[]

Tablica zawierająca identyfikatory zasobów dla obejścia listy Acl sieci dla konta usługi Cosmos DB.

properties.privateEndpointConnections

PrivateEndpointConnection[]

Lista Connections prywatnego punktu końcowego skonfigurowanego dla konta usługi Cosmos DB.

properties.provisioningState

string

Stan konta usługi Cosmos DB w momencie wywołania operacji. Stan może być jednym z następujących. "Tworzenie" — tworzone jest konto usługi Cosmos DB. Gdy konto jest w stanie Tworzenie, zwracane są tylko właściwości określone jako dane wejściowe dla operacji tworzenia konta usługi Cosmos DB. "Powodzenie" — konto usługi Cosmos DB jest aktywne do użycia. "Aktualizowanie" — trwa aktualizowanie konta usługi Cosmos DB. "Usuwanie" — konto usługi Cosmos DB jest usuwane. "Niepowodzenie" — tworzenie konta usługi Cosmos DB nie powiodło się. "DeletionFailed" — usunięcie konta usługi Cosmos DB nie powiodło się.

properties.publicNetworkAccess

PublicNetworkAccess

Czy żądania z sieci publicznej są dozwolone

properties.readLocations

Location[]

Tablica zawierająca lokalizacje odczytu włączone dla konta usługi Cosmos DB.

properties.restoreParameters

RestoreParameters

Parametry wskazujące informacje o przywracaniu.

properties.virtualNetworkRules

VirtualNetworkRule[]

Lista reguł listy kontroli dostępu Virtual Network skonfigurowanych dla konta usługi Cosmos DB.

properties.writeLocations

Location[]

Tablica zawierająca lokalizację zapisu dla konta usługi Cosmos DB.

systemData

systemData

Metadane systemowe odnoszące się do tego zasobu.

tags

object

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".

type

string

Typ zasobu platformy Azure.

DatabaseAccountKeysMetadata

Metadane związane z każdym kluczem dostępu dla danego konta bazy danych usługi Cosmos DB.

Nazwa Typ Opis
primaryMasterKey

AccountKeyMetadata

Metadane związane z podstawowym kluczem Read-Write dla danego konta bazy danych usługi Cosmos DB.

primaryReadonlyMasterKey

AccountKeyMetadata

Metadane związane z podstawowym kluczem Read-Only dla danego konta bazy danych usługi Cosmos DB.

secondaryMasterKey

AccountKeyMetadata

Metadane związane z pomocniczym kluczem Read-Write dla danego konta bazy danych usługi Cosmos DB.

secondaryReadonlyMasterKey

AccountKeyMetadata

Metadane związane z pomocniczym kluczem Read-Only dla danego konta bazy danych usługi Cosmos DB.

DatabaseAccountKind

Wskazuje typ konta bazy danych. Można to ustawić tylko podczas tworzenia konta bazy danych.

Nazwa Typ Opis
GlobalDocumentDB

string

MongoDB

string

Parse

string

DatabaseAccountOfferType

Typ oferty dla konta bazy danych usługi Cosmos DB.

Nazwa Typ Opis
Standard

string

DatabaseAccountsListResult

Odpowiedź operacji Lista zawierająca konta bazy danych i ich właściwości.

Nazwa Typ Opis
value

DatabaseAccountGetResults[]

Lista kont bazy danych i ich właściwości.

DatabaseRestoreResource

Określone bazy danych do przywrócenia.

Nazwa Typ Opis
collectionNames

string[]

Nazwy kolekcji dostępnych do przywrócenia.

databaseName

string

Nazwa bazy danych dostępnej do przywrócenia.

DefaultConsistencyLevel

Domyślny poziom spójności i ustawienia konfiguracji konta usługi Cosmos DB.

Nazwa Typ Opis
BoundedStaleness

string

ConsistentPrefix

string

Eventual

string

Session

string

Strong

string

FailoverPolicy

Zasady trybu failover dla danego regionu konta bazy danych.

Nazwa Typ Opis
failoverPriority

integer

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.

id

string

Unikatowy identyfikator regionu, w którym konto bazy danych jest replikowane. Przykład: <accountName-locationName>><.

locationName

string

Nazwa regionu, w którym istnieje konto bazy danych.

GremlinDatabaseRestoreResource

Określone bazy danych Języka Gremlin do przywrócenia.

Nazwa Typ Opis
databaseName

string

Nazwa bazy danych gremlin dostępnej do przywrócenia.

graphNames

string[]

Nazwy wykresów dostępnych do przywrócenia.

IpAddressOrRange

IpAddressOrRange, obiekt

Nazwa Typ Opis
ipAddressOrRange

string

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".

Location

Region, w którym wdrożono konto bazy danych usługi Azure Cosmos DB.

Nazwa Typ Opis
documentEndpoint

string

Punkt końcowy połączenia dla określonego regionu. Przykład: https://< accountName-locationName.documents.azure.com:443/><>

failoverPriority

integer

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.

id

string

Unikatowy identyfikator regionu w ramach konta bazy danych. Przykład: <accountName-locationName>><.

isZoneRedundant

boolean

Flaga wskazująca, czy ten region jest regionem AvailabilityZone

locationName

string

Nazwa regionu.

provisioningState

string

Stan konta usługi Cosmos DB w momencie wywołania operacji. Stan może być jednym z następujących. "Tworzenie" — tworzone jest konto usługi Cosmos DB. Gdy konto jest w stanie Tworzenie, zwracane są tylko właściwości określone jako dane wejściowe dla operacji tworzenia konta usługi Cosmos DB. "Powodzenie" — konto usługi Cosmos DB jest aktywne do użycia. "Aktualizowanie" — trwa aktualizowanie konta usługi Cosmos DB. "Usuwanie" — konto usługi Cosmos DB jest usuwane. "Niepowodzenie" — tworzenie konta usługi Cosmos DB nie powiodło się. "DeletionFailed" — usunięcie konta usługi Cosmos DB nie powiodło się.

ManagedServiceIdentity

Tożsamość zasobu.

Nazwa Typ Opis
principalId

string

Identyfikator podmiotu zabezpieczeń tożsamości przypisanej przez system. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system.

tenantId

string

Identyfikator dzierżawy tożsamości przypisanej przez system. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system.

type

ResourceIdentityType

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.

userAssignedIdentities

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}".

MinimalTlsVersion

Wskazuje minimalną dozwoloną wersję protokołu Tls. Wartość domyślna to Tls 1.2. Interfejsy API Cassandra i Mongo działają tylko z protokołem Tls 1.2.

Nazwa Typ Opis
Tls

string

Tls11

string

Tls12

string

NetworkAclBypass

Wskazuje, które usługi mogą pomijać kontrole zapory.

Nazwa Typ Opis
AzureServices

string

None

string

PeriodicModeBackupPolicy

Obiekt reprezentujący zasady tworzenia kopii zapasowych trybu okresowego.

Nazwa Typ Opis
migrationState

BackupPolicyMigrationState

Obiekt reprezentujący stan migracji między zasadami tworzenia kopii zapasowych.

periodicModeProperties

PeriodicModeProperties

Wartości konfiguracji dla okresowej kopii zapasowej trybu

type string:

Periodic

Opisuje tryb tworzenia kopii zapasowych.

PeriodicModeProperties

Wartości konfiguracji dla okresowej kopii zapasowej trybu

Nazwa Typ Opis
backupIntervalInMinutes

integer

Liczba całkowita reprezentująca interwał w minutach między dwiema kopiami zapasowymi

backupRetentionIntervalInHours

integer

Liczba całkowita reprezentująca czas przechowywania każdej kopii zapasowej (w godzinach)

backupStorageRedundancy

BackupStorageRedundancy

Wyliczenie wskazujące typ miejsca przechowywania kopii zapasowych

PrivateEndpointConnection

Połączenie prywatnego punktu końcowego

Nazwa Typ Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Nazwa zasobu

properties.groupId

string

Identyfikator grupy prywatnego punktu końcowego.

properties.privateEndpoint

PrivateEndpointProperty

Prywatny punkt końcowy, do którego należy połączenie.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionStateProperty

Stan połączenia prywatnego punktu końcowego.

properties.provisioningState

string

Stan aprowizacji prywatnego punktu końcowego.

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

PrivateEndpointProperty

Prywatny punkt końcowy, do którego należy połączenie.

Nazwa Typ Opis
id

string

Identyfikator zasobu prywatnego punktu końcowego.

PrivateLinkServiceConnectionStateProperty

Stan połączenia prywatnego punktu końcowego.

Nazwa Typ Opis
actionsRequired

string

Każda akcja wymagana poza podstawowym przepływem pracy (zatwierdzanie/odrzucanie/rozłączanie)

description

string

Opis połączenia usługi private link.

status

string

Stan połączenia usługi private link.

PublicNetworkAccess

Czy żądania z sieci publicznej są dozwolone

Nazwa Typ Opis
Disabled

string

Enabled

string

SecuredByPerimeter

string

ResourceIdentityType

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.

Nazwa Typ Opis
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

RestoreMode

Opisuje tryb przywracania.

Nazwa Typ Opis
PointInTime

string

RestoreParameters

Parametry wskazujące informacje o przywracaniu.

Nazwa Typ Opis
databasesToRestore

DatabaseRestoreResource[]

Lista określonych baz danych dostępnych do przywrócenia.

gremlinDatabasesToRestore

GremlinDatabaseRestoreResource[]

Lista określonych baz danych gremlin dostępnych do przywrócenia.

restoreMode

RestoreMode

Opisuje tryb przywracania.

restoreSource

string

Identyfikator konta bazy danych, z którego ma zostać zainicjowane przywracanie. Na przykład: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}

restoreTimestampInUtc

string

Godzina przywrócenia konta (format ISO-8601).

tablesToRestore

string[]

Lista określonych tabel dostępnych do przywrócenia.

ServerVersion

Opisuje serverVersion konta bazy danych MongoDB.

Nazwa Typ Opis
3.2

string

3.6

string

4.0

string

4.2

string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string

Sygnatura czasowa tworzenia zasobów (UTC).

createdBy

string

Tożsamość, która utworzyła zasób.

createdByType

createdByType

Typ tożsamości, która utworzyła zasób.

lastModifiedAt

string

Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)

lastModifiedBy

string

Tożsamość, która ostatnio zmodyfikowała zasób.

lastModifiedByType

createdByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.

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}".

Nazwa Typ Opis

VirtualNetworkRule

obiekt reguły listy ACL Virtual Network

Nazwa Typ Opis
id

string

Identyfikator zasobu podsieci, na przykład: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.

ignoreMissingVNetServiceEndpoint

boolean

Utwórz regułę zapory, zanim sieć wirtualna ma włączony punkt końcowy usługi sieci wirtualnej.