PrivateEndpointConnectionsImpl | @azure/arm-eventgrid

Class containing PrivateEndpointConnections operations.

Hierarchy

PrivateEndpointConnectionsImpl

Implements

PrivateEndpointConnections

Index

Constructors

constructor

Methods

Constructors

constructor

new PrivateEndpointConnectionsImpl(client: EventGridManagementClient): PrivateEndpointConnectionsImpl

- Defined in operations/privateEndpointConnections.ts:35
Initialize a new instance of the class PrivateEndpointConnections class.

Parameters
- client: EventGridManagementClient
  
  Reference to the service client
Returns PrivateEndpointConnectionsImpl

Methods

beginDelete

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

Implementation of PrivateEndpointConnections.beginDelete
- Defined in operations/privateEndpointConnections.ts:279
Delete a specific private endpoint connection under a topic, domain, or partner namespace.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- parentType: ParentType
  
  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.
- Optional options: PrivateEndpointConnectionsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

Implementation of PrivateEndpointConnections.beginDeleteAndWait
- Defined in operations/privateEndpointConnections.ts:354
Delete a specific private endpoint connection under a topic, domain, or partner namespace.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- parentType: ParentType
  
  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.
- Optional options: PrivateEndpointConnectionsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

beginUpdate(resourceGroupName: string, parentType: ParentType, parentName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsUpdateOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnectionsUpdateResponse>, PrivateEndpointConnectionsUpdateResponse>>

Implementation of PrivateEndpointConnections.beginUpdate
- Defined in operations/privateEndpointConnections.ts:167
Update a specific private endpoint connection under a topic, domain or partner namespace.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- parentType: ParentType
  
  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.
- Optional options: PrivateEndpointConnectionsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<PrivateEndpointConnectionsUpdateResponse>, PrivateEndpointConnectionsUpdateResponse>>

beginUpdateAndWait

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

Implementation of PrivateEndpointConnections.beginUpdateAndWait
- Defined in operations/privateEndpointConnections.ts:250
Update a specific private endpoint connection under a topic, domain or partner namespace.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- parentType: ParentType
  
  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.
- Optional options: PrivateEndpointConnectionsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PrivateEndpointConnectionsUpdateResponse>

get

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

Implementation of PrivateEndpointConnections.get
- Defined in operations/privateEndpointConnections.ts:137
Get a specific private endpoint connection under a topic, domain, or partner namespace.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- parentType: ParentType
  
  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.
- Optional options: PrivateEndpointConnectionsGetOptionalParams
  
  The options parameters.
Returns Promise<PrivateEndpointConnectionsGetResponse>

listByResource

listByResource(resourceGroupName: string, parentType: ParentType, parentName: string, options?: PrivateEndpointConnectionsListByResourceOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection>

Implementation of PrivateEndpointConnections.listByResource
- Defined in operations/privateEndpointConnections.ts:54
Get all private endpoint connections under a topic, domain, or partner namespace.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- parentType: ParentType
  
  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).
- Optional options: PrivateEndpointConnectionsListByResourceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<PrivateEndpointConnection>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: EventGridManagementClient

Returns PrivateEndpointConnectionsImpl

Methods

beginDelete

Parameters

resourceGroupName: string

parentType: ParentType

parentName: string

privateEndpointConnectionName: string

Optional options: PrivateEndpointConnectionsDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

parentType: ParentType

parentName: string

privateEndpointConnectionName: string

Optional options: PrivateEndpointConnectionsDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

parentType: ParentType

parentName: string

privateEndpointConnectionName: string

privateEndpointConnection: PrivateEndpointConnection

Optional options: PrivateEndpointConnectionsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<PrivateEndpointConnectionsUpdateResponse>, PrivateEndpointConnectionsUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

parentType: ParentType

parentName: string

privateEndpointConnectionName: string

privateEndpointConnection: PrivateEndpointConnection

Optional options: PrivateEndpointConnectionsUpdateOptionalParams

Returns Promise<PrivateEndpointConnectionsUpdateResponse>

get

Parameters

resourceGroupName: string

parentType: ParentType

parentName: string

privateEndpointConnectionName: string

Optional options: PrivateEndpointConnectionsGetOptionalParams

Returns Promise<PrivateEndpointConnectionsGetResponse>

listByResource

Parameters

resourceGroupName: string

parentType: ParentType

parentName: string

Optional options: PrivateEndpointConnectionsListByResourceOptionalParams

Returns PagedAsyncIterableIterator<PrivateEndpointConnection>