通过

Namespaces - List Keys

  • 参考
服务:
Notification Hubs
API 版本:
2023-09-01

获取命名空间的主连接字符串和辅助 ConnectionStrings。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/listKeys?api-version=2023-09-01

URI 参数

名称 在 必需 类型 说明
authorizationRuleName
 path True

string

minLength: 1
maxLength: 256
pattern: ^[a-zA-Z0-9!()*-._]+$

授权规则名称
namespaceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z][a-zA-Z0-9-]*$

命名空间名称
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

资源组的名称。 名称不区分大小写。
subscriptionId
 path True

string (uuid)

目标订阅的 ID。 该值必须是 UUID。
api-version
 query True

string

minLength: 1

用于此作的 API 版本。

响应

名称 类型 说明
200 OK

ResourceListKeys

成功
Other Status Codes

ErrorResponse

带原因的错误代码。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Namespaces_ListKeys

示例请求

POST https://management.azure.com/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/authorizationRules/RootManageSharedAccessKey/listKeys?api-version=2023-09-01

示例响应

状态代码:
200 
{
  "primaryConnectionString": "Endpoint=sb://nh-sdk-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=############################################",
  "secondaryConnectionString": "Endpoint=sb://nh-sdk-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=############################################",
  "primaryKey": "############################################",
  "secondaryKey": "############################################",
  "keyName": "RootManageSharedAccessKey"
}

定义

名称 说明
ErrorAdditionalInfo

资源管理错误附加信息。
ErrorDetail

错误详细信息。
ErrorResponse

错误响应
ResourceListKeys

返回命名空间或 NotificationHub 访问密钥（连接字符串）的 POST 请求的响应。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。
type

string

其他信息类型。

ErrorDetail

Object

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

ErrorDetail[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

ErrorResponse

Object

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

ResourceListKeys

Object

返回命名空间或 NotificationHub 访问密钥（连接字符串）的 POST 请求的响应。

名称 类型 说明
keyName

string

获取或设置创建的 AuthorizationRule 的 keyName
primaryConnectionString

string

获取或设置 AuthorizationRule 的主ConnectionString。
primaryKey

string

获取或设置创建的 AuthorizationRule 的主密钥。
secondaryConnectionString

string

获取或设置创建的 AuthorizationRule 的 secondaryConnectionString
secondaryKey

string

获取或设置创建的 AuthorizationRule 的 secondaryKey