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

Sql Resources - Get Sql Container

获取现有 Azure Cosmos DB 数据库帐户下的SQL容器。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}?api-version=2021-07-01-preview

URI 参数

Name In Required Type Description
accountName
path True
  • string

Cosmos DB 数据库帐户名称。

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

containerName
path True
  • string

Cosmos DB 容器名称。

databaseName
path True
  • string

Cosmos DB 数据库名称。

resourceGroupName
path True
  • string

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

subscriptionId
path True
  • string

目标订阅的 ID。

api-version
query True
  • string

要用于此操作的 API 版本。

响应

Name Type Description
200 OK

已成功检索SQL容器属性。

安全性

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 模拟用户帐户

示例

CosmosDBSqlContainerGet

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rgName/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/containers/containerName?api-version=2021-07-01-preview

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/containers/containerName",
  "name": "containerName",
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers",
  "location": "West US",
  "tags": {},
  "properties": {
    "resource": {
      "id": "containerName",
      "indexingPolicy": {
        "indexingMode": "consistent",
        "automatic": true,
        "includedPaths": [
          {
            "path": "/*",
            "indexes": [
              {
                "kind": "Range",
                "dataType": "String",
                "precision": -1
              },
              {
                "kind": "Range",
                "dataType": "Number",
                "precision": -1
              }
            ]
          }
        ],
        "excludedPaths": []
      },
      "partitionKey": {
        "paths": [
          "/AccountNumber"
        ],
        "kind": "Hash"
      },
      "defaultTtl": 100,
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [
              "/testPath"
            ]
          }
        ]
      },
      "conflictResolutionPolicy": {
        "mode": "LastWriterWins",
        "conflictResolutionPath": "/path"
      },
      "_rid": "PD5DALigDgw=",
      "_ts": 1459200611,
      "_etag": "\"00005900-0000-0000-0000-56f9a2630000\""
    },
    "options": {
      "throughput": 400
    }
  }
}

定义

AutoscaleSettings
ConflictResolutionMode

指示冲突解决模式。

ConflictResolutionPolicy

容器的冲突解决策略。

ContainerPartitionKey

用于将数据分区到多个分区的分区键的配置

DataType

为其应用索引行为的数据类型。

ExcludedPath
IncludedPath

索引中包含的路径

Indexes

路径的索引。

IndexingMode

指示索引模式。

IndexingPolicy

Cosmos DB 索引策略

IndexKind

指示索引的类型。

ManagedServiceIdentity

资源的标识。

Options
PartitionKind

指示用于分区的算法类型。 对于 MultiHash,容器创建最多支持三个最大) (多个分区键

Resource
ResourceIdentityType

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

SpatialSpec
SqlContainerGetResults

一个 Azure Cosmos DB 容器。

UniqueKey

对 Azure Cosmos DB 服务集合中的文档强制实施唯一性约束的唯一键。

UniqueKeyPolicy

用于指定 Azure Cosmos DB 服务集合中文档的唯一性约束的唯一键策略配置。

UserAssignedIdentities

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

AutoscaleSettings

Name Type Description
maxThroughput
  • integer

表示最大吞吐量,资源可以纵向扩展。

ConflictResolutionMode

指示冲突解决模式。

Name Type Description
Custom
  • string
LastWriterWins
  • string

ConflictResolutionPolicy

容器的冲突解决策略。

Name Type Default Value Description
conflictResolutionPath
  • string

LastWriterWins 模式时冲突解决路径。

conflictResolutionProcedure
  • string

解决自定义模式冲突的过程。

mode LastWriterWins

指示冲突解决模式。

ContainerPartitionKey

用于将数据分区到多个分区的分区键的配置

Name Type Default Value Description
kind Hash

指示用于分区的算法类型。 对于 MultiHash,容器创建最多支持三个最大) (多个分区键

paths
  • string[]

可以使用其中对容器中的数据进行分区的路径列表

systemKey
  • boolean

指示容器是否使用系统生成的分区键

version
  • integer

指示分区键定义的版本

DataType

为其应用索引行为的数据类型。

Name Type Description
LineString
  • string
MultiPolygon
  • string
Number
  • string
Point
  • string
Polygon
  • string
String
  • string

ExcludedPath

Name Type Description
path
  • string

索引行为应用于的路径。 索引路径通常以根开头,以通配符结尾 (/path/*)

IncludedPath

索引中包含的路径

Name Type Description
indexes

此路径的索引列表

path
  • string

索引行为应用于的路径。 索引路径通常以根开头,以通配符结尾 (/path/*)

Indexes

路径的索引。

Name Type Default Value Description
dataType String

为其应用索引行为的数据类型。

kind Hash

指示索引的类型。

precision
  • integer

索引的精度。 -1 是最大精度。

IndexingMode

指示索引模式。

Name Type Description
consistent
  • string
lazy
  • string
none
  • string

IndexingPolicy

Cosmos DB 索引策略

Name Type Default Value Description
automatic
  • boolean

指示索引策略是否自动

compositeIndexes
  • array[]

复合路径列表列表

excludedPaths

要从索引中排除的路径列表

includedPaths

要包含在索引中的路径列表

indexingMode consistent

指示索引模式。

spatialIndexes

空间细节列表

IndexKind

指示索引的类型。

Name Type Description
Hash
  • string
Range
  • string
Spatial
  • string

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}”。

Options

Name Type Description
autoscaleSettings

指定自动缩放设置。

throughput
  • integer

Cosmos DB 资源吞吐量或自动缩放设置的值。 检索产品/服务详细信息时,请使用 ThroughputSetting 资源。

PartitionKind

指示用于分区的算法类型。 对于 MultiHash,容器创建最多支持三个最大) (多个分区键

Name Type Description
Hash
  • string
MultiHash
  • string
Range
  • string

Resource

Name Type Description
_etag
  • string

一个系统生成的属性,表示乐观并发控制所需的资源 etag。

_rid
  • string

系统生成的属性。 唯一标识符。

_ts
  • number

一个系统生成的属性,表示资源的上次更新时间戳。

analyticalStorageTtl
  • integer

分析 TTL。

conflictResolutionPolicy

容器的冲突解决策略。

defaultTtl
  • integer

默认生存时间

id
  • string

Cosmos DB SQL 容器的名称

indexingPolicy

索引策略的配置。 默认情况下,容器中所有文档路径的索引都是自动的

partitionKey

用于将数据分区到多个分区的分区键的配置

uniqueKeyPolicy

用于指定 Azure Cosmos DB 服务集合中文档的唯一性约束的唯一键策略配置。

ResourceIdentityType

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

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

SpatialSpec

Name Type Description
path
  • string

索引行为应用于的路径。 索引路径通常以根开头,以通配符结尾 (/path/*)

types
  • string[]

路径的空间类型列表

SqlContainerGetResults

一个 Azure Cosmos DB 容器。

Name Type Description
id
  • string

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

identity

资源的标识。

location
  • string

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

name
  • string

ARM 资源的名称。

properties.options
properties.resource
tags
  • object

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

type
  • string

Azure 资源的类型。

UniqueKey

对 Azure Cosmos DB 服务集合中的文档强制实施唯一性约束的唯一键。

Name Type Description
paths
  • string[]

路径列表对于 Azure Cosmos DB 服务中的每个文档必须是唯一的

UniqueKeyPolicy

用于指定 Azure Cosmos DB 服务集合中文档的唯一性约束的唯一键策略配置。

Name Type Description
uniqueKeys

对 Azure Cosmos DB 服务集合中的文档强制实施唯一性约束的唯一键列表。

UserAssignedIdentities

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

Name Type Description