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 매개 변수

Name	In(다음 안에)	필수	형식	Description
communicationServiceName	path	True	string minLength: 1 maxLength: 63 pattern: ^[-\w]+$	CommunicationService 리소스의 이름입니다.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
subscriptionId	path	True	string minLength: 1	대상 구독의 ID입니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

요청 본문

Name	형식	Description
keyType	KeyType	다시 생성할 keyType입니다. 'primary' 또는 'secondary'(대/소문자를 구분하지 않는)여야 합니다.

응답

Name	형식	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"
}

정의

Name	Description
CommunicationServiceKeys	CommunicationService의 액세스 키를 나타내는 클래스입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
KeyType	다시 생성할 keyType입니다. 'primary' 또는 'secondary'(대/소문자를 구분하지 않는)여야 합니다.
RegenerateKeyParameters	매개 변수는 액세스 키를 다시 생성하기 위한 요청을 설명합니다.

CommunicationServiceKeys

Object

CommunicationService의 액세스 키를 나타내는 클래스입니다.

Name	형식	Description
primaryConnectionString	string	primaryKey를 통해 생성된 CommunicationService 연결 문자열
primaryKey	string	기본 액세스 키입니다.
secondaryConnectionString	string	secondaryKey를 통해 생성된 CommunicationService 연결 문자열
secondaryKey	string	보조 액세스 키입니다.

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

KeyType

열거형

다시 생성할 keyType입니다. 'primary' 또는 'secondary'(대/소문자를 구분하지 않는)여야 합니다.

값	Description
Primary
Secondary

RegenerateKeyParameters

Object

매개 변수는 액세스 키를 다시 생성하기 위한 요청을 설명합니다.

Name	형식	Description
keyType	KeyType	다시 생성할 keyType입니다. 'primary' 또는 'secondary'(대/소문자를 구분하지 않는)여야 합니다.