你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Namespaces - Create Or Update

创建/汇报通知中心命名空间。 此操作是幂等的。

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

URI 参数

名称 必需 类型 说明
namespaceName
path True

string

命名空间名称

正则表达式模式: ^[a-zA-Z][a-zA-Z0-9-]*$

resourceGroupName
path True

string

资源组的名称。 此名称不区分大小写。

subscriptionId
path True

string

uuid

目标订阅的 ID。 该值必须是 UUID。

api-version
query True

string

要用于此操作的 API 版本。

请求正文

名称 必需 类型 说明
location True

string

资源所在的地理位置

sku True

Sku

命名空间的 SKU 说明

properties

NamespaceProperties

表示命名空间属性。

tags

object

资源标记。

响应

名称 类型 说明
200 OK

NamespaceResource

已更新

201 Created

NamespaceResource

创建

Other Status Codes

ErrorResponse

带有原因的错误代码。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Namespaces_CreateOrUpdate

示例请求

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

{
  "sku": {
    "name": "Standard",
    "tier": "Standard"
  },
  "location": "South Central US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "zoneRedundancy": "Enabled",
    "networkAcls": {
      "ipRules": [
        {
          "ipMask": "185.48.100.00/24",
          "rights": [
            "Manage",
            "Send",
            "Listen"
          ]
        }
      ],
      "publicNetworkRule": {
        "rights": [
          "Listen"
        ]
      }
    }
  }
}

示例响应

{
  "location": "East US",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "name": "nh-sdk-ns",
    "provisioningState": "Succeeded",
    "status": "Created",
    "enabled": true,
    "critical": false,
    "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40",
    "createdAt": "2023-04-26T06:10:44.01+00:00",
    "updatedAt": "2023-04-26T06:16:17.697+00:00",
    "namespaceType": "NotificationHub",
    "publicNetworkAccess": "Enabled",
    "zoneRedundancy": "Enabled",
    "networkAcls": {
      "ipRules": [
        {
          "ipMask": "185.48.100.00/24",
          "rights": [
            "Manage",
            "Send",
            "Listen"
          ]
        }
      ],
      "publicNetworkRule": {
        "rights": [
          "Listen"
        ]
      }
    },
    "serviceBusEndpoint": "https://nh-sdk-ns.servicebus.windows.net:443/",
    "privateEndpointConnections": []
  },
  "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns",
  "name": "nh-sdk-ns",
  "type": "Microsoft.NotificationHubs/namespaces",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  }
}
{
  "location": "East US",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "provisioningState": "InProgress",
    "publicNetworkAccess": "Enabled",
    "zoneRedundancy": "Enabled",
    "networkAcls": {
      "ipRules": [
        {
          "ipMask": "185.48.100.00/24",
          "rights": [
            "Manage",
            "Send",
            "Listen"
          ]
        }
      ],
      "publicNetworkRule": {
        "rights": [
          "Listen"
        ]
      }
    }
  },
  "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns",
  "name": "nh-sdk-ns",
  "type": "Microsoft.NotificationHubs/namespaces",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  }
}

定义

名称 说明
AccessRights

定义 AccessRights 的值。

AdmCredential

NotificationHub AdmCredential 的说明。

AdmCredentialProperties

NotificationHub AdmCredential 的说明。

ApnsCredential

NotificationHub ApnsCredential 的说明。

ApnsCredentialProperties

NotificationHub ApnsCredential 的说明。

BaiduCredential

NotificationHub BaiduCredential 的说明。

BaiduCredentialProperties

NotificationHub BaiduCredential 的说明。

BrowserCredential

NotificationHub BrowserCredential 的说明。

BrowserCredentialProperties

NotificationHub BrowserCredential 的说明。

createdByType

创建资源的标识类型。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

GcmCredential

NotificationHub GcmCredential 的说明。

GcmCredentialProperties

NotificationHub GcmCredential 的说明。

IpRule

基于 IP 地址筛选流量的网络授权规则。

MpnsCredential

NotificationHub MpnsCredential 的说明。

MpnsCredentialProperties

NotificationHub MpnsCredential 的说明。

NamespaceProperties

表示命名空间属性。

NamespaceResource

通知中心命名空间资源。

NamespaceStatus

命名空间状态。

NamespaceType

定义 NamespaceType 的值。

NetworkAcls

网络授权规则的集合。

OperationProvisioningState

定义 OperationProvisioningState 的值。

PnsCredentials

通知中心或通知中心命名空间 PNS 凭据的集合。

PrivateEndpointConnectionProperties

专用终结点连接属性。

PrivateEndpointConnectionProvisioningState

专用终结点连接的状态。

PrivateEndpointConnectionResource

表示专用终结点连接 ARM 资源 - 通知中心命名空间的子资源。

PrivateLinkConnectionStatus

专用链接连接的状态。

PublicInternetAuthorizationRule

默认 (公共 Internet) 网络授权规则,如果未匹配其他网络规则,则包含权限。

PublicNetworkAccess

公用网络访问的类型。

RemotePrivateEndpointConnection

表示使用专用终结点连接连接到通知中心命名空间的专用终结点。

RemotePrivateLinkServiceConnectionState

专用链接服务连接的状态。

ReplicationRegion

允许的复制区域

Sku

命名空间的 SKU 说明

SkuName

命名空间 SKU 名称。

systemData

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

WnsCredential

NotificationHub WnsCredential 的说明。

WnsCredentialProperties

NotificationHub WnsCredential 的说明。

XiaomiCredential

NotificationHub XiaomiCredential 的说明。

XiaomiCredentialProperties

NotificationHub XiaomiCredentialProperties 的说明。

ZoneRedundancyPreference

命名空间 SKU 名称。

AccessRights

定义 AccessRights 的值。

名称 类型 说明
Listen

string

Manage

string

Send

string

AdmCredential

NotificationHub AdmCredential 的说明。

名称 类型 说明
properties

AdmCredentialProperties

NotificationHub AdmCredential 的说明。

AdmCredentialProperties

NotificationHub AdmCredential 的说明。

名称 类型 说明
authTokenUrl

string

获取或设置授权令牌的 URL。

clientId

string

获取或设置客户端标识符。

clientSecret

string

获取或设置凭据机密访问密钥。

ApnsCredential

NotificationHub ApnsCredential 的说明。

名称 类型 说明
properties

ApnsCredentialProperties

NotificationHub ApnsCredential 的说明。

ApnsCredentialProperties

NotificationHub ApnsCredential 的说明。

名称 类型 说明
apnsCertificate

string

获取或设置 APNS 证书。

appId

string

获取或设置颁发者 (iss) 注册声明密钥,其值为从开发人员帐户获取的 10 个字符的团队 ID

appName

string

获取或设置应用程序的名称

certificateKey

string

获取或设置证书密钥。

endpoint

string

获取或设置此凭据的终结点。

keyId

string

获取或设置从开发人员帐户获取的 10 个字符密钥标识符 (儿童) 密钥

thumbprint

string

获取或设置 APNS 证书指纹

token

string

获取或设置通过开发人员帐户获取的提供程序身份验证令牌

BaiduCredential

NotificationHub BaiduCredential 的说明。

名称 类型 说明
properties

BaiduCredentialProperties

NotificationHub BaiduCredential 的说明。

BaiduCredentialProperties

NotificationHub BaiduCredential 的说明。

名称 类型 说明
baiduApiKey

string

获取或设置百度 Api 密钥。

baiduEndPoint

string

获取或设置百度终结点。

baiduSecretKey

string

获取或设置百度密钥

BrowserCredential

NotificationHub BrowserCredential 的说明。

名称 类型 说明
properties

BrowserCredentialProperties

NotificationHub BrowserCredential 的说明。

BrowserCredentialProperties

NotificationHub BrowserCredential 的说明。

名称 类型 说明
subject

string

获取或设置 Web 推送主题。

vapidPrivateKey

string

获取或设置 VAPID 私钥。

vapidPublicKey

string

获取或设置 VAPID 公钥。

createdByType

创建资源的标识类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

GcmCredential

NotificationHub GcmCredential 的说明。

名称 类型 说明
properties

GcmCredentialProperties

NotificationHub GcmCredential 的说明。

GcmCredentialProperties

NotificationHub GcmCredential 的说明。

名称 类型 说明
gcmEndpoint

string

获取或设置 GCM 终结点。

googleApiKey

string

获取或设置 Google API 密钥。

IpRule

基于 IP 地址筛选流量的网络授权规则。

名称 类型 说明
ipMask

string

IP 掩码。

rights

AccessRights[]

访问权限列表。

MpnsCredential

NotificationHub MpnsCredential 的说明。

名称 类型 说明
properties

MpnsCredentialProperties

NotificationHub MpnsCredential 的说明。

MpnsCredentialProperties

NotificationHub MpnsCredential 的说明。

名称 类型 说明
certificateKey

string

获取或设置此凭据的证书密钥。

mpnsCertificate

string

获取或设置 MPNS 证书。

thumbprint

string

获取或设置 MPNS 证书指纹

NamespaceProperties

表示命名空间属性。

名称 类型 默认值 说明
createdAt

string

创建命名空间的时间。

critical

boolean

获取或设置命名空间是否设置为 Critical。

dataCenter

string

已弃用。

enabled

boolean

获取或设置命名空间当前是否已启用。

metricId

string

Azure Insights 指标 ID。

name

string

通知中心命名空间的名称。 这是不可变属性,在创建命名空间时由服务自动设置。

namespaceType

NamespaceType

定义 NamespaceType 的值。

networkAcls

NetworkAcls

网络授权规则的集合。

pnsCredentials

PnsCredentials

通知中心或通知中心命名空间 PNS 凭据的集合。

privateEndpointConnections

PrivateEndpointConnectionResource[]

命名空间的专用终结点Connections

provisioningState

OperationProvisioningState

定义 OperationProvisioningState 的值。

publicNetworkAccess

PublicNetworkAccess

Enabled

公用网络访问的类型。

region

string

区域。 该值始终设置为与 Namespace.Location 相同的值,因此我们将弃用此属性。

replicationRegion

ReplicationRegion

允许的复制区域

scaleUnit

string

获取或设置创建命名空间的 scaleUnit

serviceBusEndpoint

string

获取或设置可用于执行 NotificationHub 操作的终结点。

status

NamespaceStatus

命名空间状态。

subscriptionId

string

命名空间订阅 ID。

updatedAt

string

更新命名空间的时间。

zoneRedundancy

ZoneRedundancyPreference

Disabled

命名空间 SKU 名称。

NamespaceResource

通知中心命名空间资源。

名称 类型 说明
id

string

资源的完全限定的资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”

location

string

资源所在的地理位置

name

string

资源的名称

properties

NamespaceProperties

表示命名空间属性。

sku

Sku

命名空间的 SKU 说明

systemData

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。

tags

object

资源标记。

type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

NamespaceStatus

命名空间状态。

名称 类型 说明
Created

string

Creating

string

Deleting

string

Suspended

string

NamespaceType

定义 NamespaceType 的值。

名称 类型 说明
Messaging

string

NotificationHub

string

NetworkAcls

网络授权规则的集合。

名称 类型 说明
ipRules

IpRule[]

IP 规则列表。

publicNetworkRule

PublicInternetAuthorizationRule

默认 (公共 Internet) 网络授权规则,如果未匹配其他网络规则,则包含权限。

OperationProvisioningState

定义 OperationProvisioningState 的值。

名称 类型 说明
Canceled

string

Disabled

string

Failed

string

InProgress

string

Pending

string

Succeeded

string

Unknown

string

PnsCredentials

通知中心或通知中心命名空间 PNS 凭据的集合。

名称 类型 说明
admCredential

AdmCredential

NotificationHub AdmCredential 的说明。

apnsCredential

ApnsCredential

NotificationHub ApnsCredential 的说明。

baiduCredential

BaiduCredential

NotificationHub BaiduCredential 的说明。

browserCredential

BrowserCredential

NotificationHub BrowserCredential 的说明。

gcmCredential

GcmCredential

NotificationHub GcmCredential 的说明。

mpnsCredential

MpnsCredential

NotificationHub MpnsCredential 的说明。

wnsCredential

WnsCredential

NotificationHub WnsCredential 的说明。

xiaomiCredential

XiaomiCredential

NotificationHub XiaomiCredential 的说明。

PrivateEndpointConnectionProperties

专用终结点连接属性。

名称 类型 说明
groupIds

string[]

组 ID 列表。 对于通知中心,它始终包含单个“命名空间”元素。

privateEndpoint

RemotePrivateEndpointConnection

表示使用专用终结点连接连接到通知中心命名空间的专用终结点。

privateLinkServiceConnectionState

RemotePrivateLinkServiceConnectionState

专用链接服务连接的状态。

provisioningState

PrivateEndpointConnectionProvisioningState

专用终结点连接的状态。

PrivateEndpointConnectionProvisioningState

专用终结点连接的状态。

名称 类型 说明
Creating

string

Deleted

string

Deleting

string

DeletingByProxy

string

Succeeded

string

Unknown

string

Updating

string

UpdatingByProxy

string

PrivateEndpointConnectionResource

表示专用终结点连接 ARM 资源 - 通知中心命名空间的子资源。

名称 类型 说明
id

string

资源的完全限定的资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”

name

string

资源的名称

properties

PrivateEndpointConnectionProperties

专用终结点连接属性。

systemData

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。

type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

PrivateLinkConnectionStatus

专用链接连接的状态。

名称 类型 说明
Approved

string

Disconnected

string

Pending

string

Rejected

string

PublicInternetAuthorizationRule

默认 (公共 Internet) 网络授权规则,如果未匹配其他网络规则,则包含权限。

名称 类型 说明
rights

AccessRights[]

访问权限列表。

PublicNetworkAccess

公用网络访问的类型。

名称 类型 说明
Disabled

string

Enabled

string

RemotePrivateEndpointConnection

表示使用专用终结点连接连接到通知中心命名空间的专用终结点。

名称 类型 说明
id

string

专用终结点的 ARM 资源 ID。 这可能属于不同于通知中心命名空间的订阅和资源组。

RemotePrivateLinkServiceConnectionState

专用链接服务连接的状态。

名称 类型 说明
actionsRequired

string

所需操作的友好说明。

description

string

人性化的描述。

status

PrivateLinkConnectionStatus

专用链接连接的状态。

ReplicationRegion

允许的复制区域

名称 类型 说明
AustraliaEast

string

BrazilSouth

string

Default

string

None

string

NorthEurope

string

SouthAfricaNorth

string

SouthEastAsia

string

WestUs2

string

Sku

命名空间的 SKU 说明

名称 类型 说明
capacity

integer

获取或设置资源的容量

family

string

获取或设置 SKU 系列

name

SkuName

命名空间 SKU 名称。

size

string

获取或设置 SKU 大小

tier

string

获取或设置特定 SKU 的层

SkuName

命名空间 SKU 名称。

名称 类型 说明
Basic

string

Free

string

Standard

string

systemData

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

名称 类型 说明
createdAt

string

资源创建时间戳 (UTC) 。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识类型。

lastModifiedAt

string

资源上次修改的时间戳 (UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识类型。

WnsCredential

NotificationHub WnsCredential 的说明。

名称 类型 说明
properties

WnsCredentialProperties

NotificationHub WnsCredential 的说明。

WnsCredentialProperties

NotificationHub WnsCredential 的说明。

名称 类型 说明
certificateKey

string

Ges 或设置 WNS 证书密钥。

packageSid

string

获取或设置此凭据的包 ID。

secretKey

string

获取或设置密钥。

windowsLiveEndpoint

string

获取或设置 Windows Live 终结点。

wnsCertificate

string

获取或设置 WNS 证书。

XiaomiCredential

NotificationHub XiaomiCredential 的说明。

名称 类型 说明
properties

XiaomiCredentialProperties

NotificationHub XiaomiCredentialProperties 的说明。

XiaomiCredentialProperties

NotificationHub XiaomiCredentialProperties 的说明。

名称 类型 说明
appSecret

string

获取或设置应用机密。

endpoint

string

获取或设置小米服务终结点。

ZoneRedundancyPreference

命名空间 SKU 名称。

名称 类型 说明
Disabled

string

Enabled

string