Package com.azure.resourcemanager.iotcentral.models

Interface PrivateEndpointConnections

public interface PrivateEndpointConnections

Resource collection API of PrivateEndpointConnections.

Method Summary

Modifier and Type	Method	Description
PrivateEndpointConnection.DefinitionStages.Blank	define(String name)	Begins definition for a new PrivateEndpointConnection resource.
void	delete(String resourceGroupName, String resourceName, String privateEndpointConnectionName)	Deletes a private endpoint connection from the IoT Central Application.
void	delete(String resourceGroupName, String resourceName, String privateEndpointConnectionName, com.azure.core.util.Context context)	Deletes a private endpoint connection from the IoT Central Application.
void	deleteById(String id)	Deletes a private endpoint connection from the IoT Central Application.
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Deletes a private endpoint connection from the IoT Central Application.
PrivateEndpointConnection	get(String resourceGroupName, String resourceName, String privateEndpointConnectionName)	Get the metadata of a private endpoint connection for the IoT Central Application.
PrivateEndpointConnection	getById(String id)	Get the metadata of a private endpoint connection for the IoT Central Application.
com.azure.core.http.rest.Response<PrivateEndpointConnection>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Get the metadata of a private endpoint connection for the IoT Central Application.
com.azure.core.http.rest.Response<PrivateEndpointConnection>	getWithResponse(String resourceGroupName, String resourceName, String privateEndpointConnectionName, com.azure.core.util.Context context)	Get the metadata of a private endpoint connection for the IoT Central Application.
com.azure.core.http.rest.PagedIterable<PrivateEndpointConnection>	list(String resourceGroupName, String resourceName)	Get all private endpoint connections of a IoT Central Application.
com.azure.core.http.rest.PagedIterable<PrivateEndpointConnection>	list(String resourceGroupName, String resourceName, com.azure.core.util.Context context)	Get all private endpoint connections of a IoT Central Application.

Method Detail

get

PrivateEndpointConnection get(String resourceGroupName,
                              String resourceName,
                              String privateEndpointConnectionName)

Get the metadata of a private endpoint connection for the IoT Central Application.

Parameters:

resourceGroupName - The name of the resource group that contains the IoT Central application.

resourceName - The ARM resource name of the IoT Central application.

privateEndpointConnectionName - The private endpoint connection name.

Returns:

the metadata of a private endpoint connection for the IoT Central Application.

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,
                                                                             String resourceName,
                                                                             String privateEndpointConnectionName,
                                                                             com.azure.core.util.Context context)

Get the metadata of a private endpoint connection for the IoT Central Application.

Parameters:

resourceGroupName - The name of the resource group that contains the IoT Central application.

resourceName - The ARM resource name of the IoT Central application.

privateEndpointConnectionName - The private endpoint connection name.

context - The context to associate with this operation.

Returns:

the metadata of a private endpoint connection for the IoT Central Application 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.

delete

void delete(String resourceGroupName,
            String resourceName,
            String privateEndpointConnectionName)

Deletes a private endpoint connection from the IoT Central Application.

Parameters:

resourceGroupName - The name of the resource group that contains the IoT Central application.

resourceName - The ARM resource name of the IoT Central application.

privateEndpointConnectionName - The private endpoint connection name.

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,
            String resourceName,
            String privateEndpointConnectionName,
            com.azure.core.util.Context context)

Deletes a private endpoint connection from the IoT Central Application.

Parameters:

resourceGroupName - The name of the resource group that contains the IoT Central application.

resourceName - The ARM resource name of the IoT Central application.

privateEndpointConnectionName - The private endpoint connection name.

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.

list

com.azure.core.http.rest.PagedIterable<PrivateEndpointConnection> list(String resourceGroupName,
                                                                       String resourceName)

Get all private endpoint connections of a IoT Central Application.

Parameters:

resourceGroupName - The name of the resource group that contains the IoT Central application.

resourceName - The ARM resource name of the IoT Central application.

Returns:

all private endpoint connections of a IoT Central Application as paginated response with PagedIterable.

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.

list

com.azure.core.http.rest.PagedIterable<PrivateEndpointConnection> list(String resourceGroupName,
                                                                       String resourceName,
                                                                       com.azure.core.util.Context context)

Get all private endpoint connections of a IoT Central Application.

Parameters:

resourceGroupName - The name of the resource group that contains the IoT Central application.

resourceName - The ARM resource name of the IoT Central application.

context - The context to associate with this operation.

Returns:

all private endpoint connections of a IoT Central Application as paginated response with PagedIterable.

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.

getById

PrivateEndpointConnection getById(String id)

Get the metadata of a private endpoint connection for the IoT Central Application.

Parameters:

id - the resource ID.

Returns:

the metadata of a private endpoint connection for the IoT Central Application 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.

getByIdWithResponse

com.azure.core.http.rest.Response<PrivateEndpointConnection> getByIdWithResponse(String id,
                                                                                 com.azure.core.util.Context context)

Get the metadata of a private endpoint connection for the IoT Central Application.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the metadata of a private endpoint connection for the IoT Central Application 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.

deleteById

void deleteById(String id)

Deletes a private endpoint connection from the IoT Central Application.

Parameters:

id - the resource ID.

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.

deleteByIdWithResponse

void deleteByIdWithResponse(String id,
                            com.azure.core.util.Context context)

Deletes a private endpoint connection from the IoT Central Application.

Parameters:

id - the resource ID.

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.

define

PrivateEndpointConnection.DefinitionStages.Blank define(String name)

Begins definition for a new PrivateEndpointConnection resource.

Parameters:

name - resource name.

Returns:

the first stage of the new PrivateEndpointConnection definition.