IotDpsResources Interface

Package:

com.azure.resourcemanager.deviceprovisioningservices.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-deviceprovisioningservices:1.2.0

public interface IotDpsResources

Resource collection API of IotDpsResources.

Method Summary

Modifier and Type	Method and Description
abstract NameAvailabilityInfo	checkProvisioningServiceNameAvailability(OperationInputs arguments) Check if a provisioning service name is available.
abstract Response<NameAvailabilityInfo>	checkProvisioningServiceNameAvailabilityWithResponse(OperationInputs arguments, Context context) Check if a provisioning service name is available.
abstract Blank	define(String name) Begins definition for a new ProvisioningServiceDescription resource.
abstract Blank	definePrivateEndpointConnection(String name) Begins definition for a new PrivateEndpointConnection resource.
abstract void	delete(String resourceGroupName, String provisioningServiceName, Context context) Deletes the Provisioning Service.
abstract void	deleteById(String id) Deletes the Provisioning Service.
abstract void	deleteByIdWithResponse(String id, Context context) Deletes the Provisioning Service.
abstract void	deleteByResourceGroup(String resourceGroupName, String provisioningServiceName) Deletes the Provisioning Service.
abstract void	deletePrivateEndpointConnection(String resourceGroupName, String resourceName, String privateEndpointConnectionName) Delete private endpoint connection with the specified name.
abstract void	deletePrivateEndpointConnection(String resourceGroupName, String resourceName, String privateEndpointConnectionName, Context context) Delete private endpoint connection with the specified name.
abstract void	deletePrivateEndpointConnectionById(String id) Delete private endpoint connection with the specified name.
abstract void	deletePrivateEndpointConnectionByIdWithResponse(String id, Context context) Delete private endpoint connection with the specified name.
abstract ProvisioningServiceDescription	getById(String id) Get the metadata of the provisioning service without SAS keys.
abstract Response<ProvisioningServiceDescription>	getByIdWithResponse(String id, Context context) Get the metadata of the provisioning service without SAS keys.
abstract ProvisioningServiceDescription	getByResourceGroup(String resourceGroupName, String provisioningServiceName) Get the metadata of the provisioning service without SAS keys.
abstract Response<ProvisioningServiceDescription>	getByResourceGroupWithResponse(String resourceGroupName, String provisioningServiceName, Context context) Get the metadata of the provisioning service without SAS keys.
abstract AsyncOperationResult	getOperationResult(String operationId, String resourceGroupName, String provisioningServiceName, String asyncinfo) Gets the status of a long running operation, such as create, update or delete a provisioning service.
abstract Response<AsyncOperationResult>	getOperationResultWithResponse(String operationId, String resourceGroupName, String provisioningServiceName, String asyncinfo, Context context) Gets the status of a long running operation, such as create, update or delete a provisioning service.
abstract PrivateEndpointConnection	getPrivateEndpointConnection(String resourceGroupName, String resourceName, String privateEndpointConnectionName) Get private endpoint connection properties.
abstract PrivateEndpointConnection	getPrivateEndpointConnectionById(String id) Get private endpoint connection properties.
abstract Response<PrivateEndpointConnection>	getPrivateEndpointConnectionByIdWithResponse(String id, Context context) Get private endpoint connection properties.
abstract Response<PrivateEndpointConnection>	getPrivateEndpointConnectionWithResponse(String resourceGroupName, String resourceName, String privateEndpointConnectionName, Context context) Get private endpoint connection properties.
abstract GroupIdInformation	getPrivateLinkResources(String resourceGroupName, String resourceName, String groupId) Get the specified private link resource for the given provisioning service.
abstract Response<GroupIdInformation>	getPrivateLinkResourcesWithResponse(String resourceGroupName, String resourceName, String groupId, Context context) Get the specified private link resource for the given provisioning service.
abstract PagedIterable<ProvisioningServiceDescription>	list() List all the provisioning services for a given subscription id.
abstract PagedIterable<ProvisioningServiceDescription>	list(Context context) List all the provisioning services for a given subscription id.
abstract PagedIterable<ProvisioningServiceDescription>	listByResourceGroup(String resourceGroupName) Get a list of all provisioning services in the given resource group.
abstract PagedIterable<ProvisioningServiceDescription>	listByResourceGroup(String resourceGroupName, Context context) Get a list of all provisioning services in the given resource group.
abstract PagedIterable<SharedAccessSignatureAuthorizationRule>	listKeys(String provisioningServiceName, String resourceGroupName) List the primary and secondary keys for a provisioning service.
abstract PagedIterable<SharedAccessSignatureAuthorizationRule>	listKeys(String provisioningServiceName, String resourceGroupName, Context context) List the primary and secondary keys for a provisioning service.
abstract SharedAccessSignatureAuthorizationRule	listKeysForKeyName(String provisioningServiceName, String keyName, String resourceGroupName) List primary and secondary keys for a specific key name.
abstract Response<SharedAccessSignatureAuthorizationRule>	listKeysForKeyNameWithResponse(String provisioningServiceName, String keyName, String resourceGroupName, Context context) List primary and secondary keys for a specific key name.
abstract List<PrivateEndpointConnection>	listPrivateEndpointConnections(String resourceGroupName, String resourceName) List private endpoint connection properties.
abstract Response<List<PrivateEndpointConnection>>	listPrivateEndpointConnectionsWithResponse(String resourceGroupName, String resourceName, Context context) List private endpoint connection properties.
abstract PagedIterable<GroupIdInformation>	listPrivateLinkResources(String resourceGroupName, String resourceName) List private link resources for the given provisioning service.
abstract PagedIterable<GroupIdInformation>	listPrivateLinkResources(String resourceGroupName, String resourceName, Context context) List private link resources for the given provisioning service.
abstract PagedIterable<IotDpsSkuDefinition>	listValidSkus(String provisioningServiceName, String resourceGroupName) Gets the list of valid SKUs and tiers for a provisioning service.
abstract PagedIterable<IotDpsSkuDefinition>	listValidSkus(String provisioningServiceName, String resourceGroupName, Context context) Gets the list of valid SKUs and tiers for a provisioning service.

Method Details

checkProvisioningServiceNameAvailability

public abstract NameAvailabilityInfo checkProvisioningServiceNameAvailability(OperationInputs arguments)

Check if a provisioning service name is available. Check if a provisioning service name is available. This will validate if the name is syntactically valid and if the name is usable.

Parameters:

arguments - The request body.

Returns:

description of name availability.

checkProvisioningServiceNameAvailabilityWithResponse

public abstract Response<NameAvailabilityInfo> checkProvisioningServiceNameAvailabilityWithResponse(OperationInputs arguments, Context context)

Check if a provisioning service name is available. Check if a provisioning service name is available. This will validate if the name is syntactically valid and if the name is usable.

Parameters:

arguments - The request body.

context - The context to associate with this operation.

Returns:

description of name availability along with Response<T>.

define

public abstract ProvisioningServiceDescription.DefinitionStages.Blank define(String name)

Begins definition for a new ProvisioningServiceDescription resource.

Parameters:

name - resource name.

Returns:

the first stage of the new ProvisioningServiceDescription definition.

definePrivateEndpointConnection

public abstract PrivateEndpointConnection.DefinitionStages.Blank definePrivateEndpointConnection(String name)

Begins definition for a new PrivateEndpointConnection resource.

Parameters:

name - resource name.

Returns:

the first stage of the new PrivateEndpointConnection definition.

delete

public abstract void delete(String resourceGroupName, String provisioningServiceName, Context context)

Deletes the Provisioning Service.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

provisioningServiceName - Name of the provisioning service to retrieve.

context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Deletes the Provisioning Service.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Deletes the Provisioning Service.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

deleteByResourceGroup

public abstract void deleteByResourceGroup(String resourceGroupName, String provisioningServiceName)

Deletes the Provisioning Service.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

provisioningServiceName - Name of the provisioning service to retrieve.

deletePrivateEndpointConnection

public abstract void deletePrivateEndpointConnection(String resourceGroupName, String resourceName, String privateEndpointConnectionName)

Delete private endpoint connection with the specified name.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

resourceName - Name of the provisioning service to retrieve.

privateEndpointConnectionName - The name of the private endpoint connection.

deletePrivateEndpointConnection

public abstract void deletePrivateEndpointConnection(String resourceGroupName, String resourceName, String privateEndpointConnectionName, Context context)

Delete private endpoint connection with the specified name.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

resourceName - Name of the provisioning service to retrieve.

privateEndpointConnectionName - The name of the private endpoint connection.

context - The context to associate with this operation.

deletePrivateEndpointConnectionById

public abstract void deletePrivateEndpointConnectionById(String id)

Delete private endpoint connection with the specified name.

Parameters:

id - the resource ID.

deletePrivateEndpointConnectionByIdWithResponse

public abstract void deletePrivateEndpointConnectionByIdWithResponse(String id, Context context)

Delete private endpoint connection with the specified name.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

getById

public abstract ProvisioningServiceDescription getById(String id)

Get the metadata of the provisioning service without SAS keys.

Parameters:

id - the resource ID.

Returns:

the metadata of the provisioning service without SAS keys along with Response<T>.

getByIdWithResponse

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

Get the metadata of the provisioning service without SAS keys.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the metadata of the provisioning service without SAS keys along with Response<T>.

getByResourceGroup

public abstract ProvisioningServiceDescription getByResourceGroup(String resourceGroupName, String provisioningServiceName)

Get the metadata of the provisioning service without SAS keys.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

provisioningServiceName - Name of the provisioning service to retrieve.

Returns:

the metadata of the provisioning service without SAS keys.

getByResourceGroupWithResponse

public abstract Response<ProvisioningServiceDescription> getByResourceGroupWithResponse(String resourceGroupName, String provisioningServiceName, Context context)

Get the metadata of the provisioning service without SAS keys.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

provisioningServiceName - Name of the provisioning service to retrieve.

context - The context to associate with this operation.

Returns:

the metadata of the provisioning service without SAS keys along with Response<T>.

getOperationResult

public abstract AsyncOperationResult getOperationResult(String operationId, String resourceGroupName, String provisioningServiceName, String asyncinfo)

Gets the status of a long running operation, such as create, update or delete a provisioning service.

Parameters:

operationId - Operation id corresponding to long running operation. Use this to poll for the status.

resourceGroupName - The name of the resource group. The name is case insensitive.

provisioningServiceName - Name of the provisioning service to retrieve.

asyncinfo - Async header used to poll on the status of the operation, obtained while creating the long running operation.

Returns:

the status of a long running operation, such as create, update or delete a provisioning service.

getOperationResultWithResponse

public abstract Response<AsyncOperationResult> getOperationResultWithResponse(String operationId, String resourceGroupName, String provisioningServiceName, String asyncinfo, Context context)

Gets the status of a long running operation, such as create, update or delete a provisioning service.

Parameters:

operationId - Operation id corresponding to long running operation. Use this to poll for the status.

resourceGroupName - The name of the resource group. The name is case insensitive.

provisioningServiceName - Name of the provisioning service to retrieve.

asyncinfo - Async header used to poll on the status of the operation, obtained while creating the long running operation.

context - The context to associate with this operation.

Returns:

the status of a long running operation, such as create, update or delete a provisioning service along with Response<T>.

getPrivateEndpointConnection

public abstract PrivateEndpointConnection getPrivateEndpointConnection(String resourceGroupName, String resourceName, String privateEndpointConnectionName)

Get private endpoint connection properties.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

resourceName - Name of the provisioning service to retrieve.

privateEndpointConnectionName - The name of the private endpoint connection.

Returns:

private endpoint connection properties.

getPrivateEndpointConnectionById

public abstract PrivateEndpointConnection getPrivateEndpointConnectionById(String id)

Get private endpoint connection properties.

Parameters:

id - the resource ID.

Returns:

private endpoint connection properties along with Response<T>.

getPrivateEndpointConnectionByIdWithResponse

public abstract Response<PrivateEndpointConnection> getPrivateEndpointConnectionByIdWithResponse(String id, Context context)

Get private endpoint connection properties.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

private endpoint connection properties along with Response<T>.

getPrivateEndpointConnectionWithResponse

public abstract Response<PrivateEndpointConnection> getPrivateEndpointConnectionWithResponse(String resourceGroupName, String resourceName, String privateEndpointConnectionName, Context context)

Get private endpoint connection properties.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

resourceName - Name of the provisioning service to retrieve.

privateEndpointConnectionName - The name of the private endpoint connection.

context - The context to associate with this operation.

Returns:

private endpoint connection properties along with Response<T>.

getPrivateLinkResources

public abstract GroupIdInformation getPrivateLinkResources(String resourceGroupName, String resourceName, String groupId)

Get the specified private link resource for the given provisioning service.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

resourceName - Name of the provisioning service to retrieve.

groupId - The name of the private link resource.

Returns:

the specified private link resource for the given provisioning service.

getPrivateLinkResourcesWithResponse

public abstract Response<GroupIdInformation> getPrivateLinkResourcesWithResponse(String resourceGroupName, String resourceName, String groupId, Context context)

Get the specified private link resource for the given provisioning service.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

resourceName - Name of the provisioning service to retrieve.

groupId - The name of the private link resource.

context - The context to associate with this operation.

Returns:

the specified private link resource for the given provisioning service along with Response<T>.

list

public abstract PagedIterable<ProvisioningServiceDescription> list()

List all the provisioning services for a given subscription id.

Returns:

the response of a ProvisioningServiceDescription list operation as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<ProvisioningServiceDescription> list(Context context)

List all the provisioning services for a given subscription id.

Parameters:

context - The context to associate with this operation.

Returns:

the response of a ProvisioningServiceDescription list operation as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<ProvisioningServiceDescription> listByResourceGroup(String resourceGroupName)

Get a list of all provisioning services in the given resource group.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

Returns:

a list of all provisioning services in the given resource group as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<ProvisioningServiceDescription> listByResourceGroup(String resourceGroupName, Context context)

Get a list of all provisioning services in the given resource group.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

context - The context to associate with this operation.

Returns:

a list of all provisioning services in the given resource group as paginated response with PagedIterable<T>.

listKeys

public abstract PagedIterable<SharedAccessSignatureAuthorizationRule> listKeys(String provisioningServiceName, String resourceGroupName)

List the primary and secondary keys for a provisioning service.

Parameters:

provisioningServiceName - Name of the provisioning service to retrieve.

resourceGroupName - The name of the resource group. The name is case insensitive.

Returns:

list of shared access keys as paginated response with PagedIterable<T>.

listKeys

public abstract PagedIterable<SharedAccessSignatureAuthorizationRule> listKeys(String provisioningServiceName, String resourceGroupName, Context context)

List the primary and secondary keys for a provisioning service.

Parameters:

provisioningServiceName - Name of the provisioning service to retrieve.

resourceGroupName - The name of the resource group. The name is case insensitive.

context - The context to associate with this operation.

Returns:

list of shared access keys as paginated response with PagedIterable<T>.

listKeysForKeyName

public abstract SharedAccessSignatureAuthorizationRule listKeysForKeyName(String provisioningServiceName, String keyName, String resourceGroupName)

List primary and secondary keys for a specific key name.

Parameters:

provisioningServiceName - Name of the provisioning service to retrieve.

keyName - Logical key name to get key-values for.

resourceGroupName - The name of the resource group. The name is case insensitive.

Returns:

description of the shared access key.

listKeysForKeyNameWithResponse

public abstract Response<SharedAccessSignatureAuthorizationRule> listKeysForKeyNameWithResponse(String provisioningServiceName, String keyName, String resourceGroupName, Context context)

List primary and secondary keys for a specific key name.

Parameters:

provisioningServiceName - Name of the provisioning service to retrieve.

keyName - Logical key name to get key-values for.

resourceGroupName - The name of the resource group. The name is case insensitive.

context - The context to associate with this operation.

Returns:

description of the shared access key along with Response<T>.

listPrivateEndpointConnections

public abstract List<PrivateEndpointConnection> listPrivateEndpointConnections(String resourceGroupName, String resourceName)

List private endpoint connection properties.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

resourceName - Name of the provisioning service to retrieve.

Returns:

represents a list of private endpoint connections.

listPrivateEndpointConnectionsWithResponse

public abstract Response<List<PrivateEndpointConnection>> listPrivateEndpointConnectionsWithResponse(String resourceGroupName, String resourceName, Context context)

List private endpoint connection properties.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

resourceName - Name of the provisioning service to retrieve.

context - The context to associate with this operation.

Returns:

represents a list of private endpoint connections along with Response<T>.

listPrivateLinkResources

public abstract PagedIterable<GroupIdInformation> listPrivateLinkResources(String resourceGroupName, String resourceName)

List private link resources for the given provisioning service.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

resourceName - Name of the provisioning service to retrieve.

Returns:

the available private link resources for a provisioning service as paginated response with PagedIterable<T>.

listPrivateLinkResources

public abstract PagedIterable<GroupIdInformation> listPrivateLinkResources(String resourceGroupName, String resourceName, Context context)

List private link resources for the given provisioning service.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

resourceName - Name of the provisioning service to retrieve.

context - The context to associate with this operation.

Returns:

the available private link resources for a provisioning service as paginated response with PagedIterable<T>.

listValidSkus

public abstract PagedIterable<IotDpsSkuDefinition> listValidSkus(String provisioningServiceName, String resourceGroupName)

Gets the list of valid SKUs and tiers for a provisioning service.

Parameters:

provisioningServiceName - Name of the provisioning service to retrieve.

resourceGroupName - The name of the resource group. The name is case insensitive.

Returns:

the list of valid SKUs and tiers for a provisioning service as paginated response with PagedIterable<T>.

listValidSkus

public abstract PagedIterable<IotDpsSkuDefinition> listValidSkus(String provisioningServiceName, String resourceGroupName, Context context)

Gets the list of valid SKUs and tiers for a provisioning service.

Parameters:

provisioningServiceName - Name of the provisioning service to retrieve.

resourceGroupName - The name of the resource group. The name is case insensitive.

context - The context to associate with this operation.

Returns:

the list of valid SKUs and tiers for a provisioning service as paginated response with PagedIterable<T>.