EmailTemplate interface
EmailTemplate を表すインターフェイス。
メソッド
| create |
Email テンプレートを更新します。 |
| delete(string, string, string, string, Email |
Email テンプレートを、API Management サービス インスタンスによって提供される既定のテンプレートにリセットします。 |
| get(string, string, string, Email |
識別子で指定された電子メール テンプレートの詳細を取得します。 |
| get |
識別子で指定された電子メール テンプレートのエンティティ状態 (Etag) バージョンを取得します。 |
| list |
すべての電子メール テンプレートを取得します |
| update(string, string, string, string, Email |
電子メール テンプレート更新 API Management |
メソッドの詳細
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 Management サービスの名前。
- templateName
-
string
テンプレート名識別子をEmailします。
- parameters
- EmailTemplateUpdateParameters
Email テンプレートの更新パラメーター。
options パラメーター。
戻り値
Promise<EmailTemplateContract>
delete(string, string, string, string, EmailTemplateDeleteOptionalParams)
Email テンプレートを、API Management サービス インスタンスによって提供される既定のテンプレートにリセットします。
function delete(resourceGroupName: string, serviceName: string, templateName: string, ifMatch: string, options?: EmailTemplateDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- templateName
-
string
テンプレート名識別子をEmailします。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
options パラメーター。
戻り値
Promise<void>
get(string, string, string, EmailTemplateGetOptionalParams)
識別子で指定された電子メール テンプレートの詳細を取得します。
function get(resourceGroupName: string, serviceName: string, templateName: string, options?: EmailTemplateGetOptionalParams): Promise<EmailTemplateGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- templateName
-
string
テンプレート名識別子をEmailします。
- options
- EmailTemplateGetOptionalParams
options パラメーター。
戻り値
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 Management サービスの名前。
- templateName
-
string
テンプレート名識別子をEmailします。
options パラメーター。
戻り値
Promise<EmailTemplateGetEntityTagHeaders>
listByService(string, string, EmailTemplateListByServiceOptionalParams)
すべての電子メール テンプレートを取得します
function listByService(resourceGroupName: string, serviceName: string, options?: EmailTemplateListByServiceOptionalParams): PagedAsyncIterableIterator<EmailTemplateContract, EmailTemplateContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
options パラメーター。
戻り値
update(string, string, string, string, EmailTemplateUpdateParameters, EmailTemplateUpdateOptionalParams)
電子メール テンプレート更新 API Management
function update(resourceGroupName: string, serviceName: string, templateName: string, ifMatch: string, parameters: EmailTemplateUpdateParameters, options?: EmailTemplateUpdateOptionalParams): Promise<EmailTemplateUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- templateName
-
string
テンプレート名識別子をEmailします。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- parameters
- EmailTemplateUpdateParameters
パラメーターを更新します。
options パラメーター。
戻り値
Promise<EmailTemplateUpdateResponse>