Package com.azure.resourcemanager.eventgrid.models

Interface PrivateEndpointConnections

public interface PrivateEndpointConnections

Resource collection API of PrivateEndpointConnections.

Method Summary

Modifier and Type	Method	Description
void	delete(String resourceGroupName, PrivateEndpointConnectionsParentType parentType, String parentName, String privateEndpointConnectionName)	Delete a specific private endpoint connection under a topic or domain.
void	delete(String resourceGroupName, PrivateEndpointConnectionsParentType parentType, String parentName, String privateEndpointConnectionName, com.azure.core.util.Context context)	Delete a specific private endpoint connection under a topic or domain.
PrivateEndpointConnection	get(String resourceGroupName, PrivateEndpointConnectionsParentType parentType, String parentName, String privateEndpointConnectionName)	Get a specific private endpoint connection under a topic or domain.
com.azure.core.http.rest.Response<PrivateEndpointConnection>	getWithResponse(String resourceGroupName, PrivateEndpointConnectionsParentType parentType, String parentName, String privateEndpointConnectionName, com.azure.core.util.Context context)	Get a specific private endpoint connection under a topic or domain.
com.azure.core.http.rest.PagedIterable<PrivateEndpointConnection>	listByResource(String resourceGroupName, PrivateEndpointConnectionsParentType parentType, String parentName)	Get all private endpoint connections under a topic or domain.
com.azure.core.http.rest.PagedIterable<PrivateEndpointConnection>	listByResource(String resourceGroupName, PrivateEndpointConnectionsParentType parentType, String parentName, String filter, Integer top, com.azure.core.util.Context context)	Get all private endpoint connections under a topic or domain.
PrivateEndpointConnection	update(String resourceGroupName, PrivateEndpointConnectionsParentType parentType, String parentName, String privateEndpointConnectionName, PrivateEndpointConnectionInner privateEndpointConnection)	Update a specific private endpoint connection under a topic or domain.
PrivateEndpointConnection	update(String resourceGroupName, PrivateEndpointConnectionsParentType parentType, String parentName, String privateEndpointConnectionName, PrivateEndpointConnectionInner privateEndpointConnection, com.azure.core.util.Context context)	Update a specific private endpoint connection under a topic or domain.

Method Detail

get

PrivateEndpointConnection get(String resourceGroupName,
                              PrivateEndpointConnectionsParentType parentType,
                              String parentName,
                              String privateEndpointConnectionName)

Get a specific private endpoint connection under a topic or domain.

Parameters:

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

parentType - The type of the parent resource. This can be either \'topics\' or \'domains\'.

parentName - The name of the parent resource (namely, either, the topic name or domain name).

privateEndpointConnectionName - The name of the private endpoint connection connection.

Returns:

a specific private endpoint connection under a topic or domain.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getWithResponse

com.azure.core.http.rest.Response<PrivateEndpointConnection> getWithResponse(String resourceGroupName,
                                                                             PrivateEndpointConnectionsParentType parentType,
                                                                             String parentName,
                                                                             String privateEndpointConnectionName,
                                                                             com.azure.core.util.Context context)

Get a specific private endpoint connection under a topic or domain.

Parameters:

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

parentType - The type of the parent resource. This can be either \'topics\' or \'domains\'.

parentName - The name of the parent resource (namely, either, the topic name or domain name).

privateEndpointConnectionName - The name of the private endpoint connection connection.

context - The context to associate with this operation.

Returns:

a specific private endpoint connection under a topic or domain along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

update

PrivateEndpointConnection update(String resourceGroupName,
                                 PrivateEndpointConnectionsParentType parentType,
                                 String parentName,
                                 String privateEndpointConnectionName,
                                 PrivateEndpointConnectionInner privateEndpointConnection)

Update a specific private endpoint connection under a topic or domain.

Parameters:

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

parentType - The type of the parent resource. This can be either \'topics\' or \'domains\'.

parentName - The name of the parent resource (namely, either, the topic name or domain name).

privateEndpointConnectionName - The name of the private endpoint connection connection.

privateEndpointConnection - The private endpoint connection object to update.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

update

PrivateEndpointConnection update(String resourceGroupName,
                                 PrivateEndpointConnectionsParentType parentType,
                                 String parentName,
                                 String privateEndpointConnectionName,
                                 PrivateEndpointConnectionInner privateEndpointConnection,
                                 com.azure.core.util.Context context)

Update a specific private endpoint connection under a topic or domain.

Parameters:

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

parentType - The type of the parent resource. This can be either \'topics\' or \'domains\'.

parentName - The name of the parent resource (namely, either, the topic name or domain name).

privateEndpointConnectionName - The name of the private endpoint connection connection.

privateEndpointConnection - The private endpoint connection object to update.

context - The context to associate with this operation.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            PrivateEndpointConnectionsParentType parentType,
            String parentName,
            String privateEndpointConnectionName)

Delete a specific private endpoint connection under a topic or domain.

Parameters:

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

parentType - The type of the parent resource. This can be either \'topics\' or \'domains\'.

parentName - The name of the parent resource (namely, either, the topic name or domain name).

privateEndpointConnectionName - The name of the private endpoint connection connection.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            PrivateEndpointConnectionsParentType parentType,
            String parentName,
            String privateEndpointConnectionName,
            com.azure.core.util.Context context)

Delete a specific private endpoint connection under a topic or domain.

Parameters:

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

parentType - The type of the parent resource. This can be either \'topics\' or \'domains\'.

parentName - The name of the parent resource (namely, either, the topic name or domain name).

privateEndpointConnectionName - The name of the private endpoint connection connection.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByResource

com.azure.core.http.rest.PagedIterable<PrivateEndpointConnection> listByResource(String resourceGroupName,
                                                                                 PrivateEndpointConnectionsParentType parentType,
                                                                                 String parentName)

Get all private endpoint connections under a topic or domain.

Parameters:

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

parentType - The type of the parent resource. This can be either \'topics\' or \'domains\'.

parentName - The name of the parent resource (namely, either, the topic name or domain name).

Returns:

all private endpoint connections under a topic or domain.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByResource

com.azure.core.http.rest.PagedIterable<PrivateEndpointConnection> listByResource(String resourceGroupName,
                                                                                 PrivateEndpointConnectionsParentType parentType,
                                                                                 String parentName,
                                                                                 String filter,
                                                                                 Integer top,
                                                                                 com.azure.core.util.Context context)

Get all private endpoint connections under a topic or domain.

Parameters:

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

parentType - The type of the parent resource. This can be either \'topics\' or \'domains\'.

parentName - The name of the parent resource (namely, either, the topic name or domain name).

filter - The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.

top - The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.

context - The context to associate with this operation.

Returns:

all private endpoint connections under a topic or domain.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.