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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
dataLocation	string	The location where the SenderUsername resource data is stored at rest.
displayName	string	The display name for the senderUsername.
provisioningState	string	Provisioning state of the resource. Unknown is the default state for Communication Services. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", "Running", "Creating", "Updating", "Deleting", and "Moving". (Unknown, Succeeded, Failed, Canceled, Running, Creating, Updating, Deleting, Moving)
systemData	object	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. Required.

list_by_domains

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
dataLocation	string	The location where the SenderUsername resource data is stored at rest.
displayName	string	The display name for the senderUsername.
provisioningState	string	Provisioning state of the resource. Unknown is the default state for Communication Services. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", "Running", "Creating", "Updating", "Deleting", and "Moving". (Unknown, Succeeded, Failed, Canceled, Running, Creating, Updating, Deleting, Moving)
systemData	object	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. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, email_service_name, domain_name, sender_username, subscription_id		Get. Get a valid sender username for a domains resource.
list_by_domains	select	resource_group_name, email_service_name, domain_name, subscription_id		ListBy_Domains. List all valid sender usernames for a domains resource.
create_or_update	insert	resource_group_name, email_service_name, domain_name, sender_username, subscription_id		Create Or Update. Add a new SenderUsername resource under the parent Domains resource or update an existing SenderUsername resource.
create_or_update	replace	resource_group_name, email_service_name, domain_name, sender_username, subscription_id		Create Or Update. Add a new SenderUsername resource under the parent Domains resource or update an existing SenderUsername resource.
delete	delete	resource_group_name, email_service_name, domain_name, sender_username, subscription_id		Delete. 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
domain_name	string	The name of the Domains resource. Required.
email_service_name	string	The name of the EmailService resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
sender_username	string	The valid sender Username. Required.
subscription_id	string

SELECT examples

get

Get. Get a valid sender username for a domains resource.

SELECT
id,
name,
dataLocation,
displayName,
provisioningState,
systemData,
type,
username
FROM azure.communication.sender_usernames
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND email_service_name = '{{ email_service_name }}' -- required
AND domain_name = '{{ domain_name }}' -- required
AND sender_username = '{{ sender_username }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_domains

ListBy_Domains. List all valid sender usernames for a domains resource.

SELECT
id,
name,
dataLocation,
displayName,
provisioningState,
systemData,
type,
username
FROM azure.communication.sender_usernames
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND email_service_name = '{{ email_service_name }}' -- required
AND domain_name = '{{ domain_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

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 (
properties,
resource_group_name,
email_service_name,
domain_name,
sender_username,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ email_service_name }}',
'{{ domain_name }}',
'{{ sender_username }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: sender_usernames
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sender_usernames resource.
  - name: email_service_name
    value: "{{ email_service_name }}"
    description: Required parameter for the sender_usernames resource.
  - name: domain_name
    value: "{{ domain_name }}"
    description: Required parameter for the sender_usernames resource.
  - name: sender_username
    value: "{{ sender_username }}"
    description: Required parameter for the sender_usernames resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sender_usernames resource.
  - name: properties
    description: |
      The properties of a SenderUsername resource.
    value:
      dataLocation: "{{ dataLocation }}"
      username: "{{ username }}"
      displayName: "{{ displayName }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

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

REPLACE azure.communication.sender_usernames
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND email_service_name = '{{ email_service_name }}' --required
AND domain_name = '{{ domain_name }}' --required
AND sender_username = '{{ sender_username }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete. Operation to delete a SenderUsernames resource.

DELETE FROM azure.communication.sender_usernames
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND email_service_name = '{{ email_service_name }}' --required
AND domain_name = '{{ domain_name }}' --required
AND sender_username = '{{ sender_username }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;