published on Wednesday, Mar 4, 2026 by Pulumi
published on Wednesday, Mar 4, 2026 by Pulumi
Gets the details of the email template specified by its identifier.
Uses Azure REST API version 2022-09-01-preview.
Other available API versions: 2021-04-01-preview, 2021-08-01, 2021-12-01-preview, 2022-04-01-preview, 2022-08-01, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview, 2024-10-01-preview, 2025-03-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apimanagement [ApiVersion]. See the version guide for details.
Using getEmailTemplate
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getEmailTemplate(args: GetEmailTemplateArgs, opts?: InvokeOptions): Promise<GetEmailTemplateResult>
function getEmailTemplateOutput(args: GetEmailTemplateOutputArgs, opts?: InvokeOptions): Output<GetEmailTemplateResult>def get_email_template(resource_group_name: Optional[str] = None,
service_name: Optional[str] = None,
template_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetEmailTemplateResult
def get_email_template_output(resource_group_name: Optional[pulumi.Input[str]] = None,
service_name: Optional[pulumi.Input[str]] = None,
template_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetEmailTemplateResult]func LookupEmailTemplate(ctx *Context, args *LookupEmailTemplateArgs, opts ...InvokeOption) (*LookupEmailTemplateResult, error)
func LookupEmailTemplateOutput(ctx *Context, args *LookupEmailTemplateOutputArgs, opts ...InvokeOption) LookupEmailTemplateResultOutput> Note: This function is named LookupEmailTemplate in the Go SDK.
public static class GetEmailTemplate
{
public static Task<GetEmailTemplateResult> InvokeAsync(GetEmailTemplateArgs args, InvokeOptions? opts = null)
public static Output<GetEmailTemplateResult> Invoke(GetEmailTemplateInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetEmailTemplateResult> getEmailTemplate(GetEmailTemplateArgs args, InvokeOptions options)
public static Output<GetEmailTemplateResult> getEmailTemplate(GetEmailTemplateArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:apimanagement:getEmailTemplate
arguments:
# arguments dictionaryThe following arguments are supported:
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Template
Name string - Email Template Name Identifier.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Template
Name string - Email Template Name Identifier.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- template
Name String - Email Template Name Identifier.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- service
Name string - The name of the API Management service.
- template
Name string - Email Template Name Identifier.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- service_
name str - The name of the API Management service.
- template_
name str - Email Template Name Identifier.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- template
Name String - Email Template Name Identifier.
getEmailTemplate Result
The following output properties are available:
- Azure
Api stringVersion - The Azure API version of the resource.
- Body string
- Email Template Body. This should be a valid XDocument
- Id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Is
Default bool - Whether the template is the default template provided by API Management or has been edited.
- Name string
- The name of the resource
- Subject string
- Subject of the Template.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Description string
- Description of the Email Template.
- Parameters
List<Pulumi.
Azure Native. Api Management. Outputs. Email Template Parameters Contract Properties Response> - Email Template Parameter values.
- Title string
- Title of the Template.
- Azure
Api stringVersion - The Azure API version of the resource.
- Body string
- Email Template Body. This should be a valid XDocument
- Id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Is
Default bool - Whether the template is the default template provided by API Management or has been edited.
- Name string
- The name of the resource
- Subject string
- Subject of the Template.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Description string
- Description of the Email Template.
- Parameters
[]Email
Template Parameters Contract Properties Response - Email Template Parameter values.
- Title string
- Title of the Template.
- azure
Api StringVersion - The Azure API version of the resource.
- body String
- Email Template Body. This should be a valid XDocument
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- is
Default Boolean - Whether the template is the default template provided by API Management or has been edited.
- name String
- The name of the resource
- subject String
- Subject of the Template.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- description String
- Description of the Email Template.
- parameters
List<Email
Template Parameters Contract Properties Response> - Email Template Parameter values.
- title String
- Title of the Template.
- azure
Api stringVersion - The Azure API version of the resource.
- body string
- Email Template Body. This should be a valid XDocument
- id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- is
Default boolean - Whether the template is the default template provided by API Management or has been edited.
- name string
- The name of the resource
- subject string
- Subject of the Template.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- description string
- Description of the Email Template.
- parameters
Email
Template Parameters Contract Properties Response[] - Email Template Parameter values.
- title string
- Title of the Template.
- azure_
api_ strversion - The Azure API version of the resource.
- body str
- Email Template Body. This should be a valid XDocument
- id str
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- is_
default bool - Whether the template is the default template provided by API Management or has been edited.
- name str
- The name of the resource
- subject str
- Subject of the Template.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- description str
- Description of the Email Template.
- parameters
Sequence[Email
Template Parameters Contract Properties Response] - Email Template Parameter values.
- title str
- Title of the Template.
- azure
Api StringVersion - The Azure API version of the resource.
- body String
- Email Template Body. This should be a valid XDocument
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- is
Default Boolean - Whether the template is the default template provided by API Management or has been edited.
- name String
- The name of the resource
- subject String
- Subject of the Template.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- description String
- Description of the Email Template.
- parameters List<Property Map>
- Email Template Parameter values.
- title String
- Title of the Template.
Supporting Types
EmailTemplateParametersContractPropertiesResponse
- Description string
- Template parameter description.
- Name string
- Template parameter name.
- Title string
- Template parameter title.
- Description string
- Template parameter description.
- Name string
- Template parameter name.
- Title string
- Template parameter title.
- description String
- Template parameter description.
- name String
- Template parameter name.
- title String
- Template parameter title.
- description string
- Template parameter description.
- name string
- Template parameter name.
- title string
- Template parameter title.
- description str
- Template parameter description.
- name str
- Template parameter name.
- title str
- Template parameter title.
- description String
- Template parameter description.
- name String
- Template parameter name.
- title String
- Template parameter title.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
published on Wednesday, Mar 4, 2026 by Pulumi
