Namespaces - Create Or Update

Service:

Notification Hubs

API Version:

2023-09-01

Notification Hub 名前空間を作成/更新します。 この操作はべき等です。

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

URI パラメーター

名前	/	必須	型	説明
namespaceName	path	True	string	名前空間名 Regex pattern: ^[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 フロー

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

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

Namespaces_CreateOrUpdate

Sample Request

HTTP

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"
        ]
      }
    }
  }
}

Sample Response

Status code:

200

{
  "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"
  }
}

Status code:

201

{
  "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	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
GcmCredential	NotificationHub GcmCredential の説明。
GcmCredentialProperties	NotificationHub GcmCredential の説明。
IpRule	IP アドレスに基づいてトラフィックをフィルター処理するネットワーク承認規則。
MpnsCredential	NotificationHub MpnsCredential の説明。
MpnsCredentialProperties	NotificationHub MpnsCredential の説明。
NamespaceProperties	名前空間のプロパティを表します。
NamespaceResource	Notification Hubs 名前空間リソース。
NamespaceStatus	名前空間の状態。
NamespaceType	NamespaceType の値を定義します。
NetworkAcls	ネットワーク承認規則のコレクション。
OperationProvisioningState	OperationProvisioningState の値を定義します。
PnsCredentials	Notification Hub または Notification Hub 名前空間 PNS 資格情報のコレクション。
PrivateEndpointConnectionProperties	プライベート エンドポイント接続プロパティ。
PrivateEndpointConnectionProvisioningState	プライベート エンドポイント接続の状態。
PrivateEndpointConnectionResource	プライベート エンドポイント接続 ARM リソース (Notification Hubs 名前空間のサブリソース) を表します。
PrivateLinkConnectionStatus	Private Link接続の状態。
PublicInternetAuthorizationRule	既定の (パブリック インターネット) ネットワーク承認規則。他のネットワーク規則が一致しない場合は権限が含まれます。
PublicNetworkAccess	パブリック ネットワーク アクセスの種類。
RemotePrivateEndpointConnection	プライベート エンドポイント接続を使用して Notification Hubs 名前空間に接続されているプライベート エンドポイントを表します。
RemotePrivateLinkServiceConnectionState	Private Link サービス接続の状態。
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	開発者アカウントから取得した 10 文字のチーム ID の発行者 (iss) 登録済み要求キーを取得または設定します。
appName	string	アプリケーションの名前を取得または設定します
certificateKey	string	証明書キーを取得または設定します。
endpoint	string	この資格情報のエンドポイントを取得または設定します。
keyId	string	開発者アカウントから取得した 10 文字のキー識別子 (kid) キーを取得または設定します
thumbprint	string	APNS 証明書の拇印を取得または設定します
token	string	開発者アカウントから取得したプロバイダー認証トークンを取得または設定します

BaiduCredential

NotificationHub BaiduCredential の説明。

名前	型	説明
properties	BaiduCredentialProperties	NotificationHub BaiduCredential の説明。

BaiduCredentialProperties

NotificationHub BaiduCredential の説明。

名前	型	説明
baiduApiKey	string	baidu Api Key を取得または設定します。
baiduEndPoint	string	baidu Endpoint を取得または設定します。
baiduSecretKey	string	baidu シークレット キーを取得または設定します

BrowserCredential

NotificationHub BrowserCredential の説明。

名前	型	説明
properties	BrowserCredentialProperties	NotificationHub BrowserCredential の説明。

BrowserCredentialProperties

NotificationHub BrowserCredential の説明。

名前	型	説明
subject	string	Web プッシュサブジェクトを取得または設定します。
vapidPrivateKey	string	VAPID 秘密キーを取得または設定します。
vapidPublicKey	string	VAPID 公開キーを取得または設定します。

createdByType

リソースを作成した ID の種類。

名前	型	説明
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	error オブジェクト。

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		Notification Hubs 名前空間の名前。 これは不変プロパティであり、名前空間の作成時にサービスによって自動的に設定されます。
namespaceType	NamespaceType		NamespaceType の値を定義します。
networkAcls	NetworkAcls		ネットワーク承認規則のコレクション。
pnsCredentials	PnsCredentials		Notification Hub または Notification Hub 名前空間 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

Notification Hubs 名前空間リソース。

名前	型	説明
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 Resource Manager メタデータ。
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	既定の (パブリック インターネット) ネットワーク承認規則。他のネットワーク規則が一致しない場合は権限が含まれます。

OperationProvisioningState

OperationProvisioningState の値を定義します。

名前	型	説明
Canceled	string
Disabled	string
Failed	string
InProgress	string
Pending	string
Succeeded	string
Unknown	string

PnsCredentials

Notification Hub または Notification Hub 名前空間 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 の一覧。 Notification Hubs の場合、常に 1 つの "名前空間" 要素が含まれます。
privateEndpoint	RemotePrivateEndpointConnection	プライベート エンドポイント接続を使用して Notification Hubs 名前空間に接続されているプライベート エンドポイントを表します。
privateLinkServiceConnectionState	RemotePrivateLinkServiceConnectionState	Private Link サービス接続の状態。
provisioningState	PrivateEndpointConnectionProvisioningState	プライベート エンドポイント接続の状態。

PrivateEndpointConnectionProvisioningState

プライベート エンドポイント接続の状態。

名前	型	説明
Creating	string
Deleted	string
Deleting	string
DeletingByProxy	string
Succeeded	string
Unknown	string
Updating	string
UpdatingByProxy	string

PrivateEndpointConnectionResource

プライベート エンドポイント接続 ARM リソース (Notification Hubs 名前空間のサブリソース) を表します。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties	PrivateEndpointConnectionProperties	プライベート エンドポイント接続のプロパティ。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

PrivateLinkConnectionStatus

Private Link接続の状態。

名前	型	説明
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicInternetAuthorizationRule

既定の (パブリック インターネット) ネットワーク承認規則。他のネットワーク規則が一致しない場合は権限が含まれます。

名前	型	説明
rights	AccessRights[]	アクセス権の一覧。

PublicNetworkAccess

パブリック ネットワーク アクセスの種類。

名前	型	説明
Disabled	string
Enabled	string

RemotePrivateEndpointConnection

プライベート エンドポイント接続を使用して Notification Hubs 名前空間に接続されているプライベート エンドポイントを表します。

名前	型	説明
id	string	プライベート エンドポイントの ARM リソース ID。 これは、Notification Hubs 名前空間とは異なるサブスクリプションとリソース グループに属している可能性があります。

RemotePrivateLinkServiceConnectionState

Private Link サービス接続の状態。

名前	型	説明
actionsRequired	string	必要なアクションの人間に優しい説明。
description	string	人間に優しい説明。
status	PrivateLinkConnectionStatus	Private Link接続の状態。

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	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

WnsCredential

NotificationHub WnsCredential の説明。

名前	型	説明
properties	WnsCredentialProperties	NotificationHub WnsCredential の説明。

WnsCredentialProperties

NotificationHub WnsCredential の説明。

名前	型	説明
certificateKey	string	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	xiaomi サービス エンドポイントを取得または設定します。

ZoneRedundancyPreference

名前空間 SKU 名。

名前	型	説明
Disabled	string
Enabled	string