PrivateEndpoints interface

Package:

@azure/arm-streamanalytics

Interface representing a PrivateEndpoints.

Methods

beginDelete(string, string, string, PrivateEndpointsDeleteOptionalParams)	Delete the specified private endpoint.
beginDeleteAndWait(string, string, string, PrivateEndpointsDeleteOptionalParams)	Delete the specified private endpoint.
createOrUpdate(string, string, string, PrivateEndpoint, PrivateEndpointsCreateOrUpdateOptionalParams)	Creates a Stream Analytics Private Endpoint or replaces an already existing Private Endpoint.
get(string, string, string, PrivateEndpointsGetOptionalParams)	Gets information about the specified Private Endpoint.
listByCluster(string, string, PrivateEndpointsListByClusterOptionalParams)	Lists the private endpoints in the cluster.

Method Details

beginDelete(string, string, string, PrivateEndpointsDeleteOptionalParams)

Delete the specified private endpoint.

function beginDelete(resourceGroupName: string, clusterName: string, privateEndpointName: string, options?: PrivateEndpointsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the cluster.

privateEndpointName

string

The name of the private endpoint.

options

PrivateEndpointsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, string, PrivateEndpointsDeleteOptionalParams)

Delete the specified private endpoint.

function beginDeleteAndWait(resourceGroupName: string, clusterName: string, privateEndpointName: string, options?: PrivateEndpointsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the cluster.

privateEndpointName

string

The name of the private endpoint.

options

PrivateEndpointsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

createOrUpdate(string, string, string, PrivateEndpoint, PrivateEndpointsCreateOrUpdateOptionalParams)

Creates a Stream Analytics Private Endpoint or replaces an already existing Private Endpoint.

function createOrUpdate(resourceGroupName: string, clusterName: string, privateEndpointName: string, privateEndpoint: PrivateEndpoint, options?: PrivateEndpointsCreateOrUpdateOptionalParams): Promise<PrivateEndpoint>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the cluster.

privateEndpointName

string

The name of the private endpoint.

privateEndpoint

PrivateEndpoint

The definition of the private endpoint that will be used to create a new cluster or replace the existing one.

options

PrivateEndpointsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PrivateEndpoint>

get(string, string, string, PrivateEndpointsGetOptionalParams)

Gets information about the specified Private Endpoint.

function get(resourceGroupName: string, clusterName: string, privateEndpointName: string, options?: PrivateEndpointsGetOptionalParams): Promise<PrivateEndpoint>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the cluster.

privateEndpointName

string

The name of the private endpoint.

options

PrivateEndpointsGetOptionalParams

The options parameters.

Returns

Promise<PrivateEndpoint>

listByCluster(string, string, PrivateEndpointsListByClusterOptionalParams)

Lists the private endpoints in the cluster.

function listByCluster(resourceGroupName: string, clusterName: string, options?: PrivateEndpointsListByClusterOptionalParams): PagedAsyncIterableIterator<PrivateEndpoint, PrivateEndpoint[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the cluster.

options

PrivateEndpointsListByClusterOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PrivateEndpoint, PrivateEndpoint[], PageSettings>