Authorization Rules - Event Hubs - List Keys

Başvuru

Service:: Event Hubs

API Version:: 2024-01-01

Olay Hub'ı için ACS ve SAS bağlantı dizelerini alır.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
authorizationRuleName	path	True	string	Yetkilendirme kuralı adı.
eventHubName	path	True	string	Olay Hub'ı adı
namespaceName	path	True	string	Ad alanı adı Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	Azure aboneliğindeki kaynak grubunun adı.
subscriptionId	path	True	string	Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
api-version	query	True	string	İstemci API Sürümü.

Yanıtlar

Name	Tür	Description
200 OK	AccessKeys	Bağlantı dizeleri başarıyla döndürüldü.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan Eventhub hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

EventHubAuthorizationRuleListKey

Sample Request

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-2513/listKeys?api-version=2024-01-01

Sample Response

Status code:: 200

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

Tanımlar

Name	Description
AccessKeys	Ad Alanı/EventHub Bağlantı Dizesi
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı, Event Hub hizmetinin gelen isteği işleyemediğini gösterir. Nedeni hata iletisinde verilmiştir.

AccessKeys

Ad Alanı/EventHub Bağlantı Dizesi

Name	Tür	Description
aliasPrimaryConnectionString	string	GEO DR etkinse diğer adın birincil bağlantı dizesi
aliasSecondaryConnectionString	string	GEO DR etkinse diğer adın ikincil bağlantı dizesi
keyName	string	AuthorizationRule'un açıklandığı bir dize.
primaryConnectionString	string	Oluşturulan AuthorizationRule ad alanının birincil bağlantı dizesi.
primaryKey	string	SAS belirtecini imzalamak ve doğrulamak için base64 kodlu 256 bit birincil anahtar.
secondaryConnectionString	string	Oluşturulan AuthorizationRule ad alanının ikincil bağlantı dizesi.
secondaryKey	string	SAS belirtecini imzalamak ve doğrulamak için base64 kodlu 256 bit birincil anahtar.

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Hata yanıtı, Event Hub hizmetinin gelen isteği işleyemediğini gösterir. Nedeni hata iletisinde verilmiştir.

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

Share via