다음을 통해 공유


Web Pub Sub - Regenerate Key

리소스에 대한 액세스 키를 다시 생성합니다. PrimaryKey 및 SecondaryKey는 동시에 다시 생성할 수 없습니다.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/regenerateKey?api-version=2024-03-01

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
resourceGroupName
path True

string

리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.

resourceName
path True

string

리소스의 이름입니다.

regex 패턴: ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$

subscriptionId
path True

string

uuid

대상 구독의 ID입니다. 값은 UUID여야 합니다.

api-version
query True

string

이 작업에 사용할 API 버전입니다.

요청 본문

Name 형식 Description
keyType

KeyType

액세스 키의 유형입니다.

응답

Name 형식 Description
200 OK

WebPubSubKeys

Success

202 Accepted

WebPubSubKeys

수락되고 비동기 작업이 백그라운드에서 실행되어 새 키를 적용합니다. 응답에는 비동기 작업 결과를 쿼리하는 새 액세스 키와 위치 헤더가 포함되어 있습니다.

헤더

Location: string

Other Status Codes

ErrorResponse

작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name Description
user_impersonation 사용자 계정 가장

예제

WebPubSub_RegenerateKey

샘플 요청

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SignalRService/webPubSub/myWebPubSubService/regenerateKey?api-version=2024-03-01

{
  "keyType": "Primary"
}

샘플 응답

{}
Location: https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus...
{}

정의

Name Description
ErrorAdditionalInfo

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

ErrorDetail

오류 세부 정보입니다.

ErrorResponse

오류 응답

KeyType

액세스 키의 유형입니다.

RegenerateKeyParameters

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

WebPubSubKeys

클래스는 리소스의 액세스 키를 나타냅니다.

ErrorAdditionalInfo

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

Name 형식 Description
info

object

추가 정보입니다.

type

string

추가 정보 유형입니다.

ErrorDetail

오류 세부 정보입니다.

Name 형식 Description
additionalInfo

ErrorAdditionalInfo[]

오류 추가 정보입니다.

code

string

오류 코드입니다.

details

ErrorDetail[]

오류 세부 정보입니다.

message

string

오류 메시지입니다.

target

string

오류 대상입니다.

ErrorResponse

오류 응답

Name 형식 Description
error

ErrorDetail

Error 개체.

KeyType

액세스 키의 유형입니다.

Name 형식 Description
Primary

string

Salt

string

Secondary

string

RegenerateKeyParameters

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

Name 형식 Description
keyType

KeyType

액세스 키의 유형입니다.

WebPubSubKeys

클래스는 리소스의 액세스 키를 나타냅니다.

Name 형식 Description
primaryConnectionString

string

primaryKey를 통해 생성된 연결 문자열

primaryKey

string

기본 액세스 키입니다.

secondaryConnectionString

string

secondaryKey를 통해 생성된 연결 문자열

secondaryKey

string

보조 액세스 키입니다.