WebPubSub interface

包:

@azure/arm-webpubsub

表示 WebPubSub 的接口。

方法

beginCreateOrUpdate(string, string, WebPubSubResource, WebPubSubCreateOrUpdateOptionalParams)	创建或更新资源。
beginCreateOrUpdateAndWait(string, string, WebPubSubResource, WebPubSubCreateOrUpdateOptionalParams)	创建或更新资源。
beginDelete(string, string, WebPubSubDeleteOptionalParams)	删除资源的操作。
beginDeleteAndWait(string, string, WebPubSubDeleteOptionalParams)	删除资源的操作。
beginRegenerateKey(string, string, RegenerateKeyParameters, WebPubSubRegenerateKeyOptionalParams)	重新生成资源的访问密钥。 无法同时重新生成 PrimaryKey 和 SecondaryKey。
beginRegenerateKeyAndWait(string, string, RegenerateKeyParameters, WebPubSubRegenerateKeyOptionalParams)	重新生成资源的访问密钥。 无法同时重新生成 PrimaryKey 和 SecondaryKey。
beginRestart(string, string, WebPubSubRestartOptionalParams)	重启资源的操作。
beginRestartAndWait(string, string, WebPubSubRestartOptionalParams)	重启资源的操作。
beginUpdate(string, string, WebPubSubResource, WebPubSubUpdateOptionalParams)	更新退出资源的操作。
beginUpdateAndWait(string, string, WebPubSubResource, WebPubSubUpdateOptionalParams)	更新退出资源的操作。
checkNameAvailability(string, NameAvailabilityParameters, WebPubSubCheckNameAvailabilityOptionalParams)	检查资源名称是否有效且尚未使用。
get(string, string, WebPubSubGetOptionalParams)	获取资源及其属性。
listByResourceGroup(string, WebPubSubListByResourceGroupOptionalParams)	处理列出资源组中的所有资源的请求。
listBySubscription(WebPubSubListBySubscriptionOptionalParams)	处理请求以列出订阅中的所有资源。
listKeys(string, string, WebPubSubListKeysOptionalParams)	获取资源的访问密钥。
listReplicaSkus(string, string, string, WebPubSubListReplicaSkusOptionalParams)	列出副本资源的所有可用 SKU。
listSkus(string, string, WebPubSubListSkusOptionalParams)	列出资源的所有可用 SKU。

方法详细信息

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

创建或更新操作的参数

options

WebPubSubCreateOrUpdateOptionalParams

选项参数。

返回

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

创建或更新操作的参数

options

WebPubSubCreateOrUpdateOptionalParams

选项参数。

返回

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

描述重新生成密钥操作的参数。

options

WebPubSubRegenerateKeyOptionalParams

选项参数。

返回

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

描述重新生成密钥操作的参数。

options

WebPubSubRegenerateKeyOptionalParams

选项参数。

返回

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

提供给操作的参数。

options

WebPubSubCheckNameAvailabilityOptionalParams

选项参数。

返回

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

资源组的名称。 名称不区分大小写。

options

WebPubSubListByResourceGroupOptionalParams

选项参数。

返回

PagedAsyncIterableIterator<WebPubSubResource, WebPubSubResource[], PageSettings>

listBySubscription(WebPubSubListBySubscriptionOptionalParams)

处理请求以列出订阅中的所有资源。

function listBySubscription(options?: WebPubSubListBySubscriptionOptionalParams): PagedAsyncIterableIterator<WebPubSubResource, WebPubSubResource[], PageSettings>

参数

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

副本的名称。

options

WebPubSubListReplicaSkusOptionalParams

选项参数。

返回

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>