Package com.azure.resourcemanager.digitaltwins.models

Interface DigitalTwinsEndpoints

public interface DigitalTwinsEndpoints

Resource collection API of DigitalTwinsEndpoints.

Method Summary

Modifier and Type	Method	Description
DigitalTwinsEndpointResource.DefinitionStages.Blank	define(String name)	Begins definition for a new DigitalTwinsEndpointResource resource.
DigitalTwinsEndpointResource	delete(String resourceGroupName, String resourceName, String endpointName)	Delete a DigitalTwinsInstance endpoint.
DigitalTwinsEndpointResource	delete(String resourceGroupName, String resourceName, String endpointName, com.azure.core.util.Context context)	Delete a DigitalTwinsInstance endpoint.
DigitalTwinsEndpointResource	deleteById(String id)	Delete a DigitalTwinsInstance endpoint.
DigitalTwinsEndpointResource	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Delete a DigitalTwinsInstance endpoint.
DigitalTwinsEndpointResource	get(String resourceGroupName, String resourceName, String endpointName)	Get DigitalTwinsInstances Endpoint.
DigitalTwinsEndpointResource	getById(String id)	Get DigitalTwinsInstances Endpoint.
com.azure.core.http.rest.Response<DigitalTwinsEndpointResource>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Get DigitalTwinsInstances Endpoint.
com.azure.core.http.rest.Response<DigitalTwinsEndpointResource>	getWithResponse(String resourceGroupName, String resourceName, String endpointName, com.azure.core.util.Context context)	Get DigitalTwinsInstances Endpoint.
com.azure.core.http.rest.PagedIterable<DigitalTwinsEndpointResource>	list(String resourceGroupName, String resourceName)	Get DigitalTwinsInstance Endpoints.
com.azure.core.http.rest.PagedIterable<DigitalTwinsEndpointResource>	list(String resourceGroupName, String resourceName, com.azure.core.util.Context context)	Get DigitalTwinsInstance Endpoints.

Method Detail

list

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

Get DigitalTwinsInstance Endpoints.

Parameters:

resourceGroupName - The name of the resource group that contains the DigitalTwinsInstance.

resourceName - The name of the DigitalTwinsInstance.

Returns:

digitalTwinsInstance Endpoints 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<DigitalTwinsEndpointResource> list(String resourceGroupName,
                                                                          String resourceName,
                                                                          com.azure.core.util.Context context)

Get DigitalTwinsInstance Endpoints.

Parameters:

resourceGroupName - The name of the resource group that contains the DigitalTwinsInstance.

resourceName - The name of the DigitalTwinsInstance.

context - The context to associate with this operation.

Returns:

digitalTwinsInstance Endpoints 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.

get

DigitalTwinsEndpointResource get(String resourceGroupName,
                                 String resourceName,
                                 String endpointName)

Get DigitalTwinsInstances Endpoint.

Parameters:

resourceGroupName - The name of the resource group that contains the DigitalTwinsInstance.

resourceName - The name of the DigitalTwinsInstance.

endpointName - Name of Endpoint Resource.

Returns:

digitalTwinsInstances Endpoint.

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<DigitalTwinsEndpointResource> getWithResponse(String resourceGroupName,
                                                                                String resourceName,
                                                                                String endpointName,
                                                                                com.azure.core.util.Context context)

Get DigitalTwinsInstances Endpoint.

Parameters:

resourceGroupName - The name of the resource group that contains the DigitalTwinsInstance.

resourceName - The name of the DigitalTwinsInstance.

endpointName - Name of Endpoint Resource.

context - The context to associate with this operation.

Returns:

digitalTwinsInstances Endpoint 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

DigitalTwinsEndpointResource delete(String resourceGroupName,
                                    String resourceName,
                                    String endpointName)

Delete a DigitalTwinsInstance endpoint.

Parameters:

resourceGroupName - The name of the resource group that contains the DigitalTwinsInstance.

resourceName - The name of the DigitalTwinsInstance.

endpointName - Name of Endpoint Resource.

Returns:

digitalTwinsInstance endpoint resource.

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

DigitalTwinsEndpointResource delete(String resourceGroupName,
                                    String resourceName,
                                    String endpointName,
                                    com.azure.core.util.Context context)

Delete a DigitalTwinsInstance endpoint.

Parameters:

resourceGroupName - The name of the resource group that contains the DigitalTwinsInstance.

resourceName - The name of the DigitalTwinsInstance.

endpointName - Name of Endpoint Resource.

context - The context to associate with this operation.

Returns:

digitalTwinsInstance endpoint resource.

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

DigitalTwinsEndpointResource getById(String id)

Get DigitalTwinsInstances Endpoint.

Parameters:

id - the resource ID.

Returns:

digitalTwinsInstances Endpoint 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<DigitalTwinsEndpointResource> getByIdWithResponse(String id,
                                                                                    com.azure.core.util.Context context)

Get DigitalTwinsInstances Endpoint.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

digitalTwinsInstances Endpoint 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

DigitalTwinsEndpointResource deleteById(String id)

Delete a DigitalTwinsInstance endpoint.

Parameters:

id - the resource ID.

Returns:

digitalTwinsInstance endpoint resource.

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

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

Delete a DigitalTwinsInstance endpoint.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

digitalTwinsInstance endpoint resource.

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

DigitalTwinsEndpointResource.DefinitionStages.Blank define(String name)

Begins definition for a new DigitalTwinsEndpointResource resource.

Parameters:

name - resource name.

Returns:

the first stage of the new DigitalTwinsEndpointResource definition.