WebPubSubOperations interface

Package:

@azure/arm-webpubsub

Interface representing a WebPubSub operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginRegenerateKey
beginRegenerateKeyAndWait
beginRestart
beginRestartAndWait
beginUpdate
beginUpdateAndWait
checkNameAvailability	Checks that the resource name is valid and is not already in use.
createOrUpdate	Create or update a resource.
delete	Operation to delete a resource.
get	Get the resource and its properties.
listByResourceGroup	Handles requests to list all resources in a resource group.
listBySubscription	Handles requests to list all resources in a subscription.
listKeys	Get the access keys of the resource.
listReplicaSkus	List all available skus of the replica resource.
listSkus	List all available skus of the resource.
regenerateKey	Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
restart	Operation to restart a resource.
update	Operation to update an exiting resource.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginRegenerateKey

Warning

This API is now deprecated.

use regenerateKey instead

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

Property Value

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

beginRegenerateKeyAndWait

Warning

This API is now deprecated.

use regenerateKey instead

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

Property Value

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

beginRestart

Warning

This API is now deprecated.

use restart instead

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

Property Value

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

beginRestartAndWait

Warning

This API is now deprecated.

use restart instead

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

Property Value

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

beginUpdate

Warning

This API is now deprecated.

use update instead

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

Property Value

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

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

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

Property Value

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

checkNameAvailability

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

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

Property Value

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

createOrUpdate

Create or update a resource.

createOrUpdate: (resourceGroupName: string, resourceName: string, parameters: WebPubSubResource, options?: WebPubSubCreateOrUpdateOptionalParams) => PollerLike<OperationState<WebPubSubResource>, WebPubSubResource>

Property Value

(resourceGroupName: string, resourceName: string, parameters: WebPubSubResource, options?: WebPubSubCreateOrUpdateOptionalParams) => PollerLike<OperationState<WebPubSubResource>, WebPubSubResource>

delete

Operation to delete a resource.

delete: (resourceGroupName: string, resourceName: string, options?: WebPubSubDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, resourceName: string, options?: WebPubSubDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Get the resource and its properties.

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

Property Value

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

listByResourceGroup

Handles requests to list all resources in a resource group.

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

Property Value

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

listBySubscription

Handles requests to list all resources in a subscription.

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

Property Value

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

listKeys

Get the access keys of the resource.

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

Property Value

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

listReplicaSkus

List all available skus of the replica resource.

listReplicaSkus: (resourceGroupName: string, resourceName: string, replicaName: string, options?: WebPubSubListReplicaSkusOptionalParams) => Promise<SkuList>

Property Value

(resourceGroupName: string, resourceName: string, replicaName: string, options?: WebPubSubListReplicaSkusOptionalParams) => Promise<SkuList>

listSkus

List all available skus of the resource.

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

Property Value

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

regenerateKey

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

regenerateKey: (resourceGroupName: string, resourceName: string, parameters: RegenerateKeyParameters, options?: WebPubSubRegenerateKeyOptionalParams) => PollerLike<OperationState<WebPubSubKeys>, WebPubSubKeys>

Property Value

(resourceGroupName: string, resourceName: string, parameters: RegenerateKeyParameters, options?: WebPubSubRegenerateKeyOptionalParams) => PollerLike<OperationState<WebPubSubKeys>, WebPubSubKeys>

restart

Operation to restart a resource.

restart: (resourceGroupName: string, resourceName: string, options?: WebPubSubRestartOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, resourceName: string, options?: WebPubSubRestartOptionalParams) => PollerLike<OperationState<void>, void>

update

Operation to update an exiting resource.

update: (resourceGroupName: string, resourceName: string, parameters: WebPubSubResource, options?: WebPubSubUpdateOptionalParams) => PollerLike<OperationState<WebPubSubResource>, WebPubSubResource>

Property Value

(resourceGroupName: string, resourceName: string, parameters: WebPubSubResource, options?: WebPubSubUpdateOptionalParams) => PollerLike<OperationState<WebPubSubResource>, WebPubSubResource>