1. Packages
  2. Azure Native
  3. API Docs
  4. communication
  5. getSenderUsername
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.communication.getSenderUsername

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

Get a valid sender username for a domains resource.

Uses Azure REST API version 2023-06-01-preview.

Other available API versions: 2023-03-31, 2023-04-01, 2023-04-01-preview, 2024-09-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native communication [ApiVersion]. See the version guide for details.

Using getSenderUsername

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 getSenderUsername(args: GetSenderUsernameArgs, opts?: InvokeOptions): Promise<GetSenderUsernameResult>
function getSenderUsernameOutput(args: GetSenderUsernameOutputArgs, opts?: InvokeOptions): Output<GetSenderUsernameResult>
Copy
def get_sender_username(domain_name: Optional[str] = None,
                        email_service_name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        sender_username: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetSenderUsernameResult
def get_sender_username_output(domain_name: Optional[pulumi.Input[str]] = None,
                        email_service_name: Optional[pulumi.Input[str]] = None,
                        resource_group_name: Optional[pulumi.Input[str]] = None,
                        sender_username: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetSenderUsernameResult]
Copy
func LookupSenderUsername(ctx *Context, args *LookupSenderUsernameArgs, opts ...InvokeOption) (*LookupSenderUsernameResult, error)
func LookupSenderUsernameOutput(ctx *Context, args *LookupSenderUsernameOutputArgs, opts ...InvokeOption) LookupSenderUsernameResultOutput
Copy

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

public static class GetSenderUsername 
{
    public static Task<GetSenderUsernameResult> InvokeAsync(GetSenderUsernameArgs args, InvokeOptions? opts = null)
    public static Output<GetSenderUsernameResult> Invoke(GetSenderUsernameInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSenderUsernameResult> getSenderUsername(GetSenderUsernameArgs args, InvokeOptions options)
public static Output<GetSenderUsernameResult> getSenderUsername(GetSenderUsernameArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:communication:getSenderUsername
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DomainName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Domains resource.
EmailServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the EmailService resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SenderUsername
This property is required.
Changes to this property will trigger replacement.
string
The valid sender Username.
DomainName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Domains resource.
EmailServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the EmailService resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SenderUsername
This property is required.
Changes to this property will trigger replacement.
string
The valid sender Username.
domainName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Domains resource.
emailServiceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the EmailService resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
senderUsername
This property is required.
Changes to this property will trigger replacement.
String
The valid sender Username.
domainName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Domains resource.
emailServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the EmailService resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
senderUsername
This property is required.
Changes to this property will trigger replacement.
string
The valid sender Username.
domain_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Domains resource.
email_service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the EmailService resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
sender_username
This property is required.
Changes to this property will trigger replacement.
str
The valid sender Username.
domainName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Domains resource.
emailServiceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the EmailService resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
senderUsername
This property is required.
Changes to this property will trigger replacement.
String
The valid sender Username.

getSenderUsername Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
DataLocation string
The location where the SenderUsername resource data is stored at rest.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the resource
ProvisioningState string
Provisioning state of the resource. Unknown is the default state for Communication Services.
SystemData Pulumi.AzureNative.Communication.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Username string
A sender senderUsername to be used when sending emails.
DisplayName string
The display name for the senderUsername.
AzureApiVersion string
The Azure API version of the resource.
DataLocation string
The location where the SenderUsername resource data is stored at rest.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the resource
ProvisioningState string
Provisioning state of the resource. Unknown is the default state for Communication Services.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Username string
A sender senderUsername to be used when sending emails.
DisplayName string
The display name for the senderUsername.
azureApiVersion String
The Azure API version of the resource.
dataLocation String
The location where the SenderUsername resource data is stored at rest.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the resource
provisioningState String
Provisioning state of the resource. Unknown is the default state for Communication Services.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
username String
A sender senderUsername to be used when sending emails.
displayName String
The display name for the senderUsername.
azureApiVersion string
The Azure API version of the resource.
dataLocation string
The location where the SenderUsername resource data is stored at rest.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name string
The name of the resource
provisioningState string
Provisioning state of the resource. Unknown is the default state for Communication Services.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
username string
A sender senderUsername to be used when sending emails.
displayName string
The display name for the senderUsername.
azure_api_version str
The Azure API version of the resource.
data_location str
The location where the SenderUsername resource data is stored at rest.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name str
The name of the resource
provisioning_state str
Provisioning state of the resource. Unknown is the default state for Communication Services.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
username str
A sender senderUsername to be used when sending emails.
display_name str
The display name for the senderUsername.
azureApiVersion String
The Azure API version of the resource.
dataLocation String
The location where the SenderUsername resource data is stored at rest.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the resource
provisioningState String
Provisioning state of the resource. Unknown is the default state for Communication Services.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
username String
A sender senderUsername to be used when sending emails.
displayName String
The display name for the senderUsername.

Supporting Types

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi