SignalR interface
Interface representing a SignalR.
Methods
Method Details
beginCreateOrUpdate(string, string, SignalRResource, SignalRCreateOrUpdateOptionalParams)
Create or update a resource.
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, parameters: SignalRResource, options?: SignalRCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SignalRResource>, SignalRResource>>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
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<SignalRResource>, SignalRResource>>
beginCreateOrUpdateAndWait(string, string, SignalRResource, SignalRCreateOrUpdateOptionalParams)
Create or update a resource.
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, parameters: SignalRResource, options?: SignalRCreateOrUpdateOptionalParams): Promise<SignalRResource>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
The options parameters.
Returns
Promise<SignalRResource>
beginDelete(string, string, SignalRDeleteOptionalParams)
Operation to delete a resource.
function beginDelete(resourceGroupName: string, resourceName: string, options?: SignalRDeleteOptionalParams): 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
- SignalRDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, SignalRDeleteOptionalParams)
Operation to delete a resource.
function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: SignalRDeleteOptionalParams): 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
- SignalRDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginRegenerateKey(string, string, RegenerateKeyParameters, SignalRRegenerateKeyOptionalParams)
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?: SignalRRegenerateKeyOptionalParams): Promise<SimplePollerLike<OperationState<SignalRKeys>, SignalRKeys>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<SignalRKeys>, SignalRKeys>>
beginRegenerateKeyAndWait(string, string, RegenerateKeyParameters, SignalRRegenerateKeyOptionalParams)
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?: SignalRRegenerateKeyOptionalParams): Promise<SignalRKeys>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.
The options parameters.
Returns
Promise<SignalRKeys>
beginRestart(string, string, SignalRRestartOptionalParams)
Operation to restart a resource.
function beginRestart(resourceGroupName: string, resourceName: string, options?: SignalRRestartOptionalParams): 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
- SignalRRestartOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginRestartAndWait(string, string, SignalRRestartOptionalParams)
Operation to restart a resource.
function beginRestartAndWait(resourceGroupName: string, resourceName: string, options?: SignalRRestartOptionalParams): 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
- SignalRRestartOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, SignalRResource, SignalRUpdateOptionalParams)
Operation to update an exiting resource.
function beginUpdate(resourceGroupName: string, resourceName: string, parameters: SignalRResource, options?: SignalRUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SignalRResource>, SignalRResource>>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
- options
- SignalRUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<SignalRResource>, SignalRResource>>
beginUpdateAndWait(string, string, SignalRResource, SignalRUpdateOptionalParams)
Operation to update an exiting resource.
function beginUpdateAndWait(resourceGroupName: string, resourceName: string, parameters: SignalRResource, options?: SignalRUpdateOptionalParams): Promise<SignalRResource>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
- options
- SignalRUpdateOptionalParams
The options parameters.
Returns
Promise<SignalRResource>
checkNameAvailability(string, NameAvailabilityParameters, SignalRCheckNameAvailabilityOptionalParams)
Checks that the resource name is valid and is not already in use.
function checkNameAvailability(location: string, parameters: NameAvailabilityParameters, options?: SignalRCheckNameAvailabilityOptionalParams): Promise<NameAvailability>Parameters
- location
-
string
the region
- parameters
- NameAvailabilityParameters
Parameters supplied to the operation.
The options parameters.
Returns
Promise<NameAvailability>
get(string, string, SignalRGetOptionalParams)
Get the resource and its properties.
function get(resourceGroupName: string, resourceName: string, options?: SignalRGetOptionalParams): Promise<SignalRResource>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
- SignalRGetOptionalParams
The options parameters.
Returns
Promise<SignalRResource>
listByResourceGroup(string, SignalRListByResourceGroupOptionalParams)
Handles requests to list all resources in a resource group.
function listByResourceGroup(resourceGroupName: string, options?: SignalRListByResourceGroupOptionalParams): PagedAsyncIterableIterator<SignalRResource, SignalRResource[], 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.
The options parameters.
Returns
listBySubscription(SignalRListBySubscriptionOptionalParams)
Handles requests to list all resources in a subscription.
function listBySubscription(options?: SignalRListBySubscriptionOptionalParams): PagedAsyncIterableIterator<SignalRResource, SignalRResource[], PageSettings>Parameters
The options parameters.
Returns
listKeys(string, string, SignalRListKeysOptionalParams)
Get the access keys of the resource.
function listKeys(resourceGroupName: string, resourceName: string, options?: SignalRListKeysOptionalParams): Promise<SignalRKeys>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
- SignalRListKeysOptionalParams
The options parameters.
Returns
Promise<SignalRKeys>
listSkus(string, string, SignalRListSkusOptionalParams)
List all available skus of the resource.
function listSkus(resourceGroupName: string, resourceName: string, options?: SignalRListSkusOptionalParams): 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
- SignalRListSkusOptionalParams
The options parameters.
Returns
Promise<SkuList>