Package com.azure.resourcemanager.digitaltwins.models

Interface DigitalTwins

public interface DigitalTwins
Resource collection API of DigitalTwins.

  • Method Details

    • getByResourceGroup

      DigitalTwinsDescription getByResourceGroup(String resourceGroupName, String resourceName)
      Get DigitalTwinsInstances resource.
      Parameters:
      resourceGroupName - The name of the resource group that contains the DigitalTwinsInstance.
      resourceName - The name of the DigitalTwinsInstance.
      Returns:
      digitalTwinsInstances 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.

    • getByResourceGroupWithResponse

      com.azure.core.http.rest.Response<DigitalTwinsDescription> getByResourceGroupWithResponse(String resourceGroupName, String resourceName, com.azure.core.util.Context context)
      Get DigitalTwinsInstances resource.
      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:
      digitalTwinsInstances resource 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.

    • deleteByResourceGroup

      DigitalTwinsDescription deleteByResourceGroup(String resourceGroupName, String resourceName)
      Delete a DigitalTwinsInstance.
      Parameters:
      resourceGroupName - The name of the resource group that contains the DigitalTwinsInstance.
      resourceName - The name of the DigitalTwinsInstance.
      Returns:
      the description of the DigitalTwins service.
      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

      DigitalTwinsDescription delete(String resourceGroupName, String resourceName, com.azure.core.util.Context context)
      Delete a DigitalTwinsInstance.
      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:
      the description of the DigitalTwins service.
      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<DigitalTwinsDescription> list()
      Get all the DigitalTwinsInstances in a subscription.
      Returns:
      all the DigitalTwinsInstances in a subscription as paginated response with PagedIterable.
      Throws:
      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<DigitalTwinsDescription> list(com.azure.core.util.Context context)
      Get all the DigitalTwinsInstances in a subscription.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      all the DigitalTwinsInstances in a subscription 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.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<DigitalTwinsDescription> listByResourceGroup(String resourceGroupName)
      Get all the DigitalTwinsInstances in a resource group.
      Parameters:
      resourceGroupName - The name of the resource group that contains the DigitalTwinsInstance.
      Returns:
      all the DigitalTwinsInstances in a resource group 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.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<DigitalTwinsDescription> listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)
      Get all the DigitalTwinsInstances in a resource group.
      Parameters:
      resourceGroupName - The name of the resource group that contains the DigitalTwinsInstance.
      context - The context to associate with this operation.
      Returns:
      all the DigitalTwinsInstances in a resource group 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.

    • checkNameAvailability

      CheckNameResult checkNameAvailability(String location, CheckNameRequest digitalTwinsInstanceCheckName)
      Check if a DigitalTwinsInstance name is available.
      Parameters:
      location - Location of DigitalTwinsInstance.
      digitalTwinsInstanceCheckName - Set the name parameter in the DigitalTwinsInstanceCheckName structure to the name of the DigitalTwinsInstance to check.
      Returns:
      the result returned from a check name availability request.
      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.

    • checkNameAvailabilityWithResponse

      com.azure.core.http.rest.Response<CheckNameResult> checkNameAvailabilityWithResponse(String location, CheckNameRequest digitalTwinsInstanceCheckName, com.azure.core.util.Context context)
      Check if a DigitalTwinsInstance name is available.
      Parameters:
      location - Location of DigitalTwinsInstance.
      digitalTwinsInstanceCheckName - Set the name parameter in the DigitalTwinsInstanceCheckName structure to the name of the DigitalTwinsInstance to check.
      context - The context to associate with this operation.
      Returns:
      the result returned from a check name availability request 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.

    • getById

      DigitalTwinsDescription getById(String id)
      Get DigitalTwinsInstances resource.
      Parameters:
      id - the resource ID.
      Returns:
      digitalTwinsInstances resource 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<DigitalTwinsDescription> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Get DigitalTwinsInstances resource.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      digitalTwinsInstances resource 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

      DigitalTwinsDescription deleteById(String id)
      Delete a DigitalTwinsInstance.
      Parameters:
      id - the resource ID.
      Returns:
      the description of the DigitalTwins service.
      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

      DigitalTwinsDescription deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Delete a DigitalTwinsInstance.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      the description of the DigitalTwins service.
      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

      DigitalTwinsDescription.DefinitionStages.Blank define(String name)
      Begins definition for a new DigitalTwinsDescription resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new DigitalTwinsDescription definition.