EmailTemplate interface
代表 EmailTemplate 的介面。
方法
| create |
更新Email範本。 |
| delete(string, string, string, string, Email |
將Email範本重設為API 管理服務實例所提供的預設範本。 |
| get(string, string, string, Email |
取得其識別碼所指定之電子郵件範本的詳細資料。 |
| get |
取得 Etag) 其識別碼所指定電子郵件範本版本的實體 (狀態。 |
| list |
取得所有電子郵件範本 |
| update(string, string, string, string, Email |
更新 API 管理電子郵件範本 |
方法詳細資料
createOrUpdate(string, string, string, EmailTemplateUpdateParameters, EmailTemplateCreateOrUpdateOptionalParams)
更新Email範本。
function createOrUpdate(resourceGroupName: string, serviceName: string, templateName: string, parameters: EmailTemplateUpdateParameters, options?: EmailTemplateCreateOrUpdateOptionalParams): Promise<EmailTemplateContract>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- templateName
-
string
Email範本名稱識別碼。
- parameters
- EmailTemplateUpdateParameters
Email範本更新參數。
選項參數。
傳回
Promise<EmailTemplateContract>
delete(string, string, string, string, EmailTemplateDeleteOptionalParams)
將Email範本重設為API 管理服務實例所提供的預設範本。
function delete(resourceGroupName: string, serviceName: string, templateName: string, ifMatch: string, options?: EmailTemplateDeleteOptionalParams): Promise<void>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- templateName
-
string
Email範本名稱識別碼。
- ifMatch
-
string
實體的 ETag。 ETag 應該符合 GET 要求標頭回應的目前實體狀態，否則應該為 * 進行無條件更新。
選項參數。
傳回
Promise<void>
get(string, string, string, EmailTemplateGetOptionalParams)
取得其識別碼所指定之電子郵件範本的詳細資料。
function get(resourceGroupName: string, serviceName: string, templateName: string, options?: EmailTemplateGetOptionalParams): Promise<EmailTemplateGetResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- templateName
-
string
Email範本名稱識別碼。
- options
- EmailTemplateGetOptionalParams
選項參數。
傳回
Promise<EmailTemplateGetResponse>
getEntityTag(string, string, string, EmailTemplateGetEntityTagOptionalParams)
取得 Etag) 其識別碼所指定電子郵件範本版本的實體 (狀態。
function getEntityTag(resourceGroupName: string, serviceName: string, templateName: string, options?: EmailTemplateGetEntityTagOptionalParams): Promise<EmailTemplateGetEntityTagHeaders>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- templateName
-
string
Email範本名稱識別碼。
選項參數。
傳回
Promise<EmailTemplateGetEntityTagHeaders>
listByService(string, string, EmailTemplateListByServiceOptionalParams)
取得所有電子郵件範本
function listByService(resourceGroupName: string, serviceName: string, options?: EmailTemplateListByServiceOptionalParams): PagedAsyncIterableIterator<EmailTemplateContract, EmailTemplateContract[], PageSettings>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
選項參數。
傳回
update(string, string, string, string, EmailTemplateUpdateParameters, EmailTemplateUpdateOptionalParams)
更新 API 管理電子郵件範本
function update(resourceGroupName: string, serviceName: string, templateName: string, ifMatch: string, parameters: EmailTemplateUpdateParameters, options?: EmailTemplateUpdateOptionalParams): Promise<EmailTemplateUpdateResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- templateName
-
string
Email範本名稱識別碼。
- ifMatch
-
string
實體的 ETag。 ETag 應該符合 GET 要求標頭回應的目前實體狀態，否則應該為 * 進行無條件更新。
- parameters
- EmailTemplateUpdateParameters
更新參數。
選項參數。
傳回
Promise<EmailTemplateUpdateResponse>