Share via

SenderUsernames interface

  • Reference
Package:
@azure/arm-communication

Interface representing a SenderUsernames.

Methods

createOrUpdate(string, string, string, string, SenderUsernameResource, SenderUsernamesCreateOrUpdateOptionalParams)

Add a new SenderUsername resource under the parent Domains resource or update an existing SenderUsername resource.
delete(string, string, string, string, SenderUsernamesDeleteOptionalParams)

Operation to delete a SenderUsernames resource.
get(string, string, string, string, SenderUsernamesGetOptionalParams)

Get a valid sender username for a domains resource.
listByDomains(string, string, string, SenderUsernamesListByDomainsOptionalParams)

List all valid sender usernames for a domains resource.

Method Details

createOrUpdate(string, string, string, string, SenderUsernameResource, SenderUsernamesCreateOrUpdateOptionalParams)

Add a new SenderUsername resource under the parent Domains resource or update an existing SenderUsername resource.

function createOrUpdate(resourceGroupName: string, emailServiceName: string, domainName: string, senderUsername: string, parameters: SenderUsernameResource, options?: SenderUsernamesCreateOrUpdateOptionalParams): Promise<SenderUsernameResource>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

emailServiceName

string

The name of the EmailService resource.

domainName

string

The name of the Domains resource.

senderUsername

string

The valid sender Username.

parameters
SenderUsernameResource

Parameters for the create or update operation

options
SenderUsernamesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<SenderUsernameResource>

delete(string, string, string, string, SenderUsernamesDeleteOptionalParams)

Operation to delete a SenderUsernames resource.

function delete(resourceGroupName: string, emailServiceName: string, domainName: string, senderUsername: string, options?: SenderUsernamesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

emailServiceName

string

The name of the EmailService resource.

domainName

string

The name of the Domains resource.

senderUsername

string

The valid sender Username.

options
SenderUsernamesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, SenderUsernamesGetOptionalParams)

Get a valid sender username for a domains resource.

function get(resourceGroupName: string, emailServiceName: string, domainName: string, senderUsername: string, options?: SenderUsernamesGetOptionalParams): Promise<SenderUsernameResource>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

emailServiceName

string

The name of the EmailService resource.

domainName

string

The name of the Domains resource.

senderUsername

string

The valid sender Username.

options
SenderUsernamesGetOptionalParams

The options parameters.

Returns

Promise<SenderUsernameResource>

listByDomains(string, string, string, SenderUsernamesListByDomainsOptionalParams)

List all valid sender usernames for a domains resource.

function listByDomains(resourceGroupName: string, emailServiceName: string, domainName: string, options?: SenderUsernamesListByDomainsOptionalParams): PagedAsyncIterableIterator<SenderUsernameResource, SenderUsernameResource[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

emailServiceName

string

The name of the EmailService resource.

domainName

string

The name of the Domains resource.

options
SenderUsernamesListByDomainsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SenderUsernameResource, SenderUsernameResource[], PageSettings>