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

Service - List

获取服务的状态。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services?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

ServiceResource。

Other Status Codes

描述操作失败原因的错误响应。

安全性

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

示例

CosmosDBServicesList

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/services/sqlDedicatedGateway",
      "name": "sqlDedicatedGateway",
      "type": "Microsoft.DocumentDB/databaseAccounts/services",
      "properties": {
        "status": "Running",
        "creationTime": "2021-01-25T12:56:05.4622517Z",
        "instanceSize": "Cosmos.D4s",
        "instanceCount": 1,
        "serviceType": "SqlDedicatedGateway",
        "sqlDedicatedGatewayEndpoint": "https://sqlDedicatedGateway.sqlx.cosmos.windows-int.net/",
        "locations": [
          {
            "name": "sqlDedicatedGateway-westus2",
            "location": "West US 2",
            "status": "Running",
            "sqlDedicatedGatewayEndpoint": "https://sqlDedicatedGateway-westus.sqlx.cosmos.windows-int.net/"
          }
        ]
      }
    }
  ]
}

定义

CloudError

服务的错误响应。

DataTransferRegionalServiceResource

区域服务位置的资源。

DataTransferServiceResourceProperties

DataTransferServiceResource 的属性。

ErrorResponse

错误响应。

GraphAPIComputeRegionalServiceResource

区域服务位置的资源。

GraphAPIComputeServiceResourceProperties

GraphAPIComputeServiceResource 的属性。

MaterializedViewsBuilderRegionalServiceResource

区域服务位置的资源。

MaterializedViewsBuilderServiceResourceProperties

MaterializedViewsBuilderServiceResource 的属性。

ServiceResource

数据库帐户的属性。

ServiceResourceListResult

包含服务资源及其属性的列表操作响应。

ServiceSize

服务的实例类型。

ServiceStatus

描述服务的状态。

ServiceType

服务的 ServiceType。

SqlDedicatedGatewayRegionalServiceResource

区域服务位置的资源。

SqlDedicatedGatewayServiceResourceProperties

SqlDedicatedGatewayServiceResource 的属性。

CloudError

服务的错误响应。

Name Type Description
error

错误响应。

DataTransferRegionalServiceResource

区域服务位置的资源。

Name Type Description
location
  • string

位置名称。

name
  • string

区域服务名称。

status

描述服务的状态。

DataTransferServiceResourceProperties

DataTransferServiceResource 的属性。

Name Type Description
creationTime
  • string

上次状态更改的时间 (ISO-8601 格式) 。

instanceCount
  • integer

服务的实例计数。

instanceSize

服务的实例类型。

locations

包含服务的所有位置的数组。

serviceType string:
  • DataTransfer

服务的 ServiceType。

status

描述服务的状态。

ErrorResponse

错误响应。

Name Type Description
code
  • string

错误代码。

message
  • string

指示操作失败的原因的错误消息。

GraphAPIComputeRegionalServiceResource

区域服务位置的资源。

Name Type Description
graphApiComputeEndpoint
  • string

GraphAPICompute 的区域终结点。

location
  • string

位置名称。

name
  • string

区域服务名称。

status

描述服务的状态。

GraphAPIComputeServiceResourceProperties

GraphAPIComputeServiceResource 的属性。

Name Type Description
creationTime
  • string

上次状态更改的时间 (ISO-8601 格式) 。

graphApiComputeEndpoint
  • string

服务的 GraphAPICompute 终结点。

instanceCount
  • integer

服务的实例计数。

instanceSize

服务的实例类型。

locations

包含服务的所有位置的数组。

serviceType string:
  • GraphAPICompute

服务的 ServiceType。

status

描述服务的状态。

MaterializedViewsBuilderRegionalServiceResource

区域服务位置的资源。

Name Type Description
location
  • string

位置名称。

name
  • string

区域服务名称。

status

描述服务的状态。

MaterializedViewsBuilderServiceResourceProperties

MaterializedViewsBuilderServiceResource 的属性。

Name Type Description
creationTime
  • string

上次状态更改的时间 (ISO-8601 格式) 。

instanceCount
  • integer

服务的实例计数。

instanceSize

服务的实例类型。

locations

包含服务的所有位置的数组。

serviceType string:
  • MaterializedViewsBuilder

服务的 ServiceType。

status

描述服务的状态。

ServiceResource

数据库帐户的属性。

Name Type Description
id
  • string

数据库帐户的唯一资源标识符。

name
  • string

数据库帐户的名称。

properties ServiceResourceProperties:

服务响应资源。

type
  • string

Azure 资源的类型。

ServiceResourceListResult

包含服务资源及其属性的列表操作响应。

Name Type Description
value

服务资源及其属性的列表。

ServiceSize

服务的实例类型。

Name Type Description
Cosmos.D16s
  • string
Cosmos.D4s
  • string
Cosmos.D8s
  • string

ServiceStatus

描述服务的状态。

Name Type Description
Creating
  • string
Deleting
  • string
Error
  • string
Running
  • string
Stopped
  • string
Updating
  • string

ServiceType

服务的 ServiceType。

Name Type Description
DataTransfer
  • string
GraphAPICompute
  • string
MaterializedViewsBuilder
  • string
SqlDedicatedGateway
  • string

SqlDedicatedGatewayRegionalServiceResource

区域服务位置的资源。

Name Type Description
location
  • string

位置名称。

name
  • string

区域服务名称。

sqlDedicatedGatewayEndpoint
  • string

SqlDedicatedGateway 的区域终结点。

status

描述服务的状态。

SqlDedicatedGatewayServiceResourceProperties

SqlDedicatedGatewayServiceResource 的属性。

Name Type Description
creationTime
  • string

上次状态更改的时间 (ISO-8601 格式) 。

instanceCount
  • integer

服务的实例计数。

instanceSize

服务的实例类型。

locations

包含服务的所有位置的数组。

serviceType string:
  • SqlDedicatedGateway

服务的 ServiceType。

sqlDedicatedGatewayEndpoint
  • string

服务的 SqlDedicatedGateway 终结点。

status

描述服务的状态。