PrivateEndpointConnections interface

Package:

@azure/arm-digitaltwins

Interface representing a PrivateEndpointConnections.

Methods

beginCreateOrUpdate(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOrUpdateOptionalParams)	Update the status of a private endpoint connection with the given name.
beginCreateOrUpdateAndWait(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOrUpdateOptionalParams)	Update the status of a private endpoint connection with the given name.
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.
get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)	Get private endpoint connection properties for the given private endpoint.
list(string, string, PrivateEndpointConnectionsListOptionalParams)	List private endpoint connection properties.

Method Details

beginCreateOrUpdate(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOrUpdateOptionalParams)

Update the status of a private endpoint connection with the given name.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the DigitalTwinsInstance.

resourceName

string

The name of the DigitalTwinsInstance.

privateEndpointConnectionName

string

The name of the private endpoint connection.

privateEndpointConnection

PrivateEndpointConnection

The private endpoint connection with updated properties.

options

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOrUpdateOptionalParams)

Update the status of a private endpoint connection with the given name.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the DigitalTwinsInstance.

resourceName

string

The name of the DigitalTwinsInstance.

privateEndpointConnectionName

string

The name of the private endpoint connection.

privateEndpointConnection

PrivateEndpointConnection

The private endpoint connection with updated properties.

options

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnection>

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<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group that contains the DigitalTwinsInstance.

resourceName

string

The name of the DigitalTwinsInstance.

privateEndpointConnectionName

string

The name of the private endpoint connection.

options

PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Delete private endpoint connection with the specified name.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the DigitalTwinsInstance.

resourceName

string

The name of the DigitalTwinsInstance.

privateEndpointConnectionName

string

The name of the private endpoint connection.

options

PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)

Get private endpoint connection properties for the given private endpoint.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the DigitalTwinsInstance.

resourceName

string

The name of the DigitalTwinsInstance.

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<PrivateEndpointConnectionsResponse>

Parameters

resourceGroupName

string

The name of the resource group that contains the DigitalTwinsInstance.

resourceName

string

The name of the DigitalTwinsInstance.

options

PrivateEndpointConnectionsListOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnectionsResponse>