Package version:

Interface SignalR

Interface representing a SignalR.

Hierarchy

SignalR

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginRegenerateKey beginRegenerateKeyAndWait beginRestart beginRestartAndWait beginUpdate beginUpdateAndWait checkNameAvailability get listByResourceGroup listBySubscription listKeys listSkus

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, resourceName: string, parameters: SignalRResource, options?: SignalRCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<SignalRResource>, SignalRResource>>
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: SignalRResource
  
  Parameters for the create or update operation
- Optional options: SignalRCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SignalRResource>, SignalRResource>>
- Defined in operationsInterfaces/signalR.ts:86

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, parameters: SignalRResource, options?: SignalRCreateOrUpdateOptionalParams): Promise<SignalRResource>
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: SignalRResource
  
  Parameters for the create or update operation
- Optional options: SignalRCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SignalRResource>
- Defined in operationsInterfaces/signalR.ts:105

beginDelete

beginDelete(resourceGroupName: string, resourceName: string, options?: SignalRDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
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: SignalRDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/signalR.ts:118

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: SignalRDeleteOptionalParams): Promise<void>
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: SignalRDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/signalR.ts:130

beginRegenerateKey

beginRegenerateKey(resourceGroupName: string, resourceName: string, parameters: RegenerateKeyParameters, options?: SignalRRegenerateKeyOptionalParams): Promise<PollerLike<PollOperationState<SignalRKeys>, SignalRKeys>>
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: SignalRRegenerateKeyOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SignalRKeys>, SignalRKeys>>
- Defined in operationsInterfaces/signalR.ts:186

beginRegenerateKeyAndWait

beginRegenerateKeyAndWait(resourceGroupName: string, resourceName: string, parameters: RegenerateKeyParameters, options?: SignalRRegenerateKeyOptionalParams): Promise<SignalRKeys>
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: SignalRRegenerateKeyOptionalParams
  
  The options parameters.
Returns Promise<SignalRKeys>
- Defined in operationsInterfaces/signalR.ts:206

beginRestart

beginRestart(resourceGroupName: string, resourceName: string, options?: SignalRRestartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
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: SignalRRestartOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/signalR.ts:219

beginRestartAndWait

beginRestartAndWait(resourceGroupName: string, resourceName: string, options?: SignalRRestartOptionalParams): Promise<void>
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: SignalRRestartOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/signalR.ts:231

beginUpdate

beginUpdate(resourceGroupName: string, resourceName: string, parameters: SignalRResource, options?: SignalRUpdateOptionalParams): Promise<PollerLike<PollOperationState<SignalRResource>, SignalRResource>>
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: SignalRResource
  
  Parameters for the update operation
- Optional options: SignalRUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SignalRResource>, SignalRResource>>
- Defined in operationsInterfaces/signalR.ts:143

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, resourceName: string, parameters: SignalRResource, options?: SignalRUpdateOptionalParams): Promise<SignalRResource>
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: SignalRResource
  
  Parameters for the update operation
- Optional options: SignalRUpdateOptionalParams
  
  The options parameters.
Returns Promise<SignalRResource>
- Defined in operationsInterfaces/signalR.ts:159

checkNameAvailability

checkNameAvailability(location: string, parameters: NameAvailabilityParameters, options?: SignalRCheckNameAvailabilityOptionalParams): Promise<NameAvailability>
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: SignalRCheckNameAvailabilityOptionalParams
  
  The options parameters.
Returns Promise<NameAvailability>
- Defined in operationsInterfaces/signalR.ts:61

get

get(resourceGroupName: string, resourceName: string, options?: SignalRGetOptionalParams): Promise<SignalRResource>
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: SignalRGetOptionalParams
  
  The options parameters.
Returns Promise<SignalRResource>
- Defined in operationsInterfaces/signalR.ts:73

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: SignalRListByResourceGroupOptionalParams): PagedAsyncIterableIterator<SignalRResource>
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: SignalRListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SignalRResource>
- Defined in operationsInterfaces/signalR.ts:51

listBySubscription

listBySubscription(options?: SignalRListBySubscriptionOptionalParams): PagedAsyncIterableIterator<SignalRResource>
Handles requests to list all resources in a subscription.
Parameters
- Optional options: SignalRListBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SignalRResource>
- Defined in operationsInterfaces/signalR.ts:42

listKeys

listKeys(resourceGroupName: string, resourceName: string, options?: SignalRListKeysOptionalParams): Promise<SignalRKeys>
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: SignalRListKeysOptionalParams
  
  The options parameters.
Returns Promise<SignalRKeys>
- Defined in operationsInterfaces/signalR.ts:172

listSkus

listSkus(resourceGroupName: string, resourceName: string, options?: SignalRListSkusOptionalParams): Promise<SkuList>
List all available skus 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: SignalRListSkusOptionalParams
  
  The options parameters.
Returns Promise<SkuList>
- Defined in operationsInterfaces/signalR.ts:243

Interface SignalR

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

resourceName: string

parameters: SignalRResource

Optional options: SignalRCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<SignalRResource>, SignalRResource>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

resourceName: string

parameters: SignalRResource

Optional options: SignalRCreateOrUpdateOptionalParams

Returns Promise<SignalRResource>

beginDelete

Parameters

resourceGroupName: string

resourceName: string

Optional options: SignalRDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

resourceName: string

Optional options: SignalRDeleteOptionalParams

Returns Promise<void>

beginRegenerateKey

Parameters

resourceGroupName: string

resourceName: string

parameters: RegenerateKeyParameters

Optional options: SignalRRegenerateKeyOptionalParams

Returns Promise<PollerLike<PollOperationState<SignalRKeys>, SignalRKeys>>

beginRegenerateKeyAndWait

Parameters

resourceGroupName: string

resourceName: string

parameters: RegenerateKeyParameters

Optional options: SignalRRegenerateKeyOptionalParams

Returns Promise<SignalRKeys>

beginRestart

Parameters

resourceGroupName: string

resourceName: string

Optional options: SignalRRestartOptionalParams

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

beginRestartAndWait

Parameters

resourceGroupName: string

resourceName: string

Optional options: SignalRRestartOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

resourceName: string

parameters: SignalRResource

Optional options: SignalRUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<SignalRResource>, SignalRResource>>

beginUpdateAndWait

Parameters

resourceGroupName: string

resourceName: string

parameters: SignalRResource

Optional options: SignalRUpdateOptionalParams

Returns Promise<SignalRResource>

checkNameAvailability

Parameters

location: string

parameters: NameAvailabilityParameters

Optional options: SignalRCheckNameAvailabilityOptionalParams

Returns Promise<NameAvailability>

get

Parameters

resourceGroupName: string

`Optional` options: SignalRCreateOrUpdateOptionalParams

`Optional` options: SignalRCreateOrUpdateOptionalParams

`Optional` options: SignalRDeleteOptionalParams

`Optional` options: SignalRDeleteOptionalParams

`Optional` options: SignalRRegenerateKeyOptionalParams

`Optional` options: SignalRRegenerateKeyOptionalParams

`Optional` options: SignalRRestartOptionalParams

`Optional` options: SignalRRestartOptionalParams

`Optional` options: SignalRUpdateOptionalParams

`Optional` options: SignalRUpdateOptionalParams

`Optional` options: SignalRCheckNameAvailabilityOptionalParams

`Optional` options: SignalRGetOptionalParams

`Optional` options: SignalRListByResourceGroupOptionalParams

`Optional` options: SignalRListBySubscriptionOptionalParams

`Optional` options: SignalRListKeysOptionalParams

`Optional` options: SignalRListSkusOptionalParams