Bagikan melalui


Authorization Rules - Namespaces - Regenerate Keys

Meregenerasi string koneksi primer atau sekunder untuk Namespace yang ditentukan.

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
authorizationRuleName
path True

string

Nama aturan otorisasi.

namespaceName
path True

string

Nama Namespace

Pola regex: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$

resourceGroupName
path True

string

Nama grup sumber daya dalam langganan azure.

subscriptionId
path True

string

Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.

api-version
query True

string

Versi API Klien.

Isi Permintaan

Nama Diperlukan Jenis Deskripsi
keyType True

KeyType

Kunci akses untuk meregenerasi.

key

string

Opsional, jika nilai kunci yang disediakan, diatur untuk KeyType atau nilai Kunci yang dibuat secara otomatis yang ditetapkan untuk keyType

Respons

Nama Jenis Deskripsi
200 OK

AccessKeys

String koneksi berhasil diregenerasi.

Other Status Codes

ErrorResponse

Respons kesalahan Eventhub yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama Deskripsi
user_impersonation meniru akun pengguna Anda

Contoh

NameSpaceAuthorizationRuleRegenerateKey

Permintaan sampel

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

{
  "keyType": "PrimaryKey"
}

Respon sampel

{
  "primaryConnectionString": "Endpoint=sb://sdk-namespace-8980.servicebus.windows-int.net/;SharedAccessKeyName=sdk-Authrules-8929;SharedAccessKey=############################################",
  "secondaryConnectionString": "Endpoint=sb://sdk-namespace-8980.servicebus.windows-int.net/;SharedAccessKeyName=sdk-Authrules-8929;SharedAccessKey=############################################",
  "primaryKey": "############################################",
  "secondaryKey": "############################################",
  "keyName": "sdk-Authrules-8929"
}

Definisi

Nama Deskripsi
AccessKeys

String Koneksi Namespace/EventHub

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

ErrorDetail

Detail kesalahan.

ErrorResponse

Respons kesalahan menunjukkan layanan Event Hub tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan.

KeyType

Kunci akses untuk meregenerasi.

RegenerateAccessKeyParameters

Parameter yang diberikan ke operasi Regenerasi Aturan Otorisasi, menentukan kunci mana yang perlu direset.

AccessKeys

String Koneksi Namespace/EventHub

Nama Jenis Deskripsi
aliasPrimaryConnectionString

string

string koneksi utama alias jika GEO DR diaktifkan

aliasSecondaryConnectionString

string

String koneksi sekunder alias jika GEO DR diaktifkan

keyName

string

String yang menjelaskan AuthorizationRule.

primaryConnectionString

string

string koneksi utama dari namespace AuthorizationRule yang dibuat.

primaryKey

string

Kunci primer 256-bit yang dikodekan base64 untuk menandatangani dan memvalidasi token SAS.

secondaryConnectionString

string

String koneksi sekunder dari namespace authorizationRule yang dibuat.

secondaryKey

string

Kunci primer 256-bit yang dikodekan base64 untuk menandatangani dan memvalidasi token SAS.

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama Jenis Deskripsi
info

object

Info tambahan.

type

string

Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Nama Jenis Deskripsi
additionalInfo

ErrorAdditionalInfo[]

Info tambahan kesalahan.

code

string

Kode kesalahan.

details

ErrorDetail[]

Detail kesalahan.

message

string

Pesan kesalahan.

target

string

Target kesalahan.

ErrorResponse

Respons kesalahan menunjukkan layanan Event Hub tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan.

Nama Jenis Deskripsi
error

ErrorDetail

Objek kesalahan.

KeyType

Kunci akses untuk meregenerasi.

Nama Jenis Deskripsi
PrimaryKey

string

SecondaryKey

string

RegenerateAccessKeyParameters

Parameter yang diberikan ke operasi Regenerasi Aturan Otorisasi, menentukan kunci mana yang perlu direset.

Nama Jenis Deskripsi
key

string

Opsional, jika nilai kunci yang disediakan, diatur untuk KeyType atau nilai Kunci yang dibuat secara otomatis yang ditetapkan untuk keyType

keyType

KeyType

Kunci akses untuk meregenerasi.