Cassandra Resources - Update Cassandra View Throughput

Aktualisieren von RUs pro Sekunde einer Azure Cosmos DB Cassandra-Ansicht

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}/throughputSettings/default?api-version=2021-07-01-preview

URI-Parameter

Name In Required Type Description
accountName
path True
  • string

Name des Cosmos DB-Datenbankkontos.

Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*

keyspaceName
path True
  • string

Cosmos DB-Schlüsselraumname.

resourceGroupName
path True
  • string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

subscriptionId
path True
  • string

Hierbei handelt es sich um die ID des Zielabonnements.

viewName
path True
  • string

Name der Cosmos DB-Ansicht.

api-version
query True
  • string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name Required Type Description
properties.resource True

Das Standard-JSON-Format eines Ressourcendurchsatzes

identity

Identität für die Ressource.

location
  • string

Der Speicherort der Ressourcengruppe, zu der die Ressource gehört.

tags
  • object

Tags sind eine Liste der Schlüsselwertpaare, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Maximal 15 Tags können für eine Ressource bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Die Standardumgebung für einen Vorlagentyp wird beispielsweise mit "defaultExperience" festgelegt: "Cassandra". Aktuelle "defaultExperience"-Werte umfassen auch "Table", "Graph", "DocumentDB" und "MongoDB".

Antworten

Name Type Description
200 OK

Die RUs pro Sekunde des Cassandra-Ansichtsaktualisierungsvorgangs wurden erfolgreich abgeschlossen.

202 Accepted

Die RUs pro Sekunde des Cassandra-Ansichtsaktualisierungsvorgangs werden asynchron abgeschlossen.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

CosmosDBCassandraViewThroughputUpdate

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspacename/views/viewname/throughputSettings/default?api-version=2021-07-01-preview

{
  "tags": {},
  "properties": {
    "resource": {
      "throughput": 400
    }
  }
}

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/views/viewName/throughputSettings/default",
  "name": "default",
  "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views/throughputSettings",
  "properties": {
    "resource": {
      "throughput": 400,
      "minimumThroughput": "400",
      "offerReplacePending": "true"
    }
  }
}

Definitionen

AutoscaleSettingsResource

Cosmos DB-Objekt für bereitgestellte Durchsatzeinstellungen

AutoUpgradePolicyResource

Cosmos DB-Ressourcenrichtlinie für automatisches Upgrade

ManagedServiceIdentity

Identität für die Ressource.

Resource
ResourceIdentityType

Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" umfasst sowohl eine implizit erstellte Identität als auch eine Gruppe von benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.

ThroughputPolicyResource

Cosmos DB-Ressourcendurchsatzrichtlinie

ThroughputSettingsGetResults

Ein Azure Cosmos DB-Ressourcendurchsatz.

ThroughputSettingsResource

Cosmos DB-Ressourcendurchsatzobjekt. Entweder ist der Durchsatz erforderlich oder autoscaleSettings ist erforderlich, aber nicht beides.

ThroughputSettingsUpdateParameters

Parameter zum Aktualisieren des Cosmos DB-Ressourcendurchsatzs.

UserAssignedIdentities

Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselbezüge sind ARM-Ressourcen-IDs im Formular: '/abonnements/{subscriptionId}/resourceGroups/{resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

AutoscaleSettingsResource

Cosmos DB-Objekt für bereitgestellte Durchsatzeinstellungen

Name Type Description
autoUpgradePolicy

Cosmos DB-Ressourcenrichtlinie für automatisches Upgrade

maxThroughput
  • integer

Stellt den maximalen Durchsatzcontainer dar, der bis zu skaliert werden kann.

targetMaxThroughput
  • integer

Represents target maximum durchsatz container can scale up to once offer is not longer in pending state.

AutoUpgradePolicyResource

Cosmos DB-Ressourcenrichtlinie für automatisches Upgrade

Name Type Description
throughputPolicy

Stellt die Durchsatzrichtlinie dar, an die der Dienst für das automatische Upgrade einhalten muss

ManagedServiceIdentity

Identität für die Ressource.

Name Type Description
principalId
  • string

Die Prinzipal-ID der zugewiesenen Systemidentität. Diese Eigenschaft wird nur für eine system zugewiesene Identität bereitgestellt.

tenantId
  • string

Die Mandanten-ID der zugewiesenen Systemidentität. Diese Eigenschaft wird nur für eine system zugewiesene Identität bereitgestellt.

type

Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" umfasst sowohl eine implizit erstellte Identität als auch eine Gruppe von benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.

userAssignedIdentities

Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselbezüge sind ARM-Ressourcen-IDs im Formular: '/abonnements/{subscriptionId}/resourceGroups/{resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Resource

Name Type Description
_etag
  • string

Eine systemgenerierte Eigenschaft, die das Ressourcen-etag darstellt, das für das optimistische Übereinstimmungssteuerelement erforderlich ist.

_rid
  • string

Eine systemgenerierte Eigenschaft. Einen eindeutigen Bezeichner.

_ts
  • number

Eine systemgenerierte Eigenschaft, die den letzten aktualisierten Zeitstempel der Ressource angibt.

autoscaleSettings

Cosmos DB-Ressource für Autoscale-Einstellungen. Entweder ist der Durchsatz erforderlich oder autoscaleSettings ist erforderlich, aber nicht beides.

minimumThroughput
  • string

Der minimale Durchsatz der Ressource

offerReplacePending
  • string

Die Durchsatzersetzung ist ausstehend

throughput
  • integer

Wert des Cosmos DB-Ressourcendurchsatzes. Entweder ist der Durchsatz erforderlich oder autoscaleSettings ist erforderlich, aber nicht beides.

ResourceIdentityType

Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" umfasst sowohl eine implizit erstellte Identität als auch eine Gruppe von benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned,UserAssigned
  • string
UserAssigned
  • string

ThroughputPolicyResource

Cosmos DB-Ressourcendurchsatzrichtlinie

Name Type Description
incrementPercent
  • integer

Stellt den Prozentsatz dar, durch den der Durchsatz jedes Mal erhöht werden kann, wenn die Durchsatzrichtlinie ausgelöst wird.

isEnabled
  • boolean

Bestimmt, ob die DurchsatzPolicy aktiv ist oder nicht.

ThroughputSettingsGetResults

Ein Azure Cosmos DB-Ressourcendurchsatz.

Name Type Description
id
  • string

Der eindeutige Ressourcenbezeichner der ARM-Ressource.

identity

Identität für die Ressource.

location
  • string

Der Speicherort der Ressourcengruppe, zu der die Ressource gehört.

name
  • string

Der Name der ARM-Ressource.

properties.resource
tags
  • object

Tags sind eine Liste der Schlüsselwertpaare, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Maximal 15 Tags können für eine Ressource bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Die Standardumgebung für einen Vorlagentyp wird beispielsweise mit "defaultExperience" festgelegt: "Cassandra". Aktuelle "defaultExperience"-Werte umfassen auch "Table", "Graph", "DocumentDB" und "MongoDB".

type
  • string

Der Typ der Azure-Ressource.

ThroughputSettingsResource

Cosmos DB-Ressourcendurchsatzobjekt. Entweder ist der Durchsatz erforderlich oder autoscaleSettings ist erforderlich, aber nicht beides.

Name Type Description
autoscaleSettings

Cosmos DB-Ressource für Autoscale-Einstellungen. Entweder ist der Durchsatz erforderlich oder autoscaleSettings ist erforderlich, aber nicht beides.

minimumThroughput
  • string

Der minimale Durchsatz der Ressource

offerReplacePending
  • string

Die Durchsatzersetzung ist ausstehend

throughput
  • integer

Wert des Cosmos DB-Ressourcendurchsatzes. Entweder ist der Durchsatz erforderlich oder autoscaleSettings ist erforderlich, aber nicht beides.

ThroughputSettingsUpdateParameters

Parameter zum Aktualisieren des Cosmos DB-Ressourcendurchsatzs.

Name Type Description
id
  • string

Der eindeutige Ressourcenbezeichner der ARM-Ressource.

identity

Identität für die Ressource.

location
  • string

Der Speicherort der Ressourcengruppe, zu der die Ressource gehört.

name
  • string

Der Name der ARM-Ressource.

properties.resource

Das Standard-JSON-Format eines Ressourcendurchsatzes

tags
  • object

Tags sind eine Liste der Schlüsselwertpaare, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Maximal 15 Tags können für eine Ressource bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Die Standardumgebung für einen Vorlagentyp wird beispielsweise mit "defaultExperience" festgelegt: "Cassandra". Aktuelle "defaultExperience"-Werte umfassen auch "Table", "Graph", "DocumentDB" und "MongoDB".

type
  • string

Der Typ der Azure-Ressource.

UserAssignedIdentities

Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselbezüge sind ARM-Ressourcen-IDs im Formular: '/abonnements/{subscriptionId}/resourceGroups/{resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Name Type Description