Namespaces - Create Or Update Authorization Rule

服务:

Notification Hubs

API 版本:

2023-09-01

为命名空间创建授权规则

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}?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 版本。

请求正文

名称	类型	说明
location	string	已弃用 - 仅用于兼容性。
properties	SharedAccessAuthorizationRuleProperties	SharedAccessAuthorizationRule 属性。
tags	object	已弃用 - 仅用于兼容性。

响应

名称	类型	说明
200 OK	SharedAccessAuthorizationRuleResource	更新
201 Created	SharedAccessAuthorizationRuleResource	创建
Other Status Codes	ErrorResponse	带原因的错误代码。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Namespaces_CreateOrUpdateAuthorizationRule

示例请求

HTTP

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

{
  "properties": {
    "rights": [
      "Listen",
      "Send"
    ]
  }
}

示例响应

状态代码:

200

{
  "properties": {
    "rights": [
      "Listen",
      "Send"
    ],
    "modifiedTime": "2023-04-26T10:09:19.9675121+00:00",
    "createdTime": "2023-04-26T10:09:19.9675121+00:00"
  },
  "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/authorizationRules/NewAuthorizationRule",
  "name": "NewAuthorizationRule",
  "type": "Microsoft.NotificationHubs/namespaces/authorizationRules"
}

状态代码:

201

{
  "properties": {
    "rights": [
      "Listen",
      "Send"
    ],
    "modifiedTime": "2023-04-26T10:09:19.9675121+00:00",
    "createdTime": "2023-04-26T10:09:19.9675121+00:00"
  },
  "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/authorizationRules/NewAuthorizationRule",
  "name": "NewAuthorizationRule",
  "type": "Microsoft.NotificationHubs/namespaces/authorizationRules"
}

定义

名称	说明
AccessRights	定义 AccessRights 的值。
createdByType	创建资源的标识的类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
SharedAccessAuthorizationRuleProperties	SharedAccessAuthorizationRule 属性。
SharedAccessAuthorizationRuleResource	返回单个 SharedAccessAuthorizationRule 的 POST 请求的响应。
systemData	与创建和上次修改资源相关的元数据。

AccessRights

枚举

定义 AccessRights 的值。

值	说明
Manage
Send
Listen

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

SharedAccessAuthorizationRuleProperties

Object

SharedAccessAuthorizationRule 属性。

名称	类型	说明
claimType	string	获取描述声明类型的字符串
claimValue	string	获取描述声明值的字符串
createdTime	string (date-time)	获取此规则的创建时间
keyName	string	获取描述授权规则的字符串。
modifiedTime	string (date-time)	获取此规则的上次修改时间
primaryKey	string	获取 base64 编码的 256 位主密钥，用于签名和验证 SAS 令牌。
revision	integer (int32)	获取规则的修订号
rights	AccessRights[]	获取或设置与规则关联的权限。
secondaryKey	string	获取 base64 编码的 256 位主密钥，用于签名和验证 SAS 令牌。

SharedAccessAuthorizationRuleResource

Object

返回单个 SharedAccessAuthorizationRule 的 POST 请求的响应。

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
location	string	已弃用 - 仅用于兼容性。
name	string	资源的名称
properties	SharedAccessAuthorizationRuleProperties	SharedAccessAuthorizationRule 属性。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	已弃用 - 仅用于兼容性。
type	string	资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。