你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Database Accounts - Get

检索现有 Azure Cosmos DB 数据库帐户的属性。

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

URI 参数

Name In Required Type Description
accountName
path True
  • string

Cosmos DB 数据库帐户名称。

Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*

resourceGroupName
path True
  • string

资源组的名称。 此名称不区分大小写。

subscriptionId
path True
  • string

目标订阅的 ID。

api-version
query True
  • string

要用于此操作的 API 版本。

响应

Name Type Description
200 OK

已成功检索数据库帐户属性。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

CosmosDBDatabaseAccountGet

Sample Request

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

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1",
  "name": "ddb1",
  "location": "West US",
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "kind": "GlobalDocumentDB",
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "documentEndpoint": "https://ddb1.documents.azure.com:443/",
    "ipRules": [],
    "isVirtualNetworkFilterEnabled": false,
    "virtualNetworkRules": [],
    "databaseAccountOfferType": "Standard",
    "disableKeyBasedMetadataWriteAccess": false,
    "defaultIdentity": "FirstPartyIdentity",
    "consistencyPolicy": {
      "defaultConsistencyLevel": "Session",
      "maxIntervalInSeconds": 5,
      "maxStalenessPrefix": 100
    },
    "writeLocations": [
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/",
        "provisioningState": "Succeeded",
        "failoverPriority": 0
      }
    ],
    "readLocations": [
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/",
        "provisioningState": "Succeeded",
        "failoverPriority": 0
      }
    ],
    "locations": [
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/",
        "provisioningState": "Succeeded",
        "failoverPriority": 0
      }
    ],
    "failoverPolicies": [
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "failoverPriority": 0
      }
    ],
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.DocumentDB/databaseAccounts/account1/privateEndpointConnections/pe1",
        "properties": {
          "privateEndpoint": {
            "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/pe1"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "actionsRequired": "None"
          }
        }
      }
    ],
    "cors": [],
    "enableFreeTier": false,
    "apiProperties": {},
    "enableAnalyticalStorage": true,
    "analyticalStorageConfiguration": {
      "schemaType": "WellDefined"
    },
    "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d",
    "createMode": "Default",
    "backupPolicy": {
      "type": "Periodic",
      "periodicModeProperties": {
        "backupIntervalInMinutes": 240,
        "backupRetentionIntervalInHours": 8,
        "backupStorageRedundancy": "Geo"
      },
      "migrationState": {
        "status": "InProgress",
        "targetType": "Continuous",
        "startTime": "2021-06-09T21:07:16Z"
      }
    },
    "networkAclBypass": "None",
    "networkAclBypassResourceIds": []
  },
  "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"
      }
    }
  }
}

定义

AnalyticalStorageConfiguration

分析存储特定属性。

AnalyticalStorageSchemaType

描述分析存储的架构类型。

ApiProperties
BackupPolicyMigrationState

表示备份策略之间迁移状态的对象。

BackupPolicyMigrationStatus

描述备份策略类型之间的迁移状态。

BackupPolicyType

描述备份模式。

BackupStorageRedundancy

用于指示备份存储冗余类型的枚举。

Capability

Cosmos DB 功能对象

Capacity

表示与帐户上的容量强制实施相关的所有属性的对象。

ConnectorOffer

Cassandra 连接器为 Cosmos DB C* 数据库帐户提供类型。

ConsistencyPolicy

Cosmos DB 数据库帐户的一致性策略。

ContinuousModeBackupPolicy

表示连续模式备份策略的对象。

CorsPolicy

Cosmos DB 数据库帐户的 CORS 策略。

createdByType

创建资源的标识的类型。

CreateMode

用于指示帐户创建模式的枚举。

DatabaseAccountGetResults

Azure Cosmos DB 数据库帐户。

DatabaseAccountKind

指示数据库帐户的类型。 这只能在数据库帐户创建时设置。

DatabaseAccountOfferType

Cosmos DB 数据库帐户的产品/服务类型。

DatabaseRestoreResource

要还原的特定数据库。

DefaultConsistencyLevel

Cosmos DB 帐户的默认一致性级别和配置设置。

FailoverPolicy

数据库帐户的给定区域的故障转移策略。

IpAddressOrRange

IpAddressOrRange 对象

Location

部署 Azure Cosmos DB 数据库帐户的区域。

ManagedServiceIdentity

资源的标识。

NetworkAclBypass

指示允许哪些服务绕过防火墙检查。

PeriodicModeBackupPolicy

表示定期模式备份策略的对象。

PeriodicModeProperties

定期模式备份的配置值

PrivateEndpointConnection

专用终结点连接

PrivateEndpointProperty

连接所属的专用终结点。

PrivateLinkServiceConnectionStateProperty

专用终结点连接的连接状态。

PublicNetworkAccess

是否允许来自公用网络的请求

ResourceIdentityType

用于资源的标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。

RestoreMode

描述还原模式。

RestoreParameters

用于指示有关还原的信息的参数。

ServerVersion

描述 MongoDB 帐户的 ServerVersion。

systemData

与创建和上次修改资源相关的元数据。

UserAssignedIdentities

与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

VirtualNetworkRule

虚拟网络 ACL 规则对象

AnalyticalStorageConfiguration

分析存储特定属性。

Name Type Description
schemaType

描述分析存储的架构类型。

AnalyticalStorageSchemaType

描述分析存储的架构类型。

Name Type Description
FullFidelity
  • string
WellDefined
  • string

ApiProperties

Name Type Description
serverVersion

描述 MongoDB 帐户的 ServerVersion。

BackupPolicyMigrationState

表示备份策略之间迁移状态的对象。

Name Type Description
startTime
  • string

备份策略迁移开始的时间 (ISO-8601 格式) 。

status

描述备份策略类型之间的迁移状态。

targetType

描述备份策略迁移的目标备份策略类型。

BackupPolicyMigrationStatus

描述备份策略类型之间的迁移状态。

Name Type Description
Completed
  • string
Failed
  • string
InProgress
  • string
Invalid
  • string

BackupPolicyType

描述备份模式。

Name Type Description
Continuous
  • string
Periodic
  • string

BackupStorageRedundancy

用于指示备份存储冗余类型的枚举。

Name Type Description
Geo
  • string
Local
  • string
Zone
  • string

Capability

Cosmos DB 功能对象

Name Type Description
name
  • string

Cosmos DB 功能的名称。 例如,“name”:“EnableCassandra”。 当前值还包括“EnableTable”和“EnableGremlin”。

Capacity

表示与帐户上的容量强制实施相关的所有属性的对象。

Name Type Description
totalThroughputLimit
  • integer

对帐户施加的总吞吐量限制。 2000 的 totalThroughputLimit 对可以预配到 2000 的帐户的最大吞吐量施加严格限制。 totalThroughputLimit 为 -1 表示对预配吞吐量没有限制。

ConnectorOffer

Cassandra 连接器为 Cosmos DB C* 数据库帐户提供类型。

Name Type Description
Small
  • string

ConsistencyPolicy

Cosmos DB 数据库帐户的一致性策略。

Name Type Description
defaultConsistencyLevel

Cosmos DB 帐户的默认一致性级别和配置设置。

maxIntervalInSeconds
  • integer

与有限过期一致性级别一起使用时,此值表示容忍) 的秒内过期时间 ( (。 此值的接受范围为 5 - 86400。 defaultConsistencyPolicy 设置为“BoundedStaleness”时必需。

maxStalenessPrefix
  • integer

与有限过期一致性级别一起使用时,此值表示允许的过时请求数。 此值的接受范围为 1 – 2,147,483,647。 defaultConsistencyPolicy 设置为“BoundedStaleness”时必需。

ContinuousModeBackupPolicy

表示连续模式备份策略的对象。

Name Type Description
migrationState

表示备份策略之间迁移状态的对象。

type string:
  • Continuous

描述备份模式。

CorsPolicy

Cosmos DB 数据库帐户的 CORS 策略。

Name Type Description
allowedHeaders
  • string

源域可以在 CORS 请求上指定的请求标头。

allowedMethods
  • string

源域可用于 CORS 请求的方法(HTTP 请求谓词)。

allowedOrigins
  • string

允许通过 CORS 针对服务发出请求的源域。

exposedHeaders
  • string

可以在 CORS 请求响应中发送并由浏览器向请求发出方公开的响应标头。

maxAgeInSeconds
  • integer

浏览器应缓存预检 OPTIONS 请求的最长时间。

createdByType

创建资源的标识的类型。

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

CreateMode

用于指示帐户创建模式的枚举。

Name Type Description
Default
  • string
Restore
  • string

DatabaseAccountGetResults

Azure Cosmos DB 数据库帐户。

Name Type Default Value Description
id
  • string

ARM 资源的唯一资源标识符。

identity

资源的标识。

kind GlobalDocumentDB

指示数据库帐户的类型。 这只能在数据库帐户创建时设置。

location
  • string

资源所属的资源组的位置。

name
  • string

ARM 资源的名称。

properties.analyticalStorageConfiguration

分析存储特定属性。

properties.apiProperties

API 特定属性。

properties.backupPolicy BackupPolicy:

表示在帐户上执行备份的策略的对象。

properties.capabilities

帐户的 Cosmos DB 功能列表

properties.capacity

表示帐户上容量强制实施的所有属性的对象。

properties.connectorOffer

Cassandra 连接器为 Cosmos DB 数据库 C* 帐户提供类型。

properties.consistencyPolicy

Cosmos DB 数据库帐户的一致性策略。

properties.cors

Cosmos DB 数据库帐户的 CORS 策略。

properties.createMode Default

用于指示帐户创建模式的枚举。

properties.databaseAccountOfferType

Cosmos DB 数据库帐户的产品/服务类型。 默认值:标准。

properties.defaultIdentity
  • string

用于访问客户托管密钥等功能中使用的密钥保管库的默认标识。 用户需要显式设置默认标识。 它可以是“FirstPartyIdentity”、“SystemAssignedIdentity”等。

properties.disableKeyBasedMetadataWriteAccess
  • boolean

通过帐户密钥禁用对元数据资源 (数据库、容器、吞吐量) 的写入操作

properties.disableLocalAuth
  • boolean

选择退出本地身份验证,并确保只能将 MSI 和 AAD 用于身份验证。

properties.documentEndpoint
  • string

Cosmos DB 数据库帐户的连接终结点。

properties.enableAnalyticalStorage
  • boolean

用于指示是否启用存储分析的标志。

properties.enableAutomaticFailover
  • boolean

在发生服务中断导致区域不可用的罕见事件中,启用写入区域的自动故障转移。 自动故障转移将导致帐户的新写入区域,并根据为帐户配置的故障转移优先级进行选择。

properties.enableCassandraConnector
  • boolean

在 Cosmos DB C* 帐户上启用 cassandra 连接器

properties.enableFreeTier
  • boolean

指示是否启用免费层的标志。

properties.enableMultipleWriteLocations
  • boolean

使帐户能够在多个位置写入

properties.failoverPolicies

包含按其故障转移优先级排序的区域的数组。

properties.instanceId
  • string

分配给数据库帐户的唯一标识符

properties.ipRules

IpRules 列表。

properties.isVirtualNetworkFilterEnabled
  • boolean

用于指示是否启用/禁用 虚拟网络 ACL 规则的标志。

properties.keyVaultKeyUri
  • string

密钥保管库的 URI

properties.locations

一个数组,其中包含为 Cosmos DB 帐户启用的所有位置。

properties.networkAclBypass

指示允许哪些服务绕过防火墙检查。

properties.networkAclBypassResourceIds
  • string[]

包含 Cosmos DB 帐户的网络 Acl 旁路的资源 ID 的数组。

properties.privateEndpointConnections

为 Cosmos DB 帐户配置的专用终结点连接列表。

properties.provisioningState
  • string

调用操作时 Cosmos DB 帐户的状态。 状态可以是下列状态之一。 “创建”- 正在创建 Cosmos DB 帐户。 当帐户处于“创建”状态时,仅返回指定为创建 Cosmos DB 帐户操作输入的属性。 “成功”– Cosmos DB 帐户处于活动状态以供使用。 “正在更新” - 正在更新 Cosmos DB 帐户。 “删除”- 正在删除 Cosmos DB 帐户。 “失败”- Cosmos DB 帐户创建失败。 “DeletionFailed”– Cosmos DB 帐户删除失败。

properties.publicNetworkAccess

是否允许来自公用网络的请求

properties.readLocations

包含为 Cosmos DB 帐户启用的读取位置的数组。

properties.restoreParameters

用于指示还原信息的参数。

properties.virtualNetworkRules

为 Cosmos DB 帐户配置的 虚拟网络 ACL 规则列表。

properties.writeLocations

包含 Cosmos DB 帐户的写入位置的数组。

systemData

与此资源相关的系统元数据。

tags
  • object

标记是描述资源的键值对的列表。 在查看此资源和为此资源分组(跨资源组)时,可以使用这些标记。 最多可为资源提供 15 个标记。 每个标记的键不能超过 128 个字符,值不能超过 256 个字符。 例如,模板类型的默认体验设置为“defaultExperience”:“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。

type
  • string

Azure 资源的类型。

DatabaseAccountKind

指示数据库帐户的类型。 这只能在数据库帐户创建时设置。

Name Type Description
GlobalDocumentDB
  • string
MongoDB
  • string
Parse
  • string

DatabaseAccountOfferType

Cosmos DB 数据库帐户的产品/服务类型。

Name Type Description
Standard
  • string

DatabaseRestoreResource

要还原的特定数据库。

Name Type Description
collectionNames
  • string[]

可用于还原的集合的名称。

databaseName
  • string

可用于还原的数据库的名称。

DefaultConsistencyLevel

Cosmos DB 帐户的默认一致性级别和配置设置。

Name Type Description
BoundedStaleness
  • string
ConsistentPrefix
  • string
Eventual
  • string
Session
  • string
Strong
  • string

FailoverPolicy

数据库帐户的给定区域的故障转移策略。

Name Type Description
failoverPriority
  • integer

区域的故障转移优先级。 故障转移优先级为 0 表示写入区域。 故障转移优先级的最大值 = (总区域数 - 1) 。 对于数据库帐户所在的每个区域,故障转移优先级值必须是唯一的。

id
  • string

数据库帐户复制到的区域的唯一标识符。 示例:<accountName-locationName>><。

locationName
  • string

数据库帐户所在的区域的名称。

IpAddressOrRange

IpAddressOrRange 对象

Name Type Description
ipAddressOrRange
  • string

单个 IPv4 地址或 CIDR 格式的单个 IPv4 地址范围。 提供的 IP 格式必须正确,并且不能包含在以下范围之一:10.0.0.0/8、100.64.0.0/10、172.16.0.0/12、192.168.0.0/16,因为这些 IP 地址筛选器不可强制执行。 有效输入的示例:“23.40.210.245”或“23.40.210.0/8”。

Location

部署 Azure Cosmos DB 数据库帐户的区域。

Name Type Description
documentEndpoint
  • string

特定区域的连接终结点。 示例:https://< accountName-locationName.documents.azure.com:443/><>

failoverPriority
  • integer

区域的故障转移优先级。 故障转移优先级为 0 表示写入区域。 故障转移优先级的最大值 = (总区域数 - 1) 。 对于数据库帐户所在的每个区域,故障转移优先级值必须是唯一的。

id
  • string

数据库帐户中区域的唯一标识符。 示例:<accountName-locationName>><。

isZoneRedundant
  • boolean

指示此区域是否为 AvailabilityZone 区域的标志

locationName
  • string

区域的名称。

provisioningState
  • string

调用操作时 Cosmos DB 帐户的状态。 状态可以是下列状态之一。 “创建”- 正在创建 Cosmos DB 帐户。 当帐户处于“创建”状态时,仅返回指定为创建 Cosmos DB 帐户操作输入的属性。 “Succeeded”– Cosmos DB 帐户处于活动状态以供使用。 “正在更新”– 正在更新 Cosmos DB 帐户。 “删除”– 正在删除 Cosmos DB 帐户。 “Failed”– Cosmos DB 帐户创建失败。 “DeletionFailed”– Cosmos DB 帐户删除失败。

ManagedServiceIdentity

资源的标识。

Name Type Description
principalId
  • string

系统分配标识的主体 ID。 此属性仅适用于系统分配的标识。

tenantId
  • string

系统分配标识的租户 ID。 此属性仅适用于系统分配的标识。

type

用于资源的标识类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。

userAssignedIdentities

与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

NetworkAclBypass

指示允许哪些服务绕过防火墙检查。

Name Type Description
AzureServices
  • string
None
  • string

PeriodicModeBackupPolicy

表示定期模式备份策略的对象。

Name Type Description
migrationState

表示备份策略之间迁移状态的对象。

periodicModeProperties

定期模式备份的配置值

type string:
  • Periodic

描述备份模式。

PeriodicModeProperties

定期模式备份的配置值

Name Type Description
backupIntervalInMinutes
  • integer

一个整数,表示两个备份之间的间隔(以分钟为单位)

backupRetentionIntervalInHours
  • integer

一个整数,表示保留每个备份) 小时 (的时间

backupStorageRedundancy

用于指示备份驻留类型的枚举

PrivateEndpointConnection

专用终结点连接

Name Type Description
id
  • string

资源的完全限定的资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

资源的名称

properties.groupId
  • string

专用终结点的组 ID。

properties.privateEndpoint

连接所属的专用终结点。

properties.privateLinkServiceConnectionState

专用终结点连接的连接状态。

properties.provisioningState
  • string

专用终结点的预配状态。

type
  • string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

PrivateEndpointProperty

连接所属的专用终结点。

Name Type Description
id
  • string

专用终结点的资源 ID。

PrivateLinkServiceConnectionStateProperty

专用终结点连接的连接状态。

Name Type Description
actionsRequired
  • string

除基本工作流之外的任何操作 (批准/拒绝/断开连接)

description
  • string

专用链接服务连接说明。

status
  • string

专用链接服务连接状态。

PublicNetworkAccess

是否允许来自公用网络的请求

Name Type Description
Disabled
  • string
Enabled
  • string

ResourceIdentityType

用于资源的标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned,UserAssigned
  • string
UserAssigned
  • string

RestoreMode

描述还原模式。

Name Type Description
PointInTime
  • string

RestoreParameters

用于指示有关还原的信息的参数。

Name Type Description
databasesToRestore

可用于还原的特定数据库的列表。

restoreMode

描述还原模式。

restoreSource
  • string

必须从中启动还原的可还原数据库帐户的 ID。 例如:/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}

restoreTimestampInUtc
  • string

帐户必须还原的时间 (ISO-8601 格式) 。

ServerVersion

描述 MongoDB 帐户的 ServerVersion。

Name Type Description
3.2
  • string
3.6
  • string
4.0
  • string
4.2
  • string

systemData

与创建和上次修改资源相关的元数据。

Name Type Description
createdAt
  • string

资源创建时间戳 (UTC) 。

createdBy
  • string

创建资源的标识。

createdByType

创建资源的标识的类型。

lastModifiedAt
  • string

资源上次修改的时间戳 (UTC)

lastModifiedBy
  • string

上次修改资源的标识。

lastModifiedByType

上次修改资源的标识的类型。

UserAssignedIdentities

与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

Name Type Description

VirtualNetworkRule

虚拟网络 ACL 规则对象

Name Type Description
id
  • string

子网的资源 ID,例如:/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}。

ignoreMissingVNetServiceEndpoint
  • boolean

在虚拟网络启用 vnet 服务终结点之前创建防火墙规则。