Authorization Rules - Event Hubs - Regenerate Keys

서비스:: Event Hubs

API 버전:: 2024-01-01

이벤트 허브에 대한 ACS 및 SAS 연결 문자열을 다시 생성합니다.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}/regenerateKeys?api-version=2024-01-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
authorizationRuleName	path	True	string minLength: 1	권한 부여 규칙 이름입니다.
eventHubName	path	True	string minLength: 1 maxLength: 256	이벤트 허브 이름
namespaceName	path	True	string minLength: 6 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$	네임스페이스 이름
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Azure 구독 내의 리소스 그룹의 이름입니다.
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 일부를 형성합니다.
api-version	query	True	string	클라이언트 API 버전입니다.

요청 본문

Name	필수	형식	Description
keyType	True	KeyType	다시 생성할 액세스 키입니다.
key		string	선택적 키 값이 제공된 경우 KeyType에 대해 설정되거나 keyType에 대해 자동 생성된 키 값이 설정됩니다.

응답

Name	형식	Description
200 OK	AccessKeys	연결 문자열이 성공적으로 다시 생성되었습니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 Eventhub 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 흐름

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

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

EventHubAuthorizationRuleRegenerateKey

샘플 요청

HTTP

POST https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-namespace-960/eventhubs/sdk-EventHub-532/authorizationRules/sdk-Authrules-1534/regenerateKeys?api-version=2024-01-01

{
  "keyType": "PrimaryKey"
}

샘플 응답

상태 코드:: 200

{
  "primaryConnectionString": "Endpoint=sb://sdk-namespace-9027.servicebus.windows-int.net/;SharedAccessKeyName=sdk-Authrules-1534;SharedAccessKey=#############################################;EntityPath=sdk-EventHub-1647",
  "secondaryConnectionString": "Endpoint=sb://sdk-namespace-9027.servicebus.windows-int.net/;SharedAccessKeyName=sdk-Authrules-1534;SharedAccessKey=#############################################;EntityPath=sdk-EventHub-1647",
  "primaryKey": "#############################################",
  "secondaryKey": "#############################################",
  "keyName": "sdk-Authrules-1534"
}

정의

Name	Description
AccessKeys	네임스페이스/EventHub 연결 문자열
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답은 Event Hub 서비스가 들어오는 요청을 처리할 수 없음을 나타냅니다. 그 이유는 오류 메시지에 제공됩니다.
KeyType	다시 생성할 액세스 키입니다.
RegenerateAccessKeyParameters	권한 부여 규칙 다시 생성 작업에 제공된 매개 변수는 다시 설정해야 하는 키를 지정합니다.

AccessKeys

Object

네임스페이스/EventHub 연결 문자열

Name	형식	Description
aliasPrimaryConnectionString	string	GEO DR을 사용하는 경우 별칭의 기본 연결 문자열
aliasSecondaryConnectionString	string	GEO DR을 사용하는 경우 별칭의 보조 연결 문자열
keyName	string	AuthorizationRule을 설명하는 문자열입니다.
primaryConnectionString	string	만든 네임스페이스 AuthorizationRule의 기본 연결 문자열입니다.
primaryKey	string	SAS 토큰에 서명하고 유효성을 검사하기 위한 base64로 인코딩된 256비트 기본 키입니다.
secondaryConnectionString	string	만든 네임스페이스 AuthorizationRule의 보조 연결 문자열입니다.
secondaryKey	string	SAS 토큰에 서명하고 유효성을 검사하기 위한 base64로 인코딩된 256비트 기본 키입니다.

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

오류 세부 정보입니다.

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

ErrorResponse

Object

오류 응답은 Event Hub 서비스가 들어오는 요청을 처리할 수 없음을 나타냅니다. 그 이유는 오류 메시지에 제공됩니다.

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

KeyType

열거형

다시 생성할 액세스 키입니다.

값	Description
PrimaryKey
SecondaryKey

RegenerateAccessKeyParameters

Object

권한 부여 규칙 다시 생성 작업에 제공된 매개 변수는 다시 설정해야 하는 키를 지정합니다.

Name	형식	Description
key	string	선택적 키 값이 제공된 경우 KeyType에 대해 설정되거나 keyType에 대해 자동 생성된 키 값이 설정됩니다.
keyType	KeyType	다시 생성할 액세스 키입니다.