Package com.azure.resourcemanager.iothub.models

Interface PrivateEndpointConnections

public interface PrivateEndpointConnections

Resource collection API of PrivateEndpointConnections.

Method Summary

Modifier and Type	Method	Description
PrivateEndpointConnection	delete(String resourceGroupName, String resourceName, String privateEndpointConnectionName)	Delete private endpoint connection with the specified name.
PrivateEndpointConnection	delete(String resourceGroupName, String resourceName, String privateEndpointConnectionName, com.azure.core.util.Context context)	Delete private endpoint connection with the specified name.
PrivateEndpointConnection	get(String resourceGroupName, String resourceName, String privateEndpointConnectionName)	Get private endpoint connection properties.
com.azure.core.http.rest.Response<PrivateEndpointConnection>	getWithResponse(String resourceGroupName, String resourceName, String privateEndpointConnectionName, com.azure.core.util.Context context)	Get private endpoint connection properties.
List<PrivateEndpointConnection>	list(String resourceGroupName, String resourceName)	List private endpoint connection properties.
com.azure.core.http.rest.Response<List<PrivateEndpointConnection>>	listWithResponse(String resourceGroupName, String resourceName, com.azure.core.util.Context context)	List private endpoint connection properties.
PrivateEndpointConnection	update(String resourceGroupName, String resourceName, String privateEndpointConnectionName, PrivateEndpointConnectionInner privateEndpointConnection)	Update the status of a private endpoint connection with the specified name.
PrivateEndpointConnection	update(String resourceGroupName, String resourceName, String privateEndpointConnectionName, PrivateEndpointConnectionInner privateEndpointConnection, com.azure.core.util.Context context)	Update the status of a private endpoint connection with the specified name.

Method Detail

list

List<PrivateEndpointConnection> list(String resourceGroupName,
                                     String resourceName)

List private endpoint connection properties.

Parameters:

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

resourceName - The name of the IoT hub.

Returns:

the list of private endpoint connections for an IotHub.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorDetailsException - thrown if the request is rejected by server.

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

listWithResponse

com.azure.core.http.rest.Response<List<PrivateEndpointConnection>> listWithResponse(String resourceGroupName,
                                                                                    String resourceName,
                                                                                    com.azure.core.util.Context context)

List private endpoint connection properties.

Parameters:

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

resourceName - The name of the IoT hub.

context - The context to associate with this operation.

Returns:

the list of private endpoint connections for an IotHub along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorDetailsException - thrown if the request is rejected by server.

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

get

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

Get private endpoint connection properties.

Parameters:

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

resourceName - The name of the IoT hub.

privateEndpointConnectionName - The name of the private endpoint connection.

Returns:

private endpoint connection properties.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorDetailsException - 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 private endpoint connection properties.

Parameters:

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

resourceName - The name of the IoT hub.

privateEndpointConnectionName - The name of the private endpoint connection.

context - The context to associate with this operation.

Returns:

private endpoint connection properties along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorDetailsException - 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,
                                 String resourceName,
                                 String privateEndpointConnectionName,
                                 PrivateEndpointConnectionInner privateEndpointConnection)

Update the status of a private endpoint connection with the specified name.

Parameters:

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

resourceName - The name of the IoT hub.

privateEndpointConnectionName - The name of the private endpoint connection.

privateEndpointConnection - The private endpoint connection with updated properties.

Returns:

the private endpoint connection of an IotHub.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

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

Update the status of a private endpoint connection with the specified name.

Parameters:

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

resourceName - The name of the IoT hub.

privateEndpointConnectionName - The name of the private endpoint connection.

privateEndpointConnection - The private endpoint connection with updated properties.

context - The context to associate with this operation.

Returns:

the private endpoint connection of an IotHub.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorDetailsException - thrown if the request is rejected by server.

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

delete

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

Delete private endpoint connection with the specified name.

Parameters:

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

resourceName - The name of the IoT hub.

privateEndpointConnectionName - The name of the private endpoint connection.

Returns:

the private endpoint connection of an IotHub.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorDetailsException - thrown if the request is rejected by server.

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

delete

PrivateEndpointConnection delete(String resourceGroupName,
                                 String resourceName,
                                 String privateEndpointConnectionName,
                                 com.azure.core.util.Context context)

Delete private endpoint connection with the specified name.

Parameters:

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

resourceName - The name of the IoT hub.

privateEndpointConnectionName - The name of the private endpoint connection.

context - The context to associate with this operation.

Returns:

the private endpoint connection of an IotHub.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorDetailsException - thrown if the request is rejected by server.

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