Database Accounts - Update

Referenz

Service:: Cosmos DB Resource Provider

API Version:: 2024-05-15

Updates die Eigenschaften eines vorhandenen Azure Cosmos DB-Datenbankkontos.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}?api-version=2024-05-15

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string	Name des Cosmos DB-Datenbankkontos. Regex pattern: `^[a-z0-9]+(-[a-z0-9]+)*`
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Typ	Beschreibung
identity	ManagedServiceIdentity	Identität für die Ressource.
location	string	Der Speicherort der Ressourcengruppe, zu der die Ressource gehört.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration	Analysespeicherspezifische Eigenschaften.
properties.apiProperties	ApiProperties	API-spezifische Eigenschaften. Derzeit nur für die MongoDB-API unterstützt.
properties.backupPolicy	BackupPolicy: PeriodicModeBackupPolicy ContinuousModeBackupPolicy	Das Objekt, das die Richtlinie zum Erstellen von Sicherungen für ein Konto darstellt.
properties.capabilities	Capability[]	Liste der Cosmos DB-Funktionen für das Konto
properties.capacity	Capacity	Das -Objekt, das alle Eigenschaften im Zusammenhang mit der Kapazitätserzwingung für ein Konto darstellt.
properties.connectorOffer	ConnectorOffer	Der Cassandra-Connectorangebotstyp für das C*-Konto der Cosmos DB-Datenbank.
properties.consistencyPolicy	ConsistencyPolicy	Die Konsistenzrichtlinie für das Cosmos DB-Konto.
properties.cors	CorsPolicy[]	Die CORS-Richtlinie für das Cosmos DB-Datenbankkonto.
properties.customerManagedKeyStatus	string	Gibt die status des Features "Kundenverwalteter Schlüssel" für das Konto an. Falls Fehler auftreten, bietet die -Eigenschaft Anleitungen zur Problembehandlung.
properties.defaultIdentity	string	Die Standardidentität für den Zugriff auf Schlüsseltresor, die in Features wie kundenseitig verwalteten Schlüsseln verwendet wird. Die Standardidentität muss explizit von den Benutzern festgelegt werden. Es kann "FirstPartyIdentity", "SystemAssignedIdentity" und mehr sein.
properties.disableKeyBasedMetadataWriteAccess	boolean	Deaktivieren von Schreibvorgängen für Metadatenressourcen (Datenbanken, Container, Durchsatz) über Kontoschlüssel
properties.disableLocalAuth	boolean	Deaktivieren Sie die lokale Authentifizierung, und stellen Sie sicher, dass nur MSI und AAD ausschließlich für die Authentifizierung verwendet werden können.
properties.enableAnalyticalStorage	boolean	Flag, um anzugeben, ob Speicheranalysen aktiviert werden sollen.
properties.enableAutomaticFailover	boolean	Aktiviert das automatische Failover der Schreibregion in dem seltenen Fall, dass die Region aufgrund eines Ausfalls nicht verfügbar ist. Automatisches Failover führt zu einer neuen Schreibregion für das Konto und wird basierend auf den für das Konto konfigurierten Failoverprioritäten ausgewählt.
properties.enableBurstCapacity	boolean	Flag zum Aktivieren/Deaktivieren des Burst Capacity Preview-Features für das Konto
properties.enableCassandraConnector	boolean	Aktiviert den Cassandra-Connector für das Cosmos DB C*-Konto
properties.enableFreeTier	boolean	Flag, um anzugeben, ob der Free-Tarif aktiviert ist.
properties.enableMultipleWriteLocations	boolean	Ermöglicht dem Konto das Schreiben an mehreren Speicherorten.
properties.enablePartitionMerge	boolean	Flag zum Aktivieren/Deaktivieren der Partition Merge-Funktion für das Konto
properties.ipRules	IpAddressOrRange[]	Liste der IpRules.
properties.isVirtualNetworkFilterEnabled	boolean	Flag, um anzugeben, ob Virtual Network ACL-Regeln aktiviert/deaktiviert werden sollen.
properties.keyVaultKeyUri	string	Der URI des Schlüsseltresors
properties.locations	Location[]	Ein Array, das die Georeplizierungsstandorte enthält, die für das Cosmos DB-Konto aktiviert sind.
properties.minimalTlsVersion	MinimalTlsVersion	Gibt die mindest zulässige Tls-Version an. Der Standardwert ist Tls 1.2. Cassandra- und Mongo-APIs funktionieren nur mit Tls 1.2.
properties.networkAclBypass	NetworkAclBypass	Gibt an, welche Dienste Firewallprüfungen umgehen dürfen.
properties.networkAclBypassResourceIds	string[]	Ein Array, das die Ressourcen-IDs für die Netzwerk-ACL-Umgehung für das Cosmos DB-Konto enthält.
properties.publicNetworkAccess	PublicNetworkAccess	Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind
properties.virtualNetworkRules	VirtualNetworkRule[]	Liste der Virtual Network ACL-Regeln, die für das Cosmos DB-Konto konfiguriert sind.
tags	object	Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Die Standardumgebung für einen Vorlagentyp ist beispielsweise mit "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB".

Antworten

Name	Typ	Beschreibung
200 OK	DatabaseAccountGetResults	Der Aktualisierungsvorgang für das Datenbankkonto wird asynchron abgeschlossen.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

CosmosDBDatabaseAccountPatch

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1?api-version=2024-05-15

{
  "location": "westus",
  "tags": {
    "dept": "finance"
  },
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
    }
  },
  "properties": {
    "ipRules": [
      {
        "ipAddressOrRange": "23.43.230.120"
      },
      {
        "ipAddressOrRange": "110.12.240.0/12"
      }
    ],
    "isVirtualNetworkFilterEnabled": true,
    "virtualNetworkRules": [
      {
        "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
        "ignoreMissingVNetServiceEndpoint": false
      }
    ],
    "consistencyPolicy": {
      "defaultConsistencyLevel": "BoundedStaleness",
      "maxIntervalInSeconds": 10,
      "maxStalenessPrefix": 200
    },
    "defaultIdentity": "FirstPartyIdentity",
    "enableFreeTier": false,
    "enableAnalyticalStorage": true,
    "enableBurstCapacity": true,
    "analyticalStorageConfiguration": {
      "schemaType": "WellDefined"
    },
    "backupPolicy": {
      "type": "Periodic",
      "periodicModeProperties": {
        "backupIntervalInMinutes": 240,
        "backupRetentionIntervalInHours": 720,
        "backupStorageRedundancy": "Local"
      }
    },
    "networkAclBypass": "AzureServices",
    "networkAclBypassResourceIds": [
      "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName"
    ],
    "capacity": {
      "totalThroughputLimit": 2000
    },
    "enablePartitionMerge": true,
    "minimalTlsVersion": "Tls"
  }
}

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_database_account_patch.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.database_accounts.begin_update(
        resource_group_name="rg1",
        account_name="ddb1",
        update_parameters={
            "identity": {
                "type": "SystemAssigned,UserAssigned",
                "userAssignedIdentities": {
                    "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
                },
            },
            "location": "westus",
            "properties": {
                "analyticalStorageConfiguration": {"schemaType": "WellDefined"},
                "backupPolicy": {
                    "periodicModeProperties": {
                        "backupIntervalInMinutes": 240,
                        "backupRetentionIntervalInHours": 720,
                        "backupStorageRedundancy": "Local",
                    },
                    "type": "Periodic",
                },
                "capacity": {"totalThroughputLimit": 2000},
                "consistencyPolicy": {
                    "defaultConsistencyLevel": "BoundedStaleness",
                    "maxIntervalInSeconds": 10,
                    "maxStalenessPrefix": 200,
                },
                "defaultIdentity": "FirstPartyIdentity",
                "enableAnalyticalStorage": True,
                "enableBurstCapacity": True,
                "enableFreeTier": False,
                "enablePartitionMerge": True,
                "ipRules": [{"ipAddressOrRange": "23.43.230.120"}, {"ipAddressOrRange": "110.12.240.0/12"}],
                "isVirtualNetworkFilterEnabled": True,
                "minimalTlsVersion": "Tls",
                "networkAclBypass": "AzureServices",
                "networkAclBypassResourceIds": [
                    "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName"
                ],
                "virtualNetworkRules": [
                    {
                        "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
                        "ignoreMissingVNetServiceEndpoint": False,
                    }
                ],
            },
            "tags": {"dept": "finance"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/examples/CosmosDBDatabaseAccountPatch.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1",
  "name": "ddb1",
  "location": "West US",
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "kind": "GlobalDocumentDB",
  "tags": {
    "dept": "finance"
  },
  "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"
      }
    }
  },
  "properties": {
    "provisioningState": "Succeeded",
    "documentEndpoint": "https://ddb1.documents.azure.com:443/",
    "databaseAccountOfferType": "Standard",
    "ipRules": [
      {
        "ipAddressOrRange": "23.43.230.120"
      },
      {
        "ipAddressOrRange": "110.12.240.0/12"
      }
    ],
    "isVirtualNetworkFilterEnabled": true,
    "disableKeyBasedMetadataWriteAccess": false,
    "consistencyPolicy": {
      "defaultConsistencyLevel": "BoundedStaleness",
      "maxIntervalInSeconds": 10,
      "maxStalenessPrefix": 200
    },
    "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
      }
    ],
    "virtualNetworkRules": [
      {
        "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
        "ignoreMissingVNetServiceEndpoint": false
      }
    ],
    "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"
    },
    "backupPolicy": {
      "type": "Periodic",
      "periodicModeProperties": {
        "backupIntervalInMinutes": 240,
        "backupRetentionIntervalInHours": 720,
        "backupStorageRedundancy": "Local"
      }
    },
    "networkAclBypass": "AzureServices",
    "networkAclBypassResourceIds": [
      "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName"
    ],
    "capacity": {
      "totalThroughputLimit": 2000
    },
    "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"
  }
}

Definitionen

Name	Beschreibung
AccountKeyMetadata	Die Metadaten im Zusammenhang mit einem Zugriffsschlüssel für ein bestimmtes Datenbankkonto.
AnalyticalStorageConfiguration	Spezifische Eigenschaften des Analysespeichers.
AnalyticalStorageSchemaType	Beschreibt die Schematypen für den analytischen Speicher.
ApiProperties
BackupPolicyMigrationState	Das Objekt, das den Status der Migration zwischen den Sicherungsrichtlinien darstellt.
BackupPolicyMigrationStatus	Beschreibt die status der Migration zwischen Sicherungsrichtlinientypen.
BackupPolicyType	Beschreibt den Modus von Sicherungen.
BackupStorageRedundancy	Enumeration, um den Typ der Sicherungsspeicherredundanz anzugeben.
Capability	Cosmos DB-Funktionsobjekt
Capacity	Das -Objekt, das alle Eigenschaften im Zusammenhang mit der Kapazitätserzwingung für ein Konto darstellt.
ConnectorOffer	Der Cassandra-Connectorangebotstyp für das Cosmos DB C*-Datenbankkonto.
ConsistencyPolicy	Die Konsistenzrichtlinie für das Cosmos DB-Datenbankkonto.
ContinuousModeBackupPolicy	Das -Objekt, das die Sicherungsrichtlinie im fortlaufenden Modus darstellt.
ContinuousModeProperties	Konfigurationswerte für die sicherung im periodischen Modus
ContinuousTier	Enumeration, um den Typ der fortlaufenden Sicherungsebene anzugeben.
CorsPolicy	Die CORS-Richtlinie für das Cosmos DB-Datenbankkonto.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
CreateMode	Enumeration, um den Modus der Kontoerstellung anzugeben.
DatabaseAccountGetResults	Ein Azure Cosmos DB-Datenbankkonto.
DatabaseAccountKeysMetadata	Die Metadaten im Zusammenhang mit jedem Zugriffsschlüssel für das angegebene Cosmos DB-Datenbankkonto.
DatabaseAccountKind	Gibt den Typ des Datenbankkontos an. Dies kann nur bei der Erstellung eines Datenbankkontos festgelegt werden.
DatabaseAccountOfferType	Der Angebotstyp für das Cosmos DB-Datenbankkonto.
DatabaseAccountUpdateParameters	Parameter zum Patchen von Azure Cosmos DB-Datenbankkontoeigenschaften.
DatabaseRestoreResource	Bestimmte wiederherzustellende Datenbanken.
DefaultConsistencyLevel	Die Standardkonsistenzebene und die Konfigurationseinstellungen des Cosmos DB-Kontos.
FailoverPolicy	Die Failoverrichtlinie für eine bestimmte Region eines Datenbankkontos.
GremlinDatabaseRestoreResource	Bestimmte Gremlin-Datenbanken, die wiederhergestellt werden sollen.
IpAddressOrRange	IpAddressOrRange-Objekt
Location	Eine Region, in der das Azure Cosmos DB-Datenbankkonto bereitgestellt wird.
ManagedServiceIdentity	Identität für die Ressource.
MinimalTlsVersion	Gibt die mindest zulässige Tls-Version an. Der Standardwert ist Tls 1.2. Cassandra- und Mongo-APIs funktionieren nur mit Tls 1.2.
NetworkAclBypass	Gibt an, welche Dienste Firewallprüfungen umgehen dürfen.
PeriodicModeBackupPolicy	Das -Objekt, das die Sicherungsrichtlinie im periodischen Modus darstellt.
PeriodicModeProperties	Konfigurationswerte für die sicherung im periodischen Modus
PrivateEndpointConnection	Verbindung mit einem privaten Endpunkt
PrivateEndpointProperty	Privater Endpunkt, zu dem die Verbindung gehört.
PrivateLinkServiceConnectionStateProperty	Verbindungsstatus der Verbindung mit dem privaten Endpunkt.
PublicNetworkAccess	Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind
ResourceIdentityType	Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" umfasst sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.
RestoreMode	Beschreibt den Modus der Wiederherstellung.
RestoreParameters	Parameter, um die Informationen zur Wiederherstellung anzugeben.
ServerVersion	Beschreibt die ServerVersion eines MongoDB-Kontos.
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
UserAssignedIdentities	Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs im Format "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".
VirtualNetworkRule	Virtual Network ACL Rule-Objekt

AccountKeyMetadata

Die Metadaten im Zusammenhang mit einem Zugriffsschlüssel für ein bestimmtes Datenbankkonto.

Name	Typ	Beschreibung
generationTime	string	Generierungszeit des Schlüssels im ISO-8601-Format in UTC. Wenn der Wert im Objekt fehlt, bedeutet dies, dass die letzte Schlüsselgenerierung vor dem 18.06.2022 ausgelöst wurde.

AnalyticalStorageConfiguration

Spezifische Eigenschaften des Analysespeichers.

Name	Typ	Beschreibung
schemaType	AnalyticalStorageSchemaType	Beschreibt die Schematypen für den analytischen Speicher.

AnalyticalStorageSchemaType

Beschreibt die Schematypen für den analytischen Speicher.

Name	Typ	Beschreibung
FullFidelity	string
WellDefined	string

ApiProperties

Name	Typ	Beschreibung
serverVersion	ServerVersion	Beschreibt die ServerVersion eines MongoDB-Kontos.

BackupPolicyMigrationState

Das Objekt, das den Status der Migration zwischen den Sicherungsrichtlinien darstellt.

Name	Typ	Beschreibung
startTime	string	Zeitpunkt, zu dem die Migration der Sicherungsrichtlinie gestartet wurde (ISO-8601-Format).
status	BackupPolicyMigrationStatus	Beschreibt die status der Migration zwischen Sicherungsrichtlinientypen.
targetType	BackupPolicyType	Beschreibt den Zielsicherungsrichtlinientyp der Migration der Sicherungsrichtlinie.

BackupPolicyMigrationStatus

Beschreibt die status der Migration zwischen Sicherungsrichtlinientypen.

Name	Typ	Beschreibung
Completed	string
Failed	string
InProgress	string
Invalid	string

BackupPolicyType

Beschreibt den Modus von Sicherungen.

Name	Typ	Beschreibung
Continuous	string
Periodic	string

BackupStorageRedundancy

Enumeration, um den Typ der Sicherungsspeicherredundanz anzugeben.

Name	Typ	Beschreibung
Geo	string
Local	string
Zone	string

Capability

Cosmos DB-Funktionsobjekt

Name	Typ	Beschreibung
name	string	Name der Cosmos DB-Funktion. Beispiel: "name": "EnableCassandra". Zu den aktuellen Werten gehören auch "EnableTable" und "EnableGremlin".

Capacity

Das -Objekt, das alle Eigenschaften im Zusammenhang mit der Kapazitätserzwingung für ein Konto darstellt.

Name	Typ	Beschreibung
totalThroughputLimit	integer	Der für das Konto auferlegte Gesamtdurchsatzgrenzwert. Ein totalThroughputLimit von 2000 erzwingt einen strengen Grenzwert für den maximalen Durchsatz, der für dieses Konto bereitgestellt werden kann, auf 2000. Ein totalThroughputLimit von -1 gibt keine Grenzwerte für die Bereitstellung des Durchsatzes an.

ConnectorOffer

Der Cassandra-Connectorangebotstyp für das Cosmos DB C*-Datenbankkonto.

Name	Typ	Beschreibung
Small	string

ConsistencyPolicy

Die Konsistenzrichtlinie für das Cosmos DB-Datenbankkonto.

Name	Typ	Beschreibung
defaultConsistencyLevel	DefaultConsistencyLevel	Die Standardkonsistenzebene und die Konfigurationseinstellungen des Cosmos DB-Kontos.
maxIntervalInSeconds	integer	Bei Verwendung mit der Konsistenzebene "Begrenzte Veraltung" stellt dieser Wert den Zeitraum der Veraltung (in Sekunden) dar, der toleriert wird. Der zulässige Bereich für diesen Wert ist 5 bis 86400. Erforderlich, wenn defaultConsistencyPolicy auf "BoundedStaleness" festgelegt ist.
maxStalenessPrefix	integer	Bei Verwendung mit der Konsistenzebene "Begrenzte Veraltung" stellt dieser Wert die Anzahl veralteter Anforderungen dar, die toleriert werden. Für diesen Wert ist ein Bereich von 1 bis 2.147.483.647 zulässig. Erforderlich, wenn defaultConsistencyPolicy auf "BoundedStaleness" festgelegt ist.

ContinuousModeBackupPolicy

Das -Objekt, das die Sicherungsrichtlinie im fortlaufenden Modus darstellt.

Name	Typ	Beschreibung
continuousModeProperties	ContinuousModeProperties	Konfigurationswerte für die fortlaufende Sicherung
migrationState	BackupPolicyMigrationState	Das -Objekt, das den Status der Migration zwischen den Sicherungsrichtlinien darstellt.
type	string: Continuous	Beschreibt den Modus von Sicherungen.

ContinuousModeProperties

Konfigurationswerte für die sicherung im periodischen Modus

Name	Typ	Beschreibung
tier	ContinuousTier	Enumeration zum Angeben des Typs des fortlaufenden Sicherungsmodus

ContinuousTier

Enumeration, um den Typ der fortlaufenden Sicherungsebene anzugeben.

Name	Typ	Beschreibung
Continuous30Days	string
Continuous7Days	string

CorsPolicy

Die CORS-Richtlinie für das Cosmos DB-Datenbankkonto.

Name	Typ	Beschreibung
allowedHeaders	string	Die Anforderungsheader, die die Ursprungsdomäne für die CORS-Anforderung angeben kann.
allowedMethods	string	Die Methoden (HTTP-Anforderungsverben), die die Ursprungsdomäne für eine CORS-Anforderung verwenden kann.
allowedOrigins	string	Die Ursprungsdomänen, die über CORS eine Anforderung an den Dienst stellen dürfen.
exposedHeaders	string	Die Antwortheader, die in der Antwort an die CORS-Anforderung gesendet und vom Browser gegenüber dem Anforderungsaussteller verfügbar gemacht werden können.
maxAgeInSeconds	integer	Die maximale Zeit, über die die OPTIONS-Preflight-Anforderung vom Browser zwischengespeichert werden soll.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

Enumeration, um den Modus der Kontoerstellung anzugeben.

Name	Typ	Beschreibung
Default	string
Restore	string

DatabaseAccountGetResults

Ein Azure Cosmos DB-Datenbankkonto.

Name	Typ	Standardwert	Beschreibung
id	string		Der eindeutige Ressourcenbezeichner der ARM-Ressource.
identity	ManagedServiceIdentity		Identität für die Ressource.
kind	DatabaseAccountKind	GlobalDocumentDB	Gibt den Typ des Datenbankkontos an. Dies kann nur bei der Erstellung eines Datenbankkontos festgelegt werden.
location	string		Der Speicherort der Ressourcengruppe, zu der die Ressource gehört.
name	string		Der Name der ARM-Ressource.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration		Spezifische Eigenschaften des Analysespeichers.
properties.apiProperties	ApiProperties		API-spezifische Eigenschaften.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy		Das -Objekt, das die Richtlinie zum Erstellen von Sicherungen für ein Konto darstellt.
properties.capabilities	Capability[]		Liste der Cosmos DB-Funktionen für das Konto
properties.capacity	Capacity		Das -Objekt, das alle Eigenschaften im Zusammenhang mit der Kapazitätserzwingung für ein Konto darstellt.
properties.connectorOffer	ConnectorOffer		Der Angebotstyp des Cassandra-Connectors für das C*-Konto der Cosmos DB-Datenbank.
properties.consistencyPolicy	ConsistencyPolicy		Die Konsistenzrichtlinie für das Cosmos DB-Datenbankkonto.
properties.cors	CorsPolicy[]		Die CORS-Richtlinie für das Cosmos DB-Datenbankkonto.
properties.createMode	CreateMode	Default	Enumeration, um den Modus der Kontoerstellung anzugeben.
properties.customerManagedKeyStatus	string		Gibt die status des Features "Kundenverwalteter Schlüssel" für das Konto an. Falls Fehler auftreten, stellt die -Eigenschaft Anleitungen zur Problembehandlung bereit.
properties.databaseAccountOfferType	DatabaseAccountOfferType		Der Angebotstyp für das Cosmos DB-Datenbankkonto. Standardwert: Standard.
properties.defaultIdentity	string		Die Standardidentität für den Zugriff auf den Schlüsseltresor, der in Features wie kundenseitig verwalteten Schlüsseln verwendet wird. Die Standardidentität muss von den Benutzern explizit festgelegt werden. Dies kann "FirstPartyIdentity", "SystemAssignedIdentity" und mehr sein.
properties.disableKeyBasedMetadataWriteAccess	boolean		Deaktivieren von Schreibvorgängen für Metadatenressourcen (Datenbanken, Container, Durchsatz) über Kontoschlüssel
properties.disableLocalAuth	boolean		Deaktivieren Sie die lokale Authentifizierung, und stellen Sie sicher, dass nur MSI und AAD ausschließlich für die Authentifizierung verwendet werden können.
properties.documentEndpoint	string		Der Verbindungsendpunkt für das Cosmos DB-Datenbankkonto.
properties.enableAnalyticalStorage	boolean		Flag, um anzugeben, ob die Speicheranalyse aktiviert werden soll.
properties.enableAutomaticFailover	boolean		Aktiviert das automatische Failover der Schreibregion in dem seltenen Fall, dass die Region aufgrund eines Ausfalls nicht verfügbar ist. Das automatische Failover führt zu einer neuen Schreibregion für das Konto und wird basierend auf den für das Konto konfigurierten Failoverprioritäten ausgewählt.
properties.enableBurstCapacity	boolean		Flag zum Aktivieren/Deaktivieren der Burstkapazitätsvorschaufunktion für das Konto
properties.enableCassandraConnector	boolean		Aktiviert den Cassandra-Connector für das Cosmos DB-C*-Konto.
properties.enableFreeTier	boolean		Flag, um anzugeben, ob der Free-Tarif aktiviert ist.
properties.enableMultipleWriteLocations	boolean		Ermöglicht dem Konto das Schreiben an mehreren Speicherorten.
properties.enablePartitionMerge	boolean		Flag zum Aktivieren/Deaktivieren der Partitionszusammenführungsfunktion für das Konto
properties.failoverPolicies	FailoverPolicy[]		Ein Array, das die nach ihren Failoverprioritäten sortierten Regionen enthält.
properties.instanceId	string		Ein eindeutiger Bezeichner, der dem Datenbankkonto zugewiesen ist
properties.ipRules	IpAddressOrRange[]		Liste der IpRules.
properties.isVirtualNetworkFilterEnabled	boolean		Flag, um anzugeben, ob Virtual Network ACL-Regeln aktiviert/deaktiviert werden sollen.
properties.keyVaultKeyUri	string		Der URI des Schlüsseltresors
properties.keysMetadata	DatabaseAccountKeysMetadata		Das -Objekt, das die Metadaten für die Kontoschlüssel des Cosmos DB-Kontos darstellt.
properties.locations	Location[]		Ein Array, das alle für das Cosmos DB-Konto aktivierten Speicherorte enthält.
properties.minimalTlsVersion	MinimalTlsVersion		Gibt die mindestens zulässige Tls-Version an. Der Standardwert ist Tls 1.2. Cassandra- und Mongo-APIs funktionieren nur mit Tls 1.2.
properties.networkAclBypass	NetworkAclBypass		Gibt an, welche Dienste Firewallprüfungen umgehen dürfen.
properties.networkAclBypassResourceIds	string[]		Ein Array, das die Ressourcen-IDs für die Netzwerk-ACL-Umgehung für das Cosmos DB-Konto enthält.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Liste der für das Cosmos DB-Konto konfigurierten privaten Endpunkte Connections.
properties.provisioningState	string		Die status des Cosmos DB-Kontos zum Zeitpunkt des Aufrufs des Vorgangs. Die status kann eine der folgenden sein. Erstellen: Das Cosmos DB-Konto wird erstellt. Wenn sich ein Konto im Zustand Erstellen befindet, werden nur Eigenschaften zurückgegeben, die als Eingabe für den Create Cosmos DB-Kontovorgang angegeben sind. "Erfolgreich": Das Cosmos DB-Konto ist zur Verwendung aktiv. "Aktualisieren": Das Cosmos DB-Konto wird aktualisiert. "Löschen": Das Cosmos DB-Konto wird gelöscht. "Fehler": Fehler bei der Erstellung des Cosmos DB-Kontos. "DeletionFailed": Fehler beim Löschen des Cosmos DB-Kontos.
properties.publicNetworkAccess	PublicNetworkAccess		Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind
properties.readLocations	Location[]		Ein Array, das die Lesespeicherorte enthält, die für das Cosmos DB-Konto aktiviert sind.
properties.restoreParameters	RestoreParameters		Parameter, die die Informationen zur Wiederherstellung angeben.
properties.virtualNetworkRules	VirtualNetworkRule[]		Liste der Virtual Network ACL-Regeln, die für das Cosmos DB-Konto konfiguriert sind.
properties.writeLocations	Location[]		Ein Array, das den Schreibspeicherort für das Cosmos DB-Konto enthält.
systemData	systemData		Die Systemmetadaten zu dieser Ressource.
tags	object		Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Beispielsweise ist die Standardumgebung für einen Vorlagentyp auf "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB".
type	string		Der Typ der Azure-Ressource.

DatabaseAccountKeysMetadata

Die Metadaten im Zusammenhang mit jedem Zugriffsschlüssel für das angegebene Cosmos DB-Datenbankkonto.

Name	Typ	Beschreibung
primaryMasterKey	AccountKeyMetadata	Die Metadaten im Zusammenhang mit dem primären Read-Write Schlüssel für das angegebene Cosmos DB-Datenbankkonto.
primaryReadonlyMasterKey	AccountKeyMetadata	Die Metadaten im Zusammenhang mit dem primären Read-Only Schlüssel für das angegebene Cosmos DB-Datenbankkonto.
secondaryMasterKey	AccountKeyMetadata	Die Metadaten im Zusammenhang mit dem sekundären Read-Write Schlüssel für das angegebene Cosmos DB-Datenbankkonto.
secondaryReadonlyMasterKey	AccountKeyMetadata	Die Metadaten im Zusammenhang mit dem sekundären Read-Only Schlüssel für das angegebene Cosmos DB-Datenbankkonto.

DatabaseAccountKind

Gibt den Typ des Datenbankkontos an. Dies kann nur bei der Erstellung eines Datenbankkontos festgelegt werden.

Name	Typ	Beschreibung
GlobalDocumentDB	string
MongoDB	string
Parse	string

DatabaseAccountOfferType

Der Angebotstyp für das Cosmos DB-Datenbankkonto.

Name	Typ	Beschreibung
Standard	string

DatabaseAccountUpdateParameters

Parameter zum Patchen von Azure Cosmos DB-Datenbankkontoeigenschaften.

Name	Typ	Beschreibung
identity	ManagedServiceIdentity	Identität für die Ressource.
location	string	Der Speicherort der Ressourcengruppe, zu der die Ressource gehört.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration	Spezifische Eigenschaften des Analysespeichers.
properties.apiProperties	ApiProperties	API-spezifische Eigenschaften. Derzeit wird nur für die MongoDB-API unterstützt.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy	Das -Objekt, das die Richtlinie zum Erstellen von Sicherungen für ein Konto darstellt.
properties.capabilities	Capability[]	Liste der Cosmos DB-Funktionen für das Konto
properties.capacity	Capacity	Das -Objekt, das alle Eigenschaften im Zusammenhang mit der Kapazitätserzwingung für ein Konto darstellt.
properties.connectorOffer	ConnectorOffer	Der Angebotstyp des Cassandra-Connectors für das C*-Konto der Cosmos DB-Datenbank.
properties.consistencyPolicy	ConsistencyPolicy	Die Konsistenzrichtlinie für das Cosmos DB-Konto.
properties.cors	CorsPolicy[]	Die CORS-Richtlinie für das Cosmos DB-Datenbankkonto.
properties.customerManagedKeyStatus	string	Gibt die status des Features "Kundenverwalteter Schlüssel" für das Konto an. Falls Fehler auftreten, stellt die -Eigenschaft Anleitungen zur Problembehandlung bereit.
properties.defaultIdentity	string	Die Standardidentität für den Zugriff auf den Schlüsseltresor, der in Features wie kundenseitig verwalteten Schlüsseln verwendet wird. Die Standardidentität muss von den Benutzern explizit festgelegt werden. Dies kann "FirstPartyIdentity", "SystemAssignedIdentity" und mehr sein.
properties.disableKeyBasedMetadataWriteAccess	boolean	Deaktivieren von Schreibvorgängen für Metadatenressourcen (Datenbanken, Container, Durchsatz) über Kontoschlüssel
properties.disableLocalAuth	boolean	Deaktivieren Sie die lokale Authentifizierung, und stellen Sie sicher, dass nur MSI und AAD ausschließlich für die Authentifizierung verwendet werden können.
properties.enableAnalyticalStorage	boolean	Flag, um anzugeben, ob die Speicheranalyse aktiviert werden soll.
properties.enableAutomaticFailover	boolean	Aktiviert das automatische Failover der Schreibregion in dem seltenen Fall, dass die Region aufgrund eines Ausfalls nicht verfügbar ist. Das automatische Failover führt zu einer neuen Schreibregion für das Konto und wird basierend auf den für das Konto konfigurierten Failoverprioritäten ausgewählt.
properties.enableBurstCapacity	boolean	Flag zum Aktivieren/Deaktivieren der Burstkapazitätsvorschaufunktion für das Konto
properties.enableCassandraConnector	boolean	Aktiviert den Cassandra-Connector für das Cosmos DB-C*-Konto.
properties.enableFreeTier	boolean	Flag, um anzugeben, ob der Free-Tarif aktiviert ist.
properties.enableMultipleWriteLocations	boolean	Ermöglicht dem Konto das Schreiben an mehreren Speicherorten.
properties.enablePartitionMerge	boolean	Flag zum Aktivieren/Deaktivieren der Partitionszusammenführungsfunktion für das Konto
properties.ipRules	IpAddressOrRange[]	Liste der IpRules.
properties.isVirtualNetworkFilterEnabled	boolean	Flag, um anzugeben, ob Virtual Network ACL-Regeln aktiviert/deaktiviert werden sollen.
properties.keyVaultKeyUri	string	Der URI des Schlüsseltresors
properties.keysMetadata	DatabaseAccountKeysMetadata	Diese Eigenschaft wird während des Aktualisierungsvorgangs ignoriert, da die Metadaten schreibgeschützt sind. Das -Objekt stellt die Metadaten für die Kontoschlüssel des Cosmos DB-Kontos dar.
properties.locations	Location[]	Ein Array, das die georeplizierungsspeicherorte enthält, die für das Cosmos DB-Konto aktiviert sind.
properties.minimalTlsVersion	MinimalTlsVersion	Gibt die mindestens zulässige Tls-Version an. Der Standardwert ist Tls 1.2. Cassandra- und Mongo-APIs funktionieren nur mit Tls 1.2.
properties.networkAclBypass	NetworkAclBypass	Gibt an, welche Dienste Firewallprüfungen umgehen dürfen.
properties.networkAclBypassResourceIds	string[]	Ein Array, das die Ressourcen-IDs für die Netzwerk-ACL-Umgehung für das Cosmos DB-Konto enthält.
properties.publicNetworkAccess	PublicNetworkAccess	Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind
properties.virtualNetworkRules	VirtualNetworkRule[]	Liste der Virtual Network ACL-Regeln, die für das Cosmos DB-Konto konfiguriert sind.
tags	object	Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Beispielsweise ist die Standardumgebung für einen Vorlagentyp auf "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB".

DatabaseRestoreResource

Bestimmte wiederherzustellende Datenbanken.

Name	Typ	Beschreibung
collectionNames	string[]	Die Namen der zur Wiederherstellung verfügbaren Sammlungen.
databaseName	string	Der Name der für die Wiederherstellung verfügbaren Datenbank.

DefaultConsistencyLevel

Die Standardkonsistenzebene und die Konfigurationseinstellungen des Cosmos DB-Kontos.

Name	Typ	Beschreibung
BoundedStaleness	string
ConsistentPrefix	string
Eventual	string
Session	string
Strong	string

FailoverPolicy

Die Failoverrichtlinie für eine bestimmte Region eines Datenbankkontos.

Name	Typ	Beschreibung
failoverPriority	integer	Die Failoverpriorität der Region. Eine Failoverpriorität von 0 gibt einen Schreibbereich an. Der maximale Wert für eine Failoverpriorität = (Gesamtanzahl der Regionen - 1). Failoverprioritätswerte müssen für jede Region, in der das Datenbankkonto vorhanden ist, eindeutig sein.
id	string	Der eindeutige Bezeichner der Region, in der das Datenbankkonto repliziert wird. Beispiel: <accountName-locationName>><.
locationName	string	Der Name der Region, in der sich das Datenbankkonto befindet.

GremlinDatabaseRestoreResource

Bestimmte Gremlin-Datenbanken, die wiederhergestellt werden sollen.

Name	Typ	Beschreibung
databaseName	string	Der Name der gremlin-Datenbank, die für die Wiederherstellung verfügbar ist.
graphNames	string[]	Die Namen der Diagramme, die für die Wiederherstellung verfügbar sind.

IpAddressOrRange

IpAddressOrRange-Objekt

Name	Typ	Beschreibung
ipAddressOrRange	string	Eine einzelne IPv4-Adresse oder ein einzelner IPv4-Adressbereich im CIDR-Format. Bereitgestellte IP-Adressen müssen gut formatiert sein und können nicht in einem der folgenden Bereiche enthalten sein: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, da diese durch den IP-Adressfilter nicht durchsetzbar sind. Beispiel für gültige Eingaben: "23.40.210.245" oder "23.40.210.0/8".

Location

Eine Region, in der das Azure Cosmos DB-Datenbankkonto bereitgestellt wird.

Name	Typ	Beschreibung
documentEndpoint	string	Der Verbindungsendpunkt für die jeweilige Region. Beispiel: https://< accountName-locationName.documents.azure.com:443/><>
failoverPriority	integer	Die Failoverpriorität der Region. Eine Failoverpriorität von 0 gibt einen Schreibbereich an. Der maximale Wert für eine Failoverpriorität = (Gesamtanzahl der Regionen - 1). Failoverprioritätswerte müssen für jede Region, in der das Datenbankkonto vorhanden ist, eindeutig sein.
id	string	Der eindeutige Bezeichner der Region innerhalb des Datenbankkontos. Beispiel: <accountName-locationName>><.
isZoneRedundant	boolean	Flag, um anzugeben, ob es sich bei dieser Region um eine AvailabilityZone-Region handelt
locationName	string	Der Name der Region.
provisioningState	string	Die status des Cosmos DB-Kontos zum Zeitpunkt des Aufrufs des Vorgangs. Die status kann eine der folgenden sein. Erstellen: Das Cosmos DB-Konto wird erstellt. Wenn sich ein Konto im Zustand Erstellen befindet, werden nur Eigenschaften zurückgegeben, die als Eingabe für den Create Cosmos DB-Kontovorgang angegeben sind. "Erfolgreich": Das Cosmos DB-Konto ist zur Verwendung aktiv. "Aktualisieren": Das Cosmos DB-Konto wird aktualisiert. "Löschen": Das Cosmos DB-Konto wird gelöscht. "Fehler": Fehler bei der Erstellung des Cosmos DB-Kontos. "DeletionFailed": Fehler beim Löschen des Cosmos DB-Kontos.

ManagedServiceIdentity

Identität für die Ressource.

Name	Typ	Beschreibung
principalId	string	Die Prinzipal-ID der systemseitig zugewiesenen Identität. Diese Eigenschaft wird nur für eine systemseitig zugewiesene Identität bereitgestellt.
tenantId	string	Die Mandanten-ID der systemseitig zugewiesenen Identität. Diese Eigenschaft wird nur für eine systemseitig zugewiesene Identität bereitgestellt.
type	ResourceIdentityType	Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" umfasst sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.
userAssignedIdentities	UserAssignedIdentities	Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs im Format "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

MinimalTlsVersion

Gibt die mindest zulässige Tls-Version an. Der Standardwert ist Tls 1.2. Cassandra- und Mongo-APIs funktionieren nur mit Tls 1.2.

Name	Typ	Beschreibung
Tls	string
Tls11	string
Tls12	string

NetworkAclBypass

Gibt an, welche Dienste Firewallprüfungen umgehen dürfen.

Name	Typ	Beschreibung
AzureServices	string
None	string

PeriodicModeBackupPolicy

Das -Objekt, das die Sicherungsrichtlinie im periodischen Modus darstellt.

Name	Typ	Beschreibung
migrationState	BackupPolicyMigrationState	Das -Objekt, das den Status der Migration zwischen den Sicherungsrichtlinien darstellt.
periodicModeProperties	PeriodicModeProperties	Konfigurationswerte für die sicherung im periodischen Modus
type	string: Periodic	Beschreibt den Modus von Sicherungen.

PeriodicModeProperties

Konfigurationswerte für die sicherung im periodischen Modus

Name	Typ	Beschreibung
backupIntervalInMinutes	integer	Eine ganze Zahl, die das Intervall in Minuten zwischen zwei Sicherungen darstellt
backupRetentionIntervalInHours	integer	Eine ganze Zahl, die die Zeit (in Stunden) darstellt, zu der jede Sicherung beibehalten wird
backupStorageRedundancy	BackupStorageRedundancy	Aufzählung zum Angeben des Typs der Sicherungsresidenz

PrivateEndpointConnection

Verbindung mit einem privaten Endpunkt

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.groupId	string	Gruppen-ID des privaten Endpunkts.
properties.privateEndpoint	PrivateEndpointProperty	Privater Endpunkt, zu dem die Verbindung gehört.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Verbindungsstatus der Verbindung mit dem privaten Endpunkt.
properties.provisioningState	string	Bereitstellungsstatus des privaten Endpunkts.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PrivateEndpointProperty

Privater Endpunkt, zu dem die Verbindung gehört.

Name	Typ	Beschreibung
id	string	Ressourcen-ID des privaten Endpunkts.

PrivateLinkServiceConnectionStateProperty

Verbindungsstatus der Verbindung mit dem privaten Endpunkt.

Name	Typ	Beschreibung
actionsRequired	string	Jede Aktion, die über den grundlegenden Workflow hinaus erforderlich ist (genehmigen/ablehnen/trennen)
description	string	Die Verbindungsbeschreibung des Private Link-Diensts.
status	string	Die Private Link-Dienstverbindung status.

PublicNetworkAccess

Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind

Name	Typ	Beschreibung
Disabled	string
Enabled	string
SecuredByPerimeter	string

ResourceIdentityType

Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" umfasst sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.

Name	Typ	Beschreibung
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

RestoreMode

Beschreibt den Modus der Wiederherstellung.

Name	Typ	Beschreibung
PointInTime	string

RestoreParameters

Parameter, um die Informationen zur Wiederherstellung anzugeben.

Name	Typ	Beschreibung
databasesToRestore	DatabaseRestoreResource[]	Liste der spezifischen Datenbanken, die für die Wiederherstellung verfügbar sind.
gremlinDatabasesToRestore	GremlinDatabaseRestoreResource[]	Liste der spezifischen gremlin-Datenbanken, die für die Wiederherstellung verfügbar sind.
restoreMode	RestoreMode	Beschreibt den Modus der Wiederherstellung.
restoreSource	string	Die ID des wiederherstellbaren Datenbankkontos, von dem aus die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format).
tablesToRestore	string[]	Liste der für die Wiederherstellung verfügbaren spezifischen Tabellen.

ServerVersion

Beschreibt die ServerVersion eines MongoDB-Kontos.

Name	Typ	Beschreibung
3.2	string
3.6	string
4.0	string
4.2	string
5.0	string
6.0	string

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

UserAssignedIdentities

Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs im Format "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

Name	Typ	Beschreibung

VirtualNetworkRule

Virtual Network ACL Rule-Objekt

Name	Typ	Beschreibung
id	string	Ressourcen-ID eines Subnetzes, z. B.: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
ignoreMissingVNetServiceEndpoint	boolean	Create Firewallregel, bevor der VNET-Dienstendpunkt für das virtuelle Netzwerk aktiviert ist.

Share via

Database Accounts - Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Scopes

Beispiele

CosmosDBDatabaseAccountPatch

Sample Request

Sample Response

Definitionen

AccountKeyMetadata

AnalyticalStorageConfiguration

AnalyticalStorageSchemaType

ApiProperties

BackupPolicyMigrationState

BackupPolicyMigrationStatus

BackupPolicyType

BackupStorageRedundancy

Capability

Capacity

ConnectorOffer

ConsistencyPolicy

ContinuousModeBackupPolicy

ContinuousModeProperties

ContinuousTier

CorsPolicy

createdByType

CreateMode

DatabaseAccountGetResults

DatabaseAccountKeysMetadata

DatabaseAccountKind

DatabaseAccountOfferType

DatabaseAccountUpdateParameters

DatabaseRestoreResource

DefaultConsistencyLevel

FailoverPolicy

GremlinDatabaseRestoreResource

IpAddressOrRange

Location

ManagedServiceIdentity

MinimalTlsVersion

NetworkAclBypass

PeriodicModeBackupPolicy

PeriodicModeProperties

PrivateEndpointConnection

PrivateEndpointProperty

PrivateLinkServiceConnectionStateProperty

PublicNetworkAccess

ResourceIdentityType

RestoreMode

RestoreParameters

ServerVersion

systemData

UserAssignedIdentities

VirtualNetworkRule

Zusätzliche Ressourcen