openapi-directory/api/azure.com/apimanagement-apimnotifications.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"Use these REST APIs for performing operations on who is going to receive notifications associated with your Azure API Management deployment.","title":"ApiManagementClient","version":"2019-01-01","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/apimnotifications.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"apimanagement-apimnotifications","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications":{"get":{"description":"Lists a collection of properties defined within a service instance.","operationId":"Notification_ListByService","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListNotifications":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementListNotifications":{"value":"apimService1"}}},{"description":"Number of records to return.","in":"query","name":"$top","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":1}},{"description":"Number of records to skip.","in":"query","name":"$skip","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":0}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListNotifications":{"value":"2019-01-01"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListNotifications":{"value":"subid"}}}],"responses":{"200":{"description":"A Collection of the Notification for the specified API Management service instance.","content":{"application/json":{"schema":{"description":"Paged Notification list representation.","properties":{"nextLink":{"description":"Next page link if any.","type":"string"},"value":{"description":"Page values.","items":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Notification details.","properties":{"properties":{"description":"Notification Contract properties.","properties":{"description":{"description":"Description of the Notification.","type":"string"},"recipients":{"description":"Notification Parameter contract.","properties":{"emails":{"description":"List of Emails subscribed for the notification.","items":{"type":"string"},"type":"array"},"users":{"description":"List of Users subscribed for the notification.","items":{"type":"string"},"type":"array"}}},"title":{"description":"Title of the Notification.","maxLength":1000,"minLength":1,"type":"string"}},"required":["title"]}}},"type":"array"}}},"examples":{"ApiManagementListNotifications":{"$ref":"#/components/examples/ApiManagementListNotifications"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["Notification"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}":{"get":{"description":"Gets the details of the Notification specified by its identifier.","operationId":"Notification_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetNotification":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementGetNotification":{"value":"apimService1"}}},{"description":"Notification Name Identifier.","in":"path","name":"notificationName","required":true,"x-ms-enum":{"modelAsString":true,"name":"NotificationName","values":[{"description":"The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.","value":"RequestPublisherNotificationMessage"},{"description":"The following email recipients and users will receive email notifications about new API product subscriptions.","value":"PurchasePublisherNotificationMessage"},{"description":"The following email recipients and users will receive email notifications when new applications are submitted to the application gallery.","value":"NewApplicationNotificationMessage"},{"description":"The following recipients will receive blind carbon copies of all emails sent to developers.","value":"BCC"},{"description":"The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal.","value":"NewIssuePublisherNotificationMessage"},{"description":"The following email recipients and users will receive email notifications when developer closes his account.","value":"AccountClosedPublisher"},{"description":"The following email recipients and users will receive email notifications when subscription usage gets close to usage quota.","value":"QuotaLimitApproachingPublisherNotificationMessage"}]},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["RequestPublisherNotificationMessage","PurchasePublisherNotificationMessage","NewApplicationNotificationMessage","BCC","NewIssuePublisherNotificationMessage","AccountClosedPublisher","QuotaLimitApproachingPublisherNotificationMessage"]},"examples":{"ApiManagementGetNotification":{"value":"RequestPublisherNotificationMessage"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetNotification":{"value":"2019-01-01"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetNotification":{"value":"subid"}}}],"responses":{"200":{"description":"The response body contains the specified Notification.","content":{"application/json":{"schema":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Notification details.","properties":{"properties":{"description":"Notification Contract properties.","properties":{"description":{"description":"Description of the Notification.","type":"string"},"recipients":{"description":"Notification Parameter contract.","properties":{"emails":{"description":"List of Emails subscribed for the notification.","items":{"type":"string"},"type":"array"},"users":{"description":"List of Users subscribed for the notification.","items":{"type":"string"},"type":"array"}}},"title":{"description":"Title of the Notification.","maxLength":1000,"minLength":1,"type":"string"}},"required":["title"]}}},"examples":{"ApiManagementGetNotification":{"$ref":"#/components/examples/ApiManagementGetNotification"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["Notification"]},"put":{"description":"Create or Update API Management publisher notification.","operationId":"Notification_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreateNotification":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementCreateNotification":{"value":"apimService1"}}},{"description":"Notification Name Identifier.","in":"path","name":"notificationName","required":true,"x-ms-enum":{"modelAsString":true,"name":"NotificationName","values":[{"description":"The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.","value":"RequestPublisherNotificationMessage"},{"description":"The following email recipients and users will receive email notifications about new API product subscriptions.","value":"PurchasePublisherNotificationMessage"},{"description":"The following email recipients and users will receive email notifications when new applications are submitted to the application gallery.","value":"NewApplicationNotificationMessage"},{"description":"The following recipients will receive blind carbon copies of all emails sent to developers.","value":"BCC"},{"description":"The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal.","value":"NewIssuePublisherNotificationMessage"},{"description":"The following email recipients and users will receive email notifications when developer closes his account.","value":"AccountClosedPublisher"},{"description":"The following email recipients and users will receive email notifications when subscription usage gets close to usage quota.","value":"QuotaLimitApproachingPublisherNotificationMessage"}]},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["RequestPublisherNotificationMessage","PurchasePublisherNotificationMessage","NewApplicationNotificationMessage","BCC","NewIssuePublisherNotificationMessage","AccountClosedPublisher","QuotaLimitApproachingPublisherNotificationMessage"]},"examples":{"ApiManagementCreateNotification":{"value":"RequestPublisherNotificationMessage"}}},{"description":"ETag of the Entity. Not required when creating an entity, but required when updating an entity.","in":"header","name":"If-Match","required":false,"x-ms-parameter-location":"method","schema":{"type":"string"}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementCreateNotification":{"value":"2019-01-01"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementCreateNotification":{"value":"subid"}}}],"responses":{"200":{"description":"Notification was successfully updated.","content":{"application/json":{"schema":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Notification details.","properties":{"properties":{"description":"Notification Contract properties.","properties":{"description":{"description":"Description of the Notification.","type":"string"},"recipients":{"description":"Notification Parameter contract.","properties":{"emails":{"description":"List of Emails subscribed for the notification.","items":{"type":"string"},"type":"array"},"users":{"description":"List of Users subscribed for the notification.","items":{"type":"string"},"type":"array"}}},"title":{"description":"Title of the Notification.","maxLength":1000,"minLength":1,"type":"string"}},"required":["title"]}}},"examples":{"ApiManagementCreateNotification":{"$ref":"#/components/examples/ApiManagementCreateNotification"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["Notification"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails":{"get":{"description":"Gets the list of the Notification Recipient Emails subscribed to a notification.","operationId":"NotificationRecipientEmail_ListByNotification","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListNotificationRecipientEmails":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementListNotificationRecipientEmails":{"value":"apimService1"}}},{"description":"Notification Name Identifier.","in":"path","name":"notificationName","required":true,"x-ms-enum":{"modelAsString":true,"name":"NotificationName","values":[{"description":"The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.","value":"RequestPublisherNotificationMessage"},{"description":"The following email recipients and users will receive email notifications about new API product subscriptions.","value":"PurchasePublisherNotificationMessage"},{"description":"The following email recipients and users will receive email notifications when new applications are submitted to the application gallery.","value":"NewApplicationNotificationMessage"},{"description":"The following recipients will receive blind carbon copies of all emails sent to developers.","value":"BCC"},{"description":"The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal.","value":"NewIssuePublisherNotificationMessage"},{"description":"The following email recipients and users will receive email notifications when developer closes his account.","value":"AccountClosedPublisher"},{"description":"The following email recipients and users will receive email notifications when subscription usage gets close to usage quota.","value":"QuotaLimitApproachingPublisherNotificationMessage"}]},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["RequestPublisherNotificationMessage","PurchasePublisherNotificationMessage","NewApplicationNotificationMessage","BCC","NewIssuePublisherNotificationMessage","AccountClosedPublisher","QuotaLimitApproachingPublisherNotificationMessage"]},"examples":{"ApiManagementListNotificationRecipientEmails":{"value":"RequestPublisherNotificationMessage"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListNotificationRecipientEmails":{"value":"2019-01-01"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListNotificationRecipientEmails":{"value":"subid"}}}],"responses":{"200":{"description":"The response body contains the Recipient Email collection subscribed to the notification.","content":{"application/json":{"schema":{"description":"Paged Recipient User list representation.","properties":{"nextLink":{"description":"Next page link if any.","type":"string"},"value":{"description":"Page values.","items":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Recipient Email details.","properties":{"properties":{"description":"Recipient Email Contract Properties.","properties":{"email":{"description":"User Email subscribed to notification.","type":"string"}}}}},"type":"array"}}},"examples":{"ApiManagementListNotificationRecipientEmails":{"$ref":"#/components/examples/ApiManagementListNotificationRecipientEmails"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["NotificationRecipientEmail"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails/{email}":{"delete":{"description":"Removes the email from the list of Notification.","operationId":"NotificationRecipientEmail_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteNotificationRecipientEmail":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementDeleteNotificationRecipientEmail":{"value":"apimService1"}}},{"description":"Notification Name Identifier.","in":"path","name":"notificationName","required":true,"x-ms-enum":{"modelAsString":true,"name":"NotificationName","values":[{"description":"The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.","value":"RequestPublisherNotificationMessage"},{"description":"The following email recipients and users will receive email notifications about new API product subscriptions.","value":"PurchasePublisherNotificationMessage"},{"description":"The following email recipients and users will receive email notifications when new applications are submitted to the application gallery.","value":"NewApplicationNotificationMessage"},{"description":"The following recipients will receive blind carbon copies of all emails sent to developers.","value":"BCC"},{"description":"The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal.","value":"NewIssuePublisherNotificationMessage"},{"description":"The following email recipients and users will receive email notifications when developer closes his account.","value":"AccountClosedPublisher"},{"description":"The following email recipients and users will receive email notifications when subscription usage gets close to usage quota.","value":"QuotaLimitApproachingPublisherNotificationMessage"}]},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["RequestPublisherNotificationMessage","PurchasePublisherNotificationMessage","NewApplicationNotificationMessage","BCC","NewIssuePublisherNotificationMessage","AccountClosedPublisher","QuotaLimitApproachingPublisherNotificationMessage"]},"examples":{"ApiManagementDeleteNotificationRecipientEmail":{"value":"RequestPublisherNotificationMessage"}}},{"description":"Email identifier.","in":"path","name":"email","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteNotificationRecipientEmail":{"value":"contoso@live.com"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteNotificationRecipientEmail":{"value":"2019-01-01"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteNotificationRecipientEmail":{"value":"subid"}}}],"responses":{"200":{"description":"Recipient Email was successfully removed to the notification list."},"204":{"description":"Recipient Email was successfully removed to the notification list."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["NotificationRecipientEmail"]},"head":{"description":"Determine if Notification Recipient Email subscribed to the notification.","operationId":"NotificationRecipientEmail_CheckEntityExists","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementHeadNotificationRecipientEmail":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementHeadNotificationRecipientEmail":{"value":"apimService1"}}},{"description":"Notification Name Identifier.","in":"path","name":"notificationName","required":true,"x-ms-enum":{"modelAsString":true,"name":"NotificationName","values":[{"description":"The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.","value":"RequestPublisherNotificationMessage"},{"description":"The following email recipients and users will receive email notifications about new API product subscriptions.","value":"PurchasePublisherNotificationMessage"},{"description":"The following email recipients and users will receive email notifications when new applications are submitted to the application gallery.","value":"NewApplicationNotificationMessage"},{"description":"The following recipients will receive blind carbon copies of all emails sent to developers.","value":"BCC"},{"description":"The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal.","value":"NewIssuePublisherNotificationMessage"},{"description":"The following email recipients and users will receive email notifications when developer closes his account.","value":"AccountClosedPublisher"},{"description":"The following email recipients and users will receive email notifications when subscription usage gets close to usage quota.","value":"QuotaLimitApproachingPublisherNotificationMessage"}]},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["RequestPublisherNotificationMessage","PurchasePublisherNotificationMessage","NewApplicationNotificationMessage","BCC","NewIssuePublisherNotificationMessage","AccountClosedPublisher","QuotaLimitApproachingPublisherNotificationMessage"]},"examples":{"ApiManagementHeadNotificationRecipientEmail":{"value":"RequestPublisherNotificationMessage"}}},{"description":"Email identifier.","in":"path","name":"email","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementHeadNotificationRecipientEmail":{"value":"contoso@live.com"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementHeadNotificationRecipientEmail":{"value":"2019-01-01"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementHeadNotificationRecipientEmail":{"value":"subid"}}}],"responses":{"204":{"description":"The Users is subscribed to receive the notification."},"404":{"description":"The Users is not subscribed to receive the notification."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["NotificationRecipientEmail"]},"put":{"description":"Adds the Email address to the list of Recipients for the Notification.","operationId":"NotificationRecipientEmail_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreateNotificationRecipientEmail":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementCreateNotificationRecipientEmail":{"value":"apimService1"}}},{"description":"Notification Name Identifier.","in":"path","name":"notificationName","required":true,"x-ms-enum":{"modelAsString":true,"name":"NotificationName","values":[{"description":"The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.","value":"RequestPublisherNotificationMessage"},{"description":"The following email recipients and users will receive email notifications about new API product subscriptions.","value":"PurchasePublisherNotificationMessage"},{"description":"The following email recipients and users will receive email notifications when new applications are submitted to the application gallery.","value":"NewApplicationNotificationMessage"},{"description":"The following recipients will receive blind carbon copies of all emails sent to developers.","value":"BCC"},{"description":"The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal.","value":"NewIssuePublisherNotificationMessage"},{"description":"The following email recipients and users will receive email notifications when developer closes his account.","value":"AccountClosedPublisher"},{"description":"The following email recipients and users will receive email notifications when subscription usage gets close to usage quota.","value":"QuotaLimitApproachingPublisherNotificationMessage"}]},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["RequestPublisherNotificationMessage","PurchasePublisherNotificationMessage","NewApplicationNotificationMessage","BCC","NewIssuePublisherNotificationMessage","AccountClosedPublisher","QuotaLimitApproachingPublisherNotificationMessage"]},"examples":{"ApiManagementCreateNotificationRecipientEmail":{"value":"RequestPublisherNotificationMessage"}}},{"description":"Email identifier.","in":"path","name":"email","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreateNotificationRecipientEmail":{"value":"foobar@live.com"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementCreateNotificationRecipientEmail":{"value":"2019-01-01"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementCreateNotificationRecipientEmail":{"value":"subid"}}}],"responses":{"200":{"description":"Recipient Email is already part of the notification list.","content":{"application/json":{"schema":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Recipient Email details.","properties":{"properties":{"description":"Recipient Email Contract Properties.","properties":{"email":{"description":"User Email subscribed to notification.","type":"string"}}}}},"examples":{"ApiManagementCreateNotificationRecipientEmail":{"$ref":"#/components/examples/ApiManagementCreateNotificationRecipientEmail"}}}}},"201":{"description":"Recipient Email was successfully added to the notification list.","content":{"application/json":{"schema":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Recipient Email details.","properties":{"properties":{"description":"Recipient Email Contract Properties.","properties":{"email":{"description":"User Email subscribed to notification.","type":"string"}}}}},"examples":{"ApiManagementCreateNotificationRecipientEmail":{"$ref":"#/components/examples/ApiManagementCreateNotificationRecipientEmail"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["NotificationRecipientEmail"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientUsers":{"get":{"description":"Gets the list of the Notification Recipient User subscribed to the notification.","operationId":"NotificationRecipientUser_ListByNotification","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListNotificationRecipientUsers":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementListNotificationRecipientUsers":{"value":"apimService1"}}},{"description":"Notification Name Identifier.","in":"path","name":"notificationName","required":true,"x-ms-enum":{"modelAsString":true,"name":"NotificationName","values":[{"description":"The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.","value":"RequestPublisherNotificationMessage"},{"description":"The following email recipients and users will receive email notifications about new API product subscriptions.","value":"PurchasePublisherNotificationMessage"},{"description":"The following email recipients and users will receive email notifications when new applications are submitted to the application gallery.","value":"NewApplicationNotificationMessage"},{"description":"The following recipients will receive blind carbon copies of all emails sent to developers.","value":"BCC"},{"description":"The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal.","value":"NewIssuePublisherNotificationMessage"},{"description":"The following email recipients and users will receive email notifications when developer closes his account.","value":"AccountClosedPublisher"},{"description":"The following email recipients and users will receive email notifications when subscription usage gets close to usage quota.","value":"QuotaLimitApproachingPublisherNotificationMessage"}]},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["RequestPublisherNotificationMessage","PurchasePublisherNotificationMessage","NewApplicationNotificationMessage","BCC","NewIssuePublisherNotificationMessage","AccountClosedPublisher","QuotaLimitApproachingPublisherNotificationMessage"]},"examples":{"ApiManagementListNotificationRecipientUsers":{"value":"RequestPublisherNotificationMessage"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListNotificationRecipientUsers":{"value":"2019-01-01"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListNotificationRecipientUsers":{"value":"subid"}}}],"responses":{"200":{"description":"The response body contains the Recipient User collection for the notification.","content":{"application/json":{"schema":{"description":"Paged Recipient User list representation.","properties":{"nextLink":{"description":"Next page link if any.","type":"string"},"value":{"description":"Page values.","items":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Recipient User details.","properties":{"properties":{"description":"Recipient User Contract Properties.","properties":{"userId":{"description":"API Management UserId subscribed to notification.","type":"string"}}}}},"type":"array"}}},"examples":{"ApiManagementListNotificationRecipientUsers":{"$ref":"#/components/examples/ApiManagementListNotificationRecipientUsers"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["NotificationRecipientUser"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientUsers/{userId}":{"delete":{"description":"Removes the API Management user from the list of Notification.","operationId":"NotificationRecipientUser_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteNotificationRecipientUser":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementDeleteNotificationRecipientUser":{"value":"apimService1"}}},{"description":"Notification Name Identifier.","in":"path","name":"notificationName","required":true,"x-ms-enum":{"modelAsString":true,"name":"NotificationName","values":[{"description":"The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.","value":"RequestPublisherNotificationMessage"},{"description":"The following email recipients and users will receive email notifications about new API product subscriptions.","value":"PurchasePublisherNotificationMessage"},{"description":"The following email recipients and users will receive email notifications when new applications are submitted to the application gallery.","value":"NewApplicationNotificationMessage"},{"description":"The following recipients will receive blind carbon copies of all emails sent to developers.","value":"BCC"},{"description":"The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal.","value":"NewIssuePublisherNotificationMessage"},{"description":"The following email recipients and users will receive email notifications when developer closes his account.","value":"AccountClosedPublisher"},{"description":"The following email recipients and users will receive email notifications when subscription usage gets close to usage quota.","value":"QuotaLimitApproachingPublisherNotificationMessage"}]},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["RequestPublisherNotificationMessage","PurchasePublisherNotificationMessage","NewApplicationNotificationMessage","BCC","NewIssuePublisherNotificationMessage","AccountClosedPublisher","QuotaLimitApproachingPublisherNotificationMessage"]},"examples":{"ApiManagementDeleteNotificationRecipientUser":{"value":"RequestPublisherNotificationMessage"}}},{"description":"User identifier. Must be unique in the current API Management service instance.","in":"path","name":"userId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementDeleteNotificationRecipientUser":{"value":"576823d0a40f7e74ec07d642"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteNotificationRecipientUser":{"value":"2019-01-01"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteNotificationRecipientUser":{"value":"subid"}}}],"responses":{"200":{"description":"Recipient User was successfully removed from the notification list."},"204":{"description":"Recipient User was successfully removed from the notification list."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["NotificationRecipientUser"]},"head":{"description":"Determine if the Notification Recipient User is subscribed to the notification.","operationId":"NotificationRecipientUser_CheckEntityExists","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementHeadNotificationRecipientUser":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementHeadNotificationRecipientUser":{"value":"apimService1"}}},{"description":"Notification Name Identifier.","in":"path","name":"notificationName","required":true,"x-ms-enum":{"modelAsString":true,"name":"NotificationName","values":[{"description":"The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.","value":"RequestPublisherNotificationMessage"},{"description":"The following email recipients and users will receive email notifications about new API product subscriptions.","value":"PurchasePublisherNotificationMessage"},{"description":"The following email recipients and users will receive email notifications when new applications are submitted to the application gallery.","value":"NewApplicationNotificationMessage"},{"description":"The following recipients will receive blind carbon copies of all emails sent to developers.","value":"BCC"},{"description":"The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal.","value":"NewIssuePublisherNotificationMessage"},{"description":"The following email recipients and users will receive email notifications when developer closes his account.","value":"AccountClosedPublisher"},{"description":"The following email recipients and users will receive email notifications when subscription usage gets close to usage quota.","value":"QuotaLimitApproachingPublisherNotificationMessage"}]},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["RequestPublisherNotificationMessage","PurchasePublisherNotificationMessage","NewApplicationNotificationMessage","BCC","NewIssuePublisherNotificationMessage","AccountClosedPublisher","QuotaLimitApproachingPublisherNotificationMessage"]},"examples":{"ApiManagementHeadNotificationRecipientUser":{"value":"RequestPublisherNotificationMessage"}}},{"description":"User identifier. Must be unique in the current API Management service instance.","in":"path","name":"userId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementHeadNotificationRecipientUser":{"value":"576823d0a40f7e74ec07d642"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementHeadNotificationRecipientUser":{"value":"2019-01-01"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementHeadNotificationRecipientUser":{"value":"subid"}}}],"responses":{"204":{"description":"The User is subscribed to receive the notification."},"404":{"description":"Entity does not exists."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","