NotificationRecipientUser interface
NotificationRecipientUser を表すインターフェイス。
メソッド
| check |
通知受信者ユーザーが通知をサブスクライブしているかどうかを確認します。 |
| create |
通知の受信者の一覧に API Management ユーザーを追加します。 |
| delete(string, string, string, string, Notification |
通知の一覧から API Management ユーザーを削除します。 |
| list |
通知をサブスクライブしている通知受信者ユーザーの一覧を取得します。 |
メソッドの詳細
checkEntityExists(string, string, string, string, NotificationRecipientUserCheckEntityExistsOptionalParams)
通知受信者ユーザーが通知をサブスクライブしているかどうかを確認します。
function checkEntityExists(resourceGroupName: string, serviceName: string, notificationName: string, userId: string, options?: NotificationRecipientUserCheckEntityExistsOptionalParams): Promise<NotificationRecipientUserCheckEntityExistsResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- notificationName
-
string
通知名識別子。
- userId
-
string
ユーザー識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。
戻り値
createOrUpdate(string, string, string, string, NotificationRecipientUserCreateOrUpdateOptionalParams)
通知の受信者の一覧に API Management ユーザーを追加します。
function createOrUpdate(resourceGroupName: string, serviceName: string, notificationName: string, userId: string, options?: NotificationRecipientUserCreateOrUpdateOptionalParams): Promise<RecipientUserContract>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- notificationName
-
string
通知名識別子。
- userId
-
string
ユーザー識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。
戻り値
Promise<RecipientUserContract>
delete(string, string, string, string, NotificationRecipientUserDeleteOptionalParams)
通知の一覧から API Management ユーザーを削除します。
function delete(resourceGroupName: string, serviceName: string, notificationName: string, userId: string, options?: NotificationRecipientUserDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- notificationName
-
string
通知名識別子。
- userId
-
string
ユーザー識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。
戻り値
Promise<void>
listByNotification(string, string, string, NotificationRecipientUserListByNotificationOptionalParams)
通知をサブスクライブしている通知受信者ユーザーの一覧を取得します。
function listByNotification(resourceGroupName: string, serviceName: string, notificationName: string, options?: NotificationRecipientUserListByNotificationOptionalParams): Promise<RecipientUserCollection>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- notificationName
-
string
通知名識別子。
options パラメーター。
戻り値
Promise<RecipientUserCollection>