ManagedPrivateEndpoints interface

Package:

@azure/arm-kusto

Interface representing a ManagedPrivateEndpoints.

Methods

beginCreateOrUpdate(string, string, string, ManagedPrivateEndpoint, ManagedPrivateEndpointsCreateOrUpdateOptionalParams)	Creates a managed private endpoint.
beginCreateOrUpdateAndWait(string, string, string, ManagedPrivateEndpoint, ManagedPrivateEndpointsCreateOrUpdateOptionalParams)	Creates a managed private endpoint.
beginDelete(string, string, string, ManagedPrivateEndpointsDeleteOptionalParams)	Deletes a managed private endpoint.
beginDeleteAndWait(string, string, string, ManagedPrivateEndpointsDeleteOptionalParams)	Deletes a managed private endpoint.
beginUpdate(string, string, string, ManagedPrivateEndpoint, ManagedPrivateEndpointsUpdateOptionalParams)	Updates a managed private endpoint.
beginUpdateAndWait(string, string, string, ManagedPrivateEndpoint, ManagedPrivateEndpointsUpdateOptionalParams)	Updates a managed private endpoint.
checkNameAvailability(string, string, ManagedPrivateEndpointsCheckNameRequest, ManagedPrivateEndpointsCheckNameAvailabilityOptionalParams)	Checks that the managed private endpoints resource name is valid and is not already in use.
get(string, string, string, ManagedPrivateEndpointsGetOptionalParams)	Gets a managed private endpoint.
list(string, string, ManagedPrivateEndpointsListOptionalParams)	Returns the list of managed private endpoints.

Method Details

beginCreateOrUpdate(string, string, string, ManagedPrivateEndpoint, ManagedPrivateEndpointsCreateOrUpdateOptionalParams)

Creates a managed private endpoint.

function beginCreateOrUpdate(resourceGroupName: string, clusterName: string, managedPrivateEndpointName: string, parameters: ManagedPrivateEndpoint, options?: ManagedPrivateEndpointsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedPrivateEndpoint>, ManagedPrivateEndpoint>>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

managedPrivateEndpointName

string

The name of the managed private endpoint.

parameters

ManagedPrivateEndpoint

The managed private endpoint parameters.

options

ManagedPrivateEndpointsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ManagedPrivateEndpoint>, ManagedPrivateEndpoint>>

beginCreateOrUpdateAndWait(string, string, string, ManagedPrivateEndpoint, ManagedPrivateEndpointsCreateOrUpdateOptionalParams)

Creates a managed private endpoint.

function beginCreateOrUpdateAndWait(resourceGroupName: string, clusterName: string, managedPrivateEndpointName: string, parameters: ManagedPrivateEndpoint, options?: ManagedPrivateEndpointsCreateOrUpdateOptionalParams): Promise<ManagedPrivateEndpoint>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

managedPrivateEndpointName

string

The name of the managed private endpoint.

parameters

ManagedPrivateEndpoint

The managed private endpoint parameters.

options

ManagedPrivateEndpointsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ManagedPrivateEndpoint>

beginDelete(string, string, string, ManagedPrivateEndpointsDeleteOptionalParams)

Deletes a managed private endpoint.

function beginDelete(resourceGroupName: string, clusterName: string, managedPrivateEndpointName: string, options?: ManagedPrivateEndpointsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

managedPrivateEndpointName

string

The name of the managed private endpoint.

options

ManagedPrivateEndpointsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, ManagedPrivateEndpointsDeleteOptionalParams)

Deletes a managed private endpoint.

function beginDeleteAndWait(resourceGroupName: string, clusterName: string, managedPrivateEndpointName: string, options?: ManagedPrivateEndpointsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

managedPrivateEndpointName

string

The name of the managed private endpoint.

options

ManagedPrivateEndpointsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, ManagedPrivateEndpoint, ManagedPrivateEndpointsUpdateOptionalParams)

Updates a managed private endpoint.

function beginUpdate(resourceGroupName: string, clusterName: string, managedPrivateEndpointName: string, parameters: ManagedPrivateEndpoint, options?: ManagedPrivateEndpointsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedPrivateEndpoint>, ManagedPrivateEndpoint>>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

managedPrivateEndpointName

string

The name of the managed private endpoint.

parameters

ManagedPrivateEndpoint

The managed private endpoint parameters.

options

ManagedPrivateEndpointsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ManagedPrivateEndpoint>, ManagedPrivateEndpoint>>

beginUpdateAndWait(string, string, string, ManagedPrivateEndpoint, ManagedPrivateEndpointsUpdateOptionalParams)

Updates a managed private endpoint.

function beginUpdateAndWait(resourceGroupName: string, clusterName: string, managedPrivateEndpointName: string, parameters: ManagedPrivateEndpoint, options?: ManagedPrivateEndpointsUpdateOptionalParams): Promise<ManagedPrivateEndpoint>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

managedPrivateEndpointName

string

The name of the managed private endpoint.

parameters

ManagedPrivateEndpoint

The managed private endpoint parameters.

options

ManagedPrivateEndpointsUpdateOptionalParams

The options parameters.

Returns

Promise<ManagedPrivateEndpoint>

checkNameAvailability(string, string, ManagedPrivateEndpointsCheckNameRequest, ManagedPrivateEndpointsCheckNameAvailabilityOptionalParams)

Checks that the managed private endpoints resource name is valid and is not already in use.

function checkNameAvailability(resourceGroupName: string, clusterName: string, resourceName: ManagedPrivateEndpointsCheckNameRequest, options?: ManagedPrivateEndpointsCheckNameAvailabilityOptionalParams): Promise<CheckNameResult>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

resourceName

ManagedPrivateEndpointsCheckNameRequest

The name of the resource.

options

ManagedPrivateEndpointsCheckNameAvailabilityOptionalParams

The options parameters.

Returns

Promise<CheckNameResult>

get(string, string, string, ManagedPrivateEndpointsGetOptionalParams)

Gets a managed private endpoint.

function get(resourceGroupName: string, clusterName: string, managedPrivateEndpointName: string, options?: ManagedPrivateEndpointsGetOptionalParams): Promise<ManagedPrivateEndpoint>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

managedPrivateEndpointName

string

The name of the managed private endpoint.

options

ManagedPrivateEndpointsGetOptionalParams

The options parameters.

Returns

Promise<ManagedPrivateEndpoint>

list(string, string, ManagedPrivateEndpointsListOptionalParams)

Returns the list of managed private endpoints.

function list(resourceGroupName: string, clusterName: string, options?: ManagedPrivateEndpointsListOptionalParams): PagedAsyncIterableIterator<ManagedPrivateEndpoint, ManagedPrivateEndpoint[], PageSettings>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

options

ManagedPrivateEndpointsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ManagedPrivateEndpoint, ManagedPrivateEndpoint[], PageSettings>