Interface DevicesClient
public interface DevicesClient
An instance of this class provides access to all the operations defined in DevicesClient.
-
Method Summary
Modifier and TypeMethodDescriptioncom.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DeviceInner>,
DeviceInner> beginCreateOrUpdate
(String resourceGroupName, String deviceName, DeviceInner parameters) Creates or updates a device.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DeviceInner>,
DeviceInner> beginCreateOrUpdate
(String resourceGroupName, String deviceName, DeviceInner parameters, com.azure.core.util.Context context) Creates or updates a device.beginDelete
(String resourceGroupName, String deviceName) Deletes the specified device.beginDelete
(String resourceGroupName, String deviceName, com.azure.core.util.Context context) Deletes the specified device.createOrUpdate
(String resourceGroupName, String deviceName, DeviceInner parameters) Creates or updates a device.createOrUpdate
(String resourceGroupName, String deviceName, DeviceInner parameters, com.azure.core.util.Context context) Creates or updates a device.void
Deletes the specified device.void
Deletes the specified device.getByResourceGroup
(String resourceGroupName, String deviceName) Gets information about the specified device.com.azure.core.http.rest.Response<DeviceInner>
getByResourceGroupWithResponse
(String resourceGroupName, String deviceName, com.azure.core.util.Context context) Gets information about the specified device.com.azure.core.http.rest.PagedIterable<DeviceInner>
list()
Lists all the devices in a subscription.com.azure.core.http.rest.PagedIterable<DeviceInner>
list
(com.azure.core.util.Context context) Lists all the devices in a subscription.com.azure.core.http.rest.PagedIterable<DeviceInner>
listByResourceGroup
(String resourceGroupName) Lists all the device resource in a resource group.com.azure.core.http.rest.PagedIterable<DeviceInner>
listByResourceGroup
(String resourceGroupName, com.azure.core.util.Context context) Lists all the device resource in a resource group.listRegistrationKey
(String resourceGroupName, String deviceName) List the registration key for the device.com.azure.core.http.rest.Response<DeviceRegistrationKeyInner>
listRegistrationKeyWithResponse
(String resourceGroupName, String deviceName, com.azure.core.util.Context context) List the registration key for the device.updateTags
(String resourceGroupName, String deviceName, TagsObject parameters) Updates device tags.com.azure.core.http.rest.Response<DeviceInner>
updateTagsWithResponse
(String resourceGroupName, String deviceName, TagsObject parameters, com.azure.core.util.Context context) Updates device tags.
-
Method Details
-
beginDelete
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String deviceName) Deletes the specified device.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.deviceName
- The name of the device resource.- Returns:
- the
SyncPoller
for polling of long-running 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.
-
beginDelete
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String deviceName, com.azure.core.util.Context context) Deletes the specified device.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.deviceName
- The name of the device resource.context
- The context to associate with this operation.- Returns:
- the
SyncPoller
for polling of long-running 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.
-
delete
Deletes the specified device.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.deviceName
- The name of the device 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
Deletes the specified device.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.deviceName
- The name of the device resource.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.
-
getByResourceGroupWithResponse
com.azure.core.http.rest.Response<DeviceInner> getByResourceGroupWithResponse(String resourceGroupName, String deviceName, com.azure.core.util.Context context) Gets information about the specified device.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.deviceName
- The name of the device resource.context
- The context to associate with this operation.- Returns:
- information about the specified device 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.
-
getByResourceGroup
Gets information about the specified device.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.deviceName
- The name of the device resource.- Returns:
- information about the specified device.
- 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<DeviceInner>,DeviceInner> beginCreateOrUpdate(String resourceGroupName, String deviceName, DeviceInner parameters) Creates or updates a device.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.deviceName
- Resource name for the device resource.parameters
- Parameters supplied to the create or update device operation.- Returns:
- the
SyncPoller
for polling of device 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.
-
beginCreateOrUpdate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DeviceInner>,DeviceInner> beginCreateOrUpdate(String resourceGroupName, String deviceName, DeviceInner parameters, com.azure.core.util.Context context) Creates or updates a device.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.deviceName
- Resource name for the device resource.parameters
- Parameters supplied to the create or update device operation.context
- The context to associate with this operation.- Returns:
- the
SyncPoller
for polling of device 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.
-
createOrUpdate
Creates or updates a device.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.deviceName
- Resource name for the device resource.parameters
- Parameters supplied to the create or update device operation.- Returns:
- device 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.
-
createOrUpdate
DeviceInner createOrUpdate(String resourceGroupName, String deviceName, DeviceInner parameters, com.azure.core.util.Context context) Creates or updates a device.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.deviceName
- Resource name for the device resource.parameters
- Parameters supplied to the create or update device operation.context
- The context to associate with this operation.- Returns:
- device 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.
-
updateTagsWithResponse
com.azure.core.http.rest.Response<DeviceInner> updateTagsWithResponse(String resourceGroupName, String deviceName, TagsObject parameters, com.azure.core.util.Context context) Updates device tags.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.deviceName
- The name of the device resource.parameters
- Parameters supplied to the update device tags operation.context
- The context to associate with this operation.- Returns:
- device 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.
-
updateTags
Updates device tags.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.deviceName
- The name of the device resource.parameters
- Parameters supplied to the update device tags operation.- Returns:
- device 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.
-
list
com.azure.core.http.rest.PagedIterable<DeviceInner> list()Lists all the devices in a subscription.- Returns:
- response for devices API service call 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
Lists all the devices in a subscription.- Parameters:
context
- The context to associate with this operation.- Returns:
- response for devices API service call 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
Lists all the device resource in a resource group.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.- Returns:
- response for devices API service call 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<DeviceInner> listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context) Lists all the device resource in a resource group.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.context
- The context to associate with this operation.- Returns:
- response for devices API service call 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.
-
listRegistrationKeyWithResponse
com.azure.core.http.rest.Response<DeviceRegistrationKeyInner> listRegistrationKeyWithResponse(String resourceGroupName, String deviceName, com.azure.core.util.Context context) List the registration key for the device.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.deviceName
- The name of the device resource.context
- The context to associate with this operation.- Returns:
- the device registration key 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.
-
listRegistrationKey
List the registration key for the device.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.deviceName
- The name of the device resource.- Returns:
- the device registration key.
- 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.
-