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>