NotificationRecipientUser interface
Interface que representa um NotificationRecipientUser.
Métodos
| check |
Determine se o usuário destinatário da notificação está inscrito na notificação. |
| create |
Adiciona o usuário do Gerenciamento de API à lista de destinatários da notificação. |
| delete(string, string, string, string, Notification |
Remove o usuário do Gerenciamento de API da lista de notificações. |
| list |
Obtém a lista do usuário do destinatário da notificação inscrito na notificação. |
Detalhes do método
checkEntityExists(string, string, string, string, NotificationRecipientUserCheckEntityExistsOptionalParams)
Determine se o usuário destinatário da notificação está inscrito na notificação.
function checkEntityExists(resourceGroupName: string, serviceName: string, notificationName: string, userId: string, options?: NotificationRecipientUserCheckEntityExistsOptionalParams): Promise<NotificationRecipientUserCheckEntityExistsResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- notificationName
-
string
Identificador de nome de notificação.
- userId
-
string
Identificador do usuário. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
Os parâmetros de opções.
Retornos
createOrUpdate(string, string, string, string, NotificationRecipientUserCreateOrUpdateOptionalParams)
Adiciona o usuário do Gerenciamento de API à lista de destinatários da notificação.
function createOrUpdate(resourceGroupName: string, serviceName: string, notificationName: string, userId: string, options?: NotificationRecipientUserCreateOrUpdateOptionalParams): Promise<RecipientUserContract>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- notificationName
-
string
Identificador de nome de notificação.
- userId
-
string
Identificador do usuário. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
Os parâmetros de opções.
Retornos
Promise<RecipientUserContract>
delete(string, string, string, string, NotificationRecipientUserDeleteOptionalParams)
Remove o usuário do Gerenciamento de API da lista de notificações.
function delete(resourceGroupName: string, serviceName: string, notificationName: string, userId: string, options?: NotificationRecipientUserDeleteOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- notificationName
-
string
Identificador de nome de notificação.
- userId
-
string
Identificador do usuário. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
Os parâmetros de opções.
Retornos
Promise<void>
listByNotification(string, string, string, NotificationRecipientUserListByNotificationOptionalParams)
Obtém a lista do usuário do destinatário da notificação inscrito na notificação.
function listByNotification(resourceGroupName: string, serviceName: string, notificationName: string, options?: NotificationRecipientUserListByNotificationOptionalParams): Promise<RecipientUserCollection>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- notificationName
-
string
Identificador de nome de notificação.
Os parâmetros de opções.
Retornos
Promise<RecipientUserCollection>