PrivateEndpointConnections interface

Package:

@azure/arm-iotcentral

Interface representing a PrivateEndpointConnections.

Methods

beginCreate(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOptionalParams)	Update a private endpoint connection.
beginCreateAndWait(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOptionalParams)	Update a private endpoint connection.
beginDelete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)	Deletes a private endpoint connection from the IoT Central Application.
beginDeleteAndWait(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)	Deletes a private endpoint connection from the IoT Central Application.
get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)	Get the metadata of a private endpoint connection for the IoT Central Application.
list(string, string, PrivateEndpointConnectionsListOptionalParams)	Get all private endpoint connections of a IoT Central Application.

Method Details

beginCreate(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOptionalParams)

Update a private endpoint connection.

function beginCreate(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnectionsCreateResponse>, PrivateEndpointConnectionsCreateResponse>>

Parameters

resourceGroupName

string

The name of the resource group that contains the IoT Central application.

resourceName

string

The ARM resource name of the IoT Central application.

privateEndpointConnectionName

string

The private endpoint connection name.

privateEndpointConnection

PrivateEndpointConnection

The private endpoint connection metadata.

options

PrivateEndpointConnectionsCreateOptionalParams

The options parameters.

Returns

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

beginCreateAndWait(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOptionalParams)

Update a private endpoint connection.

function beginCreateAndWait(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOptionalParams): Promise<PrivateEndpointConnectionsCreateResponse>

Parameters

resourceGroupName

string

The name of the resource group that contains the IoT Central application.

resourceName

string

The ARM resource name of the IoT Central application.

privateEndpointConnectionName

string

The private endpoint connection name.

privateEndpointConnection

PrivateEndpointConnection

The private endpoint connection metadata.

options

PrivateEndpointConnectionsCreateOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnectionsCreateResponse>

beginDelete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Deletes a private endpoint connection from the IoT Central Application.

function beginDelete(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnectionsDeleteHeaders>, PrivateEndpointConnectionsDeleteHeaders>>

Parameters

resourceGroupName

string

The name of the resource group that contains the IoT Central application.

resourceName

string

The ARM resource name of the IoT Central application.

privateEndpointConnectionName

string

The private endpoint connection name.

options

PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Deletes a private endpoint connection from the IoT Central Application.

function beginDeleteAndWait(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<PrivateEndpointConnectionsDeleteHeaders>

Parameters

resourceGroupName

string

The name of the resource group that contains the IoT Central application.

resourceName

string

The ARM resource name of the IoT Central application.

privateEndpointConnectionName

string

The private endpoint connection name.

options

PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnectionsDeleteHeaders>

get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)

Get the metadata of a private endpoint connection for the IoT Central Application.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the IoT Central application.

resourceName

string

The ARM resource name of the IoT Central application.

privateEndpointConnectionName

string

The private endpoint connection name.

options

PrivateEndpointConnectionsGetOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnection>

list(string, string, PrivateEndpointConnectionsListOptionalParams)

Get all private endpoint connections of a IoT Central Application.

function list(resourceGroupName: string, resourceName: string, options?: PrivateEndpointConnectionsListOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group that contains the IoT Central application.

resourceName

string

The ARM resource name of the IoT Central application.

options

PrivateEndpointConnectionsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>