WebPubSubImpl | @azure/arm-webpubsub

Class representing a WebPubSub.

Hierarchy

WebPubSubImpl

Implements

WebPubSub

Index

Constructors

constructor

Methods

Constructors

constructor

new WebPubSubImpl(client: WebPubSubManagementClientContext): WebPubSubImpl

- Defined in operations/webPubSub.ts:49
Initialize a new instance of the class WebPubSub class.

Parameters
- client: WebPubSubManagementClientContext
  
  Reference to the service client
Returns WebPubSubImpl

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, resourceName: string, parameters: WebPubSubResource, options?: WebPubSubCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<WebPubSubCreateOrUpdateResponse>, WebPubSubCreateOrUpdateResponse>>

Implementation of WebPubSub.beginCreateOrUpdate
- Defined in operations/webPubSub.ts:227
Create or update a resource.

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
- Optional options: WebPubSubCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<WebPubSubCreateOrUpdateResponse>, WebPubSubCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

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

Implementation of WebPubSub.beginCreateOrUpdateAndWait
- Defined in operations/webPubSub.ts:296
Create or update a resource.

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
- Optional options: WebPubSubCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<WebPubSubCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, resourceName: string, options?: WebPubSubDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of WebPubSub.beginDelete
- Defined in operations/webPubSub.ts:318
Operation to delete a resource.

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.
- Optional options: WebPubSubDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

Implementation of WebPubSub.beginDeleteAndWait
- Defined in operations/webPubSub.ts:380
Operation to delete a resource.

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.
- Optional options: WebPubSubDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginRegenerateKey

beginRegenerateKey(resourceGroupName: string, resourceName: string, parameters: RegenerateKeyParameters, options?: WebPubSubRegenerateKeyOptionalParams): Promise<PollerLike<PollOperationState<WebPubSubRegenerateKeyResponse>, WebPubSubRegenerateKeyResponse>>

Implementation of WebPubSub.beginRegenerateKey
- Defined in operations/webPubSub.ts:512
Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.

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.
- Optional options: WebPubSubRegenerateKeyOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<WebPubSubRegenerateKeyResponse>, WebPubSubRegenerateKeyResponse>>

beginRegenerateKeyAndWait

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

Implementation of WebPubSub.beginRegenerateKeyAndWait
- Defined in operations/webPubSub.ts:583
Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.

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.
- Optional options: WebPubSubRegenerateKeyOptionalParams
  
  The options parameters.
Returns Promise<WebPubSubRegenerateKeyResponse>

beginRestart

beginRestart(resourceGroupName: string, resourceName: string, options?: WebPubSubRestartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of WebPubSub.beginRestart
- Defined in operations/webPubSub.ts:605
Operation to restart a resource.

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.
- Optional options: WebPubSubRestartOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRestartAndWait

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

Implementation of WebPubSub.beginRestartAndWait
- Defined in operations/webPubSub.ts:668
Operation to restart a resource.

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.
- Optional options: WebPubSubRestartOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

beginUpdate(resourceGroupName: string, resourceName: string, parameters: WebPubSubResource, options?: WebPubSubUpdateOptionalParams): Promise<PollerLike<PollOperationState<WebPubSubUpdateResponse>, WebPubSubUpdateResponse>>

Implementation of WebPubSub.beginUpdate
- Defined in operations/webPubSub.ts:401
Operation to update an exiting resource.

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
- Optional options: WebPubSubUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<WebPubSubUpdateResponse>, WebPubSubUpdateResponse>>

beginUpdateAndWait

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

Implementation of WebPubSub.beginUpdateAndWait
- Defined in operations/webPubSub.ts:470
Operation to update an exiting resource.

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
- Optional options: WebPubSubUpdateOptionalParams
  
  The options parameters.
Returns Promise<WebPubSubUpdateResponse>

checkNameAvailability

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

Implementation of WebPubSub.checkNameAvailability
- Defined in operations/webPubSub.ts:161
Checks that the resource name is valid and is not already in use.

Parameters
- location: string
  
  the region
- parameters: NameAvailabilityParameters
  
  Parameters supplied to the operation.
- Optional options: WebPubSubCheckNameAvailabilityOptionalParams
  
  The options parameters.
Returns Promise<WebPubSubCheckNameAvailabilityResponse>

get

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

Implementation of WebPubSub.get
- Defined in operations/webPubSub.ts:208
Get the resource and its properties.

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.
- Optional options: WebPubSubGetOptionalParams
  
  The options parameters.
Returns Promise<WebPubSubGetResponse>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: WebPubSubListByResourceGroupOptionalParams): PagedAsyncIterableIterator<WebPubSubResource>

Implementation of WebPubSub.listByResourceGroup
- Defined in operations/webPubSub.ts:107
Handles requests to list all resources in a resource group.

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.
- Optional options: WebPubSubListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<WebPubSubResource>

listBySubscription

listBySubscription(options?: WebPubSubListBySubscriptionOptionalParams): PagedAsyncIterableIterator<WebPubSubResource>

Implementation of WebPubSub.listBySubscription
- Defined in operations/webPubSub.ts:63
Handles requests to list all resources in a subscription.

Parameters
- Optional options: WebPubSubListBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<WebPubSubResource>

listKeys

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

Implementation of WebPubSub.listKeys
- Defined in operations/webPubSub.ts:492
Get the access keys of the resource.

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.
- Optional options: WebPubSubListKeysOptionalParams
  
  The options parameters.
Returns Promise<WebPubSubListKeysResponse>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: WebPubSubManagementClientContext

Returns WebPubSubImpl

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

resourceName: string

parameters: WebPubSubResource

Optional options: WebPubSubCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<WebPubSubCreateOrUpdateResponse>, WebPubSubCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

resourceName: string

parameters: WebPubSubResource

Optional options: WebPubSubCreateOrUpdateOptionalParams

Returns Promise<WebPubSubCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

resourceName: string

Optional options: WebPubSubDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

resourceName: string

Optional options: WebPubSubDeleteOptionalParams

Returns Promise<void>

beginRegenerateKey

Parameters

resourceGroupName: string

resourceName: string

parameters: RegenerateKeyParameters

Optional options: WebPubSubRegenerateKeyOptionalParams

Returns Promise<PollerLike<PollOperationState<WebPubSubRegenerateKeyResponse>, WebPubSubRegenerateKeyResponse>>

beginRegenerateKeyAndWait

Parameters

resourceGroupName: string

resourceName: string

parameters: RegenerateKeyParameters

Optional options: WebPubSubRegenerateKeyOptionalParams

Returns Promise<WebPubSubRegenerateKeyResponse>

beginRestart

Parameters

resourceGroupName: string

resourceName: string

Optional options: WebPubSubRestartOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRestartAndWait

Parameters

resourceGroupName: string

resourceName: string

Optional options: WebPubSubRestartOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

resourceName: string

parameters: WebPubSubResource

Optional options: WebPubSubUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<WebPubSubUpdateResponse>, WebPubSubUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

resourceName: string

parameters: WebPubSubResource

Optional options: WebPubSubUpdateOptionalParams

Returns Promise<WebPubSubUpdateResponse>

checkNameAvailability

Parameters

location: string