smtp_usernames

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

Overview

Name	smtp_usernames
Type	Resource
Id	azure.communication.smtp_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.
entraApplicationId	string	The application Id for the linked Entra Application. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantId	string	The tenant of the linked Entra Application. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
username	string	The SMTP username. Could be free form or in the email address format. Required.

list

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.
entraApplicationId	string	The application Id for the linked Entra Application. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantId	string	The tenant of the linked Entra Application. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
username	string	The SMTP username. Could be free form or in the email address format. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, communication_service_name, smtp_username, subscription_id		Get. Get a SmtpUsernameResource.
list	select	resource_group_name, communication_service_name, subscription_id		Get. Get all SmtpUsernameResources for a Communication resource.
create_or_update	insert	resource_group_name, communication_service_name, smtp_username, subscription_id		Create Or Update. Create or update an SmtpUsernameResource.
create_or_update	replace	resource_group_name, communication_service_name, smtp_username, subscription_id		Create Or Update. Create or update an SmtpUsernameResource.
delete	delete	resource_group_name, communication_service_name, smtp_username, subscription_id		Delete. Operation to delete a single SmtpUsername 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
communication_service_name	string	The name of the CommunicationService resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
smtp_username	string	The name of the SmtpUsernameResource. Required.
subscription_id	string

SELECT examples

get

Get. Get a SmtpUsernameResource.

SELECT
id,
name,
entraApplicationId,
systemData,
tenantId,
type,
username
FROM azure.communication.smtp_usernames
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND communication_service_name = '{{ communication_service_name }}' -- required
AND smtp_username = '{{ smtp_username }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get. Get all SmtpUsernameResources for a Communication resource.

SELECT
id,
name,
entraApplicationId,
systemData,
tenantId,
type,
username
FROM azure.communication.smtp_usernames
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND communication_service_name = '{{ communication_service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create Or Update. Create or update an SmtpUsernameResource.

INSERT INTO azure.communication.smtp_usernames (
properties,
resource_group_name,
communication_service_name,
smtp_username,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ communication_service_name }}',
'{{ smtp_username }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: smtp_usernames
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the smtp_usernames resource.
  - name: communication_service_name
    value: "{{ communication_service_name }}"
    description: Required parameter for the smtp_usernames resource.
  - name: smtp_username
    value: "{{ smtp_username }}"
    description: Required parameter for the smtp_usernames resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the smtp_usernames resource.
  - name: properties
    description: |
      The properties of a SmtpUsername resource.
    value:
      username: "{{ username }}"
      entraApplicationId: "{{ entraApplicationId }}"
      tenantId: "{{ tenantId }}"

REPLACE examples

create_or_update

Create Or Update. Create or update an SmtpUsernameResource.

REPLACE azure.communication.smtp_usernames
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND communication_service_name = '{{ communication_service_name }}' --required
AND smtp_username = '{{ smtp_username }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete. Operation to delete a single SmtpUsername resource.

DELETE FROM azure.communication.smtp_usernames
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND communication_service_name = '{{ communication_service_name }}' --required
AND smtp_username = '{{ smtp_username }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;