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":"2018-06-01-preview","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/preview/2018-06-01-preview/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":{"ApiManagementListNotification":{"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":{"ApiManagementListNotification":{"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":{"ApiManagementListNotification":{"value":"2018-06-01-preview"}}},{"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":{"ApiManagementListNotification":{"value":"subid"}}}],"responses":{"200":{"description":"A Collection of the Notification for the specified API Management service instance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationCollection"},"examples":{"ApiManagementListNotification":{"$ref":"#/components/examples/ApiManagementListNotification"}}}}}},"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"}}},{"$ref":"#/components/parameters/NotificationNameParameter"},{"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":"2018-06-01-preview"}}},{"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":{"$ref":"#/components/schemas/NotificationContract"},"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":"Updates an 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":{"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"}}},{"$ref":"#/components/parameters/NotificationNameParameter"},{"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":{"ApiManagementGetNotification":{"value":"2018-06-01-preview"}}},{"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":"Notification was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationContract"},"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"]}},"/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":{"ApiManagementListNotificationRecipientEmail":{"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":{"ApiManagementListNotificationRecipientEmail":{"value":"apimService1"}}},{"$ref":"#/components/parameters/NotificationNameParameter"},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListNotificationRecipientEmail":{"value":"2018-06-01-preview"}}},{"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":{"ApiManagementListNotificationRecipientEmail":{"value":"subid"}}}],"responses":{"200":{"description":"The response body contains the Recipient Email collection subscribed to the notification.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecipientEmailCollection"},"examples":{"ApiManagementListNotificationRecipientEmail":{"$ref":"#/components/examples/ApiManagementListNotificationRecipientEmail"}}}}},"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"}}},{"$ref":"#/components/parameters/NotificationNameParameter"},{"$ref":"#/components/parameters/EmailParameter"},{"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":"2018-06-01-preview"}}},{"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"}}},{"$ref":"#/components/parameters/NotificationNameParameter"},{"$ref":"#/components/parameters/EmailParameter"},{"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":"2018-06-01-preview"}}},{"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":{"ApiManagementCreateRecipientEmail":{"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":{"ApiManagementCreateRecipientEmail":{"value":"apimService1"}}},{"$ref":"#/components/parameters/NotificationNameParameter"},{"$ref":"#/components/parameters/EmailParameter"},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementCreateRecipientEmail":{"value":"2018-06-01-preview"}}},{"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":{"ApiManagementCreateRecipientEmail":{"value":"subid"}}}],"responses":{"200":{"description":"Recipient Email is already part of the notification list.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecipientEmailContract"},"examples":{"ApiManagementCreateRecipientEmail":{"$ref":"#/components/examples/ApiManagementCreateRecipientEmail"}}}}},"201":{"description":"Recipient Email was successfully added to the notification list.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecipientEmailContract"},"examples":{"ApiManagementCreateRecipientEmail":{"$ref":"#/components/examples/ApiManagementCreateRecipientEmail"}}}}},"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":{"ApiManagementListNotificationRecipientUser":{"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":{"ApiManagementListNotificationRecipientUser":{"value":"apimService1"}}},{"$ref":"#/components/parameters/NotificationNameParameter"},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListNotificationRecipientUser":{"value":"2018-06-01-preview"}}},{"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":{"ApiManagementListNotificationRecipientUser":{"value":"subid"}}}],"responses":{"200":{"description":"The response body contains the Recipient User collection for the notification.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecipientUserCollection"},"examples":{"ApiManagementListNotificationRecipientUser":{"$ref":"#/components/examples/ApiManagementListNotificationRecipientUser"}}}}},"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}/recipientUsers/{uid}":{"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"}}},{"$ref":"#/components/parameters/NotificationNameParameter"},{"description":"User identifier. Must be unique in the current API Management service instance.","in":"path","name":"uid","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)"},"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":"2018-06-01-preview"}}},{"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"}}},{"$ref":"#/components/parameters/NotificationNameParameter"},{"description":"User identifier. Must be unique in the current API Management service instance.","in":"path","name":"uid","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)"},"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":"2018-06-01-preview"}}},{"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.","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"]},"put":{"description":"Adds the API Management User to the list of Recipients for the Notification.","operationId":"NotificationRecipientUser_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreateRecipientUser":{"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":{"ApiManagementCreateRecipientUser":{"value":"apimService1"}}},{"$ref":"#/components/parameters/NotificationNameParameter"},{"description":"User identifier. Must be unique in the current API Management service instance.","in":"path","name":"uid","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)"},"examples":{"ApiManagementCreateRecipientUser":{"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":{"ApiManagementCreateRecipientUser":{"value":"2018-06-01-preview"}}},{"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":{"ApiManagementCreateRecipientUser":{"value":"subid"}}}],"responses":{"200":{"description":"Recipient User is already part of the notification list.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecipientUserContract"},"examples":{"ApiManagementCreateRecipientUser":{"$ref":"#/components/examples/ApiManagementCreateRecipientUser"}}}}},"201":{"description":"Recipient User was successfully added to the notification list.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecipientUserContract"},"examples":{"ApiManagementCreateRecipientUser":{"$ref":"#/components/examples/ApiManagementCreateRecipientUser"}}}}},"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"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"ApiManagementListNotification":{"value":{"nextLink":"","value":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage","name":"RequestPublisherNotificationMessage","properties":{"description":"The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.","recipients":{"emails":["/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com","/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live","/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com"],"users":["/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642"]},"title":"Subscription requests (requiring approval)"},"type":"Microsoft.ApiManagement/service/notifications"},{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/PurchasePublisherNotificationMessage","name":"PurchasePublisherNotificationMessage","properties":{"description":"The following email recipients and users will receive email notifications about new API product subscriptions.","recipients":{"emails":["/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com"],"users":["/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"]},"title":"New subscriptions"},"type":"Microsoft.ApiManagement/service/notifications"},{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/NewApplicationNotificationMessage","name":"NewApplicationNotificationMessage","properties":{"description":"The following email recipients and users will receive email notifications when new applications are submitted to the application gallery.","recipients":{"emails":["/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com"],"users":[]},"title":"Application gallery requests"},"type":"Microsoft.ApiManagement/service/notifications"},{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/BCC","name":"BCC","properties":{"description":"The following recipients will receive blind carbon copies of all emails sent to developers.","recipients":{"emails":[],"users":[]},"title":"BCC"},"type":"Microsoft.ApiManagement/service/notifications"},{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/NewIssuePublisherNotificationMessage","name":"NewIssuePublisherNotificationMessage","properties":{"description":"The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal.","recipients":{"emails":[],"users":["/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"]},"title":"New issue or comment"},"type":"Microsoft.ApiManagement/service/notifications"},{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/AccountClosedPublisher","name":"AccountClosedPublisher","properties":{"description":"The following email recipients and users will receive email notifications when developer closes his account","recipients":{"emails":["/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com"],"users":[]},"title":"Close account message"},"type":"Microsoft.ApiManagement/service/notifications"},{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/QuotaLimitApproachingPublisherNotificationMessage","name":"QuotaLimitApproachingPublisherNotificationMessage","properties":{"description":"The following email recipients and users will receive email notifications when subscription usage gets close to usage quota.","recipients":{"emails":[],"users":["/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"]},"title":"Approaching subscription quota limit"},"type":"Microsoft.ApiManagement/service/notifications"}]}},"ApiManagementGetNotification":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage","name":"RequestPublisherNotificationMessage","properties":{"description":"The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.","recipients":{"emails":["/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/contoso@live.com","/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/foobar!live","/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/foobar@live.com"],"users":["/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642"]},"title":"Subscription requests (requiring approval)"},"type":"Microsoft.ApiManagement/service/notifications"}},"ApiManagementListNotificationRecipientEmail":{"value":{"nextLink":"","value":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com","name":"contoso@live.com","properties":{"email":"contoso@live.com"},"type":"Microsoft.ApiManagement/service/notifications/recipientEmails"},{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live","name":"foobar!live","properties":{"email":"foobar!live"},"type":"Microsoft.ApiManagement/service/notifications/recipientEmails"},{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com","name":"foobar@live.com","properties":{"email":"foobar@live.com"},"type":"Microsoft.ApiManagement/service/notifications/recipientEmails"}]}},"ApiManagementCreateRecipientEmail":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com","name":"foobar@live.com","properties":{"email":"foobar@live.com"},"type":"Microsoft.ApiManagement/service/notifications/recipientEmails"}},"ApiManagementListNotificationRecipientUser":{"value":{"nextLink":"","value":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642","name":"576823d0a40f7e74ec07d642","properties":{"userId":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642"},"type":"Microsoft.ApiManagement/service/notifications/recipientUsers"}]}},"ApiManagementCreateRecipientUser":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642","name":"576823d0a40f7e74ec07d642","properties":{"userId":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642"},"type":"Microsoft.ApiManagement/service/notifications/recipientUsers"}}},"parameters":{"EmailParameter":{"description":"Email identifier.","in":"path","name":"email","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteNotificationRecipientEmail":{"value":"contoso@live.com"},"ApiManagementHeadNotificationRecipientEmail":{"value":"contoso@live.com"},"ApiManagementCreateRecipientEmail":{"value":"foobar@live.com"}}},"NotificationNameParameter":{"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"},"ApiManagementListNotificationRecipientEmail":{"value":"RequestPublisherNotificationMessage"},"ApiManagementDeleteNotificationRecipientEmail":{"value":"RequestPublisherNotificationMessage"},"ApiManagementHeadNotificationRecipientEmail":{"value":"RequestPublisherNotificationMessage"},"ApiManagementCreateRecipientEmail":{"value":"RequestPublisherNotificationMessage"},"ApiManagementListNotificationRecipientUser":{"value":"RequestPublisherNotificationMessage"},"ApiManagementDeleteNotificationRecipientUser":{"value":"RequestPublisherNotificationMessage"},"ApiManagementHeadNotificationRecipientUser":{"value":"RequestPublisherNotificationMessage"},"ApiManagementCreateRecipientUser":{"value":"RequestPublisherNotificationMessage"}}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow.","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"NotificationCollection":{"description":"Paged Notification list representation.","properties":{"nextLink":{"description":"Next page link if any.","type":"string"},"value":{"description":"Page values.","items":{"$ref":"#/components/schemas/NotificationContract"},"type":"array"}}},"NotificationContract":{"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":{"$ref":"#/components/schemas/NotificationContractProperties"}}},"NotificationContractProperties":{"description":"Notification Contract properties.","properties":{"description":{"description":"Description of the Notification.","type":"string"},"recipients":{"$ref":"#/components/schemas/RecipientsContractProperties"},"title":{"description":"Title of the Notification.","maxLength":1000,"minLength":1,"type":"string"}},"required":["title"]},"RecipientEmailCollection":{"description":"Paged Recipient User list representation.","properties":{"nextLink":{"description":"Next page link if any.","type":"string"},"value":{"description":"Page values.","items":{"$ref":"#/components/schemas/RecipientEmailContract"},"type":"array"}}},"RecipientEmailContract":{"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":{"$ref":"#/components/schemas/RecipientEmailContractProperties"}}},"RecipientEmailContractProperties":{"description":"Recipient Email Contract Properties.","properties":{"email":{"description":"User Email subscribed to notification.","type":"string"}}},"RecipientUserCollection":{"description":"Paged Recipient User list representation.","properties":{"nextLink":{"description":"Next page link if any.","type":"string"},"value":{"description":"Page values.","items":{"$ref":"#/components/schemas/RecipientUserContract"},"type":"array"}}},"RecipientUserContract":{"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":{"$ref":"#/components/schemas/RecipientUsersContractProperties"}}},"RecipientUsersContractProperties":{"description":"Recipient User Contract Properties.","properties":{"userId":{"description":"API Management UserId subscribed to notification.","type":"string"}}},"RecipientsContractProperties":{"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"}}}}}}