Package com.azure.resourcemanager.digitaltwins.fluent

Interface DigitalTwinsClient

public interface DigitalTwinsClient
An instance of this class provides access to all the operations defined in DigitalTwinsClient.

  • Method Details

    • getByResourceGroup

      DigitalTwinsDescriptionInner 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<DigitalTwinsDescriptionInner> 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.

    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DigitalTwinsDescriptionInner>,DigitalTwinsDescriptionInner> beginCreateOrUpdate(String resourceGroupName, String resourceName, DigitalTwinsDescriptionInner digitalTwinsCreate)
      Create or update the metadata of a DigitalTwinsInstance. The usual pattern to modify a property is to retrieve the DigitalTwinsInstance and security metadata, and then combine them with the modified values in a new body to update the DigitalTwinsInstance.
      Parameters:
      resourceGroupName - The name of the resource group that contains the DigitalTwinsInstance.
      resourceName - The name of the DigitalTwinsInstance.
      digitalTwinsCreate - The DigitalTwinsInstance and security metadata.
      Returns:
      the SyncPoller for polling of 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.

    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DigitalTwinsDescriptionInner>,DigitalTwinsDescriptionInner> beginCreateOrUpdate(String resourceGroupName, String resourceName, DigitalTwinsDescriptionInner digitalTwinsCreate, com.azure.core.util.Context context)
      Create or update the metadata of a DigitalTwinsInstance. The usual pattern to modify a property is to retrieve the DigitalTwinsInstance and security metadata, and then combine them with the modified values in a new body to update the DigitalTwinsInstance.
      Parameters:
      resourceGroupName - The name of the resource group that contains the DigitalTwinsInstance.
      resourceName - The name of the DigitalTwinsInstance.
      digitalTwinsCreate - The DigitalTwinsInstance and security metadata.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of 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.

    • createOrUpdate

      DigitalTwinsDescriptionInner createOrUpdate(String resourceGroupName, String resourceName, DigitalTwinsDescriptionInner digitalTwinsCreate)
      Create or update the metadata of a DigitalTwinsInstance. The usual pattern to modify a property is to retrieve the DigitalTwinsInstance and security metadata, and then combine them with the modified values in a new body to update the DigitalTwinsInstance.
      Parameters:
      resourceGroupName - The name of the resource group that contains the DigitalTwinsInstance.
      resourceName - The name of the DigitalTwinsInstance.
      digitalTwinsCreate - The DigitalTwinsInstance and security metadata.
      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.

    • createOrUpdate

      DigitalTwinsDescriptionInner createOrUpdate(String resourceGroupName, String resourceName, DigitalTwinsDescriptionInner digitalTwinsCreate, com.azure.core.util.Context context)
      Create or update the metadata of a DigitalTwinsInstance. The usual pattern to modify a property is to retrieve the DigitalTwinsInstance and security metadata, and then combine them with the modified values in a new body to update the DigitalTwinsInstance.
      Parameters:
      resourceGroupName - The name of the resource group that contains the DigitalTwinsInstance.
      resourceName - The name of the DigitalTwinsInstance.
      digitalTwinsCreate - The DigitalTwinsInstance and security metadata.
      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.

    • beginUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DigitalTwinsDescriptionInner>,DigitalTwinsDescriptionInner> beginUpdate(String resourceGroupName, String resourceName, DigitalTwinsPatchDescription digitalTwinsPatchDescription)
      Update metadata of DigitalTwinsInstance.
      Parameters:
      resourceGroupName - The name of the resource group that contains the DigitalTwinsInstance.
      resourceName - The name of the DigitalTwinsInstance.
      digitalTwinsPatchDescription - The DigitalTwinsInstance and security metadata.
      Returns:
      the SyncPoller for polling of 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.

    • beginUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DigitalTwinsDescriptionInner>,DigitalTwinsDescriptionInner> beginUpdate(String resourceGroupName, String resourceName, DigitalTwinsPatchDescription digitalTwinsPatchDescription, com.azure.core.util.Context context)
      Update metadata of DigitalTwinsInstance.
      Parameters:
      resourceGroupName - The name of the resource group that contains the DigitalTwinsInstance.
      resourceName - The name of the DigitalTwinsInstance.
      digitalTwinsPatchDescription - The DigitalTwinsInstance and security metadata.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of 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.

    • update

      DigitalTwinsDescriptionInner update(String resourceGroupName, String resourceName, DigitalTwinsPatchDescription digitalTwinsPatchDescription)
      Update metadata of DigitalTwinsInstance.
      Parameters:
      resourceGroupName - The name of the resource group that contains the DigitalTwinsInstance.
      resourceName - The name of the DigitalTwinsInstance.
      digitalTwinsPatchDescription - The DigitalTwinsInstance and security metadata.
      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.

    • update

      DigitalTwinsDescriptionInner update(String resourceGroupName, String resourceName, DigitalTwinsPatchDescription digitalTwinsPatchDescription, com.azure.core.util.Context context)
      Update metadata of DigitalTwinsInstance.
      Parameters:
      resourceGroupName - The name of the resource group that contains the DigitalTwinsInstance.
      resourceName - The name of the DigitalTwinsInstance.
      digitalTwinsPatchDescription - The DigitalTwinsInstance and security metadata.
      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.

    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DigitalTwinsDescriptionInner>,DigitalTwinsDescriptionInner> beginDelete(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 SyncPoller for polling of 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.

    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DigitalTwinsDescriptionInner>,DigitalTwinsDescriptionInner> beginDelete(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 SyncPoller for polling of 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

      DigitalTwinsDescriptionInner delete(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

      DigitalTwinsDescriptionInner 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<DigitalTwinsDescriptionInner> 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<DigitalTwinsDescriptionInner> 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<DigitalTwinsDescriptionInner> 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<DigitalTwinsDescriptionInner> 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

      CheckNameResultInner 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<CheckNameResultInner> 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.