你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Redis - Flush Cache

服务:

Redis Cache

API 版本:

2024-11-01

删除缓存中的所有密钥。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/flush?api-version=2024-11-01

URI 参数

名称	在	必需	类型	说明
cacheName	path	True	string	Redis 缓存的名称。 正则表达式模式: ^([a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]|[a-zA-Z0-9])$
resourceGroupName	path	True	string	资源组的名称。 名称不区分大小写。
subscriptionId	path	True	string	目标订阅的 ID。
api-version	query	True	string	用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	OperationStatusResult	刷新操作成功。 标头 Location: string Azure-AsyncOperation: string
202 Accepted		刷新操作已成功排队;按照 Location 标头轮询最终结果。 标头 Location: string Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

RedisCacheFlush

示例请求

HTTP

POST https://management.azure.com/subscriptions/subcription-id/resourceGroups/resource-group-name/providers/Microsoft.Cache/redis/cache-name/flush?api-version=2024-11-01

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.redis import RedisManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-redis
# USAGE
    python redis_cache_flush.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 = RedisManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subcription-id",
    )

    response = client.redis.begin_flush_cache(
        resource_group_name="resource-group-name",
        cache_name="cache-name",
    ).result()
    print(response)


# x-ms-original-file: specification/redis/resource-manager/Microsoft.Cache/stable/2024-11-01/examples/RedisCacheFlush.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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Redis.Models;
using Azure.ResourceManager.Redis;

// Generated from example definition: specification/redis/resource-manager/Microsoft.Cache/stable/2024-11-01/examples/RedisCacheFlush.json
// this example is just showing the usage of "Redis_FlushCache" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this RedisResource created on azure
// for more information of creating RedisResource, please refer to the document of RedisResource
string subscriptionId = "subcription-id";
string resourceGroupName = "resource-group-name";
string cacheName = "cache-name";
ResourceIdentifier redisResourceId = RedisResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, cacheName);
RedisResource redis = client.GetRedisResource(redisResourceId);

// invoke the operation
ArmOperation<OperationStatusResult> lro = await redis.FlushCacheAsync(WaitUntil.Completed);
OperationStatusResult result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

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://management.azure.com/subscriptions/subscription-id/providers/Microsoft.Cache/...pathToOperationResult...
Azure-AsyncOperation: https://management.azure.com/subscriptions/subscription-id/providers/Microsoft.Cache/...pathToOperationResult...

状态代码:

200

{
  "status": "Succeeded"
}

定义

名称	说明
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
OperationStatusResult	异步操作的当前状态。

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

OperationStatusResult

异步操作的当前状态。

名称	类型	说明
endTime	string	操作的结束时间。
error	ErrorDetail	如果存在，则操作错误的详细信息。
id	string	异步操作的完全限定 ID。
name	string	异步操作的名称。
operations	OperationStatusResult[]	操作列表。
percentComplete	number	完成的操作的百分比。
startTime	string	操作的开始时间。
status	string	操作状态。