WebPubSub interface

Package:

@azure/arm-webpubsub

Interface representing a WebPubSub.

Methods

beginCreateOrUpdate(string, string, WebPubSubResource, WebPubSubCreateOrUpdateOptionalParams)	Create or update a resource.
beginCreateOrUpdateAndWait(string, string, WebPubSubResource, WebPubSubCreateOrUpdateOptionalParams)	Create or update a resource.
beginDelete(string, string, WebPubSubDeleteOptionalParams)	Operation to delete a resource.
beginDeleteAndWait(string, string, WebPubSubDeleteOptionalParams)	Operation to delete a resource.
beginRegenerateKey(string, string, RegenerateKeyParameters, WebPubSubRegenerateKeyOptionalParams)	Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
beginRegenerateKeyAndWait(string, string, RegenerateKeyParameters, WebPubSubRegenerateKeyOptionalParams)	Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
beginRestart(string, string, WebPubSubRestartOptionalParams)	Operation to restart a resource.
beginRestartAndWait(string, string, WebPubSubRestartOptionalParams)	Operation to restart a resource.
beginUpdate(string, string, WebPubSubResource, WebPubSubUpdateOptionalParams)	Operation to update an exiting resource.
beginUpdateAndWait(string, string, WebPubSubResource, WebPubSubUpdateOptionalParams)	Operation to update an exiting resource.
checkNameAvailability(string, NameAvailabilityParameters, WebPubSubCheckNameAvailabilityOptionalParams)	Checks that the resource name is valid and is not already in use.
get(string, string, WebPubSubGetOptionalParams)	Get the resource and its properties.
listByResourceGroup(string, WebPubSubListByResourceGroupOptionalParams)	Handles requests to list all resources in a resource group.
listBySubscription(WebPubSubListBySubscriptionOptionalParams)	Handles requests to list all resources in a subscription.
listKeys(string, string, WebPubSubListKeysOptionalParams)	Get the access keys of the resource.
listSkus(string, string, WebPubSubListSkusOptionalParams)	List all available skus of the resource.

Method Details

beginCreateOrUpdate(string, string, WebPubSubResource, WebPubSubCreateOrUpdateOptionalParams)

Create or update a resource.

function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, parameters: WebPubSubResource, options?: WebPubSubCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WebPubSubResource>, WebPubSubResource>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

resourceName

string

The name of the resource.

parameters

WebPubSubResource

Parameters for the create or update operation

options

WebPubSubCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<WebPubSubResource>, WebPubSubResource>>

beginCreateOrUpdateAndWait(string, string, WebPubSubResource, WebPubSubCreateOrUpdateOptionalParams)

Create or update a resource.

function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, parameters: WebPubSubResource, options?: WebPubSubCreateOrUpdateOptionalParams): Promise<WebPubSubResource>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

resourceName

string

The name of the resource.

parameters

WebPubSubResource

Parameters for the create or update operation

options

WebPubSubCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<WebPubSubResource>

beginDelete(string, string, WebPubSubDeleteOptionalParams)

Operation to delete a resource.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

resourceName

string

The name of the resource.

options

WebPubSubDeleteOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, WebPubSubDeleteOptionalParams)

Operation to delete a resource.

function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: WebPubSubDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

resourceName

string

The name of the resource.

options

WebPubSubDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginRegenerateKey(string, string, RegenerateKeyParameters, WebPubSubRegenerateKeyOptionalParams)

Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.

function beginRegenerateKey(resourceGroupName: string, resourceName: string, parameters: RegenerateKeyParameters, options?: WebPubSubRegenerateKeyOptionalParams): Promise<SimplePollerLike<OperationState<WebPubSubKeys>, WebPubSubKeys>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

resourceName

string

The name of the resource.

parameters

RegenerateKeyParameters

Parameter that describes the Regenerate Key Operation.

options

WebPubSubRegenerateKeyOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<WebPubSubKeys>, WebPubSubKeys>>

beginRegenerateKeyAndWait(string, string, RegenerateKeyParameters, WebPubSubRegenerateKeyOptionalParams)

Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.

function beginRegenerateKeyAndWait(resourceGroupName: string, resourceName: string, parameters: RegenerateKeyParameters, options?: WebPubSubRegenerateKeyOptionalParams): Promise<WebPubSubKeys>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

resourceName

string

The name of the resource.

parameters

RegenerateKeyParameters

Parameter that describes the Regenerate Key Operation.

options

WebPubSubRegenerateKeyOptionalParams

The options parameters.

Returns

Promise<WebPubSubKeys>

beginRestart(string, string, WebPubSubRestartOptionalParams)

Operation to restart a resource.

function beginRestart(resourceGroupName: string, resourceName: string, options?: WebPubSubRestartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

resourceName

string

The name of the resource.

options

WebPubSubRestartOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginRestartAndWait(string, string, WebPubSubRestartOptionalParams)

Operation to restart a resource.

function beginRestartAndWait(resourceGroupName: string, resourceName: string, options?: WebPubSubRestartOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

resourceName

string

The name of the resource.

options

WebPubSubRestartOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, WebPubSubResource, WebPubSubUpdateOptionalParams)

Operation to update an exiting resource.

function beginUpdate(resourceGroupName: string, resourceName: string, parameters: WebPubSubResource, options?: WebPubSubUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WebPubSubResource>, WebPubSubResource>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

resourceName

string

The name of the resource.

parameters

WebPubSubResource

Parameters for the update operation

options

WebPubSubUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<WebPubSubResource>, WebPubSubResource>>

beginUpdateAndWait(string, string, WebPubSubResource, WebPubSubUpdateOptionalParams)

Operation to update an exiting resource.

function beginUpdateAndWait(resourceGroupName: string, resourceName: string, parameters: WebPubSubResource, options?: WebPubSubUpdateOptionalParams): Promise<WebPubSubResource>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

resourceName

string

The name of the resource.

parameters

WebPubSubResource

Parameters for the update operation

options

WebPubSubUpdateOptionalParams

The options parameters.

Returns

Promise<WebPubSubResource>

checkNameAvailability(string, NameAvailabilityParameters, WebPubSubCheckNameAvailabilityOptionalParams)

Checks that the resource name is valid and is not already in use.

function checkNameAvailability(location: string, parameters: NameAvailabilityParameters, options?: WebPubSubCheckNameAvailabilityOptionalParams): Promise<NameAvailability>

Parameters

location

string

the region

parameters

NameAvailabilityParameters

Parameters supplied to the operation.

options

WebPubSubCheckNameAvailabilityOptionalParams

The options parameters.

Returns

Promise<NameAvailability>

get(string, string, WebPubSubGetOptionalParams)

Get the resource and its properties.

function get(resourceGroupName: string, resourceName: string, options?: WebPubSubGetOptionalParams): Promise<WebPubSubResource>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

resourceName

string

The name of the resource.

options

WebPubSubGetOptionalParams

The options parameters.

Returns

Promise<WebPubSubResource>

listByResourceGroup(string, WebPubSubListByResourceGroupOptionalParams)

Handles requests to list all resources in a resource group.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

options

WebPubSubListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<WebPubSubResource, WebPubSubResource[], PageSettings>

listBySubscription(WebPubSubListBySubscriptionOptionalParams)

Handles requests to list all resources in a subscription.

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

Parameters

options

WebPubSubListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<WebPubSubResource, WebPubSubResource[], PageSettings>

listKeys(string, string, WebPubSubListKeysOptionalParams)

Get the access keys of the resource.

function listKeys(resourceGroupName: string, resourceName: string, options?: WebPubSubListKeysOptionalParams): Promise<WebPubSubKeys>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

resourceName

string

The name of the resource.

options

WebPubSubListKeysOptionalParams

The options parameters.

Returns

Promise<WebPubSubKeys>

listSkus(string, string, WebPubSubListSkusOptionalParams)

List all available skus of the resource.

function listSkus(resourceGroupName: string, resourceName: string, options?: WebPubSubListSkusOptionalParams): Promise<SkuList>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

resourceName

string

The name of the resource.

options

WebPubSubListSkusOptionalParams

The options parameters.

Returns

Promise<SkuList>