Notification Hubs - Get Authorization Rule

リファレンス

Service:: Notification Hubs

API Version:: 2023-09-01

NotificationHub の承認規則を名前で取得します。

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

URI パラメーター

名前	/	必須	型	説明
authorizationRuleName	path	True	string	承認規則名 Regex pattern: `^[a-zA-Z0-9!()*-._]+$`
namespaceName	path	True	string	名前空間名 Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]*$`
notificationHubName	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 バージョン。

応答

名前	型	説明
200 OK	SharedAccessAuthorizationRuleResource	Success
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	ユーザーアカウントの借用

例

NotificationHubs_GetAuthorizationRule

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

定義

名前	説明
AccessRights	AccessRights の値を定義します。
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
SharedAccessAuthorizationRuleProperties	SharedAccessAuthorizationRule プロパティ。
SharedAccessAuthorizationRuleResource	単一の SharedAccessAuthorizationRule を返す POST 要求に対する応答。
systemData	リソースの作成と最後の変更に関連するメタデータ。

AccessRights

AccessRights の値を定義します。

名前	型	説明
Listen	string
Manage	string
Send	string

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 オブジェクト。

SharedAccessAuthorizationRuleProperties

SharedAccessAuthorizationRule プロパティ。

名前	型	説明
claimType	string	要求の種類を説明する文字列を取得します
claimValue	string	要求値を記述する文字列を取得します
createdTime	string	このルールの作成時刻を取得します
keyName	string	承認規則を記述する文字列を取得します。
modifiedTime	string	このルールの最終変更時刻を取得します
primaryKey	string	SAS トークンに署名して検証するための base64 でエンコードされた 256 ビット主キーを取得します。
revision	integer	ルールのリビジョン番号を取得します
rights	AccessRights[]	規則に関連付けられている権限を取得または設定します。
secondaryKey	string	SAS トークンに署名して検証するための base64 でエンコードされた 256 ビット主キーを取得します。

SharedAccessAuthorizationRuleResource

単一の SharedAccessAuthorizationRule を返す POST 要求に対する応答。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	非推奨 - 互換性のみを目的としています。
name	string	リソースの名前
properties	SharedAccessAuthorizationRuleProperties	SharedAccessAuthorizationRule プロパティ。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object	非推奨 - 互換性のみを目的としています。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

Share via