Communication Service - Regenerate Key

服務:

Communication

API 版本:

2020-08-20

重新產生金鑰
重新產生 CommunicationService 存取金鑰。 PrimaryKey 和 SecondaryKey 無法同時重新產生。

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

URI 參數

名稱	位於	必要	類型	Description
communicationServiceName	path	True	string	CommunicationService 資源的名稱。 Regex 模式: ^[-\w]+$
resourceGroupName	path	True	string	資源群組的名稱。 名稱不區分大小寫。
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	要用於這項作業的 API 版本。

要求本文

名稱	類型	Description
keyType	KeyType	要重新產生的keyType。 必須是 'primary' 或 'secondary'（不區分大小寫）。

回應

名稱	類型	Description
200 OK	CommunicationServiceKeys	創建。 回應包含新的索引鍵。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

範例

Regenerate key

範例要求

HTTP

POST https://management.azure.com/subscriptions/12345/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/communicationServices/MyCommunicationResource/regenerateKey?api-version=2020-08-20

{
  "keyType": "Primary"
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.communication.models.KeyType;
import com.azure.resourcemanager.communication.models.RegenerateKeyParameters;

/** Samples for CommunicationService RegenerateKey. */
public final class Main {
    /*
     * x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2020-08-20/examples/regenerateKey.json
     */
    /**
     * Sample code: Regenerate key.
     *
     * @param manager Entry point to CommunicationManager.
     */
    public static void regenerateKey(com.azure.resourcemanager.communication.CommunicationManager manager) {
        manager
            .communicationServices()
            .regenerateKeyWithResponse(
                "MyResourceGroup",
                "MyCommunicationResource",
                new RegenerateKeyParameters().withKeyType(KeyType.PRIMARY),
                Context.NONE);
    }
}

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

Go

package armcommunication_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/communication/armcommunication"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/communication/resource-manager/Microsoft.Communication/stable/2020-08-20/examples/regenerateKey.json
func ExampleServiceClient_RegenerateKey() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armcommunication.NewServiceClient("12345", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.RegenerateKey(ctx,
		"MyResourceGroup",
		"MyCommunicationResource",
		armcommunication.RegenerateKeyParameters{
			KeyType: to.Ptr(armcommunication.KeyTypePrimary),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

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

JavaScript

const { CommunicationServiceManagementClient } = require("@azure/arm-communication");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Regenerate CommunicationService access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
 *
 * @summary Regenerate CommunicationService access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
 * x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2020-08-20/examples/regenerateKey.json
 */
async function regenerateKey() {
  const subscriptionId = "12345";
  const resourceGroupName = "MyResourceGroup";
  const communicationServiceName = "MyCommunicationResource";
  const parameters = { keyType: "Primary" };
  const credential = new DefaultAzureCredential();
  const client = new CommunicationServiceManagementClient(credential, subscriptionId);
  const result = await client.communicationService.regenerateKey(
    resourceGroupName,
    communicationServiceName,
    parameters
  );
  console.log(result);
}

regenerateKey().catch(console.error);

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"
}

定義

名稱	Description
CommunicationServiceKeys	類別，表示 CommunicationService 的存取密鑰。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
KeyType	要重新產生的keyType。 必須是 'primary' 或 'secondary'（不區分大小寫）。
RegenerateKeyParameters	參數描述重新產生存取密鑰的要求

CommunicationServiceKeys

類別，表示 CommunicationService 的存取密鑰。

名稱	類型	Description
primaryConnectionString	string	透過 primaryKey 建構的 CommunicationService 連接字串
primaryKey	string	主要存取金鑰。
secondaryConnectionString	string	透過 secondaryKey 建構的 CommunicationService 連接字串
secondaryKey	string	次要存取金鑰。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

KeyType

要重新產生的keyType。 必須是 'primary' 或 'secondary'（不區分大小寫）。

名稱	類型	Description
Primary	string
Secondary	string

RegenerateKeyParameters

參數描述重新產生存取密鑰的要求

名稱	類型	Description
keyType	KeyType	要重新產生的keyType。 必須是 'primary' 或 'secondary'（不區分大小寫）。