你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

@azure/arm-communication package

接口

CheckNameAvailabilityRequest

检查可用性请求正文。

CheckNameAvailabilityResponse

检查可用性结果。

CommunicationServiceKeys

一个表示 CommunicationService 的访问密钥的类。

CommunicationServiceManagementClientOptionalParams

客户端的可选参数。

CommunicationServiceProperties

一个描述CommunicationService属性的类。

CommunicationServiceResource

一个表示 CommunicationService 资源的类。

CommunicationServiceResourceUpdate

表示 CommunicationService 资源的更新参数的类。

CommunicationServiceUpdateProperties

一个描述可更新 CommunicationService 资源属性的类。

CommunicationServicesCheckNameAvailabilityOptionalParams

可选参数。

CommunicationServicesCreateOrUpdateOptionalParams

可选参数。

CommunicationServicesDeleteOptionalParams

可选参数。

CommunicationServicesGetOptionalParams

可选参数。

CommunicationServicesLinkNotificationHubOptionalParams

可选参数。

CommunicationServicesListByResourceGroupOptionalParams

可选参数。

CommunicationServicesListBySubscriptionOptionalParams

可选参数。

CommunicationServicesListKeysOptionalParams

可选参数。

CommunicationServicesOperations

代表通信服务运营的接口。

CommunicationServicesRegenerateKeyOptionalParams

可选参数。

CommunicationServicesUpdateOptionalParams

可选参数。

DnsRecord

表示 VerificationStatus 记录的类。

DomainProperties

一个描述 Domains 资源属性的类。

DomainPropertiesVerificationRecords

DnsRecord 列表

DomainPropertiesVerificationStates

VerificationStatusRecord 列表

DomainResource

表示域资源的类。

DomainsCancelVerificationOptionalParams

可选参数。

DomainsCreateOrUpdateOptionalParams

可选参数。

DomainsDeleteOptionalParams

可选参数。

DomainsGetOptionalParams

可选参数。

DomainsInitiateVerificationOptionalParams

可选参数。

DomainsListByEmailServiceResourceOptionalParams

可选参数。

DomainsOperations

表示域操作的接口。

DomainsUpdateOptionalParams

可选参数。

EmailServiceProperties

一个描述EmailService属性的类。

EmailServiceResource

表示 EmailService 资源的类。

EmailServiceResourceUpdate

表示 EmailService 资源的更新参数的类。

EmailServicesCreateOrUpdateOptionalParams

可选参数。

EmailServicesDeleteOptionalParams

可选参数。

EmailServicesGetOptionalParams

可选参数。

EmailServicesListByResourceGroupOptionalParams

可选参数。

EmailServicesListBySubscriptionOptionalParams

可选参数。

EmailServicesListVerifiedExchangeOnlineDomainsOptionalParams

可选参数。

EmailServicesOperations

代表电子邮件服务运营的接口。

EmailServicesUpdateOptionalParams

可选参数。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

所有 Azure 资源管理器 API 的常见错误响应,以返回失败作的错误详细信息。

LinkNotificationHubParameters

用于链接到通信服务的 Azure 通知中心的说明

LinkedNotificationHub

已链接到通信服务的通知中心

ManagedServiceIdentity

托管服务标识(系统分配和/或用户分配的标识)

NameAvailabilityParameters

数据 POST 到 nameAvailability作

Operation

从资源提供程序作 API 返回的 REST API作的详细信息

OperationDisplay

作的局部显示信息。

OperationsListOptionalParams

可选参数。

OperationsOperations

表示作作的接口。

PageSettings

byPage 方法的选项

PagedAsyncIterableIterator

允许异步迭代到完成和逐页迭代的接口。

ProxyResource

Azure 资源管理器代理资源的资源模型定义。 它不具有标记和位置

RegenerateKeyParameters

参数描述重新生成访问密钥的请求

Resource

所有 Azure 资源管理器资源的响应中返回的常见字段

RestorePollerOptions
SenderUsernameProperties

一个描述 SenderUsername 资源属性的类。

SenderUsernameResource

一个表示 SenderUsername 资源的类。

SenderUsernamesCreateOrUpdateOptionalParams

可选参数。

SenderUsernamesDeleteOptionalParams

可选参数。

SenderUsernamesGetOptionalParams

可选参数。

SenderUsernamesListByDomainsOptionalParams

可选参数。

SenderUsernamesOperations

表示发件人用户名操作的接口。

SimplePollerLike

可用于轮询长时间运行的操作的简单轮询程序。

SmtpUsernameProperties

一个描述 SmtpUsername 资源属性的类。

SmtpUsernameResource

描述 smtp 用户名资源的对象。

SmtpUsernamesCreateOrUpdateOptionalParams

可选参数。

SmtpUsernamesDeleteOptionalParams

可选参数。

SmtpUsernamesGetOptionalParams

可选参数。

SmtpUsernamesListOptionalParams

可选参数。

SmtpUsernamesOperations

表示 SmtpUsernames 操作的接口。

SuppressionListAddressProperties

一个描述 SuppressionListAddress 资源属性的类。

SuppressionListAddressResource

一个表示 SuppressionList 记录的对象。

SuppressionListAddressesCreateOrUpdateOptionalParams

可选参数。

SuppressionListAddressesDeleteOptionalParams

可选参数。

SuppressionListAddressesGetOptionalParams

可选参数。

SuppressionListAddressesListOptionalParams

可选参数。

SuppressionListAddressesOperations

表示 SuppressionListAddresses 操作的接口。

SuppressionListProperties

一个描述 SuppressionList 资源属性的类。

SuppressionListResource

一个表示 SuppressionList 资源的类。

SuppressionListsCreateOrUpdateOptionalParams

可选参数。

SuppressionListsDeleteOptionalParams

可选参数。

SuppressionListsGetOptionalParams

可选参数。

SuppressionListsListByDomainOptionalParams

可选参数。

SuppressionListsOperations

表示 SuppressionLists 操作的接口。

SystemData

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

TaggedResource

可以接受标记的 ARM 资源

TrackedResource

Azure 资源管理器的资源模型定义跟踪了具有“标记”和“位置”的顶级资源

UpdateDomainProperties

一个描述 Domains 资源可更新属性的类。

UpdateDomainRequestParameters

描述域资源的 PATCH 请求参数的类。

UserAssignedIdentity

用户分配的标识属性

VerificationParameter

验证 API 的输入参数

VerificationStatusRecord

表示 VerificationStatus 记录的类。

类型别名

ActionType

可扩展枚举。 指示操作类型。 “内部”是指仅适用于内部 API 的操作。
KnownActionType 可与 ActionType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

内部:操作适用于仅限内部的 API。

AzureSupportedClouds

云设置为字符串文字类型的支持值

CheckNameAvailabilityReason

名称不可用的可能原因。
KnownCheckNameAvailabilityReason 可与 CheckNameAvailabilityReason 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

无效:名称无效。
AlreadyExists:名称已存在。

CommunicationServicesProvisioningState

资源的预配状态。
KnownCommunicationServicesProvisioningState 可与 CommunicationServicesProvisioningState 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

未知: 未知
成功:成功
失败:失败
取消:取消
跑步:跑步
创建:创建
更新:更新中
删除:删除
搬家:搬家

ContinuablePage

描述结果页的接口。

CreatedByType

创建资源的实体类型。
KnownCreatedByType 可与 CreatedByType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

用户:实体是由用户创建的。
应用程序:实体是由应用程序创建的。
ManagedIdentity:实体是由托管标识创建的。
密钥:实体是由密钥创建的。

DomainManagement

描述如何管理域资源。
KnownDomainManagement 可与 DomainManagement 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

AzureManaged: AzureManaged
CustomerManaged:CustomerManaged
ExchangeOnline中CustomerManaged:ExchangeOnline中CustomerManaged。

DomainsProvisioningState

资源的预配状态。
KnownDomainsProvisioningState 可与 DomainsProvisioningState 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

未知: 未知
成功:成功
失败:失败
取消:取消
跑步:跑步
创建:创建
更新:更新中
删除:删除
搬家:搬家

EmailServicesListVerifiedExchangeOnlineDomainsResponse
EmailServicesProvisioningState

资源的预配状态。
KnownEmailServicesProvisioningState 可与 EmailServicesProvisioningState 互换,此枚举包含服务支持的已知值。

服务支持的已知值

未知: 未知
成功:成功
失败:失败
取消:取消
跑步:跑步
创建:创建
更新:更新中
删除:删除
搬家:搬家

KeyType

要重新生成的 keyType。 必须是“primary”或“secondary”(不区分大小写)。

ManagedServiceIdentityType

托管服务标识的类型(其中允许 SystemAssigned 和 UserAssigned 类型)。
KnownManagedServiceIdentityType 可与 ManagedServiceIdentityType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

:没有托管标识。
SystemAssigned:系统分配的托管标识。
UserAssigned:用户分配的托管标识。
SystemAssigned,UserAssigned:系统和用户分配的托管标识。

Origin

操作的预期执行者;例如在基于资源的访问控制(RBAC)和审核日志的用户体验中。 默认值为“user,system”
KnownOrigin 可与 Origin 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

用户:指示操作是由用户启动的。
系统:指示操作是由系统启动的。
用户,系统:指示操作是由用户或系统启动的。

ProvisioningState

资源的预配状态。 通信服务的默认状态是未知。
KnownProvisioningState 可与 ProvisioningState 互换,此枚举包含服务支持的已知值。

服务支持的已知值

未知: 未知
成功:成功
失败:失败
取消:取消
跑步:跑步
创建:创建
更新:更新中
删除:删除
搬家:搬家

PublicNetworkAccess

允许、禁止或让 Network Security 外围配置控制对受保护资源的公用网络访问。 值是可选的,但如果传入,则必须为 'Enabled'、'Disabled' 或 'SecuredByPerimeter'。
KnownPublicNetworkAccess 可与 PublicNetworkAccess 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

启用:允许公共网络访问资源
禁用:禁止公共网络访问资源
SecuredByPerimeter:网络安全边界配置规则允许或禁止公共网络访问资源。 需要关联的网络安全边界。

UserEngagementTracking

描述用户参与跟踪是启用还是禁用。
KnownUserEngagementTracking 可与 UserEngagementTracking 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

禁用:禁用
已启用:已启用

VerificationStatus

验证作状态。
KnownVerificationStatus 可与 VerificationStatus 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

未开始:未开始
请求验证:请求验证
验证进行中:进行验证进行中
验证失败:验证失败
已验证:已验证
取消请求:取消请求

VerificationType

验证类型。
KnownVerificationType 可与 VerificationType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

领域:领域
防晒:防晒
DKIM:DKIM
DKIM2:DKIM2
DMARC:DMARC

枚举

AzureClouds

一个用来描述Azure云环境的enum。

KnownActionType

可扩展枚举。 指示操作类型。 “内部”是指仅适用于内部 API 的操作。

KnownCheckNameAvailabilityReason

名称不可用的可能原因。

KnownCommunicationServicesProvisioningState

资源的预配状态。

KnownCreatedByType

创建资源的实体类型。

KnownDomainManagement

描述如何管理域资源。

KnownDomainsProvisioningState

资源的预配状态。

KnownEmailServicesProvisioningState

资源的预配状态。

KnownManagedServiceIdentityType

托管服务标识的类型(其中允许 SystemAssigned 和 UserAssigned 类型)。

KnownOrigin

操作的预期执行者;例如在基于资源的访问控制(RBAC)和审核日志的用户体验中。 默认值为“user,system”

KnownProvisioningState

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

KnownPublicNetworkAccess

允许、禁止或让 Network Security 外围配置控制对受保护资源的公用网络访问。 值是可选的,但如果传入,则必须为 'Enabled'、'Disabled' 或 'SecuredByPerimeter'。

KnownUserEngagementTracking

描述用户参与跟踪是启用还是禁用。

KnownVerificationStatus

验证作状态。

KnownVerificationType

验证类型。

KnownVersions

可用的 API 版本。

函数

restorePoller<TResponse, TResult>(CommunicationServiceManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

从另一轮询程序的序列化状态创建轮询器。 如果要在不同的主机上创建轮询器,或者在原始轮询器不在范围内后构造轮询器,这非常有用。

函数详细信息

restorePoller<TResponse, TResult>(CommunicationServiceManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

从另一轮询程序的序列化状态创建轮询器。 如果要在不同的主机上创建轮询器,或者在原始轮询器不在范围内后构造轮询器,这非常有用。

function restorePoller<TResponse, TResult>(client: CommunicationServiceManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

参数

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

返回

PollerLike<OperationState<TResult>, TResult>