Mongo DB Resources - Mongo DB Container Retrieve Throughput Distribution

Service:

Cosmos DB Resource Provider

API-versie:

2025-05-01-preview

Doorvoerdistributie ophalen voor een Azure Cosmos DB MongoDB-container

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

URI-parameters

Name	In	Vereist	Type	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Naam van cosmos DB-databaseaccount.
collectionName	path	True	string	Naam van cosmos DB-verzameling.
databaseName	path	True	string	Cosmos DB-databasenaam.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is hoofdletterongevoelig.
subscriptionId	path	True	string minLength: 1	De id van het doelabonnement.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
retrieveThroughputParameters	RetrieveThroughputParameters	De parameters die moeten worden opgegeven voor het ophalen van doorvoerdistributie voor de huidige MongoDB-container.

Antwoorden

Name	Type	Description
200 OK	PhysicalPartitionThroughputInfoResult	De doorvoerdistributie voor mongoDB-containerbewerking is voltooid.
202 Accepted		De doorvoerdistributie voor mongoDB-containerbewerking wordt asynchroon voltooid. Kopteksten azure-AsyncOperation: string location: string
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount nabootsen

Voorbeelden

CosmosDBMongoDBCollectionRetrieveThroughputDistribution

Voorbeeldaanvraag

HTTP

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

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

Voorbeeldrespons

Statuscode:

200

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

Statuscode:

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

Definities

Name	Description
CloudError	Een foutreactie van de service.
ErrorResponse	Foutreactie.
ManagedServiceIdentity	Identiteit voor de resource.
PhysicalPartitionId	Matrix van PhysicalPartitionId-objecten.
PhysicalPartitionThroughputInfoResource	Matrix van gegevensobjecten voor fysieke partitiedoorvoer
PhysicalPartitionThroughputInfoResult	Een Azure Cosmos DB PhysicalPartitionThroughputInfoResult-object.
Resource	eigenschappen van gegevens over fysieke partitiedoorvoer
ResourceIdentityType	Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd.
RetrieveThroughputParameters	De parameters die moeten worden opgegeven voor het ophalen van doorvoerdistributie voor de huidige MongoDB-container.
RetrieveThroughputPropertiesResource	De standaard JSON-indeling van een resourcedoorvoer
UserAssignedIdentities	De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen voor de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

CloudError

Object

Een foutreactie van de service.

Name	Type	Description
error	ErrorResponse	Foutreactie.

ErrorResponse

Object

Foutreactie.

Name	Type	Description
code	string	Foutcode.
message	string	Foutbericht dat aangeeft waarom de bewerking is mislukt.

ManagedServiceIdentity

Object

Identiteit voor de resource.

Name	Type	Description
principalId	string	De principal-id van de door het systeem toegewezen identiteit. Deze eigenschap wordt alleen verstrekt voor een door het systeem toegewezen identiteit.
tenantId	string	De tenant-id van de door het systeem toegewezen identiteit. Deze eigenschap wordt alleen verstrekt voor een door het systeem toegewezen identiteit.
type	ResourceIdentityType	Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd.
userAssignedIdentities	UserAssignedIdentities	De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen voor de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

PhysicalPartitionId

Object

Matrix van PhysicalPartitionId-objecten.

Name	Type	Description
id	string	Id van een fysieke partitie

PhysicalPartitionThroughputInfoResource

Object

Matrix van gegevensobjecten voor fysieke partitiedoorvoer

Name	Type	Description
id	string	Id van een fysieke partitie
targetThroughput	number (double)	Doeldoorvoer van een fysieke partitie
throughput	number (double)	Doorvoer van een fysieke partitie

PhysicalPartitionThroughputInfoResult

Object

Een Azure Cosmos DB PhysicalPartitionThroughputInfoResult-object.

Name	Type	Description
id	string	De unieke resource-id van de ARM-resource.
identity	ManagedServiceIdentity	Identiteit voor de resource.
location	string	De locatie van de resourcegroep waartoe de resource behoort.
name	string	De naam van de ARM-resource.
properties.resource	Resource	eigenschappen van gegevens over fysieke partitiedoorvoer
tags	object	Tags zijn een lijst met sleutel-waardeparen die de resource beschrijven. Deze tags kunnen worden gebruikt voor het weergeven en groeperen van deze resource (tussen resourcegroepen). Er kunnen maximaal 15 tags worden opgegeven voor een resource. Elke tag moet een sleutel hebben van maximaal 128 tekens en een waarde van maximaal 256 tekens. De standaardervaring voor een sjabloontype wordt bijvoorbeeld ingesteld met 'defaultExperience': 'Cassandra'. Huidige 'defaultExperience'-waarden bevatten ook 'Table', 'Graph', 'DocumentDB' en 'MongoDB'.
type	string	Het type Azure-resource.

Resource

Object

eigenschappen van gegevens over fysieke partitiedoorvoer

Name	Type	Description
physicalPartitionThroughputInfo	PhysicalPartitionThroughputInfoResource[]	Matrix van gegevensobjecten voor fysieke partitiedoorvoer

ResourceIdentityType

Inventarisatie

Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd.

Waarde	Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

RetrieveThroughputParameters

Object

De parameters die moeten worden opgegeven voor het ophalen van doorvoerdistributie voor de huidige MongoDB-container.

Name	Type	Description
id	string	De unieke resource-id van de ARM-resource.
identity	ManagedServiceIdentity	Identiteit voor de resource.
location	string	De locatie van de resourcegroep waartoe de resource behoort.
name	string	De naam van de ARM-resource.
properties.resource	RetrieveThroughputPropertiesResource	De standaard JSON-indeling van een resourcedoorvoer
tags	object	Tags zijn een lijst met sleutel-waardeparen die de resource beschrijven. Deze tags kunnen worden gebruikt voor het weergeven en groeperen van deze resource (tussen resourcegroepen). Er kunnen maximaal 15 tags worden opgegeven voor een resource. Elke tag moet een sleutel hebben van maximaal 128 tekens en een waarde van maximaal 256 tekens. De standaardervaring voor een sjabloontype wordt bijvoorbeeld ingesteld met 'defaultExperience': 'Cassandra'. Huidige 'defaultExperience'-waarden bevatten ook 'Table', 'Graph', 'DocumentDB' en 'MongoDB'.
type	string	Het type Azure-resource.

RetrieveThroughputPropertiesResource

Object

De standaard JSON-indeling van een resourcedoorvoer

Name	Type	Description
physicalPartitionIds	PhysicalPartitionId[]	Matrix van PhysicalPartitionId-objecten.

UserAssignedIdentities

Object

De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen voor de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

Name	Type	Description