Sql Resources - Sql Database Retrieve Throughput Distribution

リファレンス

サービス:: Cosmos DB Resource Provider

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

Azure Cosmos DB SQL データベースのスループット分散を取得する

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default/retrieveThroughputDistribution?api-version=2025-05-01-preview

URI パラメーター

名前	/	必須	型	説明
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Cosmos DB データベースアカウント名。
databaseName	path	True	string	Cosmos DB データベース名。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前は大文字と小文字が区別されます。
subscriptionId	path	True	string minLength: 1	ターゲットサブスクリプションの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	型	説明
retrieveThroughputParameters	RetrieveThroughputParameters	現在の SQL データベースのスループット分布を取得するために提供するパラメーター。

応答

名前	型	説明
200 OK	PhysicalPartitionThroughputInfoResult	SQL データベース操作のスループット分散の取得が正常に完了しました。
202 Accepted		SQL データベース操作のスループット分散の取得は非同期的に完了します。ヘッダー azure-AsyncOperation: string location: string
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

名前

型

説明

200 OK

PhysicalPartitionThroughputInfoResult

SQL データベース操作のスループット分散の取得が正常に完了しました。

202 Accepted

SQL データベース操作のスループット分散の取得は非同期的に完了します。

ヘッダー

azure-AsyncOperation: string
location: string

Other Status Codes

CloudError

操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

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

例

CosmosDBSqlDatabaseRetrieveThroughputDistribution

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/throughputSettings/default/retrieveThroughputDistribution?api-version=2025-05-01-preview

{
  "properties": {
    "resource": {
      "physicalPartitionIds": [
        {
          "id": "0"
        },
        {
          "id": "1"
        }
      ]
    }
  }
}

応答のサンプル

状態コード:: 200

{
  "properties": {
    "resource": {
      "physicalPartitionThroughputInfo": [
        {
          "id": "0",
          "throughput": 5000,
          "targetThroughput": 5000
        },
        {
          "id": "1",
          "throughput": 5000,
          "targetThroughput": 5000
        }
      ]
    }
  }
}

状態コード:: 202

azure-AsyncOperation: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2025-05-01-preview
location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2025-05-01-preview

定義

名前	説明
CloudError	サービスからのエラー応答。
ErrorResponse	エラー応答。
ManagedServiceIdentity	リソースの ID。
PhysicalPartitionId	PhysicalPartitionId オブジェクトの配列。
PhysicalPartitionThroughputInfoResource	物理パーティションのスループット情報オブジェクトの配列
PhysicalPartitionThroughputInfoResult	Azure Cosmos DB PhysicalPartitionThroughputInfoResult オブジェクト。
Resource	物理パーティションのスループット情報のプロパティ
ResourceIdentityType	リソースに使用される ID の種類。型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。型 'None' は、サービスからすべての ID を削除します。
RetrieveThroughputParameters	現在の SQL データベースのスループット分布を取得するために提供するパラメーター。
RetrieveThroughputPropertiesResource	リソーススループットの標準 JSON 形式
UserAssignedIdentities	リソースに関連付けられているユーザー ID の一覧。ユーザー ID ディクショナリのキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

CloudError

Object

サービスからのエラー応答。

名前	型	説明
error	ErrorResponse	エラー応答。

ErrorResponse

Object

エラー応答。

名前	型	説明
code	string	エラーコード。
message	string	操作が失敗した理由を示すエラーメッセージ。

ManagedServiceIdentity

Object

リソースの ID。

名前	型	説明
principalId	string	システム割り当て ID のプリンシパル ID。このプロパティは、システム割り当て ID にのみ提供されます。
tenantId	string	システム割り当て ID のテナント ID。このプロパティは、システム割り当て ID にのみ提供されます。
type	ResourceIdentityType	リソースに使用される ID の種類。型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。型 'None' は、サービスからすべての ID を削除します。
userAssignedIdentities	UserAssignedIdentities	リソースに関連付けられているユーザー ID の一覧。ユーザー ID ディクショナリのキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

PhysicalPartitionId

Object

PhysicalPartitionId オブジェクトの配列。

名前	型	説明
id	string	物理パーティションの ID

PhysicalPartitionThroughputInfoResource

Object

物理パーティションのスループット情報オブジェクトの配列

名前	型	説明
id	string	物理パーティションの ID
targetThroughput	number (double)	物理パーティションのターゲットスループット
throughput	number (double)	物理パーティションのスループット

PhysicalPartitionThroughputInfoResult

Object

Azure Cosmos DB PhysicalPartitionThroughputInfoResult オブジェクト。

名前	型	説明
id	string	ARM リソースの一意のリソース識別子。
identity	ManagedServiceIdentity	リソースの ID。
location	string	リソースが属するリソースグループの場所。
name	string	ARM リソースの名前。
properties.resource	Resource	物理パーティションのスループット情報のプロパティ
tags	object	タグは、リソースを記述するキーと値のペアの一覧です。これらのタグは、(リソースグループ間で) このリソースを表示およびグループ化する場合に使用できます。リソースには最大 15 個のタグを指定できます。各タグには、128 文字以下のキーと 256 文字以下の値が必要です。たとえば、テンプレートの種類の既定のエクスペリエンスは"defaultExperience": "Cassandra" で設定されます。現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。
type	string	Azure リソースの種類。

Resource

Object

物理パーティションのスループット情報のプロパティ

名前	型	説明
physicalPartitionThroughputInfo	PhysicalPartitionThroughputInfoResource[]	物理パーティションのスループット情報オブジェクトの配列

ResourceIdentityType

列挙

リソースに使用される ID の種類。型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。型 'None' は、サービスからすべての ID を削除します。

値	説明
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

RetrieveThroughputParameters

Object

現在の SQL データベースのスループット分布を取得するために提供するパラメーター。

名前	型	説明
id	string	ARM リソースの一意のリソース識別子。
identity	ManagedServiceIdentity	リソースの ID。
location	string	リソースが属するリソースグループの場所。
name	string	ARM リソースの名前。
properties.resource	RetrieveThroughputPropertiesResource	リソーススループットの標準 JSON 形式
tags	object	タグは、リソースを記述するキーと値のペアの一覧です。これらのタグは、(リソースグループ間で) このリソースを表示およびグループ化する場合に使用できます。リソースには最大 15 個のタグを指定できます。各タグには、128 文字以下のキーと 256 文字以下の値が必要です。たとえば、テンプレートの種類の既定のエクスペリエンスは"defaultExperience": "Cassandra" で設定されます。現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。
type	string	Azure リソースの種類。

RetrieveThroughputPropertiesResource

Object

リソーススループットの標準 JSON 形式

名前	型	説明
physicalPartitionIds	PhysicalPartitionId[]	PhysicalPartitionId オブジェクトの配列。

UserAssignedIdentities

Object

リソースに関連付けられているユーザー ID の一覧。ユーザー ID ディクショナリのキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

名前	型	説明

次の方法で共有

Sql Resources - Sql Database Retrieve Throughput Distribution

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

CosmosDBSqlDatabaseRetrieveThroughputDistribution

要求のサンプル

応答のサンプル

定義

CloudError

ErrorResponse

ManagedServiceIdentity

PhysicalPartitionId

PhysicalPartitionThroughputInfoResource

PhysicalPartitionThroughputInfoResult

Resource

ResourceIdentityType

RetrieveThroughputParameters

RetrieveThroughputPropertiesResource

UserAssignedIdentities