Sender Usernames - Get

服务:

Communication

API 版本:

2025-09-01

获取域资源的有效发件人用户名。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/senderUsernames/{senderUsername}?api-version=2025-09-01

URI 参数

名称	在	必需	类型	说明
domainName	path	True	string minLength: 1 maxLength: 253	域资源的名称。
emailServiceName	path	True	string minLength: 1 maxLength: 63 pattern: ^[a-zA-Z0-9-]+$	EmailService 资源的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 此名称不区分大小写。
senderUsername	path	True	string minLength: 1 maxLength: 253	有效的发件人用户名。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	SenderUsernameResource	成功。 回复描述了对应的 SenderUsername 资源。
Other Status Codes	ErrorResponse	描述作失败的原因的错误响应。

示例

Get SenderUsernames resource

示例请求

HTTP

GET https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/contosoResourceGroup/providers/Microsoft.Communication/emailServices/contosoEmailService/domains/contoso.com/senderUsernames/contosoNewsAlerts?api-version=2025-09-01

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Communication;

// Generated from example definition: specification/communication/resource-manager/Microsoft.Communication/stable/2025-09-01/examples/senderUsernames/get.json
// this example is just showing the usage of "SenderUsernames_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SenderUsernameResource created on azure
// for more information of creating SenderUsernameResource, please refer to the document of SenderUsernameResource
string subscriptionId = "11112222-3333-4444-5555-666677778888";
string resourceGroupName = "contosoResourceGroup";
string emailServiceName = "contosoEmailService";
string domainName = "contoso.com";
string senderUsername = "contosoNewsAlerts";
ResourceIdentifier senderUsernameResourceId = SenderUsernameResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, emailServiceName, domainName, senderUsername);
SenderUsernameResource senderUsernameResource = client.GetSenderUsernameResource(senderUsernameResourceId);

// invoke the operation
SenderUsernameResource result = await senderUsernameResource.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SenderUsernameResourceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

示例响应

状态代码:

200

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

状态代码:

default

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

定义

名称	说明
createdByType	创建资源的标识的类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ProvisioningState	资源的预配状态。 通信服务的默认状态是未知。
SenderUsernameResource	一个表示 SenderUsername 资源的类。
systemData	与创建和上次修改资源相关的元数据。

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info	object	附加信息。
type	string	附加信息类型。

ErrorDetail

对象

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

对象

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

ProvisioningState

枚举

资源的预配状态。 通信服务的默认状态是未知。

值	说明
Unknown
Succeeded
Failed
Canceled
Running
Creating
Updating
Deleting
Moving

SenderUsernameResource

对象

一个表示 SenderUsername 资源的类。

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。 例如，“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	资源的名称
properties.dataLocation	string	发送用户名资源数据静止存储的位置。
properties.displayName	string	senderUsername 的显示名称。
properties.provisioningState	ProvisioningState	资源的预配状态。 通信服务的默认状态是未知。
properties.username	string	发送电子邮件时要使用的发件人 senderUsername。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type	string	资源类型。 例如，“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

systemData

对象

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	资源上次修改的时间戳 （UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。