openapi-directory

Version:

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

github.com/httptoolkit/openapi-directory-js

1 lines • 34.9 kB

JSON

{"openapi":"3.0.0","info":{"description":"Use these REST APIs for performing operations on Email Templates 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/apimemailtemplates.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"apimanagement-apimemailtemplates","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates":{"get":{"description":"Lists a collection of properties defined within a service instance.","operationId":"EmailTemplate_ListByService","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListEmailTemplates":{"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":{"ApiManagementListEmailTemplates":{"value":"apimService1"}}},{"description":"| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | ","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"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":{"ApiManagementListEmailTemplates":{"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":{"ApiManagementListEmailTemplates":{"value":"subid"}}}],"responses":{"200":{"description":"A Collection of the Email Template for the specified API Management service instance.","content":{"application/json":{"schema":{"description":"Paged email template 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":"Email Template details.","properties":{"properties":{"description":"Email Template Contract properties.","properties":{"body":{"description":"Email Template Body. This should be a valid XDocument","minLength":1,"type":"string"},"description":{"description":"Description of the Email Template.","type":"string"},"isDefault":{"description":"Whether the template is the default template provided by Api Management or has been edited.","readOnly":true,"type":"boolean"},"parameters":{"description":"Email Template Parameter values.","items":{"description":"Email Template Parameter contract.","properties":{"description":{"description":"Template parameter description.","maxLength":256,"minLength":1,"pattern":"^[A-Za-z0-9-._]+$","type":"string"},"name":{"description":"Template parameter name.","maxLength":256,"minLength":1,"pattern":"^[A-Za-z0-9-._]+$","type":"string"},"title":{"description":"Template parameter title.","maxLength":4096,"minLength":1,"type":"string"}}},"type":"array"},"subject":{"description":"Subject of the Template.","maxLength":1000,"minLength":1,"type":"string"},"title":{"description":"Title of the Template.","type":"string"}},"required":["body","subject"]}}},"type":"array"}}},"examples":{"ApiManagementListEmailTemplates":{"$ref":"#/components/examples/ApiManagementListEmailTemplates"}}}}},"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":["EmailTemplate"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates/{templateName}":{"delete":{"description":"Reset the Email Template to default template provided by the API Management service instance.","operationId":"EmailTemplate_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteEmailTemplate":{"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":{"ApiManagementDeleteEmailTemplate":{"value":"apimService1"}}},{"description":"Email Template Name Identifier.","in":"path","name":"templateName","required":true,"x-ms-enum":{"modelAsString":true,"name":"TemplateName"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["applicationApprovedNotificationMessage","accountClosedDeveloper","quotaLimitApproachingDeveloperNotificationMessage","newDeveloperNotificationMessage","emailChangeIdentityDefault","inviteUserNotificationMessage","newCommentNotificationMessage","confirmSignUpIdentityDefault","newIssueNotificationMessage","purchaseDeveloperNotificationMessage","passwordResetIdentityDefault","passwordResetByAdminNotificationMessage","rejectDeveloperNotificationMessage","requestDeveloperNotificationMessage"]},"examples":{"ApiManagementDeleteEmailTemplate":{"value":"newIssueNotificationMessage"}}},{"description":"ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.","in":"header","name":"If-Match","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteEmailTemplate":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteEmailTemplate":{"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":{"ApiManagementDeleteEmailTemplate":{"value":"subid"}}}],"responses":{"200":{"description":"Email Template was successfully reset to default."},"204":{"description":"Email Template was successfully reset to default."},"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":["EmailTemplates"]},"get":{"description":"Gets the details of the email template specified by its identifier.","operationId":"EmailTemplate_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetEmailTemplate":{"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":{"ApiManagementGetEmailTemplate":{"value":"apimService1"}}},{"description":"Email Template Name Identifier.","in":"path","name":"templateName","required":true,"x-ms-enum":{"modelAsString":true,"name":"TemplateName"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["applicationApprovedNotificationMessage","accountClosedDeveloper","quotaLimitApproachingDeveloperNotificationMessage","newDeveloperNotificationMessage","emailChangeIdentityDefault","inviteUserNotificationMessage","newCommentNotificationMessage","confirmSignUpIdentityDefault","newIssueNotificationMessage","purchaseDeveloperNotificationMessage","passwordResetIdentityDefault","passwordResetByAdminNotificationMessage","rejectDeveloperNotificationMessage","requestDeveloperNotificationMessage"]},"examples":{"ApiManagementGetEmailTemplate":{"value":"newIssueNotificationMessage"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetEmailTemplate":{"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":{"ApiManagementGetEmailTemplate":{"value":"subid"}}}],"responses":{"200":{"description":"The response body contains the specified Email template.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"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":"Email Template details.","properties":{"properties":{"description":"Email Template Contract properties.","properties":{"body":{"description":"Email Template Body. This should be a valid XDocument","minLength":1,"type":"string"},"description":{"description":"Description of the Email Template.","type":"string"},"isDefault":{"description":"Whether the template is the default template provided by Api Management or has been edited.","readOnly":true,"type":"boolean"},"parameters":{"description":"Email Template Parameter values.","items":{"description":"Email Template Parameter contract.","properties":{"description":{"description":"Template parameter description.","maxLength":256,"minLength":1,"pattern":"^[A-Za-z0-9-._]+$","type":"string"},"name":{"description":"Template parameter name.","maxLength":256,"minLength":1,"pattern":"^[A-Za-z0-9-._]+$","type":"string"},"title":{"description":"Template parameter title.","maxLength":4096,"minLength":1,"type":"string"}}},"type":"array"},"subject":{"description":"Subject of the Template.","maxLength":1000,"minLength":1,"type":"string"},"title":{"description":"Title of the Template.","type":"string"}},"required":["body","subject"]}}},"examples":{"ApiManagementGetEmailTemplate":{"$ref":"#/components/examples/ApiManagementGetEmailTemplate"}}}}},"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":["EmailTemplates"]},"head":{"description":"Gets the entity state (Etag) version of the email template specified by its identifier.","operationId":"EmailTemplate_GetEntityTag","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementHeadEmailTemplate":{"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":{"ApiManagementHeadEmailTemplate":{"value":"apimService1"}}},{"description":"Email Template Name Identifier.","in":"path","name":"templateName","required":true,"x-ms-enum":{"modelAsString":true,"name":"TemplateName"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["applicationApprovedNotificationMessage","accountClosedDeveloper","quotaLimitApproachingDeveloperNotificationMessage","newDeveloperNotificationMessage","emailChangeIdentityDefault","inviteUserNotificationMessage","newCommentNotificationMessage","confirmSignUpIdentityDefault","newIssueNotificationMessage","purchaseDeveloperNotificationMessage","passwordResetIdentityDefault","passwordResetByAdminNotificationMessage","rejectDeveloperNotificationMessage","requestDeveloperNotificationMessage"]},"examples":{"ApiManagementHeadEmailTemplate":{"value":"newIssueNotificationMessage"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementHeadEmailTemplate":{"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":{"ApiManagementHeadEmailTemplate":{"value":"subid"}}}],"responses":{"200":{"description":"Specified email template entity exists and current entity state version is present in the ETag header.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}}},"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":["EmailTemplates"]},"patch":{"description":"Updates the specific Email Template.","operationId":"EmailTemplate_Update","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementUpdateEmailTemplate":{"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":{"ApiManagementUpdateEmailTemplate":{"value":"apimService1"}}},{"description":"Email Template Name Identifier.","in":"path","name":"templateName","required":true,"x-ms-enum":{"modelAsString":true,"name":"TemplateName"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["applicationApprovedNotificationMessage","accountClosedDeveloper","quotaLimitApproachingDeveloperNotificationMessage","newDeveloperNotificationMessage","emailChangeIdentityDefault","inviteUserNotificationMessage","newCommentNotificationMessage","confirmSignUpIdentityDefault","newIssueNotificationMessage","purchaseDeveloperNotificationMessage","passwordResetIdentityDefault","passwordResetByAdminNotificationMessage","rejectDeveloperNotificationMessage","requestDeveloperNotificationMessage"]},"examples":{"ApiManagementUpdateEmailTemplate":{"value":"applicationApprovedNotificationMessage"}}},{"description":"ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.","in":"header","name":"If-Match","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementUpdateEmailTemplate":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementUpdateEmailTemplate":{"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":{"ApiManagementUpdateEmailTemplate":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Email Template update Parameters.","properties":{"properties":{"description":"Email Template Update Contract properties.","properties":{"body":{"description":"Email Template Body. This should be a valid XDocument","minLength":1,"type":"string"},"description":{"description":"Description of the Email Template.","type":"string"},"parameters":{"description":"Email Template Parameter values.","items":{"description":"Email Template Parameter contract.","properties":{"description":{"description":"Template parameter description.","maxLength":256,"minLength":1,"pattern":"^[A-Za-z0-9-._]+$","type":"string"},"name":{"description":"Template parameter name.","maxLength":256,"minLength":1,"pattern":"^[A-Za-z0-9-._]+$","type":"string"},"title":{"description":"Template parameter title.","maxLength":4096,"minLength":1,"type":"string"}}},"type":"array"},"subject":{"description":"Subject of the Template.","maxLength":1000,"minLength":1,"type":"string"},"title":{"description":"Title of the Template.","type":"string"}}}}}}},"description":"Update parameters.","required":true},"responses":{"204":{"description":"Email Template was successfully updated."},"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":["EmailTemplates"]},"put":{"description":"Updates an Email Template.","operationId":"EmailTemplate_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreateEmailTemplate":{"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":{"ApiManagementCreateEmailTemplate":{"value":"apimService1"}}},{"description":"Email Template Name Identifier.","in":"path","name":"templateName","required":true,"x-ms-enum":{"modelAsString":true,"name":"TemplateName"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["applicationApprovedNotificationMessage","accountClosedDeveloper","quotaLimitApproachingDeveloperNotificationMessage","newDeveloperNotificationMessage","emailChangeIdentityDefault","inviteUserNotificationMessage","newCommentNotificationMessage","confirmSignUpIdentityDefault","newIssueNotificationMessage","purchaseDeveloperNotificationMessage","passwordResetIdentityDefault","passwordResetByAdminNotificationMessage","rejectDeveloperNotificationMessage","requestDeveloperNotificationMessage"]},"examples":{"ApiManagementCreateEmailTemplate":{"value":"newIssueNotificationMessage"}}},{"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":{"ApiManagementCreateEmailTemplate":{"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":{"ApiManagementCreateEmailTemplate":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Email Template update Parameters.","properties":{"properties":{"description":"Email Template Update Contract properties.","properties":{"body":{"description":"Email Template Body. This should be a valid XDocument","minLength":1,"type":"string"},"description":{"description":"Description of the Email Template.","type":"string"},"parameters":{"description":"Email Template Parameter values.","items":{"description":"Email Template Parameter contract.","properties":{"description":{"description":"Template parameter description.","maxLength":256,"minLength":1,"pattern":"^[A-Za-z0-9-._]+$","type":"string"},"name":{"description":"Template parameter name.","maxLength":256,"minLength":1,"pattern":"^[A-Za-z0-9-._]+$","type":"string"},"title":{"description":"Template parameter title.","maxLength":4096,"minLength":1,"type":"string"}}},"type":"array"},"subject":{"description":"Subject of the Template.","maxLength":1000,"minLength":1,"type":"string"},"title":{"description":"Title of the Template.","type":"string"}}}}}}},"description":"Email Template update parameters.","required":true},"responses":{"200":{"description":"Email Template 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":"Email Template details.","properties":{"properties":{"description":"Email Template Contract properties.","properties":{"body":{"description":"Email Template Body. This should be a valid XDocument","minLength":1,"type":"string"},"description":{"description":"Description of the Email Template.","type":"string"},"isDefault":{"description":"Whether the template is the default template provided by Api Management or has been edited.","readOnly":true,"type":"boolean"},"parameters":{"description":"Email Template Parameter values.","items":{"description":"Email Template Parameter contract.","properties":{"description":{"description":"Template parameter description.","maxLength":256,"minLength":1,"pattern":"^[A-Za-z0-9-._]+$","type":"string"},"name":{"description":"Template parameter name.","maxLength":256,"minLength":1,"pattern":"^[A-Za-z0-9-._]+$","type":"string"},"title":{"description":"Template parameter title.","maxLength":4096,"minLength":1,"type":"string"}}},"type":"array"},"subject":{"description":"Subject of the Template.","maxLength":1000,"minLength":1,"type":"string"},"title":{"description":"Title of the Template.","type":"string"}},"required":["body","subject"]}}},"examples":{"ApiManagementCreateEmailTemplate":{"$ref":"#/components/examples/ApiManagementCreateEmailTemplate"}}}}},"201":{"description":"Email Template 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":"Email Template details.","properties":{"properties":{"description":"Email Template Contract properties.","properties":{"body":{"description":"Email Template Body. This should be a valid XDocument","minLength":1,"type":"string"},"description":{"description":"Description of the Email Template.","type":"string"},"isDefault":{"description":"Whether the template is the default template provided by Api Management or has been edited.","readOnly":true,"type":"boolean"},"parameters":{"description":"Email Template Parameter values.","items":{"description":"Email Template Parameter contract.","properties":{"description":{"description":"Template parameter description.","maxLength":256,"minLength":1,"pattern":"^[A-Za-z0-9-._]+$","type":"string"},"name":{"description":"Template parameter name.","maxLength":256,"minLength":1,"pattern":"^[A-Za-z0-9-._]+$","type":"string"},"title":{"description":"Template parameter title.","maxLength":4096,"minLength":1,"type":"string"}}},"type":"array"},"subject":{"description":"Subject of the Template.","maxLength":1000,"minLength":1,"type":"string"},"title":{"description":"Title of the Template.","type":"string"}},"required":["body","subject"]}}},"examples":{"ApiManagementCreateEmailTemplate":{"$ref":"#/components/examples/ApiManagementCreateEmailTemplate"}}}}},"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":["EmailTemplates"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"ApiManagementListEmailTemplates":{"value":{"nextLink":"","value":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/ApplicationApprovedNotificationMessage","name":"ApplicationApprovedNotificationMessage","properties":{"body":"<!DOCTYPE html >\r\n<html>\r\n <head />\r\n <body>\r\n Dear $DevFirstName $DevLastName,\r\n \r\n We are happy to let you know that your request to publish the $AppName application in the application gallery has been approved. Your application has been published and can be viewed <a href=\"http://$DevPortalUrl/Applications/Details/$AppId\">here</a>.\r\n \r\n Best,\r\n The $OrganizationName API Team\r\n </body>\r\n</html>","description":"Developers who submitted their application for publication in the application gallery on the developer portal receive this email after their submission is approved.","isDefault":true,"parameters":[{"name":"AppId","title":"Application id"},{"name":"AppName","title":"Application name"},{"name":"DevFirstName","title":"Developer first name"},{"name":"DevLastName","title":"Developer last name"},{"name":"OrganizationName","title":"Organization name"},{"name":"DevPortalUrl","title":"Developer portal URL"}],"subject":"Your application $AppName is published in the application gallery","title":"Application gallery submission approved"},"type":"Microsoft.ApiManagement/service/templates"}]}},"ApiManagementGetEmailTemplate":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/NewIssueNotificationMessage","name":"NewIssueNotificationMessage","properties":{"body":"<!DOCTYPE html >\r\n<html>\r\n <head />\r\n <body>\r\n Dear $DevFirstName $DevLastName,\r\n Thank you for contacting us. Our API team will review your issue and get back to you soon.\r\n \r\n Click this <a href=\"http://$DevPortalUrl/issues/$IssueId\">link</a> to view or edit your request.\r\n \r\n Best,\r\n The $OrganizationName API Team\r\n </body>\r\n</html>","description":"This email is sent to developers after they create a new topic on the Issues page of the developer portal.","isDefault":true,"parameters":[{"name":"DevFirstName","title":"Developer first name"},{"name":"DevLastName","title":"Developer last name"},{"name":"IssueId","title":"Issue id"},{"name":"IssueName","title":"Issue name"},{"name":"OrganizationName","title":"Organization name"},{"name":"DevPortalUrl","title":"Developer portal URL"}],"subject":"Your request $IssueName was received","title":"New issue received"},"type":"Microsoft.ApiManagement/service/templates"}},"ApiManagementCreateEmailTemplate":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/NewIssueNotificationMessage","name":"NewIssueNotificationMessage","properties":{"body":"<!DOCTYPE html >\r\n<html>\r\n <head />\r\n <body>\r\n Dear $DevFirstName $DevLastName,\r\n Thank you for contacting us. Our API team will review your issue and get back to you soon.\r\n \r\n Click this <a href=\"http://$DevPortalUrl/issues/$IssueId\">link</a> to view or edit your request.\r\n \r\n Best,\r\n The $OrganizationName API Team\r\n </body>\r\n</html>","description":"This email is sent to developers after they create a new topic on the Issues page of the developer portal.","isDefault":false,"parameters":[{"name":"DevFirstName","title":"Developer first name"},{"name":"DevLastName","title":"Developer last name"},{"name":"IssueId","title":"Issue id"},{"name":"IssueName","title":"Issue name"},{"name":"OrganizationName","title":"Organization name"},{"name":"DevPortalUrl","title":"Developer portal URL"}],"subject":"Your request for $IssueName was successfully received.","title":"New issue received"},"type":"Microsoft.ApiManagement/service/templates"}}},"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"}}}}}}}