WebPubSubReplicas interface
Interface representing a WebPubSubReplicas.
Methods
Method Details
beginCreateOrUpdate(string, string, string, Replica, WebPubSubReplicasCreateOrUpdateOptionalParams)
Create or update a replica.
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, replicaName: string, parameters: Replica, options?: WebPubSubReplicasCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Replica>, Replica>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the resource.
- replicaName
-
string
The name of the replica.
- parameters
- Replica
Parameters for the create or update operation
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Replica>, Replica>>
beginCreateOrUpdateAndWait(string, string, string, Replica, WebPubSubReplicasCreateOrUpdateOptionalParams)
Create or update a replica.
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, replicaName: string, parameters: Replica, options?: WebPubSubReplicasCreateOrUpdateOptionalParams): Promise<Replica>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the resource.
- replicaName
-
string
The name of the replica.
- parameters
- Replica
Parameters for the create or update operation
The options parameters.
Returns
Promise<Replica>
beginRestart(string, string, string, WebPubSubReplicasRestartOptionalParams)
Operation to restart a replica.
function beginRestart(resourceGroupName: string, resourceName: string, replicaName: string, options?: WebPubSubReplicasRestartOptionalParams): Promise<SimplePollerLike<OperationState<WebPubSubReplicasRestartHeaders>, WebPubSubReplicasRestartHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the resource.
- replicaName
-
string
The name of the replica.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<WebPubSubReplicasRestartHeaders>, WebPubSubReplicasRestartHeaders>>
beginRestartAndWait(string, string, string, WebPubSubReplicasRestartOptionalParams)
Operation to restart a replica.
function beginRestartAndWait(resourceGroupName: string, resourceName: string, replicaName: string, options?: WebPubSubReplicasRestartOptionalParams): Promise<WebPubSubReplicasRestartHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the resource.
- replicaName
-
string
The name of the replica.
The options parameters.
Returns
Promise<WebPubSubReplicasRestartHeaders>
beginUpdate(string, string, string, Replica, WebPubSubReplicasUpdateOptionalParams)
Operation to update an exiting replica.
function beginUpdate(resourceGroupName: string, resourceName: string, replicaName: string, parameters: Replica, options?: WebPubSubReplicasUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Replica>, Replica>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the resource.
- replicaName
-
string
The name of the replica.
- parameters
- Replica
Parameters for the update operation
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Replica>, Replica>>
beginUpdateAndWait(string, string, string, Replica, WebPubSubReplicasUpdateOptionalParams)
Operation to update an exiting replica.
function beginUpdateAndWait(resourceGroupName: string, resourceName: string, replicaName: string, parameters: Replica, options?: WebPubSubReplicasUpdateOptionalParams): Promise<Replica>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the resource.
- replicaName
-
string
The name of the replica.
- parameters
- Replica
Parameters for the update operation
The options parameters.
Returns
Promise<Replica>
delete(string, string, string, WebPubSubReplicasDeleteOptionalParams)
Operation to delete a replica.
function delete(resourceGroupName: string, resourceName: string, replicaName: string, options?: WebPubSubReplicasDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the resource.
- replicaName
-
string
The name of the replica.
The options parameters.
Returns
Promise<void>
get(string, string, string, WebPubSubReplicasGetOptionalParams)
Get the replica and its properties.
function get(resourceGroupName: string, resourceName: string, replicaName: string, options?: WebPubSubReplicasGetOptionalParams): Promise<Replica>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the resource.
- replicaName
-
string
The name of the replica.
The options parameters.
Returns
Promise<Replica>
list(string, string, WebPubSubReplicasListOptionalParams)
List all replicas belong to this resource
function list(resourceGroupName: string, resourceName: string, options?: WebPubSubReplicasListOptionalParams): PagedAsyncIterableIterator<Replica, Replica[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the resource.
The options parameters.