@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

ドメインリソースの特性を記述するクラスです。

DomainPropertiesVerificationRecords

DnsRecord の一覧

DomainPropertiesVerificationStates

VerificationStatusRecord の一覧

DomainResource

Domains リソースを表すクラス。

DomainsCancelVerificationOptionalParams

省略可能なパラメーター。

DomainsCreateOrUpdateOptionalParams

省略可能なパラメーター。

DomainsDeleteOptionalParams

省略可能なパラメーター。

DomainsGetOptionalParams

省略可能なパラメーター。

DomainsInitiateVerificationOptionalParams

省略可能なパラメーター。

DomainsListByEmailServiceResourceOptionalParams

省略可能なパラメーター。

DomainsOperations

ドメイン操作を表すインターフェース。

DomainsUpdateOptionalParams

省略可能なパラメーター。

EmailServiceProperties

EmailServiceのプロパティを記述するクラスです。

EmailServiceResource

EmailService リソースを表すクラス。

EmailServiceResourceUpdate

EmailService リソースの更新パラメーターを表すクラス。

EmailServicesCreateOrUpdateOptionalParams

省略可能なパラメーター。

EmailServicesDeleteOptionalParams

省略可能なパラメーター。

EmailServicesGetOptionalParams

省略可能なパラメーター。

EmailServicesListByResourceGroupOptionalParams

省略可能なパラメーター。

EmailServicesListBySubscriptionOptionalParams

省略可能なパラメーター。

EmailServicesListVerifiedExchangeOnlineDomainsOptionalParams

省略可能なパラメーター。

EmailServicesOperations

EmailServicesの運用を表すインターフェース。

EmailServicesUpdateOptionalParams

省略可能なパラメーター。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

ErrorDetail

エラーの詳細。

ErrorResponse

失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。

LinkNotificationHubParameters

通信サービスにリンクする Azure Notification Hub の説明

LinkedNotificationHub

通信サービスにリンクされている通知ハブ

ManagedServiceIdentity

マネージド サービス ID (システム割り当て ID またはユーザー割り当て ID)

NameAvailabilityParameters

nameAvailability アクションへのデータ POST

Operation

リソース プロバイダー操作 API から返される REST API 操作の詳細

OperationDisplay

作戦のためのローカライズされた表示情報。

OperationsListOptionalParams

省略可能なパラメーター。

OperationsOperations

オペレーション操作を表すインターフェイス。

PageSettings

byPage メソッドのオプション

PagedAsyncIterableIterator

完了とページごとの非同期反復を可能にするインターフェイス。

ProxyResource

Azure Resource Manager プロキシ リソースのリソース モデル定義。 タグと場所はありません

RegenerateKeyParameters

パラメーターは、アクセス キーを再生成する要求を記述します

Resource

すべての Azure Resource Manager リソースの応答で返される共通フィールド

RestorePollerOptions
SenderUsernameProperties

SenderUsernameリソースのプロパティを記述するクラスです。

SenderUsernameResource

SenderUsername リソースを表すクラス。

SenderUsernamesCreateOrUpdateOptionalParams

省略可能なパラメーター。

SenderUsernamesDeleteOptionalParams

省略可能なパラメーター。

SenderUsernamesGetOptionalParams

省略可能なパラメーター。

SenderUsernamesListByDomainsOptionalParams

省略可能なパラメーター。

SenderUsernamesOperations

SenderUsernames操作を表すインターフェースです。

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 Resource Manager のリソース モデル定義は、"タグ" と "場所" を持つ最上位リソースを追跡しました

UpdateDomainProperties

ドメインリソースの更新可能なプロパティを記述するクラスです。

UpdateDomainRequestParameters

Domains リソースの PATCH 要求パラメーターを記述するクラス。

UserAssignedIdentity

ユーザー割り当て ID プロパティ

VerificationParameter

検証 API の入力パラメーター

VerificationStatusRecord

VerificationStatus レコードを表すクラス。

型エイリアス

ActionType

拡張可能な列挙型。 アクションの種類を示します。 "内部" とは、内部のみの API に対するアクションを指します。
KnownActionType ActionType と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

内部: アクションは内部専用 API 用です。

AzureSupportedClouds

文字列リテラル型としてのクラウド設定でサポートされている値

CheckNameAvailabilityReason

名前が使用できない原因として考えられます。
KnownCheckNameAvailabilityReason CheckNameAvailabilityReason と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

無効な: 名前が無効です。
AlreadyExists: 名前は既に存在します。

CommunicationServicesProvisioningState

リソースのプロビジョニング状態。
KnownCommunicationServicesProvisioningState CommunicationServicesProvisioningState と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

不明な: 不明
成功:成功
失敗: 失敗
キャンセル:キャンセル
ランニング:ランニング
作成:作成
更新:更新中
削除: 削除
引っ越し:引っ越し

ContinuablePage

結果のページを記述するインターフェイス。

CreatedByType

リソースを作成したエンティティの種類。
KnownCreatedByType を CreatedByType と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

ユーザー: エンティティはユーザーによって作成されました。
アプリケーション: エンティティはアプリケーションによって作成されました。
ManagedIdentity: エンティティはマネージド ID によって作成されました。
キー: エンティティはキーによって作成されました。

DomainManagement

ドメイン リソースの管理方法について説明します。
KnownDomainManagement を DomainManagement と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

AzureManaged: AzureManaged
CustomerManaged: CustomerManaged
ExchangeOnlineでCustomerManaged:ExchangeOnlineでCustomerManaged。

DomainsProvisioningState

リソースのプロビジョニング状態。
KnownDomainsProvisioningState DomainsProvisioningState と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

不明な: 不明
成功:成功
失敗: 失敗
キャンセル:キャンセル
ランニング:ランニング
作成:作成
更新:更新中
削除: 削除
引っ越し:引っ越し

EmailServicesListVerifiedExchangeOnlineDomainsResponse
EmailServicesProvisioningState

リソースのプロビジョニング状態。
KnownEmailServicesProvisioningState EmailServicesProvisioningState と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

不明な: 不明
成功:成功
失敗: 失敗
キャンセル:キャンセル
ランニング:ランニング
作成:作成
更新:更新中
削除: 削除
引っ越し:引っ越し

KeyType

再生成する keyType。 'primary' または 'secondary' (大文字と小文字は区別されません) である必要があります。

ManagedServiceIdentityType

マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。
KnownManagedServiceIdentityType ManagedServiceIdentityType と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

なし: マネージド ID はありません。
SystemAssigned: システム割り当てマネージド ID。
UserAssigned: ユーザーが割り当てたマネージド ID。
SystemAssigned,UserAssigned: システムとユーザーが割り当てたマネージド ID。

Origin

操作の目的の実行プログラム。リソース ベースのアクセス制御 (RBAC) と監査ログ UX と同様です。 既定値は "user,system" です
KnownOrigin を Origin と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

ユーザー: 操作がユーザーによって開始されたことを示します。
システム: 操作がシステムによって開始されたことを示します。
ユーザー、システム: 操作がユーザーまたはシステムによって開始されたことを示します。

ProvisioningState

リソースのプロビジョニング状態。 通信サービスのデフォルト状態は不明です。
KnownProvisioningState ProvisioningState と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

不明な: 不明
成功:成功
失敗: 失敗
キャンセル:キャンセル
ランニング:ランニング
作成:作成
更新:更新中
削除: 削除
引っ越し:引っ越し

PublicNetworkAccess

ネットワーク セキュリティ境界構成で、保護されたリソースへのパブリック ネットワーク アクセスを許可、禁止、または制御します。 値はオプションですが、渡す場合は 'Enabled'、'Disabled'、または 'SecuredByPerimeter' である必要があります。
KnownPublicNetworkAccess PublicNetworkAccess と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

有効:リソースへの公共ネットワークアクセスを許可します
無効化:リソースへのパブリックネットワークアクセスを禁止します
SecuredByPerimeter:ネットワークセキュリティペリメーターの設定ルールは、リソースへのパブリックネットワークアクセスを許可または禁止します。 関連するネットワークセキュリティ境界が必要です。

UserEngagementTracking

ユーザー エンゲージメント追跡が有効か無効かを説明します。
KnownUserEngagementTracking UserEngagementTracking と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

無効:無効化
有効: 有効

VerificationStatus

検証操作の状態。
KnownVerificationStatus VerificationStatus と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

ノットスタート:ノットスタート
検証要求:確認要求
進行中の検証:進行中の検証
検証失敗:検証失敗
確認済み:確認済み
キャンセルリクエスト:キャンセルリクエスト

VerificationType

検証の種類。
KnownVerificationType VerificationType と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

ドメイン:ドメイン
SPF:SPF
DKIM:DKIM
DKIM2:DKIM2
DMARC:DMARC

列挙型

AzureClouds

Azure Cloud 環境を説明するための列挙式です。

KnownActionType

拡張可能な列挙型。 アクションの種類を示します。 "内部" とは、内部のみの API に対するアクションを指します。

KnownCheckNameAvailabilityReason

名前が使用できない原因として考えられます。

KnownCommunicationServicesProvisioningState

リソースのプロビジョニング状態。

KnownCreatedByType

リソースを作成したエンティティの種類。

KnownDomainManagement

ドメイン リソースの管理方法について説明します。

KnownDomainsProvisioningState

リソースのプロビジョニング状態。

KnownEmailServicesProvisioningState

リソースのプロビジョニング状態。

KnownManagedServiceIdentityType

マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。

KnownOrigin

操作の目的の実行プログラム。リソース ベースのアクセス制御 (RBAC) と監査ログ UX と同様です。 既定値は "user,system" です

KnownProvisioningState

リソースのプロビジョニング状態。 通信サービスのデフォルト状態は不明です。

KnownPublicNetworkAccess

ネットワーク セキュリティ境界構成で、保護されたリソースへのパブリック ネットワーク アクセスを許可、禁止、または制御します。 値はオプションですが、渡す場合は '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>