WebPubSub interface
WebPubSub を表すインターフェイス。
メソッド
メソッドの詳細
beginCreateOrUpdate(string, string, WebPubSubResource, WebPubSubCreateOrUpdateOptionalParams)
リソースを作成または更新します。
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, parameters: WebPubSubResource, options?: WebPubSubCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WebPubSubResource>, WebPubSubResource>>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceName
-
string
リソースの名前。
- parameters
- WebPubSubResource
作成または更新操作のパラメーター
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<WebPubSubResource>, WebPubSubResource>>
beginCreateOrUpdateAndWait(string, string, WebPubSubResource, WebPubSubCreateOrUpdateOptionalParams)
リソースを作成または更新します。
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, parameters: WebPubSubResource, options?: WebPubSubCreateOrUpdateOptionalParams): Promise<WebPubSubResource>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceName
-
string
リソースの名前。
- parameters
- WebPubSubResource
作成または更新操作のパラメーター
オプション パラメーター。
戻り値
Promise<WebPubSubResource>
beginDelete(string, string, WebPubSubDeleteOptionalParams)
リソースを削除する操作。
function beginDelete(resourceGroupName: string, resourceName: string, options?: WebPubSubDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceName
-
string
リソースの名前。
- options
- WebPubSubDeleteOptionalParams
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, WebPubSubDeleteOptionalParams)
リソースを削除する操作。
function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: WebPubSubDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceName
-
string
リソースの名前。
- options
- WebPubSubDeleteOptionalParams
オプション パラメーター。
戻り値
Promise<void>
beginRegenerateKey(string, string, RegenerateKeyParameters, WebPubSubRegenerateKeyOptionalParams)
リソースのアクセス キーを再生成します。 PrimaryKey と SecondaryKey を同時に再生成することはできません。
function beginRegenerateKey(resourceGroupName: string, resourceName: string, parameters: RegenerateKeyParameters, options?: WebPubSubRegenerateKeyOptionalParams): Promise<SimplePollerLike<OperationState<WebPubSubKeys>, WebPubSubKeys>>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceName
-
string
リソースの名前。
- parameters
- RegenerateKeyParameters
キーの再生成操作を記述するパラメーター。
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<WebPubSubKeys>, WebPubSubKeys>>
beginRegenerateKeyAndWait(string, string, RegenerateKeyParameters, WebPubSubRegenerateKeyOptionalParams)
リソースのアクセス キーを再生成します。 PrimaryKey と SecondaryKey を同時に再生成することはできません。
function beginRegenerateKeyAndWait(resourceGroupName: string, resourceName: string, parameters: RegenerateKeyParameters, options?: WebPubSubRegenerateKeyOptionalParams): Promise<WebPubSubKeys>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceName
-
string
リソースの名前。
- parameters
- RegenerateKeyParameters
キーの再生成操作を記述するパラメーター。
オプション パラメーター。
戻り値
Promise<WebPubSubKeys>
beginRestart(string, string, WebPubSubRestartOptionalParams)
リソースを再起動する操作。
function beginRestart(resourceGroupName: string, resourceName: string, options?: WebPubSubRestartOptionalParams): Promise<SimplePollerLike<OperationState<WebPubSubRestartHeaders>, WebPubSubRestartHeaders>>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceName
-
string
リソースの名前。
- options
- WebPubSubRestartOptionalParams
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<WebPubSubRestartHeaders>, WebPubSubRestartHeaders>>
beginRestartAndWait(string, string, WebPubSubRestartOptionalParams)
リソースを再起動する操作。
function beginRestartAndWait(resourceGroupName: string, resourceName: string, options?: WebPubSubRestartOptionalParams): Promise<WebPubSubRestartHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceName
-
string
リソースの名前。
- options
- WebPubSubRestartOptionalParams
オプション パラメーター。
戻り値
Promise<WebPubSubRestartHeaders>
beginUpdate(string, string, WebPubSubResource, WebPubSubUpdateOptionalParams)
終了しているリソースを更新する操作。
function beginUpdate(resourceGroupName: string, resourceName: string, parameters: WebPubSubResource, options?: WebPubSubUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WebPubSubResource>, WebPubSubResource>>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceName
-
string
リソースの名前。
- parameters
- WebPubSubResource
更新操作のパラメーター
- options
- WebPubSubUpdateOptionalParams
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<WebPubSubResource>, WebPubSubResource>>
beginUpdateAndWait(string, string, WebPubSubResource, WebPubSubUpdateOptionalParams)
終了しているリソースを更新する操作。
function beginUpdateAndWait(resourceGroupName: string, resourceName: string, parameters: WebPubSubResource, options?: WebPubSubUpdateOptionalParams): Promise<WebPubSubResource>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceName
-
string
リソースの名前。
- parameters
- WebPubSubResource
更新操作のパラメーター
- options
- WebPubSubUpdateOptionalParams
オプション パラメーター。
戻り値
Promise<WebPubSubResource>
checkNameAvailability(string, NameAvailabilityParameters, WebPubSubCheckNameAvailabilityOptionalParams)
リソース名が有効であり、まだ使用されていないことを確認します。
function checkNameAvailability(location: string, parameters: NameAvailabilityParameters, options?: WebPubSubCheckNameAvailabilityOptionalParams): Promise<NameAvailability>パラメーター
- location
-
string
リージョン
- parameters
- NameAvailabilityParameters
操作に指定されたパラメーター。
オプション パラメーター。
戻り値
Promise<NameAvailability>
get(string, string, WebPubSubGetOptionalParams)
リソースとそのプロパティを取得します。
function get(resourceGroupName: string, resourceName: string, options?: WebPubSubGetOptionalParams): Promise<WebPubSubResource>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceName
-
string
リソースの名前。
- options
- WebPubSubGetOptionalParams
オプション パラメーター。
戻り値
Promise<WebPubSubResource>
listByResourceGroup(string, WebPubSubListByResourceGroupOptionalParams)
リソース グループ内のすべてのリソースを一覧表示する要求を処理します。
function listByResourceGroup(resourceGroupName: string, options?: WebPubSubListByResourceGroupOptionalParams): PagedAsyncIterableIterator<WebPubSubResource, WebPubSubResource[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
オプション パラメーター。
戻り値
listBySubscription(WebPubSubListBySubscriptionOptionalParams)
サブスクリプション内のすべてのリソースを一覧表示する要求を処理します。
function listBySubscription(options?: WebPubSubListBySubscriptionOptionalParams): PagedAsyncIterableIterator<WebPubSubResource, WebPubSubResource[], PageSettings>パラメーター
オプション パラメーター。
戻り値
listKeys(string, string, WebPubSubListKeysOptionalParams)
リソースのアクセス キーを取得します。
function listKeys(resourceGroupName: string, resourceName: string, options?: WebPubSubListKeysOptionalParams): Promise<WebPubSubKeys>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceName
-
string
リソースの名前。
- options
- WebPubSubListKeysOptionalParams
オプション パラメーター。
戻り値
Promise<WebPubSubKeys>
listReplicaSkus(string, string, string, WebPubSubListReplicaSkusOptionalParams)
レプリカ リソースの使用可能なすべての SKU を一覧表示します。
function listReplicaSkus(resourceGroupName: string, resourceName: string, replicaName: string, options?: WebPubSubListReplicaSkusOptionalParams): Promise<SkuList>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceName
-
string
リソースの名前。
- replicaName
-
string
レプリカの名前。
オプション パラメーター。
戻り値
Promise<SkuList>
listSkus(string, string, WebPubSubListSkusOptionalParams)
リソースの使用可能なすべての SKU を一覧表示します。
function listSkus(resourceGroupName: string, resourceName: string, options?: WebPubSubListSkusOptionalParams): Promise<SkuList>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceName
-
string
リソースの名前。
- options
- WebPubSubListSkusOptionalParams
オプション パラメーター。
戻り値
Promise<SkuList>