PrivateEndpointConnections interface

Package:

@azure/arm-eventgrid

Interface representing a PrivateEndpointConnections.

Methods

beginDelete(string, string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)	Delete a specific private endpoint connection under a topic, domain, or partner namespace.
beginDeleteAndWait(string, string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)	Delete a specific private endpoint connection under a topic, domain, or partner 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.
listByResource(string, string, string, PrivateEndpointConnectionsListByResourceOptionalParams)	Get all private endpoint connections under a topic, domain, or partner namespace.

Method Details

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

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

function beginDelete(resourceGroupName: string, parentType: string, parentName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

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

parentName

string

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

privateEndpointConnectionName

string

The name of the private endpoint connection connection.

options

PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<PollOperationState<void>, void>>

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

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

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

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

parentName

string

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

privateEndpointConnectionName

string

The name of the private endpoint connection connection.

options

PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

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<PollerLike<PollOperationState<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'.

parentName

string

The name of the parent resource (namely, either, the topic name, domain name, or partner 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<PollerLike<PollOperationState<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'.

parentName

string

The name of the parent resource (namely, either, the topic name, domain name, or partner 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<PrivateEndpointConnection>

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

Get a specific private endpoint connection under a topic, domain, or partner 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'.

parentName

string

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

privateEndpointConnectionName

string

The name of the private endpoint connection connection.

options

PrivateEndpointConnectionsGetOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnection>

listByResource(string, string, string, PrivateEndpointConnectionsListByResourceOptionalParams)

Get all private endpoint connections under a topic, domain, or partner 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'.

parentName

string

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

options

PrivateEndpointConnectionsListByResourceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>