PrivateEndpointConnections interface

Package:

@azure/arm-iothub

Interface representing a PrivateEndpointConnections.

Methods

beginDelete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)	Delete private endpoint connection with the specified name
beginDeleteAndWait(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)	Delete private endpoint connection with the specified name
beginUpdate(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsUpdateOptionalParams)	Update the status of a private endpoint connection with the specified name
beginUpdateAndWait(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsUpdateOptionalParams)	Update the status of a private endpoint connection with the specified name
get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)	Get private endpoint connection properties
list(string, string, PrivateEndpointConnectionsListOptionalParams)	List private endpoint connection properties

Method Details

beginDelete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Delete private endpoint connection with the specified name

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

Parameters

resourceGroupName

string

The name of the resource group that contains the IoT hub.

resourceName

string

The name of the IoT hub.

privateEndpointConnectionName

string

The name of the private endpoint connection

options

PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

beginDeleteAndWait(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Delete private endpoint connection with the specified name

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

Parameters

resourceGroupName

string

The name of the resource group that contains the IoT hub.

resourceName

string

The name of the IoT hub.

privateEndpointConnectionName

string

The name of the private endpoint connection

options

PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnection>

beginUpdate(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsUpdateOptionalParams)

Update the status of a private endpoint connection with the specified name

function beginUpdate(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

Parameters

resourceGroupName

string

The name of the resource group that contains the IoT hub.

resourceName

string

The name of the IoT hub.

privateEndpointConnectionName

string

The name of the private endpoint connection

privateEndpointConnection

PrivateEndpointConnection

The private endpoint connection with updated properties

options

PrivateEndpointConnectionsUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

beginUpdateAndWait(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsUpdateOptionalParams)

Update the status of a private endpoint connection with the specified name

function beginUpdateAndWait(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsUpdateOptionalParams): Promise<PrivateEndpointConnection>

Parameters

resourceGroupName

string

The name of the resource group that contains the IoT hub.

resourceName

string

The name of the IoT hub.

privateEndpointConnectionName

string

The name of the private endpoint connection

privateEndpointConnection

PrivateEndpointConnection

The private endpoint connection with updated properties

options

PrivateEndpointConnectionsUpdateOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnection>

get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)

Get private endpoint connection properties

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 hub.

resourceName

string

The name of the IoT hub.

privateEndpointConnectionName

string

The name of the private endpoint connection

options

PrivateEndpointConnectionsGetOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnection>

list(string, string, PrivateEndpointConnectionsListOptionalParams)

List private endpoint connection properties

function list(resourceGroupName: string, resourceName: string, options?: PrivateEndpointConnectionsListOptionalParams): Promise<PrivateEndpointConnectionsListResponse>

Parameters

resourceGroupName

string

The name of the resource group that contains the IoT hub.

resourceName

string

The name of the IoT hub.

options

PrivateEndpointConnectionsListOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnectionsListResponse>