Fleetspace - Get

リファレンス

サービス:: Cosmos DB Resource Provider

API バージョン:: 2025-05-01-preview

フリートの下にある既存の Azure Cosmos DB フリートスペースのプロパティを取得します

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

URI パラメーター

名前	/	必須	型	説明
fleetName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Cosmos DB フリート名。サブスクリプションの下で一意である必要があります。
fleetspaceName	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	FleetspaceResource	fleetspace プロパティが正常に取得されました。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

CosmosDB Fleetspace Get

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rg1/providers/Microsoft.DocumentDB/fleets/fleet1/fleetspaces/fleetspace1",
  "name": "fleetspace1",
  "type": "Microsoft.DocumentDB/fleets/fleetspaces",
  "properties": {
    "provisioningState": "Succeeded",
    "throughputPoolConfiguration": {
      "minThroughput": 100000,
      "maxThroughput": 500000,
      "serviceTier": "GeneralPurpose",
      "dataRegions": [
        "westus2"
      ]
    }
  }
}

定義

名前	説明
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
FleetspaceResource	Azure Cosmos DB Fleetspace。
status	フリートのプロビジョニング状態。
systemData	リソースの作成と最後の変更に関連するメタデータ。
ThroughputPoolConfiguration	フリートスペース内のスループットプールの構成。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
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	エラーオブジェクト。

FleetspaceResource

Object

Azure Cosmos DB Fleetspace。

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.fleetspaceApiKind	enum: NoSQL	このフリートスペースが属する API の種類。許容される値: 'NoSQL'
properties.provisioningState	status	Fleetspace のプロビジョニング状態。
properties.throughputPoolConfiguration	ThroughputPoolConfiguration	フリートスペース内のスループットプールの構成。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

status

列挙

フリートのプロビジョニング状態。

値	説明
Canceled
Creating
Failed
Succeeded
Updating

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

ThroughputPoolConfiguration

Object

フリートスペース内のスループットプールの構成。

名前	型	説明
dataRegions	string[]	フリートスペースに割り当てられたデータ領域の一覧。例 [westus2]
maxThroughput	integer (int32)	プールの最大スループット。
minThroughput	integer (int32)	プールの最小スループット。
serviceTier	enum: BusinessCritical GeneralPurpose	フリートスペースのサービスレベル。 GeneralPurpose 型は、このフリートスペースに追加できる単一の書き込みリージョンアカウントを指し、BusinessCritical は複数の書き込みリージョンを指します。

次の方法で共有

Fleetspace - Get

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

CosmosDB Fleetspace Get

要求のサンプル

応答のサンプル

定義

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FleetspaceResource

status

systemData

ThroughputPoolConfiguration