Database Accounts - Update
Uppdateringar egenskaperna för ett befintligt Azure Cosmos DB-databaskonto.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}?api-version=2024-05-15
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
account
|
path | True |
string |
Cosmos DB-databaskontots namn. Reguljärt uttrycksmönster: |
resource
|
path | True |
string |
Namnet på resursgruppen. Namnet är skiftlägesokänsligt. |
subscription
|
path | True |
string |
ID för målprenumerationen. |
api-version
|
query | True |
string |
Den API-version som ska användas för den här åtgärden. |
Begärandetext
Name | Typ | Description |
---|---|---|
identity |
Identitet för resursen. |
|
location |
string |
Platsen för den resursgrupp som resursen tillhör. |
properties.analyticalStorageConfiguration |
Analyslagringsspecifika egenskaper. |
|
properties.apiProperties |
API-specifika egenskaper. För närvarande stöds endast för MongoDB API. |
|
properties.backupPolicy | BackupPolicy: |
Objektet som representerar principen för att ta säkerhetskopior på ett konto. |
properties.capabilities |
Lista över Cosmos DB-funktioner för kontot |
|
properties.capacity |
Objektet som representerar alla egenskaper som rör kapacitetstillämpning för ett konto. |
|
properties.connectorOffer |
Erbjudandetypen för Cassandra-anslutningsappen för Cosmos DB-databasens C*-konto. |
|
properties.consistencyPolicy |
Konsekvensprincipen för Cosmos DB-kontot. |
|
properties.cors |
CORS-principen för Cosmos DB-databaskontot. |
|
properties.customerManagedKeyStatus |
string |
Anger status för funktionen Kundhanterad nyckel för kontot. Om det uppstår fel ger egenskapen felsökningsvägledning. |
properties.defaultIdentity |
string |
Standardidentiteten för åtkomst till nyckelvalv som används i funktioner som kundhanterade nycklar. Standardidentiteten måste anges uttryckligen av användarna. Det kan vara "FirstPartyIdentity", "SystemAssignedIdentity" med mera. |
properties.disableKeyBasedMetadataWriteAccess |
boolean |
Inaktivera skrivåtgärder för metadataresurser (databaser, containrar, dataflöde) via kontonycklar |
properties.disableLocalAuth |
boolean |
Avregistrera lokal autentisering och se till att endast MSI och AAD kan användas exklusivt för autentisering. |
properties.enableAnalyticalStorage |
boolean |
Flagga för att ange om lagringsanalys ska aktiveras. |
properties.enableAutomaticFailover |
boolean |
Aktiverar automatisk redundans för skrivregionen i den sällsynta händelsen att regionen inte är tillgänglig på grund av ett avbrott. Automatisk redundans resulterar i en ny skrivregion för kontot och väljs baserat på de redundansprioriteringar som konfigurerats för kontot. |
properties.enableBurstCapacity |
boolean |
Flagga som anger aktivering/inaktivering av funktionen Burst Capacity Preview för kontot |
properties.enableCassandraConnector |
boolean |
Aktiverar cassandra-anslutningsappen på Cosmos DB C*-kontot |
properties.enableFreeTier |
boolean |
Flagga för att ange om den kostnadsfria nivån är aktiverad. |
properties.enableMultipleWriteLocations |
boolean |
Gör att kontot kan skriva på flera platser |
properties.enablePartitionMerge |
boolean |
Flagga för att ange aktivering/inaktivering av funktionen för sammanslagning av partitioner på kontot |
properties.ipRules |
Lista över IpRules. |
|
properties.isVirtualNetworkFilterEnabled |
boolean |
Flagga för att ange om du vill aktivera/inaktivera Virtual Network ACL-regler. |
properties.keyVaultKeyUri |
string |
URI för nyckelvalvet |
properties.locations |
Location[] |
En matris som innehåller de georeplication-platser som är aktiverade för Cosmos DB-kontot. |
properties.minimalTlsVersion |
Anger den lägsta tillåtna Tls-versionen. Standardvärdet är Tls 1.2. Cassandra- och Mongo-API:er fungerar bara med Tls 1.2. |
|
properties.networkAclBypass |
Anger vilka tjänster som tillåts kringgå brandväggskontroller. |
|
properties.networkAclBypassResourceIds |
string[] |
En matris som innehåller resurs-ID:n för Förbikoppling av nätverks-Acl för Cosmos DB-kontot. |
properties.publicNetworkAccess |
Om begäranden från offentligt nätverk tillåts |
|
properties.virtualNetworkRules |
Lista över Virtual Network ACL-regler som konfigurerats för Cosmos DB-kontot. |
|
tags |
object |
Taggar är en lista över nyckel/värde-par som beskriver resursen. De här taggarna kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB". |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Uppdateringsåtgärden för databaskontot slutförs asynkront. |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
user_impersonation | Personifiera ditt användarkonto |
Exempel
CosmosDBDatabaseAccountPatch
Exempelbegäran
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"
}
}
Exempelsvar
{
"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"
}
}
Definitioner
Name | Description |
---|---|
Account |
Metadata relaterade till en åtkomstnyckel för ett visst databaskonto. |
Analytical |
Analyslagringsspecifika egenskaper. |
Analytical |
Beskriver schematyperna för analytisk lagring. |
Api |
|
Backup |
Objektet som representerar migreringens tillstånd mellan säkerhetskopieringsprinciperna. |
Backup |
Beskriver status för migrering mellan typer av säkerhetskopieringsprinciper. |
Backup |
Beskriver läget för säkerhetskopior. |
Backup |
Räkna upp för att ange typen av redundans för lagring av säkerhetskopior. |
Capability |
Cosmos DB-funktionsobjekt |
Capacity |
Objektet som representerar alla egenskaper som är relaterade till kapacitetstillämpning för ett konto. |
Connector |
Erbjudandetypen för Cassandra-anslutningsappen för Cosmos DB C*-databaskontot. |
Consistency |
Konsekvensprincipen för Cosmos DB-databaskontot. |
Continuous |
Objektet som representerar säkerhetskopieringspolicy för kontinuerligt läge. |
Continuous |
Konfigurationsvärden för säkerhetskopiering i periodiskt läge |
Continuous |
Räkna upp för att ange typ av kontinuerlig säkerhetskopieringsnivå. |
Cors |
CORS-principen för Cosmos DB-databaskontot. |
created |
Den typ av identitet som skapade resursen. |
Create |
Räkna upp för att ange läget för kontoskapande. |
Database |
Ett Azure Cosmos DB-databaskonto. |
Database |
Metadata relaterade till varje åtkomstnyckel för det angivna Cosmos DB-databaskontot. |
Database |
Anger typen av databaskonto. Detta kan bara anges när databaskontot skapas. |
Database |
Erbjudandetypen för Cosmos DB-databaskontot. |
Database |
Parametrar för att korrigera azure Cosmos DB-databaskontoegenskaper. |
Database |
Specifika databaser som ska återställas. |
Default |
Standardkonsekvensnivån och konfigurationsinställningarna för Cosmos DB-kontot. |
Failover |
Redundansprincipen för en viss region för ett databaskonto. |
Gremlin |
Specifika Gremlin-databaser som ska återställas. |
Ip |
IpAddressOrRange-objekt |
Location |
En region där Azure Cosmos DB-databaskontot distribueras. |
Managed |
Identitet för resursen. |
Minimal |
Anger den lägsta tillåtna Tls-versionen. Standardvärdet är Tls 1.2. Cassandra- och Mongo-API:er fungerar bara med Tls 1.2. |
Network |
Anger vilka tjänster som tillåts kringgå brandväggskontroller. |
Periodic |
Objektet som representerar säkerhetskopieringspolicy för periodiskt läge. |
Periodic |
Konfigurationsvärden för säkerhetskopiering i periodiskt läge |
Private |
En privat slutpunktsanslutning |
Private |
Privat slutpunkt som anslutningen tillhör. |
Private |
Anslutningstillstånd för den privata slutpunktsanslutningen. |
Public |
Om begäranden från offentligt nätverk tillåts |
Resource |
Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten. |
Restore |
Beskriver återställningsläget. |
Restore |
Parametrar som anger information om återställningen. |
Server |
Beskriver ServerVersion för ett MongoDB-konto. |
system |
Metadata som rör skapande och senaste ändring av resursen. |
User |
Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
Virtual |
Virtual Network ACL-regelobjekt |
AccountKeyMetadata
Metadata relaterade till en åtkomstnyckel för ett visst databaskonto.
Name | Typ | Description |
---|---|---|
generationTime |
string |
Genereringstid i UTC för nyckeln i ISO-8601-format. Om värdet saknas i objektet innebär det att den sista nyckelregenereringen utlöstes före 2022-06-18. |
AnalyticalStorageConfiguration
Analyslagringsspecifika egenskaper.
Name | Typ | Description |
---|---|---|
schemaType |
Beskriver schematyperna för analytisk lagring. |
AnalyticalStorageSchemaType
Beskriver schematyperna för analytisk lagring.
Name | Typ | Description |
---|---|---|
FullFidelity |
string |
|
WellDefined |
string |
ApiProperties
Name | Typ | Description |
---|---|---|
serverVersion |
Beskriver ServerVersion för ett MongoDB-konto. |
BackupPolicyMigrationState
Objektet som representerar migreringens tillstånd mellan säkerhetskopieringsprinciperna.
Name | Typ | Description |
---|---|---|
startTime |
string |
Tidpunkt då migreringen av säkerhetskopieringsprincipen startade (ISO-8601-format). |
status |
Beskriver status för migrering mellan typer av säkerhetskopieringsprinciper. |
|
targetType |
Beskriver principtypen för målsäkerhetskopiering för migreringen av säkerhetskopieringsprincipen. |
BackupPolicyMigrationStatus
Beskriver status för migrering mellan typer av säkerhetskopieringsprinciper.
Name | Typ | Description |
---|---|---|
Completed |
string |
|
Failed |
string |
|
InProgress |
string |
|
Invalid |
string |
BackupPolicyType
Beskriver läget för säkerhetskopior.
Name | Typ | Description |
---|---|---|
Continuous |
string |
|
Periodic |
string |
BackupStorageRedundancy
Räkna upp för att ange typen av redundans för lagring av säkerhetskopior.
Name | Typ | Description |
---|---|---|
Geo |
string |
|
Local |
string |
|
Zone |
string |
Capability
Cosmos DB-funktionsobjekt
Name | Typ | Description |
---|---|---|
name |
string |
Namnet på Cosmos DB-funktionen. Till exempel "name": "EnableCassandra". Aktuella värden inkluderar även "EnableTable" och "EnableGremlin". |
Capacity
Objektet som representerar alla egenskaper som är relaterade till kapacitetstillämpning för ett konto.
Name | Typ | Description |
---|---|---|
totalThroughputLimit |
integer |
Den totala dataflödesgräns som har införts för kontot. En totalThroughputLimit på 2000 inför en strikt gräns för maximalt dataflöde som kan etableras på det kontot till 2000. Ett totalThroughputLimit på -1 anger inga begränsningar för etablering av dataflöde. |
ConnectorOffer
Erbjudandetypen för Cassandra-anslutningsappen för Cosmos DB C*-databaskontot.
Name | Typ | Description |
---|---|---|
Small |
string |
ConsistencyPolicy
Konsekvensprincipen för Cosmos DB-databaskontot.
Name | Typ | Description |
---|---|---|
defaultConsistencyLevel |
Standardkonsekvensnivån och konfigurationsinställningarna för Cosmos DB-kontot. |
|
maxIntervalInSeconds |
integer |
När det används med konsekvensnivån Begränsad föråldring representerar det här värdet den tidsmängd av föråldring (i sekunder) som tolereras. Godkänt intervall för det här värdet är 5–86400. Krävs när defaultConsistencyPolicy är inställt på "BoundedStaleness". |
maxStalenessPrefix |
integer |
När det används med konsekvensnivån Begränsad föråldring representerar det här värdet antalet inaktuella begäranden som tolereras. Godkänt intervall för det här värdet är 1–2 147 483 647. Krävs när defaultConsistencyPolicy är inställt på "BoundedStaleness". |
ContinuousModeBackupPolicy
Objektet som representerar säkerhetskopieringspolicy för kontinuerligt läge.
Name | Typ | Description |
---|---|---|
continuousModeProperties |
Konfigurationsvärden för säkerhetskopiering i kontinuerligt läge |
|
migrationState |
Objektet som representerar migreringens tillstånd mellan säkerhetskopieringsprinciperna. |
|
type |
string:
Continuous |
Beskriver läget för säkerhetskopior. |
ContinuousModeProperties
Konfigurationsvärden för säkerhetskopiering i periodiskt läge
Name | Typ | Description |
---|---|---|
tier |
Räkna upp för att ange typ av läge för kontinuerlig säkerhetskopiering |
ContinuousTier
Räkna upp för att ange typ av kontinuerlig säkerhetskopieringsnivå.
Name | Typ | Description |
---|---|---|
Continuous30Days |
string |
|
Continuous7Days |
string |
CorsPolicy
CORS-principen för Cosmos DB-databaskontot.
Name | Typ | Description |
---|---|---|
allowedHeaders |
string |
Begärandehuvudena som ursprungsdomänen kan ange i CORS-begäran. |
allowedMethods |
string |
De metoder (HTTP-begärandeverb) som ursprungsdomänen kan använda för en CORS-begäran. |
allowedOrigins |
string |
De ursprungsdomäner som tillåts att göra en begäran mot tjänsten via CORS. |
exposedHeaders |
string |
Svarshuvudena som kan skickas i svaret på CORS-begäran och exponeras av webbläsaren för frågeutfärdaren. |
maxAgeInSeconds |
integer |
Den maximala tid som en webbläsare ska cachelagrat för förhandsversionen av OPTIONS-begäran. |
createdByType
Den typ av identitet som skapade resursen.
Name | Typ | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
CreateMode
Räkna upp för att ange läget för kontoskapande.
Name | Typ | Description |
---|---|---|
Default |
string |
|
Restore |
string |
DatabaseAccountGetResults
Ett Azure Cosmos DB-databaskonto.
Name | Typ | Standardvärde | Description |
---|---|---|---|
id |
string |
Den unika resursidentifieraren för ARM-resursen. |
|
identity |
Identitet för resursen. |
||
kind | GlobalDocumentDB |
Anger typen av databaskonto. Detta kan bara anges när databaskontot skapas. |
|
location |
string |
Platsen för resursgruppen som resursen tillhör. |
|
name |
string |
Namnet på ARM-resursen. |
|
properties.analyticalStorageConfiguration |
Analyslagringsspecifika egenskaper. |
||
properties.apiProperties |
API-specifika egenskaper. |
||
properties.backupPolicy | BackupPolicy: |
Objektet som representerar principen för säkerhetskopiering av ett konto. |
|
properties.capabilities |
Lista över Cosmos DB-funktioner för kontot |
||
properties.capacity |
Objektet som representerar alla egenskaper som är relaterade till kapacitetstillämpning för ett konto. |
||
properties.connectorOffer |
Erbjudandetypen för Cassandra-anslutningsappen för Cosmos DB-databasens C*-konto. |
||
properties.consistencyPolicy |
Konsekvensprincipen för Cosmos DB-databaskontot. |
||
properties.cors |
CORS-principen för Cosmos DB-databaskontot. |
||
properties.createMode | Default |
Uppräkning för att ange läget för kontoskapande. |
|
properties.customerManagedKeyStatus |
string |
Anger status för funktionen Kundhanterad nyckel för kontot. Om det finns fel ger egenskapen felsökningsvägledning. |
|
properties.databaseAccountOfferType |
Erbjudandetypen för Cosmos DB-databaskontot. Standardvärde: Standard. |
||
properties.defaultIdentity |
string |
Standardidentiteten för åtkomst till nyckelvalv som används i funktioner som kundhanterade nycklar. Standardidentiteten måste anges explicit av användarna. Det kan vara "FirstPartyIdentity", "SystemAssignedIdentity" med mera. |
|
properties.disableKeyBasedMetadataWriteAccess |
boolean |
Inaktivera skrivåtgärder för metadataresurser (databaser, containrar, dataflöde) via kontonycklar |
|
properties.disableLocalAuth |
boolean |
Välj bort lokal autentisering och se till att endast MSI och AAD kan användas uteslutande för autentisering. |
|
properties.documentEndpoint |
string |
Anslutningsslutpunkten för Cosmos DB-databaskontot. |
|
properties.enableAnalyticalStorage |
boolean |
Flagga för att ange om lagringsanalys ska aktiveras. |
|
properties.enableAutomaticFailover |
boolean |
Aktiverar automatisk redundans för skrivregionen i den sällsynta händelse att regionen inte är tillgänglig på grund av ett avbrott. Automatisk redundans resulterar i en ny skrivregion för kontot och väljs baserat på de redundansprioriteringar som konfigurerats för kontot. |
|
properties.enableBurstCapacity |
boolean |
Flagga som anger aktivering/inaktivering av funktionen Burst Capacity Preview på kontot |
|
properties.enableCassandraConnector |
boolean |
Aktiverar Cassandra-anslutningsappen på Cosmos DB C*-kontot |
|
properties.enableFreeTier |
boolean |
Flagga för att ange om den kostnadsfria nivån är aktiverad. |
|
properties.enableMultipleWriteLocations |
boolean |
Gör att kontot kan skriva på flera platser |
|
properties.enablePartitionMerge |
boolean |
Flagga som anger aktivering/inaktivering av funktionen För partitionssammanslagning för kontot |
|
properties.failoverPolicies |
En matris som innehåller de regioner som sorteras efter deras redundansprioriteringar. |
||
properties.instanceId |
string |
En unik identifierare som tilldelats databaskontot |
|
properties.ipRules |
Lista över IpRules. |
||
properties.isVirtualNetworkFilterEnabled |
boolean |
Flagga för att ange om du vill aktivera/inaktivera Virtual Network ACL-regler. |
|
properties.keyVaultKeyUri |
string |
URI för nyckelvalvet |
|
properties.keysMetadata |
Objektet som representerar metadata för kontonycklarna för Cosmos DB-kontot. |
||
properties.locations |
Location[] |
En matris som innehåller alla platser som är aktiverade för Cosmos DB-kontot. |
|
properties.minimalTlsVersion |
Anger den lägsta tillåtna Tls-versionen. Standardvärdet är Tls 1.2. API:er för Cassandra och Mongo fungerar bara med Tls 1.2. |
||
properties.networkAclBypass |
Anger vilka tjänster som tillåts att kringgå brandväggskontroller. |
||
properties.networkAclBypassResourceIds |
string[] |
En matris som innehåller resurs-ID:n för förbikoppling av nätverks-Acl för Cosmos DB-kontot. |
|
properties.privateEndpointConnections |
Lista över privata slutpunkter Connections som konfigurerats för Cosmos DB-kontot. |
||
properties.provisioningState |
string |
Status för Cosmos DB-kontot vid den tidpunkt då åtgärden anropades. Statusen kan vara något av följande. "Skapar" – Cosmos DB-kontot skapas. När ett konto är i läget Skapa returneras endast egenskaper som anges som indata för Skapa Cosmos DB-kontoåtgärden. "Lyckades" – Cosmos DB-kontot är aktivt för användning. "Uppdaterar" – Cosmos DB-kontot uppdateras. "Tar bort" – Cosmos DB-kontot tas bort. "Misslyckades" – Cosmos DB-kontot kunde inte skapas. "DeletionFailed" – Det gick inte att ta bort Cosmos DB-kontot. |
|
properties.publicNetworkAccess |
Om begäranden från offentligt nätverk tillåts |
||
properties.readLocations |
Location[] |
En matris som innehåller de läsplatser som är aktiverade för Cosmos DB-kontot. |
|
properties.restoreParameters |
Parametrar som anger information om återställningen. |
||
properties.virtualNetworkRules |
Lista över Virtual Network ACL-regler som konfigurerats för Cosmos DB-kontot. |
||
properties.writeLocations |
Location[] |
En matris som innehåller skrivplatsen för Cosmos DB-kontot. |
|
systemData |
Systemmetadata som är relaterade till den här resursen. |
||
tags |
object |
Taggar är en lista över nyckel/värde-par som beskriver resursen. De här taggarna kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB". |
|
type |
string |
Typen av Azure-resurs. |
DatabaseAccountKeysMetadata
Metadata relaterade till varje åtkomstnyckel för det angivna Cosmos DB-databaskontot.
Name | Typ | Description |
---|---|---|
primaryMasterKey |
Metadata relaterade till den primära Read-Write nyckeln för det angivna Cosmos DB-databaskontot. |
|
primaryReadonlyMasterKey |
Metadata relaterade till den primära Read-Only nyckeln för det angivna Cosmos DB-databaskontot. |
|
secondaryMasterKey |
Metadata relaterade till den sekundära Read-Write-nyckeln för det angivna Cosmos DB-databaskontot. |
|
secondaryReadonlyMasterKey |
Metadata relaterade till den sekundära Read-Only-nyckeln för det angivna Cosmos DB-databaskontot. |
DatabaseAccountKind
Anger typen av databaskonto. Detta kan bara anges när databaskontot skapas.
Name | Typ | Description |
---|---|---|
GlobalDocumentDB |
string |
|
MongoDB |
string |
|
Parse |
string |
DatabaseAccountOfferType
Erbjudandetypen för Cosmos DB-databaskontot.
Name | Typ | Description |
---|---|---|
Standard |
string |
DatabaseAccountUpdateParameters
Parametrar för att korrigera azure Cosmos DB-databaskontoegenskaper.
Name | Typ | Description |
---|---|---|
identity |
Identitet för resursen. |
|
location |
string |
Platsen för resursgruppen som resursen tillhör. |
properties.analyticalStorageConfiguration |
Analyslagringsspecifika egenskaper. |
|
properties.apiProperties |
API-specifika egenskaper. Stöds för närvarande endast för MongoDB API. |
|
properties.backupPolicy | BackupPolicy: |
Objektet som representerar principen för säkerhetskopiering av ett konto. |
properties.capabilities |
Lista över Cosmos DB-funktioner för kontot |
|
properties.capacity |
Objektet som representerar alla egenskaper som är relaterade till kapacitetstillämpning för ett konto. |
|
properties.connectorOffer |
Erbjudandetypen för Cassandra-anslutningsappen för Cosmos DB-databasens C*-konto. |
|
properties.consistencyPolicy |
Konsekvensprincipen för Cosmos DB-kontot. |
|
properties.cors |
CORS-principen för Cosmos DB-databaskontot. |
|
properties.customerManagedKeyStatus |
string |
Anger status för funktionen Kundhanterad nyckel för kontot. Om det finns fel ger egenskapen felsökningsvägledning. |
properties.defaultIdentity |
string |
Standardidentiteten för åtkomst till nyckelvalv som används i funktioner som kundhanterade nycklar. Standardidentiteten måste anges explicit av användarna. Det kan vara "FirstPartyIdentity", "SystemAssignedIdentity" med mera. |
properties.disableKeyBasedMetadataWriteAccess |
boolean |
Inaktivera skrivåtgärder för metadataresurser (databaser, containrar, dataflöde) via kontonycklar |
properties.disableLocalAuth |
boolean |
Välj bort lokal autentisering och se till att endast MSI och AAD kan användas uteslutande för autentisering. |
properties.enableAnalyticalStorage |
boolean |
Flagga för att ange om lagringsanalys ska aktiveras. |
properties.enableAutomaticFailover |
boolean |
Aktiverar automatisk redundans för skrivregionen i den sällsynta händelse att regionen inte är tillgänglig på grund av ett avbrott. Automatisk redundans resulterar i en ny skrivregion för kontot och väljs baserat på de redundansprioriteringar som konfigurerats för kontot. |
properties.enableBurstCapacity |
boolean |
Flagga som anger aktivering/inaktivering av funktionen Burst Capacity Preview på kontot |
properties.enableCassandraConnector |
boolean |
Aktiverar Cassandra-anslutningsappen på Cosmos DB C*-kontot |
properties.enableFreeTier |
boolean |
Flagga för att ange om den kostnadsfria nivån är aktiverad. |
properties.enableMultipleWriteLocations |
boolean |
Gör att kontot kan skriva på flera platser |
properties.enablePartitionMerge |
boolean |
Flagga som anger aktivering/inaktivering av funktionen För partitionssammanslagning för kontot |
properties.ipRules |
Lista över IpRules. |
|
properties.isVirtualNetworkFilterEnabled |
boolean |
Flagga för att ange om du vill aktivera/inaktivera Virtual Network ACL-regler. |
properties.keyVaultKeyUri |
string |
URI för nyckelvalvet |
properties.keysMetadata |
Den här egenskapen ignoreras under uppdateringsåtgärden eftersom metadata är skrivskyddade. Objektet representerar metadata för kontonycklarna för Cosmos DB-kontot. |
|
properties.locations |
Location[] |
En matris som innehåller de georeplication-platser som är aktiverade för Cosmos DB-kontot. |
properties.minimalTlsVersion |
Anger den lägsta tillåtna Tls-versionen. Standardvärdet är Tls 1.2. API:er för Cassandra och Mongo fungerar bara med Tls 1.2. |
|
properties.networkAclBypass |
Anger vilka tjänster som tillåts att kringgå brandväggskontroller. |
|
properties.networkAclBypassResourceIds |
string[] |
En matris som innehåller resurs-ID:n för förbikoppling av nätverks-Acl för Cosmos DB-kontot. |
properties.publicNetworkAccess |
Om begäranden från offentligt nätverk tillåts |
|
properties.virtualNetworkRules |
Lista över Virtual Network ACL-regler som konfigurerats för Cosmos DB-kontot. |
|
tags |
object |
Taggar är en lista över nyckel/värde-par som beskriver resursen. De här taggarna kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB". |
DatabaseRestoreResource
Specifika databaser som ska återställas.
Name | Typ | Description |
---|---|---|
collectionNames |
string[] |
Namnen på samlingarna som är tillgängliga för återställning. |
databaseName |
string |
Namnet på databasen som är tillgänglig för återställning. |
DefaultConsistencyLevel
Standardkonsekvensnivån och konfigurationsinställningarna för Cosmos DB-kontot.
Name | Typ | Description |
---|---|---|
BoundedStaleness |
string |
|
ConsistentPrefix |
string |
|
Eventual |
string |
|
Session |
string |
|
Strong |
string |
FailoverPolicy
Redundansprincipen för en viss region för ett databaskonto.
Name | Typ | Description |
---|---|---|
failoverPriority |
integer |
Redundansprioriteten för regionen. En redundansprioritet på 0 anger en skrivregion. Det maximala värdet för en redundansprioritet = (totalt antal regioner – 1). Redundansprioritetsvärden måste vara unika för var och en av de regioner där databaskontot finns. |
id |
string |
Den unika identifieraren för den region där databaskontot replikeras till. Exempel: <accountName-locationName>><. |
locationName |
string |
Namnet på den region där databaskontot finns. |
GremlinDatabaseRestoreResource
Specifika Gremlin-databaser som ska återställas.
Name | Typ | Description |
---|---|---|
databaseName |
string |
Namnet på den gremlindatabas som är tillgänglig för återställning. |
graphNames |
string[] |
Namnen på de grafer som är tillgängliga för återställning. |
IpAddressOrRange
IpAddressOrRange-objekt
Name | Typ | Description |
---|---|---|
ipAddressOrRange |
string |
En enda IPv4-adress eller ett enda IPv4-adressintervall i CIDR-format. Angivna IP-adresser måste vara välformaterade och kan inte finnas i något av följande intervall: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, eftersom dessa inte kan tillämpas av IP-adressfiltret. Exempel på giltiga indata: "23.40.210.245" eller "23.40.210.0/8". |
Location
En region där Azure Cosmos DB-databaskontot distribueras.
Name | Typ | Description |
---|---|---|
documentEndpoint |
string |
Anslutningsslutpunkten för den specifika regionen. Exempel: https://< accountName-locationName.documents.azure.com:443/><> |
failoverPriority |
integer |
Regionens redundansprioritet. Redundansprioritet 0 anger en skrivregion. Det maximala värdet för en redundansprioritet = (totalt antal regioner – 1). Prioritetsvärden för redundans måste vara unika för var och en av de regioner där databaskontot finns. |
id |
string |
Den unika identifieraren för regionen i databaskontot. Exempel: <accountName-locationName>><. |
isZoneRedundant |
boolean |
Flagga för att ange om den här regionen är en AvailabilityZone-region eller inte |
locationName |
string |
Namnet på regionen. |
provisioningState |
string |
Status för Cosmos DB-kontot vid den tidpunkt då åtgärden anropades. Statusen kan vara något av följande. "Skapar" – Cosmos DB-kontot skapas. När ett konto är i läget Skapa returneras endast egenskaper som anges som indata för Skapa Cosmos DB-kontoåtgärden. "Lyckades" – Cosmos DB-kontot är aktivt för användning. "Uppdaterar" – Cosmos DB-kontot uppdateras. "Tar bort" – Cosmos DB-kontot tas bort. "Misslyckades" – Cosmos DB-kontot kunde inte skapas. "DeletionFailed" – Det gick inte att ta bort Cosmos DB-kontot. |
ManagedServiceIdentity
Identitet för resursen.
Name | Typ | Description |
---|---|---|
principalId |
string |
Huvud-ID:t för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet. |
tenantId |
string |
Klient-ID:t för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet. |
type |
Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten. |
|
userAssignedIdentities |
Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
MinimalTlsVersion
Anger den lägsta tillåtna Tls-versionen. Standardvärdet är Tls 1.2. Cassandra- och Mongo-API:er fungerar bara med Tls 1.2.
Name | Typ | Description |
---|---|---|
Tls |
string |
|
Tls11 |
string |
|
Tls12 |
string |
NetworkAclBypass
Anger vilka tjänster som tillåts kringgå brandväggskontroller.
Name | Typ | Description |
---|---|---|
AzureServices |
string |
|
None |
string |
PeriodicModeBackupPolicy
Objektet som representerar säkerhetskopieringspolicy för periodiskt läge.
Name | Typ | Description |
---|---|---|
migrationState |
Objektet som representerar migreringens tillstånd mellan säkerhetskopieringsprinciperna. |
|
periodicModeProperties |
Konfigurationsvärden för periodisk säkerhetskopiering i läge |
|
type |
string:
Periodic |
Beskriver läget för säkerhetskopior. |
PeriodicModeProperties
Konfigurationsvärden för säkerhetskopiering i periodiskt läge
Name | Typ | Description |
---|---|---|
backupIntervalInMinutes |
integer |
Ett heltal som representerar intervallet i minuter mellan två säkerhetskopior |
backupRetentionIntervalInHours |
integer |
Ett heltal som representerar den tid (i timmar) som varje säkerhetskopia behålls |
backupStorageRedundancy |
Räkna upp för att ange typ av säkerhetskopieringshemvist |
PrivateEndpointConnection
En privat slutpunktsanslutning
Name | Typ | Description |
---|---|---|
id |
string |
Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Namnet på resursen |
properties.groupId |
string |
Grupp-ID för den privata slutpunkten. |
properties.privateEndpoint |
Privat slutpunkt som anslutningen tillhör. |
|
properties.privateLinkServiceConnectionState |
Anslutningstillstånd för den privata slutpunktsanslutningen. |
|
properties.provisioningState |
string |
Etableringstillstånd för den privata slutpunkten. |
type |
string |
Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" |
PrivateEndpointProperty
Privat slutpunkt som anslutningen tillhör.
Name | Typ | Description |
---|---|---|
id |
string |
Resurs-ID för den privata slutpunkten. |
PrivateLinkServiceConnectionStateProperty
Anslutningstillstånd för den privata slutpunktsanslutningen.
Name | Typ | Description |
---|---|---|
actionsRequired |
string |
Alla åtgärder som krävs utöver grundläggande arbetsflöde (godkänn/avvisa/koppla från) |
description |
string |
Beskrivning av tjänstanslutningen för privat länk. |
status |
string |
Anslutningsstatus för tjänsten private link. |
PublicNetworkAccess
Om begäranden från offentligt nätverk tillåts
Name | Typ | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
|
SecuredByPerimeter |
string |
ResourceIdentityType
Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.
Name | Typ | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned,UserAssigned |
string |
|
UserAssigned |
string |
RestoreMode
Beskriver återställningsläget.
Name | Typ | Description |
---|---|---|
PointInTime |
string |
RestoreParameters
Parametrar som anger information om återställningen.
Name | Typ | Description |
---|---|---|
databasesToRestore |
Lista över specifika databaser som är tillgängliga för återställning. |
|
gremlinDatabasesToRestore |
Lista över specifika gremlin-databaser som är tillgängliga för återställning. |
|
restoreMode |
Beskriver återställningsläget. |
|
restoreSource |
string |
ID:t för det återställningsbara databaskonto som återställningen måste initieras från. Exempel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
restoreTimestampInUtc |
string |
Tid då kontot måste återställas (ISO-8601-format). |
tablesToRestore |
string[] |
Lista över specifika tabeller som är tillgängliga för återställning. |
ServerVersion
Beskriver ServerVersion för ett MongoDB-konto.
Name | Typ | Description |
---|---|---|
3.2 |
string |
|
3.6 |
string |
|
4.0 |
string |
|
4.2 |
string |
|
5.0 |
string |
|
6.0 |
string |
systemData
Metadata som rör skapande och senaste ändring av resursen.
Name | Typ | Description |
---|---|---|
createdAt |
string |
Tidsstämpeln för resursskapande (UTC). |
createdBy |
string |
Identiteten som skapade resursen. |
createdByType |
Den typ av identitet som skapade resursen. |
|
lastModifiedAt |
string |
Tidsstämpeln för resursens senaste ändring (UTC) |
lastModifiedBy |
string |
Identiteten som senast ändrade resursen. |
lastModifiedByType |
Den typ av identitet som senast ändrade resursen. |
UserAssignedIdentities
Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
Name | Typ | Description |
---|---|---|
|
VirtualNetworkRule
Virtual Network ACL-regelobjekt
Name | Typ | Description |
---|---|---|
id |
string |
Resurs-ID för ett undernät, till exempel: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. |
ignoreMissingVNetServiceEndpoint |
boolean |
Skapa brandväggsregel innan VNet-tjänstslutpunkten är aktiverad för det virtuella nätverket. |