sender_usernames

Creates, updates, deletes, gets or lists a sender_usernames resource.

Overview

Name	sender_usernames
Type	Resource
Id	azure.communication.sender_usernames

Fields

The following fields are returned by SELECT queries:

get

Success. The response describe the corresponding SenderUsername resource.

Name	Datatype	Description
properties	object	The properties of a SenderUsername resource.

list_by_domains

Success. The response describe the Domains SenderUsername collection.

Name	Datatype	Description
properties	object	The properties of a SenderUsername resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, emailServiceName, domainName, senderUsername		Get a valid sender username for a domains resource.
list_by_domains	select	subscriptionId, resourceGroupName, emailServiceName, domainName		List all valid sender usernames for a domains resource.
create_or_update	insert	subscriptionId, resourceGroupName, emailServiceName, domainName, senderUsername		Add a new SenderUsername resource under the parent Domains resource or update an existing SenderUsername resource.
delete	delete	subscriptionId, resourceGroupName, emailServiceName, domainName, senderUsername		Operation to delete a SenderUsernames resource.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domainName	string	The name of the Domains resource.
emailServiceName	string	The name of the EmailService resource.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
senderUsername	string	The valid sender Username.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get a valid sender username for a domains resource.

SELECT
properties
FROM azure.communication.sender_usernames
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND emailServiceName = '{{ emailServiceName }}' -- required
AND domainName = '{{ domainName }}' -- required
AND senderUsername = '{{ senderUsername }}' -- required
;

list_by_domains

List all valid sender usernames for a domains resource.

SELECT
properties
FROM azure.communication.sender_usernames
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND emailServiceName = '{{ emailServiceName }}' -- required
AND domainName = '{{ domainName }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure.communication.sender_usernames (
data__properties,
subscriptionId,
resourceGroupName,
emailServiceName,
domainName,
senderUsername
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ emailServiceName }}',
'{{ domainName }}',
'{{ senderUsername }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: sender_usernames
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the sender_usernames resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the sender_usernames resource.
    - name: emailServiceName
      value: string
      description: Required parameter for the sender_usernames resource.
    - name: domainName
      value: string
      description: Required parameter for the sender_usernames resource.
    - name: senderUsername
      value: string
      description: Required parameter for the sender_usernames resource.
    - name: properties
      value: object
      description: |
        The properties of a SenderUsername resource.

DELETE examples

delete

Operation to delete a SenderUsernames resource.

DELETE FROM azure.communication.sender_usernames
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND emailServiceName = '{{ emailServiceName }}' --required
AND domainName = '{{ domainName }}' --required
AND senderUsername = '{{ senderUsername }}' --required
;