Fleet - Update

服务:

Cosmos DB Resource Provider

API 版本:

2025-05-01-preview

更新现有 Azure Cosmos DB 机队的属性。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}?api-version=2025-05-01-preview

URI 参数

名称	在	必需	类型	说明
fleetName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Cosmos DB 舰队名称。 订阅下需要是唯一的。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 此名称不区分大小写。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	FleetResource	同步完成。 已成功检索机群属性。
Other Status Codes	ErrorResponse	描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟您的用户账户

示例

CosmosDB Fleet Update

示例请求

HTTP

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rg1/providers/Microsoft.DocumentDB/fleets/fleet1?api-version=2025-05-01-preview

{
  "properties": {}
}

示例响应

状态代码:

200

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rg1/providers/Microsoft.DocumentDB/fleets/fleet1",
  "name": "fleet1",
  "type": "Microsoft.DocumentDB/fleets",
  "location": "West US",
  "tags": {
    "Dept": "Finance",
    "Environment": "Production"
  },
  "properties": {
    "provisioningState": "Succeeded"
  }
}

定义

名称	说明
createdByType	创建资源的标识的类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
FleetResource	Azure Cosmos DB FleetResource。
FleetResourceUpdate	表示用于更新的机群资源。
status	舰队的预配状态。
systemData	与创建和上次修改资源相关的元数据。

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

FleetResource

Object

Azure Cosmos DB FleetResource。

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
location	string	资源所在的地理位置
name	string	资源的名称
properties.provisioningState	status	舰队的预配状态。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	资源标记。
type	string	资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

FleetResourceUpdate

Object

表示用于更新的机群资源。

名称	类型	说明
properties.provisioningState	status	舰队的预配状态。

status

枚举

舰队的预配状态。

值	说明
Canceled
Creating
Failed
Succeeded
Updating

systemData

Object

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

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。