CommunicationServices interface

  • リファレンス
パッケージ:
@azure/arm-communication

CommunicationServices を表すインターフェイス。

メソッド

beginCreateOrUpdate(string, string, CommunicationServiceResource, CommunicationServicesCreateOrUpdateOptionalParams)

新しい CommunicationService を作成するか、既存の CommunicationService を更新します。
beginCreateOrUpdateAndWait(string, string, CommunicationServiceResource, CommunicationServicesCreateOrUpdateOptionalParams)

新しい CommunicationService を作成するか、既存の CommunicationService を更新します。
beginDelete(string, string, CommunicationServicesDeleteOptionalParams)

CommunicationService を削除する操作。
beginDeleteAndWait(string, string, CommunicationServicesDeleteOptionalParams)

CommunicationService を削除する操作。
checkNameAvailability(NameAvailabilityParameters, CommunicationServicesCheckNameAvailabilityOptionalParams)

CommunicationService 名が有効であり、まだ使用されていないことを確認します。
get(string, string, CommunicationServicesGetOptionalParams)

CommunicationService とそのプロパティを取得します。
linkNotificationHub(string, string, CommunicationServicesLinkNotificationHubOptionalParams)

Azure Notification Hub をこの通信サービスにリンクします。
listByResourceGroup(string, CommunicationServicesListByResourceGroupOptionalParams)

リソース グループ内のすべてのリソースを一覧表示する要求を処理します。
listBySubscription(CommunicationServicesListBySubscriptionOptionalParams)

サブスクリプション内のすべてのリソースを一覧表示する要求を処理します。
listKeys(string, string, CommunicationServicesListKeysOptionalParams)

CommunicationService リソースのアクセス キーを取得します。
regenerateKey(string, string, RegenerateKeyParameters, CommunicationServicesRegenerateKeyOptionalParams)

CommunicationService アクセス キーを再生成します。 PrimaryKey と SecondaryKey を同時に再生成することはできません。
update(string, string, CommunicationServiceResourceUpdate, CommunicationServicesUpdateOptionalParams)

既存の CommunicationService を更新する操作。

メソッドの詳細

beginCreateOrUpdate(string, string, CommunicationServiceResource, CommunicationServicesCreateOrUpdateOptionalParams)

新しい CommunicationService を作成するか、既存の CommunicationService を更新します。

function beginCreateOrUpdate(resourceGroupName: string, communicationServiceName: string, parameters: CommunicationServiceResource, options?: CommunicationServicesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<CommunicationServiceResource>, CommunicationServiceResource>>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

communicationServiceName

string

CommunicationService リソースの名前。

parameters
CommunicationServiceResource

作成または更新操作のパラメーター

options
CommunicationServicesCreateOrUpdateOptionalParams

options パラメーター。

戻り値

Promise<@azure/core-lro.SimplePollerLike<OperationState<CommunicationServiceResource>, CommunicationServiceResource>>

beginCreateOrUpdateAndWait(string, string, CommunicationServiceResource, CommunicationServicesCreateOrUpdateOptionalParams)

新しい CommunicationService を作成するか、既存の CommunicationService を更新します。

function beginCreateOrUpdateAndWait(resourceGroupName: string, communicationServiceName: string, parameters: CommunicationServiceResource, options?: CommunicationServicesCreateOrUpdateOptionalParams): Promise<CommunicationServiceResource>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

communicationServiceName

string

CommunicationService リソースの名前。

parameters
CommunicationServiceResource

作成または更新操作のパラメーター

options
CommunicationServicesCreateOrUpdateOptionalParams

options パラメーター。

戻り値

Promise<CommunicationServiceResource>

beginDelete(string, string, CommunicationServicesDeleteOptionalParams)

CommunicationService を削除する操作。

function beginDelete(resourceGroupName: string, communicationServiceName: string, options?: CommunicationServicesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

communicationServiceName

string

CommunicationService リソースの名前。

options
CommunicationServicesDeleteOptionalParams

options パラメーター。

戻り値

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, CommunicationServicesDeleteOptionalParams)

CommunicationService を削除する操作。

function beginDeleteAndWait(resourceGroupName: string, communicationServiceName: string, options?: CommunicationServicesDeleteOptionalParams): Promise<void>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

communicationServiceName

string

CommunicationService リソースの名前。

options
CommunicationServicesDeleteOptionalParams

options パラメーター。

戻り値

Promise<void>

checkNameAvailability(NameAvailabilityParameters, CommunicationServicesCheckNameAvailabilityOptionalParams)

CommunicationService 名が有効であり、まだ使用されていないことを確認します。

function checkNameAvailability(nameAvailabilityParameters: NameAvailabilityParameters, options?: CommunicationServicesCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityResponse>

パラメーター

nameAvailabilityParameters
NameAvailabilityParameters

操作に指定されたパラメーター。

options
CommunicationServicesCheckNameAvailabilityOptionalParams

options パラメーター。

戻り値

Promise<CheckNameAvailabilityResponse>

get(string, string, CommunicationServicesGetOptionalParams)

CommunicationService とそのプロパティを取得します。

function get(resourceGroupName: string, communicationServiceName: string, options?: CommunicationServicesGetOptionalParams): Promise<CommunicationServiceResource>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

communicationServiceName

string

CommunicationService リソースの名前。

options
CommunicationServicesGetOptionalParams

options パラメーター。

戻り値

Promise<CommunicationServiceResource>

linkNotificationHub(string, string, CommunicationServicesLinkNotificationHubOptionalParams)

Azure Notification Hub をこの通信サービスにリンクします。

function linkNotificationHub(resourceGroupName: string, communicationServiceName: string, options?: CommunicationServicesLinkNotificationHubOptionalParams): Promise<LinkedNotificationHub>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

communicationServiceName

string

CommunicationService リソースの名前。

options
CommunicationServicesLinkNotificationHubOptionalParams

options パラメーター。

戻り値

Promise<LinkedNotificationHub>

listByResourceGroup(string, CommunicationServicesListByResourceGroupOptionalParams)

リソース グループ内のすべてのリソースを一覧表示する要求を処理します。

function listByResourceGroup(resourceGroupName: string, options?: CommunicationServicesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<CommunicationServiceResource, CommunicationServiceResource[], PageSettings>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

options
CommunicationServicesListByResourceGroupOptionalParams

options パラメーター。

戻り値

PagedAsyncIterableIterator<CommunicationServiceResource, CommunicationServiceResource[], PageSettings>

listBySubscription(CommunicationServicesListBySubscriptionOptionalParams)

サブスクリプション内のすべてのリソースを一覧表示する要求を処理します。

function listBySubscription(options?: CommunicationServicesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<CommunicationServiceResource, CommunicationServiceResource[], PageSettings>

パラメーター

options
CommunicationServicesListBySubscriptionOptionalParams

options パラメーター。

戻り値

PagedAsyncIterableIterator<CommunicationServiceResource, CommunicationServiceResource[], PageSettings>

listKeys(string, string, CommunicationServicesListKeysOptionalParams)

CommunicationService リソースのアクセス キーを取得します。

function listKeys(resourceGroupName: string, communicationServiceName: string, options?: CommunicationServicesListKeysOptionalParams): Promise<CommunicationServiceKeys>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

communicationServiceName

string

CommunicationService リソースの名前。

options
CommunicationServicesListKeysOptionalParams

options パラメーター。

戻り値

Promise<CommunicationServiceKeys>

regenerateKey(string, string, RegenerateKeyParameters, CommunicationServicesRegenerateKeyOptionalParams)

CommunicationService アクセス キーを再生成します。 PrimaryKey と SecondaryKey を同時に再生成することはできません。

function regenerateKey(resourceGroupName: string, communicationServiceName: string, parameters: RegenerateKeyParameters, options?: CommunicationServicesRegenerateKeyOptionalParams): Promise<CommunicationServiceKeys>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

communicationServiceName

string

CommunicationService リソースの名前。

parameters
RegenerateKeyParameters

キーの再生成操作を記述するパラメーター。

options
CommunicationServicesRegenerateKeyOptionalParams

options パラメーター。

戻り値

Promise<CommunicationServiceKeys>

update(string, string, CommunicationServiceResourceUpdate, CommunicationServicesUpdateOptionalParams)

既存の CommunicationService を更新する操作。

function update(resourceGroupName: string, communicationServiceName: string, parameters: CommunicationServiceResourceUpdate, options?: CommunicationServicesUpdateOptionalParams): Promise<CommunicationServiceResource>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

communicationServiceName

string

CommunicationService リソースの名前。

parameters
CommunicationServiceResourceUpdate

更新操作のパラメーター

options
CommunicationServicesUpdateOptionalParams

options パラメーター。

戻り値

Promise<CommunicationServiceResource>