1. Packages
  2. Ibm Provider
  3. API Docs
  4. getEnSmtpUsers
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.getEnSmtpUsers

Explore with Pulumi AI

Provides a read-only data source for SMTP Users. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const smtpConfigUsers = ibm.getEnSmtpUsers({
    instanceGuid: ibm_resource_instance.en_terraform_test_resource.guid,
});
Copy
import pulumi
import pulumi_ibm as ibm

smtp_config_users = ibm.get_en_smtp_users(instance_guid=ibm_resource_instance["en_terraform_test_resource"]["guid"])
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.GetEnSmtpUsers(ctx, &ibm.GetEnSmtpUsersArgs{
			InstanceGuid: ibm_resource_instance.En_terraform_test_resource.Guid,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var smtpConfigUsers = Ibm.GetEnSmtpUsers.Invoke(new()
    {
        InstanceGuid = ibm_resource_instance.En_terraform_test_resource.Guid,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetEnSmtpUsersArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var smtpConfigUsers = IbmFunctions.getEnSmtpUsers(GetEnSmtpUsersArgs.builder()
            .instanceGuid(ibm_resource_instance.en_terraform_test_resource().guid())
            .build());

    }
}
Copy
variables:
  smtpConfigUsers:
    fn::invoke:
      function: ibm:getEnSmtpUsers
      arguments:
        instanceGuid: ${ibm_resource_instance.en_terraform_test_resource.guid}
Copy

Using getEnSmtpUsers

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 getEnSmtpUsers(args: GetEnSmtpUsersArgs, opts?: InvokeOptions): Promise<GetEnSmtpUsersResult>
function getEnSmtpUsersOutput(args: GetEnSmtpUsersOutputArgs, opts?: InvokeOptions): Output<GetEnSmtpUsersResult>
Copy
def get_en_smtp_users(id: Optional[str] = None,
                      instance_guid: Optional[str] = None,
                      search_key: Optional[str] = None,
                      smtp_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetEnSmtpUsersResult
def get_en_smtp_users_output(id: Optional[pulumi.Input[str]] = None,
                      instance_guid: Optional[pulumi.Input[str]] = None,
                      search_key: Optional[pulumi.Input[str]] = None,
                      smtp_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetEnSmtpUsersResult]
Copy
func GetEnSmtpUsers(ctx *Context, args *GetEnSmtpUsersArgs, opts ...InvokeOption) (*GetEnSmtpUsersResult, error)
func GetEnSmtpUsersOutput(ctx *Context, args *GetEnSmtpUsersOutputArgs, opts ...InvokeOption) GetEnSmtpUsersResultOutput
Copy

> Note: This function is named GetEnSmtpUsers in the Go SDK.

public static class GetEnSmtpUsers 
{
    public static Task<GetEnSmtpUsersResult> InvokeAsync(GetEnSmtpUsersArgs args, InvokeOptions? opts = null)
    public static Output<GetEnSmtpUsersResult> Invoke(GetEnSmtpUsersInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetEnSmtpUsersResult> getEnSmtpUsers(GetEnSmtpUsersArgs args, InvokeOptions options)
public static Output<GetEnSmtpUsersResult> getEnSmtpUsers(GetEnSmtpUsersArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getEnSmtpUsers:getEnSmtpUsers
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

InstanceGuid This property is required. string
Unique identifier for IBM Cloud Event Notifications instance.
SmtpId This property is required. string
SMTP confg Id.
Id string
(String) Autogenerated SMTP User ID.
SearchKey string
Filter the SMTP Configuration by name.
InstanceGuid This property is required. string
Unique identifier for IBM Cloud Event Notifications instance.
SmtpId This property is required. string
SMTP confg Id.
Id string
(String) Autogenerated SMTP User ID.
SearchKey string
Filter the SMTP Configuration by name.
instanceGuid This property is required. String
Unique identifier for IBM Cloud Event Notifications instance.
smtpId This property is required. String
SMTP confg Id.
id String
(String) Autogenerated SMTP User ID.
searchKey String
Filter the SMTP Configuration by name.
instanceGuid This property is required. string
Unique identifier for IBM Cloud Event Notifications instance.
smtpId This property is required. string
SMTP confg Id.
id string
(String) Autogenerated SMTP User ID.
searchKey string
Filter the SMTP Configuration by name.
instance_guid This property is required. str
Unique identifier for IBM Cloud Event Notifications instance.
smtp_id This property is required. str
SMTP confg Id.
id str
(String) Autogenerated SMTP User ID.
search_key str
Filter the SMTP Configuration by name.
instanceGuid This property is required. String
Unique identifier for IBM Cloud Event Notifications instance.
smtpId This property is required. String
SMTP confg Id.
id String
(String) Autogenerated SMTP User ID.
searchKey String
Filter the SMTP Configuration by name.

getEnSmtpUsers Result

The following output properties are available:

Id string
(String) Autogenerated SMTP User ID.
InstanceGuid string
SmtpId string
SmtpUsers List<GetEnSmtpUsersSmtpUser>
(List) List of users.
TotalCount double
(Integer) Total number of SMTP Users.
SearchKey string
Id string
(String) Autogenerated SMTP User ID.
InstanceGuid string
SmtpId string
SmtpUsers []GetEnSmtpUsersSmtpUser
(List) List of users.
TotalCount float64
(Integer) Total number of SMTP Users.
SearchKey string
id String
(String) Autogenerated SMTP User ID.
instanceGuid String
smtpId String
smtpUsers List<GetEnSmtpUsersSmtpUser>
(List) List of users.
totalCount Double
(Integer) Total number of SMTP Users.
searchKey String
id string
(String) Autogenerated SMTP User ID.
instanceGuid string
smtpId string
smtpUsers GetEnSmtpUsersSmtpUser[]
(List) List of users.
totalCount number
(Integer) Total number of SMTP Users.
searchKey string
id str
(String) Autogenerated SMTP User ID.
instance_guid str
smtp_id str
smtp_users Sequence[GetEnSmtpUsersSmtpUser]
(List) List of users.
total_count float
(Integer) Total number of SMTP Users.
search_key str
id String
(String) Autogenerated SMTP User ID.
instanceGuid String
smtpId String
smtpUsers List<Property Map>
(List) List of users.
totalCount Number
(Integer) Total number of SMTP Users.
searchKey String

Supporting Types

GetEnSmtpUsersSmtpUser

CreatedAt This property is required. string
(Stringr) Created time.
Description This property is required. string
(String) SMTP User description.
Domain This property is required. string
(String) Domain Name.
Id This property is required. string
(String) Autogenerated SMTP User ID.
SmtpConfigId This property is required. string
(String) SMTP confg Id.
UpdatedAt This property is required. string
(Stringr) Updated time.
Username This property is required. string
(String) SMTP user name.
CreatedAt This property is required. string
(Stringr) Created time.
Description This property is required. string
(String) SMTP User description.
Domain This property is required. string
(String) Domain Name.
Id This property is required. string
(String) Autogenerated SMTP User ID.
SmtpConfigId This property is required. string
(String) SMTP confg Id.
UpdatedAt This property is required. string
(Stringr) Updated time.
Username This property is required. string
(String) SMTP user name.
createdAt This property is required. String
(Stringr) Created time.
description This property is required. String
(String) SMTP User description.
domain This property is required. String
(String) Domain Name.
id This property is required. String
(String) Autogenerated SMTP User ID.
smtpConfigId This property is required. String
(String) SMTP confg Id.
updatedAt This property is required. String
(Stringr) Updated time.
username This property is required. String
(String) SMTP user name.
createdAt This property is required. string
(Stringr) Created time.
description This property is required. string
(String) SMTP User description.
domain This property is required. string
(String) Domain Name.
id This property is required. string
(String) Autogenerated SMTP User ID.
smtpConfigId This property is required. string
(String) SMTP confg Id.
updatedAt This property is required. string
(Stringr) Updated time.
username This property is required. string
(String) SMTP user name.
created_at This property is required. str
(Stringr) Created time.
description This property is required. str
(String) SMTP User description.
domain This property is required. str
(String) Domain Name.
id This property is required. str
(String) Autogenerated SMTP User ID.
smtp_config_id This property is required. str
(String) SMTP confg Id.
updated_at This property is required. str
(Stringr) Updated time.
username This property is required. str
(String) SMTP user name.
createdAt This property is required. String
(Stringr) Created time.
description This property is required. String
(String) SMTP User description.
domain This property is required. String
(String) Domain Name.
id This property is required. String
(String) Autogenerated SMTP User ID.
smtpConfigId This property is required. String
(String) SMTP confg Id.
updatedAt This property is required. String
(Stringr) Updated time.
username This property is required. String
(String) SMTP user name.

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.