Sender Usernames - Create Or Update

Serviço:: Communication

Versão da API:: 2026-03-18

Criar ou atualizar
Adicione um novo recurso SenderUsername no recurso de Domínios pai ou atualize um recurso SenderUsername existente.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/senderUsernames/{senderUsername}?api-version=2026-03-18

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
domainName	path	True	string minLength: 1 maxLength: 253	O nome do recurso Domínios.
emailServiceName	path	True	string minLength: 1 maxLength: 63 pattern: ^[a-zA-Z0-9-]+$	O nome do recurso EmailService.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
senderUsername	path	True	string minLength: 1 maxLength: 253	O nome de usuário do remetente válido.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
properties.username	True	string	Um remetente senderUsername a ser usado ao enviar emails.
properties.displayName		string	O nome de exibição do senderUsername.

Respostas

Nome	Tipo	Description
200 OK	SenderUsernameResource	Operação de atualização 'SenderUsernameResource' de recurso bem-sucedida
201 Created	SenderUsernameResource	Recurso 'SenderUsernameResource' operação de criação foi bem-sucedida
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Create or update SenderUsernames resource

PUT https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/contosoResourceGroup/providers/Microsoft.Communication/emailServices/contosoEmailService/domains/contoso.com/senderUsernames/contosoNewsAlerts?api-version=2026-03-18

{
  "properties": {
    "displayName": "Contoso News Alerts",
    "username": "contosoNewsAlerts"
  }
}

const { CommunicationServiceManagementClient } = require("@azure/arm-communication");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to add a new SenderUsername resource under the parent Domains resource or update an existing SenderUsername resource.
 *
 * @summary add a new SenderUsername resource under the parent Domains resource or update an existing SenderUsername resource.
 * x-ms-original-file: 2026-03-18/senderUsernames/createOrUpdate.json
 */
async function createOrUpdateSenderUsernamesResource() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "11112222-3333-4444-5555-666677778888";
  const client = new CommunicationServiceManagementClient(credential, subscriptionId);
  const result = await client.senderUsernames.createOrUpdate(
    "contosoResourceGroup",
    "contosoEmailService",
    "contoso.com",
    "contosoNewsAlerts",
    { displayName: "Contoso News Alerts", username: "contosoNewsAlerts" },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:: 200

{
  "name": "contoso.com",
  "type": "Microsoft.Communication/EmailServices/Domains",
  "id": "/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/contosoResourceGroup/providers/Microsoft.Communication/EmailServices/contosoEmailService/Domains/contoso.com/senderUsernames/contosoNewsAlerts",
  "properties": {
    "dataLocation": "United States",
    "displayName": "Contoso News Alerts",
    "username": "contosoNewsAlerts"
  }
}

Código de status:: 201

{
  "name": "contoso.com",
  "type": "Microsoft.Communication/EmailServices/Domains",
  "id": "/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/contosoResourceGroup/providers/Microsoft.Communication/EmailServices/contosoEmailService/Domains/contoso.com/senderUsernames/contosoNewsAlerts",
  "properties": {
    "dataLocation": "United States",
    "displayName": "Contoso News Alerts",
    "username": "contosoNewsAlerts"
  }
}

Código de status:: default

{
  "error": {
    "code": "ResourceNotFound",
    "message": "The requested resource was not found"
  }
}

Definições

Nome	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ProvisioningState	Estado de provisionamento do recurso. Desconhecido é o estado padrão para Serviços de Comunicação.
SenderUsernameResource	Uma classe que representa um recurso SenderUsername.
systemData	Metadados relativos à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ProvisioningState

Enumeração

Estado de provisionamento do recurso. Desconhecido é o estado padrão para Serviços de Comunicação.

Valor	Description
Unknown	Unknown
Succeeded	Succeeded
Failed	Falha
Canceled	Cancelado
Running	Executando
Creating	Criar
Updating	Atualização
Deleting	Excluindo
Moving	Movente

SenderUsernameResource

Objeto

Uma classe que representa um recurso SenderUsername.

Nome	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.dataLocation	string	O local onde os dados do recurso NomeUsuário do Remetente são armazenados em repouso.
properties.displayName	string	O nome de exibição do senderUsername.
properties.provisioningState	ProvisioningState	Estado de provisionamento do recurso. Desconhecido é o estado padrão para Serviços de Comunicação.
properties.username	string	Um remetente senderUsername a ser usado ao enviar emails.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.