Communication Services - Regenerate Key

服务:

Communication

API 版本:

2025-09-01

重新生成密钥
重新生成 CommunicationService 访问密钥。 无法同时重新生成 PrimaryKey 和 SecondaryKey。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}/regenerateKey?api-version=2025-09-01

URI 参数

名称	在	必需	类型	说明
communicationServiceName	path	True	string minLength: 1 maxLength: 63 pattern: ^[-\w]+$	CommunicationService 资源的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 此名称不区分大小写。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。

请求正文

名称	类型	说明
keyType	KeyType	要重新生成的 keyType。 必须是“primary”或“secondary”（不区分大小写）。

响应

名称	类型	说明
200 OK	CommunicationServiceKeys	重新生成密钥请求已成功完成。 响应包含了新的密钥。
Other Status Codes	ErrorResponse	描述作失败的原因的错误响应。

示例

Regenerate key

示例请求

HTTP

POST https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/communicationServices/MyCommunicationResource/regenerateKey?api-version=2025-09-01

{
  "keyType": "Primary"
}

dotnet

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

// Generated from example definition: specification/communication/resource-manager/Microsoft.Communication/stable/2025-09-01/examples/communicationServices/regenerateKey.json
// this example is just showing the usage of "CommunicationServices_RegenerateKey" 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 CommunicationServiceResource created on azure
// for more information of creating CommunicationServiceResource, please refer to the document of CommunicationServiceResource
string subscriptionId = "11112222-3333-4444-5555-666677778888";
string resourceGroupName = "MyResourceGroup";
string communicationServiceName = "MyCommunicationResource";
ResourceIdentifier communicationServiceResourceId = CommunicationServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, communicationServiceName);
CommunicationServiceResource communicationServiceResource = client.GetCommunicationServiceResource(communicationServiceResourceId);

// invoke the operation
RegenerateCommunicationServiceKeyContent content = new RegenerateCommunicationServiceKeyContent
{
    KeyType = CommunicationServiceKeyType.Primary,
};
CommunicationServiceKeys result = await communicationServiceResource.RegenerateKeyAsync(content);

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

示例响应

状态代码:

200

{
  "primaryKey": "1234",
  "primaryConnectionString": "endpoint=http://example.com;accesskey=1234"
}

定义

名称	说明
CommunicationServiceKeys	一个代表通信服务访问密钥的类。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
KeyType	要重新生成的 keyType。 必须是“primary”或“secondary”（不区分大小写）。
RegenerateKeyParameters	参数描述重新生成访问密钥的请求

CommunicationServiceKeys

对象

一个代表通信服务访问密钥的类。

名称	类型	说明
primaryConnectionString	string	通过 primaryKey 构建的 CommunicationService 连接字符串
primaryKey	string	主访问密钥。
secondaryConnectionString	string	通过次要密钥构建的CommunicationService连接字符串
secondaryKey	string	辅助访问密钥。

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info	object	附加信息。
type	string	附加信息类型。

ErrorDetail

对象

错误详细信息。

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

ErrorResponse

对象

错误响应

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

KeyType

枚举

要重新生成的 keyType。 必须是“primary”或“secondary”（不区分大小写）。

值	说明
Primary
Secondary

RegenerateKeyParameters

对象

参数描述重新生成访问密钥的请求

名称	类型	说明
keyType	KeyType	要重新生成的 keyType。 必须是“primary”或“secondary”（不区分大小写）。