Cassandra Clusters - Deallocate

サービス:

Cosmos DB Resource Provider

API バージョン:

2026-03-15

マネージド Cassandra クラスターと関連するデータ センターの割り当てを解除します。 割り当てを解除すると、このクラスターのホスト仮想マシンの割り当てが解除され、データ ディスクが予約されます。 これにより、既に割り当てが解除されているクラスターでは何も実行されません。 [開始] を使用してクラスターを再起動します。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/deallocate?api-version=2026-03-15

URI パラメーター

名前	/	必須	型	説明
clusterName	path	True	string minLength: 1 maxLength: 100 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$	マネージド Cassandra クラスター名。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前は大文字と小文字を区別しません。
subscriptionId	path	True	string (uuid)	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
x-ms-force-deallocate		string	クラスターの種類が運用環境のクラスターの割り当てを強制的に解除します。 クラスターの種類の運用のクラスターの割り当てを強制的に解除すると、データが失われる可能性があります

応答

名前	型	説明
202 Accepted		リソース操作が受け入れられます。 ヘッダー Location: string Retry-After: integer
Other Status Codes	CloudError	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

名前	説明
user_impersonation	あなたのユーザー アカウントになりすます

例

CosmosDBManagedCassandraClusterDeallocate

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod/deallocate?api-version=2026-03-15

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_managed_cassandra_cluster_deallocate.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    client.cassandra_clusters.begin_deallocate(
        resource_group_name="cassandra-prod-rg",
        cluster_name="cassandra-prod",
    ).result()


# x-ms-original-file: 2026-03-15/CosmosDBManagedCassandraClusterDeallocate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:

202

Location: https://centraluseuap.management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2026-03-15
Azure-AsyncOperation: https://centraluseuap.management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2026-03-15

定義

名前	説明
CloudError	サービスからのエラー応答。
ErrorResponse	エラー応答。

CloudError

Object

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

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

ErrorResponse

Object

エラー応答。

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