DigitalTwins Interface

Package:

com.azure.resourcemanager.digitaltwins.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-digitaltwins:1.3.0

public interface DigitalTwins

Resource collection API of DigitalTwins.

Method Summary

Modifier and Type	Method and Description
abstract CheckNameResult	checkNameAvailability(String location, CheckNameRequest digitalTwinsInstanceCheckName) Check if a DigitalTwinsInstance name is available.
abstract Response<CheckNameResult>	checkNameAvailabilityWithResponse(String location, CheckNameRequest digitalTwinsInstanceCheckName, Context context) Check if a DigitalTwinsInstance name is available.
abstract Blank	define(String name) Begins definition for a new DigitalTwinsDescription resource.
abstract DigitalTwinsDescription	delete(String resourceGroupName, String resourceName, Context context) Delete a DigitalTwinsInstance.
abstract DigitalTwinsDescription	deleteById(String id) Delete a DigitalTwinsInstance.
abstract DigitalTwinsDescription	deleteByIdWithResponse(String id, Context context) Delete a DigitalTwinsInstance.
abstract DigitalTwinsDescription	deleteByResourceGroup(String resourceGroupName, String resourceName) Delete a DigitalTwinsInstance.
abstract DigitalTwinsDescription	getById(String id) Get DigitalTwinsInstances resource.
abstract Response<DigitalTwinsDescription>	getByIdWithResponse(String id, Context context) Get DigitalTwinsInstances resource.
abstract DigitalTwinsDescription	getByResourceGroup(String resourceGroupName, String resourceName) Get DigitalTwinsInstances resource.
abstract Response<DigitalTwinsDescription>	getByResourceGroupWithResponse(String resourceGroupName, String resourceName, Context context) Get DigitalTwinsInstances resource.
abstract PagedIterable<DigitalTwinsDescription>	list() Get all the DigitalTwinsInstances in a subscription.
abstract PagedIterable<DigitalTwinsDescription>	list(Context context) Get all the DigitalTwinsInstances in a subscription.
abstract PagedIterable<DigitalTwinsDescription>	listByResourceGroup(String resourceGroupName) Get all the DigitalTwinsInstances in a resource group.
abstract PagedIterable<DigitalTwinsDescription>	listByResourceGroup(String resourceGroupName, Context context) Get all the DigitalTwinsInstances in a resource group.

Method Details

checkNameAvailability

public abstract 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.

checkNameAvailabilityWithResponse

public abstract Response<CheckNameResult> checkNameAvailabilityWithResponse(String location, CheckNameRequest digitalTwinsInstanceCheckName, 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<T>.

define

public abstract 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.

delete

public abstract DigitalTwinsDescription delete(String resourceGroupName, String resourceName, 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.

deleteById

public abstract DigitalTwinsDescription deleteById(String id)

Delete a DigitalTwinsInstance.

Parameters:

id - the resource ID.

Returns:

the description of the DigitalTwins service.

deleteByIdWithResponse

public abstract DigitalTwinsDescription deleteByIdWithResponse(String id, 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.

deleteByResourceGroup

public abstract 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.

getById

public abstract DigitalTwinsDescription getById(String id)

Get DigitalTwinsInstances resource.

Parameters:

id - the resource ID.

Returns:

digitalTwinsInstances resource along with Response<T>.

getByIdWithResponse

public abstract Response<DigitalTwinsDescription> getByIdWithResponse(String id, Context context)

Get DigitalTwinsInstances resource.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

digitalTwinsInstances resource along with Response<T>.

getByResourceGroup

public abstract 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.

getByResourceGroupWithResponse

public abstract Response<DigitalTwinsDescription> getByResourceGroupWithResponse(String resourceGroupName, String resourceName, 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<T>.

list

public abstract PagedIterable<DigitalTwinsDescription> list()

Get all the DigitalTwinsInstances in a subscription.

Returns:

all the DigitalTwinsInstances in a subscription as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<DigitalTwinsDescription> list(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<T>.

listByResourceGroup

public abstract 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<T>.

listByResourceGroup

public abstract PagedIterable<DigitalTwinsDescription> listByResourceGroup(String resourceGroupName, 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<T>.