Share via

WebPubSubPrivateEndpointConnections interface

  • Reference
Package:
@azure/arm-webpubsub

Interface representing a WebPubSubPrivateEndpointConnections.

Methods

beginDelete(string, string, string, WebPubSubPrivateEndpointConnectionsDeleteOptionalParams)

Delete the specified private endpoint connection
beginDeleteAndWait(string, string, string, WebPubSubPrivateEndpointConnectionsDeleteOptionalParams)

Delete the specified private endpoint connection
get(string, string, string, WebPubSubPrivateEndpointConnectionsGetOptionalParams)

Get the specified private endpoint connection
list(string, string, WebPubSubPrivateEndpointConnectionsListOptionalParams)

List private endpoint connections
update(string, string, string, PrivateEndpointConnection, WebPubSubPrivateEndpointConnectionsUpdateOptionalParams)

Update the state of specified private endpoint connection

Method Details

beginDelete(string, string, string, WebPubSubPrivateEndpointConnectionsDeleteOptionalParams)

Delete the specified private endpoint connection

function beginDelete(privateEndpointConnectionName: string, resourceGroupName: string, resourceName: string, options?: WebPubSubPrivateEndpointConnectionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

privateEndpointConnectionName

string

The name of the private endpoint connection

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
WebPubSubPrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, WebPubSubPrivateEndpointConnectionsDeleteOptionalParams)

Delete the specified private endpoint connection

function beginDeleteAndWait(privateEndpointConnectionName: string, resourceGroupName: string, resourceName: string, options?: WebPubSubPrivateEndpointConnectionsDeleteOptionalParams): Promise<void>

Parameters

privateEndpointConnectionName

string

The name of the private endpoint connection

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
WebPubSubPrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, WebPubSubPrivateEndpointConnectionsGetOptionalParams)

Get the specified private endpoint connection

function get(privateEndpointConnectionName: string, resourceGroupName: string, resourceName: string, options?: WebPubSubPrivateEndpointConnectionsGetOptionalParams): Promise<PrivateEndpointConnection>

Parameters

privateEndpointConnectionName

string

The name of the private endpoint connection

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
WebPubSubPrivateEndpointConnectionsGetOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnection>

list(string, string, WebPubSubPrivateEndpointConnectionsListOptionalParams)

List private endpoint connections

function list(resourceGroupName: string, resourceName: string, options?: WebPubSubPrivateEndpointConnectionsListOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], 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.

resourceName

string

The name of the resource.

options
WebPubSubPrivateEndpointConnectionsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>

update(string, string, string, PrivateEndpointConnection, WebPubSubPrivateEndpointConnectionsUpdateOptionalParams)

Update the state of specified private endpoint connection

function update(privateEndpointConnectionName: string, resourceGroupName: string, resourceName: string, parameters: PrivateEndpointConnection, options?: WebPubSubPrivateEndpointConnectionsUpdateOptionalParams): Promise<PrivateEndpointConnection>

Parameters

privateEndpointConnectionName

string

The name of the private endpoint connection

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
PrivateEndpointConnection

The resource of private endpoint and its properties

options
WebPubSubPrivateEndpointConnectionsUpdateOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnection>