4.0.0 • Published 3 years ago

@datafire/azure_apimanagement_apimnotifications v4.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
3 years ago

@datafire/azure_apimanagement_apimnotifications

Client library for ApiManagementClient

Installation and Usage

npm install --save @datafire/azure_apimanagement_apimnotifications
let azure_apimanagement_apimnotifications = require('@datafire/azure_apimanagement_apimnotifications').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Use these REST APIs for performing operations on who is going to receive notifications associated with your Azure API Management deployment.

Actions

Notification_ListByService

Lists a collection of properties defined within a service instance.

azure_apimanagement_apimnotifications.Notification_ListByService({
  "resourceGroupName": "",
  "serviceName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

  • input object
    • resourceGroupName required string: The name of the resource group.
    • serviceName required string: The name of the API Management service.
    • $top integer: Number of records to return.
    • $skip integer: Number of records to skip.
    • api-version required string: Version of the API to be used with the client request.
    • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

  • output object: Paged Notification list representation.
    • nextLink string: Next page link if any.
    • value array: Page values.
      • items object: Notification details.
        • properties object: Notification Contract properties.
          • description string: Description of the Notification.
          • recipients object: Notification Parameter contract.
            • emails array: List of Emails subscribed for the notification.
            • users array: List of Users subscribed for the notification.
          • title required string: Title of the Notification.
        • id string: Resource ID.
        • name string: Resource name.
        • type string: Resource type for API Management resource.

Notification_Get

Gets the details of the Notification specified by its identifier.

azure_apimanagement_apimnotifications.Notification_Get({
  "resourceGroupName": "",
  "serviceName": "",
  "notificationName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

  • input object
    • resourceGroupName required string: The name of the resource group.
    • serviceName required string: The name of the API Management service.
    • notificationName required string (values: RequestPublisherNotificationMessage, PurchasePublisherNotificationMessage, NewApplicationNotificationMessage, BCC, NewIssuePublisherNotificationMessage, AccountClosedPublisher, QuotaLimitApproachingPublisherNotificationMessage): Notification Name Identifier.
    • api-version required string: Version of the API to be used with the client request.
    • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

  • output object: Notification details.
    • properties object: Notification Contract properties.
      • description string: Description of the Notification.
      • recipients object: Notification Parameter contract.
        • emails array: List of Emails subscribed for the notification.
          • items string
        • users array: List of Users subscribed for the notification.
          • items string
      • title required string: Title of the Notification.
    • id string: Resource ID.
    • name string: Resource name.
    • type string: Resource type for API Management resource.

Notification_CreateOrUpdate

Create or Update API Management publisher notification.

azure_apimanagement_apimnotifications.Notification_CreateOrUpdate({
  "resourceGroupName": "",
  "serviceName": "",
  "notificationName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

  • input object
    • resourceGroupName required string: The name of the resource group.
    • serviceName required string: The name of the API Management service.
    • notificationName required string (values: RequestPublisherNotificationMessage, PurchasePublisherNotificationMessage, NewApplicationNotificationMessage, BCC, NewIssuePublisherNotificationMessage, AccountClosedPublisher, QuotaLimitApproachingPublisherNotificationMessage): Notification Name Identifier.
    • If-Match string: ETag of the Entity. Not required when creating an entity, but required when updating an entity.
    • api-version required string: Version of the API to be used with the client request.
    • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

  • output object: Notification details.
    • properties object: Notification Contract properties.
      • description string: Description of the Notification.
      • recipients object: Notification Parameter contract.
        • emails array: List of Emails subscribed for the notification.
          • items string
        • users array: List of Users subscribed for the notification.
          • items string
      • title required string: Title of the Notification.
    • id string: Resource ID.
    • name string: Resource name.
    • type string: Resource type for API Management resource.

NotificationRecipientEmail_ListByNotification

Gets the list of the Notification Recipient Emails subscribed to a notification.

azure_apimanagement_apimnotifications.NotificationRecipientEmail_ListByNotification({
  "resourceGroupName": "",
  "serviceName": "",
  "notificationName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

  • input object
    • resourceGroupName required string: The name of the resource group.
    • serviceName required string: The name of the API Management service.
    • notificationName required string (values: RequestPublisherNotificationMessage, PurchasePublisherNotificationMessage, NewApplicationNotificationMessage, BCC, NewIssuePublisherNotificationMessage, AccountClosedPublisher, QuotaLimitApproachingPublisherNotificationMessage): Notification Name Identifier.
    • api-version required string: Version of the API to be used with the client request.
    • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

  • output object: Paged Recipient User list representation.
    • nextLink string: Next page link if any.
    • value array: Page values.
      • items object: Recipient Email details.
        • properties object: Recipient Email Contract Properties.
          • email string: User Email subscribed to notification.
        • id string: Resource ID.
        • name string: Resource name.
        • type string: Resource type for API Management resource.

NotificationRecipientEmail_Delete

Removes the email from the list of Notification.

azure_apimanagement_apimnotifications.NotificationRecipientEmail_Delete({
  "resourceGroupName": "",
  "serviceName": "",
  "notificationName": "",
  "email": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

  • input object
    • resourceGroupName required string: The name of the resource group.
    • serviceName required string: The name of the API Management service.
    • notificationName required string (values: RequestPublisherNotificationMessage, PurchasePublisherNotificationMessage, NewApplicationNotificationMessage, BCC, NewIssuePublisherNotificationMessage, AccountClosedPublisher, QuotaLimitApproachingPublisherNotificationMessage): Notification Name Identifier.
    • email required string: Email identifier.
    • api-version required string: Version of the API to be used with the client request.
    • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

NotificationRecipientEmail_CheckEntityExists

Determine if Notification Recipient Email subscribed to the notification.

azure_apimanagement_apimnotifications.NotificationRecipientEmail_CheckEntityExists({
  "resourceGroupName": "",
  "serviceName": "",
  "notificationName": "",
  "email": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

  • input object
    • resourceGroupName required string: The name of the resource group.
    • serviceName required string: The name of the API Management service.
    • notificationName required string (values: RequestPublisherNotificationMessage, PurchasePublisherNotificationMessage, NewApplicationNotificationMessage, BCC, NewIssuePublisherNotificationMessage, AccountClosedPublisher, QuotaLimitApproachingPublisherNotificationMessage): Notification Name Identifier.
    • email required string: Email identifier.
    • api-version required string: Version of the API to be used with the client request.
    • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

NotificationRecipientEmail_CreateOrUpdate

Adds the Email address to the list of Recipients for the Notification.

azure_apimanagement_apimnotifications.NotificationRecipientEmail_CreateOrUpdate({
  "resourceGroupName": "",
  "serviceName": "",
  "notificationName": "",
  "email": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

  • input object
    • resourceGroupName required string: The name of the resource group.
    • serviceName required string: The name of the API Management service.
    • notificationName required string (values: RequestPublisherNotificationMessage, PurchasePublisherNotificationMessage, NewApplicationNotificationMessage, BCC, NewIssuePublisherNotificationMessage, AccountClosedPublisher, QuotaLimitApproachingPublisherNotificationMessage): Notification Name Identifier.
    • email required string: Email identifier.
    • api-version required string: Version of the API to be used with the client request.
    • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

  • output object: Recipient Email details.
    • properties object: Recipient Email Contract Properties.
      • email string: User Email subscribed to notification.
    • id string: Resource ID.
    • name string: Resource name.
    • type string: Resource type for API Management resource.

NotificationRecipientUser_ListByNotification

Gets the list of the Notification Recipient User subscribed to the notification.

azure_apimanagement_apimnotifications.NotificationRecipientUser_ListByNotification({
  "resourceGroupName": "",
  "serviceName": "",
  "notificationName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

  • input object
    • resourceGroupName required string: The name of the resource group.
    • serviceName required string: The name of the API Management service.
    • notificationName required string (values: RequestPublisherNotificationMessage, PurchasePublisherNotificationMessage, NewApplicationNotificationMessage, BCC, NewIssuePublisherNotificationMessage, AccountClosedPublisher, QuotaLimitApproachingPublisherNotificationMessage): Notification Name Identifier.
    • api-version required string: Version of the API to be used with the client request.
    • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

  • output object: Paged Recipient User list representation.
    • nextLink string: Next page link if any.
    • value array: Page values.
      • items object: Recipient User details.
        • properties object: Recipient User Contract Properties.
          • userId string: API Management UserId subscribed to notification.
        • id string: Resource ID.
        • name string: Resource name.
        • type string: Resource type for API Management resource.

NotificationRecipientUser_Delete

Removes the API Management user from the list of Notification.

azure_apimanagement_apimnotifications.NotificationRecipientUser_Delete({
  "resourceGroupName": "",
  "serviceName": "",
  "notificationName": "",
  "userId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

  • input object
    • resourceGroupName required string: The name of the resource group.
    • serviceName required string: The name of the API Management service.
    • notificationName required string (values: RequestPublisherNotificationMessage, PurchasePublisherNotificationMessage, NewApplicationNotificationMessage, BCC, NewIssuePublisherNotificationMessage, AccountClosedPublisher, QuotaLimitApproachingPublisherNotificationMessage): Notification Name Identifier.
    • userId required string: User identifier. Must be unique in the current API Management service instance.
    • api-version required string: Version of the API to be used with the client request.
    • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

NotificationRecipientUser_CheckEntityExists

Determine if the Notification Recipient User is subscribed to the notification.

azure_apimanagement_apimnotifications.NotificationRecipientUser_CheckEntityExists({
  "resourceGroupName": "",
  "serviceName": "",
  "notificationName": "",
  "userId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

  • input object
    • resourceGroupName required string: The name of the resource group.
    • serviceName required string: The name of the API Management service.
    • notificationName required string (values: RequestPublisherNotificationMessage, PurchasePublisherNotificationMessage, NewApplicationNotificationMessage, BCC, NewIssuePublisherNotificationMessage, AccountClosedPublisher, QuotaLimitApproachingPublisherNotificationMessage): Notification Name Identifier.
    • userId required string: User identifier. Must be unique in the current API Management service instance.
    • api-version required string: Version of the API to be used with the client request.
    • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

NotificationRecipientUser_CreateOrUpdate

Adds the API Management User to the list of Recipients for the Notification.

azure_apimanagement_apimnotifications.NotificationRecipientUser_CreateOrUpdate({
  "resourceGroupName": "",
  "serviceName": "",
  "notificationName": "",
  "userId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

  • input object
    • resourceGroupName required string: The name of the resource group.
    • serviceName required string: The name of the API Management service.
    • notificationName required string (values: RequestPublisherNotificationMessage, PurchasePublisherNotificationMessage, NewApplicationNotificationMessage, BCC, NewIssuePublisherNotificationMessage, AccountClosedPublisher, QuotaLimitApproachingPublisherNotificationMessage): Notification Name Identifier.
    • userId required string: User identifier. Must be unique in the current API Management service instance.
    • api-version required string: Version of the API to be used with the client request.
    • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

  • output object: Recipient User details.
    • properties object: Recipient User Contract Properties.
      • userId string: API Management UserId subscribed to notification.
    • id string: Resource ID.
    • name string: Resource name.
    • type string: Resource type for API Management resource.

Definitions

This integration has no definitions

datafire
@infinitebrahmanuniverse/nolb-_datafire_az@everything-registry/sub-chunk-220
4.0.0

3 years ago

3.0.0

6 years ago