PrivateEndpointConnections interface

Interface representing a PrivateEndpointConnections.

Methods

beginDelete(string, string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Delete a specific private endpoint connection under a topic, domain, or partner namespace or namespace.

beginDeleteAndWait(string, string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Delete a specific private endpoint connection under a topic, domain, or partner namespace or namespace.

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

Update a specific private endpoint connection under a topic, domain or partner namespace.

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

Update a specific private endpoint connection under a topic, domain or partner namespace.

get(string, string, string, string, PrivateEndpointConnectionsGetOptionalParams)

Get a specific private endpoint connection under a topic, domain, or partner namespace or namespace.

listByResource(string, string, string, PrivateEndpointConnectionsListByResourceOptionalParams)

Get all private endpoint connections under a topic, domain, or partner namespace or namespace.

Method Details

beginDelete(string, string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Delete a specific private endpoint connection under a topic, domain, or partner namespace or namespace.

function beginDelete(resourceGroupName: string, parentType: string, parentName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<PrivateEndpointConnectionsDeleteHeaders>, PrivateEndpointConnectionsDeleteHeaders>>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

parentType

string

The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces' or 'namespaces'.

parentName

string

The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name or namespace name).

privateEndpointConnectionName

string

The name of the private endpoint connection connection.

options
PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

beginDeleteAndWait(string, string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Delete a specific private endpoint connection under a topic, domain, or partner namespace or namespace.

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

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

parentType

string

The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces' or 'namespaces'.

parentName

string

The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name or namespace name).

privateEndpointConnectionName

string

The name of the private endpoint connection connection.

options
PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

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

Update a specific private endpoint connection under a topic, domain or partner namespace.

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

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

parentType

string

The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces' or 'namespaces'.

parentName

string

The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name or namespace name).

privateEndpointConnectionName

string

The name of the private endpoint connection connection.

privateEndpointConnection
PrivateEndpointConnection

The private endpoint connection object to update.

options
PrivateEndpointConnectionsUpdateOptionalParams

The options parameters.

Returns

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

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

Update a specific private endpoint connection under a topic, domain or partner namespace.

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

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

parentType

string

The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces' or 'namespaces'.

parentName

string

The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name or namespace name).

privateEndpointConnectionName

string

The name of the private endpoint connection connection.

privateEndpointConnection
PrivateEndpointConnection

The private endpoint connection object to update.

options
PrivateEndpointConnectionsUpdateOptionalParams

The options parameters.

Returns

get(string, string, string, string, PrivateEndpointConnectionsGetOptionalParams)

Get a specific private endpoint connection under a topic, domain, or partner namespace or namespace.

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

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

parentType

string

The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces' or 'namespaces'.

parentName

string

The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name or namespace name).

privateEndpointConnectionName

string

The name of the private endpoint connection connection.

options
PrivateEndpointConnectionsGetOptionalParams

The options parameters.

Returns

listByResource(string, string, string, PrivateEndpointConnectionsListByResourceOptionalParams)

Get all private endpoint connections under a topic, domain, or partner namespace or namespace.

function listByResource(resourceGroupName: string, parentType: string, parentName: string, options?: PrivateEndpointConnectionsListByResourceOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

parentType

string

The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces' or 'namespaces'.

parentName

string

The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name or namespace name).

Returns