Skip to content

[CosmosDB] Apis to redistribute throughput among physical partitions #18664

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 24, 2022
Merged

[CosmosDB] Apis to redistribute throughput among physical partitions #18664

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e36daf4
initial changes
ravgill Apr 12, 2022
ea321c2
Fix IsDryRun parameter
amar-sagare Apr 14, 2022
b35859d
Revert IsDryRun change, fix spec for RedistributeThroughput
amar-sagare Apr 17, 2022
29ce067
model throughputpolicy as an enum
ravgill Apr 19, 2022
1fe9585
remove 200 from specs
ravgill Apr 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
369 changes: 369 additions & 0 deletions ...cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-02-15-preview/cosmos-db.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2474,6 +2474,116 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default/retrieveThroughputDistribution": {
"post": {
"operationId": "SqlResources_SqlContainerRetrieveThroughputDistribution",
"x-ms-examples": {
"CosmosDBSqlContainerRetrieveThroughputDistribution": {
"$ref": "./examples/CosmosDBSqlContainerRetrieveThroughputDistribution.json"
}
},
"description": "Retrieve throughput distribution for an Azure Cosmos DB SQL container",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/accountNameParameter"
},
{
"$ref": "#/parameters/databaseNameParameter"
},
{
"$ref": "#/parameters/containerNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"name": "retrieveThroughputParameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/RetrieveThroughputParameters"
},
"description": "The parameters to provide for retrieving throughput distribution for the current SQL container."
}
],
"responses": {
"202": {
"description": "The retrieve throughput distribution for SQL container operation will complete asynchronously."
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default/redistributeThroughput": {
"post": {
"operationId": "SqlResources_SqlContainerRedistributeThroughput",
"x-ms-examples": {
"CosmosDBSqlContainerRedistributeThroughput": {
"$ref": "./examples/CosmosDBSqlContainerRedistributeThroughput.json"
}
},
"description": "Redistribute throughput for an Azure Cosmos DB SQL container",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/accountNameParameter"
},
{
"$ref": "#/parameters/databaseNameParameter"
},
{
"$ref": "#/parameters/containerNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"name": "redistributeThroughputParameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/RedistributeThroughputParameters"
},
"description": "The parameters to provide for redistributing throughput for the current SQL container."
}
],
"responses": {
"202": {
"description": "The redistribution throughput for SQL container operation will complete asynchronously."
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures": {
"get": {
"operationId": "SqlResources_ListSqlStoredProcedures",
Expand Down Expand Up @@ -3349,6 +3459,116 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/retrieveThroughputDistribution": {
"post": {
"operationId": "MongoDBResources_SqlContainerRetrieveThroughputDistribution",
"x-ms-examples": {
"CosmosDBMongoDBCollectionRetrieveThroughputDistribution": {
"$ref": "./examples/CosmosDBMongoDBCollectionRetrieveThroughputDistribution.json"
}
},
"description": "Retrieve throughput distribution for an Azure Cosmos DB MongoDB container",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/accountNameParameter"
},
{
"$ref": "#/parameters/databaseNameParameter"
},
{
"$ref": "#/parameters/collectionNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"name": "retrieveThroughputParameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/RetrieveThroughputParameters"
},
"description": "The parameters to provide for retrieving throughput distribution for the current MongoDB container."
}
],
"responses": {
"202": {
"description": "The retrieve throughput distribution for MongoDB container operation will complete asynchronously."
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/redistributeThroughput": {
"post": {
"operationId": "MongoDBResources_MongoDBContainerRedistributeThroughput",
"x-ms-examples": {
"CosmosDBMongoDBCollectionRedistributeThroughput": {
"$ref": "./examples/CosmosDBMongoDBCollectionRedistributeThroughput.json"
}
},
"description": "Redistribute throughput for an Azure Cosmos DB MongoDB container",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/accountNameParameter"
},
{
"$ref": "#/parameters/databaseNameParameter"
},
{
"$ref": "#/parameters/collectionNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"name": "redistributeThroughputParameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/RedistributeThroughputParameters"
},
"description": "The parameters to provide for redistributing throughput for the current MongoDB container."
}
],
"responses": {
"202": {
"description": "The redistribution throughput for MongoDB container operation will complete asynchronously."
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections": {
"get": {
"operationId": "MongoDBResources_ListMongoDBCollections",
Expand Down Expand Up @@ -8263,6 +8483,155 @@
}
}
},
"RedistributeThroughputParameters": {
"description": "Cosmos DB redistribute throughput parameters object",
"type": "object",
"properties": {
"properties": {
"x-ms-client-flatten": true,
"description": "Properties to redistribute throughput parameters object",
"$ref": "#/definitions/RedistributeThroughputProperties"
}
},
"allOf": [
{
"$ref": "#/definitions/ARMResourceProperties"
}
],
"required": [
"properties"
]
},
"RedistributeThroughputProperties": {
"description": "Properties to redistribute throughput for Azure Cosmos DB resource.",
"type": "object",
"properties": {
"resource": {
"description": "The standard JSON format of a resource throughput",
"$ref": "#/definitions/RedistributeThroughputPropertiesResource"
}
},
"required": [
"resource"
]
},
"RedistributeThroughputPropertiesResource": {
"type": "object",
"description": "Resource to redistribute throughput for Azure Cosmos DB resource",
"properties": {
"throughputPolicy": {
"description": "ThroughputPolicy to apply for throughput redistribution",
"type": "string",
"enum": [
"none",
"equal",
"custom"
],
"x-ms-enum": {
"name": "ThroughputPolicyType",
"modelAsString": true
}
},
"targetPhysicalPartitionThroughputInfo": {
"type": "array",
"description": "Array of PhysicalPartitionThroughputInfoResource objects.",
"items": {
"$ref": "#/definitions/PhysicalPartitionThroughputInfoResource"
}
},
"sourcePhysicalPartitionThroughputInfo": {
"type": "array",
"description": "Array of PhysicalPartitionThroughputInfoResource objects.",
"items": {
"$ref": "#/definitions/PhysicalPartitionThroughputInfoResource"
}
}
},
"required": [
"throughputPolicy",
"targetPhysicalPartitionThroughputInfo",
"sourcePhysicalPartitionThroughputInfo"
]
},
"RetrieveThroughputParameters": {
"description": "Cosmos DB retrieve throughput parameters object",
"type": "object",
"properties": {
"properties": {
"x-ms-client-flatten": true,
"description": "Properties to retrieve throughput parameters object",
"$ref": "#/definitions/RetrieveThroughputProperties"
}
},
"allOf": [
{
"$ref": "#/definitions/ARMResourceProperties"
}
],
"required": [
"properties"
]
},
"RetrieveThroughputProperties": {
"description": "Properties to retrieve throughput for Azure Cosmos DB resource.",
"type": "object",
"properties": {
"resource": {
"description": "The standard JSON format of a resource throughput",
"$ref": "#/definitions/RetrieveThroughputPropertiesResource"
}
},
"required": [
"resource"
]
},
"RetrieveThroughputPropertiesResource": {
"type": "object",
"description": "Resource to retrieve throughput information for Cosmos DB resource",
"properties": {
"physicalPartitionIds": {
"type": "array",
"description": "Array of PhysicalPartitionId objects.",
"items": {
"$ref": "#/definitions/PhysicalPartitionId"
}
}
},
"required": [
"physicalPartitionIds"
]
},
"PhysicalPartitionId": {
"type": "object",
"description": "PhysicalPartitionId object",
"properties": {
"id": {
"type": "string",
"description": "Id of a physical partition"
}
},
"required": [
"id"
]
},
"PhysicalPartitionThroughputInfoResource": {
"type": "object",
"description": "PhysicalPartitionThroughputInfo object",
"properties": {
"id": {
"type": "string",
"description": "Id of a physical partition"
},
"throughput": {
"type": "number",
"format": "double",
"description": "Throughput of a physical partition"
}
},
"required": [
"id"
]
},
"ClientEncryptionKeyResource": {
"type": "object",
"description": "Cosmos DB client encryption key resource object.",
Expand Down
Loading