| Description | : Retrieves the properties of an existing Azure Cosmos DB database account. |
| Reference | : Link ¶ |
⚼ Request
GET:
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
{
subscriptionId:
string
,
resourceGroupName:
string
,
accountName:
string
,
api-version:
string
,
}
⚐ Response (200)
{
kind:
enum
,
identity:
{
,
principalId:
string
,
tenantId:
string
,
type:
enum
,
userAssignedIdentities:
object
,
}
properties:
{
,
provisioningState:
string
,
documentEndpoint:
string
,
databaseAccountOfferType:
enum
,
ipRules:
[
]
,
{
,
ipAddressOrRange:
string
,
}
isVirtualNetworkFilterEnabled:
boolean
,
enableAutomaticFailover:
boolean
,
consistencyPolicy:
{
,
defaultConsistencyLevel:
enum
,
maxStalenessPrefix:
integer
,
maxIntervalInSeconds:
integer
,
}
capabilities:
[
]
,
{
,
name:
string
,
}
writeLocations:
[
]
,
{
,
id:
string
,
locationName:
string
,
documentEndpoint:
string
,
provisioningState:
string
,
failoverPriority:
integer
,
isZoneRedundant:
boolean
,
}
readLocations:
[
]
,
{
,
id:
string
,
locationName:
string
,
documentEndpoint:
string
,
provisioningState:
string
,
failoverPriority:
integer
,
isZoneRedundant:
boolean
,
}
locations:
[
]
,
{
,
id:
string
,
locationName:
string
,
documentEndpoint:
string
,
provisioningState:
string
,
failoverPriority:
integer
,
isZoneRedundant:
boolean
,
}
failoverPolicies:
[
]
,
{
,
id:
string
,
locationName:
string
,
failoverPriority:
integer
,
}
virtualNetworkRules:
[
]
,
{
,
id:
string
,
ignoreMissingVNetServiceEndpoint:
boolean
,
}
privateEndpointConnections:
[
]
,
{
,
properties:
}
{
,
privateEndpoint:
{
,
id:
string
,
}
privateLinkServiceConnectionState:
{
,
status:
string
,
description:
string
,
actionsRequired:
string
,
}
groupId:
string
,
provisioningState:
string
,
}
enableMultipleWriteLocations:
boolean
,
enableCassandraConnector:
boolean
,
connectorOffer:
enum
,
disableKeyBasedMetadataWriteAccess:
boolean
,
keyVaultKeyUri:
string
,
defaultIdentity:
string
,
publicNetworkAccess:
enum
,
enableFreeTier:
boolean
,
apiProperties:
{
,
serverVersion:
enum
,
}
enableAnalyticalStorage:
boolean
,
analyticalStorageConfiguration:
{
,
schemaType:
enum
,
}
instanceId:
string
,
createMode:
enum
,
restoreParameters:
{
,
restoreMode:
enum
,
databasesToRestore:
[
]
,
{
,
databaseName:
string
,
collectionNames:
}
[
,
string
,
]
gremlinDatabasesToRestore:
[
]
,
{
,
databaseName:
string
,
graphNames:
}
[
,
string
,
]
tablesToRestore:
}
[
,
string
,
]
backupPolicy:
{
,
type:
enum
,
migrationState:
}
{
,
status:
enum
,
targetType:
enum
,
startTime:
string
,
}
cors:
[
]
,
{
,
allowedOrigins:
string
,
allowedMethods:
string
,
allowedHeaders:
string
,
exposedHeaders:
string
,
maxAgeInSeconds:
integer
,
}
networkAclBypass:
enum
,
networkAclBypassResourceIds:
[
,
string
,
]
disableLocalAuth:
boolean
,
capacity:
{
,
totalThroughputLimit:
integer
,
}
keysMetadata:
{
,
primaryMasterKey:
{
,
generationTime:
string
,
}
secondaryMasterKey:
{
,
generationTime:
string
,
}
primaryReadonlyMasterKey:
{
,
generationTime:
string
,
}
secondaryReadonlyMasterKey:
}
{
,
generationTime:
string
,
}
enablePartitionMerge:
boolean
,
minimalTlsVersion:
enum
,
enableBurstCapacity:
boolean
,
customerManagedKeyStatus:
string
,
enablePerRegionPerPartitionAutoscale:
boolean
,
}
systemData:
}
{
,
createdBy:
string
,
createdByType:
enum
,
createdAt:
string
,
lastModifiedBy:
string
,
lastModifiedByType:
enum
,
lastModifiedAt:
string
,
}