Package com.azure.resourcemanager.hardwaresecuritymodules.fluent

Interface DedicatedHsmsClient

public interface DedicatedHsmsClient

An instance of this class provides access to all the operations defined in DedicatedHsmsClient.

Method Summary

Modifier and Type	Method	Description
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DedicatedHsmInner>,DedicatedHsmInner>	beginCreateOrUpdate(String resourceGroupName, String name, DedicatedHsmInner parameters)	Create or Update a dedicated HSM in the specified subscription.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DedicatedHsmInner>,DedicatedHsmInner>	beginCreateOrUpdate(String resourceGroupName, String name, DedicatedHsmInner parameters, com.azure.core.util.Context context)	Create or Update a dedicated HSM in the specified subscription.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDelete(String resourceGroupName, String name)	Deletes the specified Azure Dedicated HSM.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDelete(String resourceGroupName, String name, com.azure.core.util.Context context)	Deletes the specified Azure Dedicated HSM.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DedicatedHsmInner>,DedicatedHsmInner>	beginUpdate(String resourceGroupName, String name, DedicatedHsmPatchParameters parameters)	Update a dedicated HSM in the specified subscription.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DedicatedHsmInner>,DedicatedHsmInner>	beginUpdate(String resourceGroupName, String name, DedicatedHsmPatchParameters parameters, com.azure.core.util.Context context)	Update a dedicated HSM in the specified subscription.
DedicatedHsmInner	createOrUpdate(String resourceGroupName, String name, DedicatedHsmInner parameters)	Create or Update a dedicated HSM in the specified subscription.
DedicatedHsmInner	createOrUpdate(String resourceGroupName, String name, DedicatedHsmInner parameters, com.azure.core.util.Context context)	Create or Update a dedicated HSM in the specified subscription.
void	delete(String resourceGroupName, String name)	Deletes the specified Azure Dedicated HSM.
void	delete(String resourceGroupName, String name, com.azure.core.util.Context context)	Deletes the specified Azure Dedicated HSM.
DedicatedHsmInner	getByResourceGroup(String resourceGroupName, String name)	Gets the specified Azure dedicated HSM.
com.azure.core.http.rest.Response<DedicatedHsmInner>	getByResourceGroupWithResponse(String resourceGroupName, String name, com.azure.core.util.Context context)	Gets the specified Azure dedicated HSM.
com.azure.core.http.rest.PagedIterable<DedicatedHsmInner>	list()	The List operation gets information about the dedicated HSMs associated with the subscription.
com.azure.core.http.rest.PagedIterable<DedicatedHsmInner>	list(Integer top, com.azure.core.util.Context context)	The List operation gets information about the dedicated HSMs associated with the subscription.
com.azure.core.http.rest.PagedIterable<DedicatedHsmInner>	listByResourceGroup(String resourceGroupName)	The List operation gets information about the dedicated hsms associated with the subscription and within the specified resource group.
com.azure.core.http.rest.PagedIterable<DedicatedHsmInner>	listByResourceGroup(String resourceGroupName, Integer top, com.azure.core.util.Context context)	The List operation gets information about the dedicated hsms associated with the subscription and within the specified resource group.
com.azure.core.http.rest.PagedIterable<OutboundEnvironmentEndpointInner>	listOutboundNetworkDependenciesEndpoints(String resourceGroupName, String name)	Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified dedicated hsm resource.
com.azure.core.http.rest.PagedIterable<OutboundEnvironmentEndpointInner>	listOutboundNetworkDependenciesEndpoints(String resourceGroupName, String name, com.azure.core.util.Context context)	Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified dedicated hsm resource.
DedicatedHsmInner	update(String resourceGroupName, String name, DedicatedHsmPatchParameters parameters)	Update a dedicated HSM in the specified subscription.
DedicatedHsmInner	update(String resourceGroupName, String name, DedicatedHsmPatchParameters parameters, com.azure.core.util.Context context)	Update a dedicated HSM in the specified subscription.

Method Detail

beginCreateOrUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DedicatedHsmInner>,DedicatedHsmInner> beginCreateOrUpdate(String resourceGroupName,
                                                                                                                                                    String name,
                                                                                                                                                    DedicatedHsmInner parameters)

Create or Update a dedicated HSM in the specified subscription.

Parameters:

resourceGroupName - The name of the Resource Group to which the resource belongs.

name - Name of the dedicated Hsm.

parameters - Parameters to create or update the dedicated hsm.

Returns:

the SyncPoller for polling of resource information with extended details.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorException - 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<DedicatedHsmInner>,DedicatedHsmInner> beginCreateOrUpdate(String resourceGroupName,
                                                                                                                                                    String name,
                                                                                                                                                    DedicatedHsmInner parameters,
                                                                                                                                                    com.azure.core.util.Context context)

Create or Update a dedicated HSM in the specified subscription.

Parameters:

resourceGroupName - The name of the Resource Group to which the resource belongs.

name - Name of the dedicated Hsm.

parameters - Parameters to create or update the dedicated hsm.

context - The context to associate with this operation.

Returns:

the SyncPoller for polling of resource information with extended details.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

DedicatedHsmInner createOrUpdate(String resourceGroupName,
                                 String name,
                                 DedicatedHsmInner parameters)

Create or Update a dedicated HSM in the specified subscription.

Parameters:

resourceGroupName - The name of the Resource Group to which the resource belongs.

name - Name of the dedicated Hsm.

parameters - Parameters to create or update the dedicated hsm.

Returns:

resource information with extended details.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

DedicatedHsmInner createOrUpdate(String resourceGroupName,
                                 String name,
                                 DedicatedHsmInner parameters,
                                 com.azure.core.util.Context context)

Create or Update a dedicated HSM in the specified subscription.

Parameters:

resourceGroupName - The name of the Resource Group to which the resource belongs.

name - Name of the dedicated Hsm.

parameters - Parameters to create or update the dedicated hsm.

context - The context to associate with this operation.

Returns:

resource information with extended details.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorException - 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<DedicatedHsmInner>,DedicatedHsmInner> beginUpdate(String resourceGroupName,
                                                                                                                                            String name,
                                                                                                                                            DedicatedHsmPatchParameters parameters)

Update a dedicated HSM in the specified subscription.

Parameters:

resourceGroupName - The name of the Resource Group to which the server belongs.

name - Name of the dedicated HSM.

parameters - Parameters to patch the dedicated HSM.

Returns:

the SyncPoller for polling of resource information with extended details.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorException - 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<DedicatedHsmInner>,DedicatedHsmInner> beginUpdate(String resourceGroupName,
                                                                                                                                            String name,
                                                                                                                                            DedicatedHsmPatchParameters parameters,
                                                                                                                                            com.azure.core.util.Context context)

Update a dedicated HSM in the specified subscription.

Parameters:

resourceGroupName - The name of the Resource Group to which the server belongs.

name - Name of the dedicated HSM.

parameters - Parameters to patch the dedicated HSM.

context - The context to associate with this operation.

Returns:

the SyncPoller for polling of resource information with extended details.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

update

DedicatedHsmInner update(String resourceGroupName,
                         String name,
                         DedicatedHsmPatchParameters parameters)

Update a dedicated HSM in the specified subscription.

Parameters:

resourceGroupName - The name of the Resource Group to which the server belongs.

name - Name of the dedicated HSM.

parameters - Parameters to patch the dedicated HSM.

Returns:

resource information with extended details.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

update

DedicatedHsmInner update(String resourceGroupName,
                         String name,
                         DedicatedHsmPatchParameters parameters,
                         com.azure.core.util.Context context)

Update a dedicated HSM in the specified subscription.

Parameters:

resourceGroupName - The name of the Resource Group to which the server belongs.

name - Name of the dedicated HSM.

parameters - Parameters to patch the dedicated HSM.

context - The context to associate with this operation.

Returns:

resource information with extended details.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorException - 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 name)

Deletes the specified Azure Dedicated HSM.

Parameters:

resourceGroupName - The name of the Resource Group to which the dedicated HSM belongs.

name - The name of the dedicated HSM to delete.

Returns:

the SyncPoller for polling of long-running operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorException - 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 name,
                                                                                                                  com.azure.core.util.Context context)

Deletes the specified Azure Dedicated HSM.

Parameters:

resourceGroupName - The name of the Resource Group to which the dedicated HSM belongs.

name - The name of the dedicated HSM to delete.

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.

ErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String name)

Deletes the specified Azure Dedicated HSM.

Parameters:

resourceGroupName - The name of the Resource Group to which the dedicated HSM belongs.

name - The name of the dedicated HSM to delete.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String name,
            com.azure.core.util.Context context)

Deletes the specified Azure Dedicated HSM.

Parameters:

resourceGroupName - The name of the Resource Group to which the dedicated HSM belongs.

name - The name of the dedicated HSM to delete.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByResourceGroup

DedicatedHsmInner getByResourceGroup(String resourceGroupName,
                                     String name)

Gets the specified Azure dedicated HSM.

Parameters:

resourceGroupName - The name of the Resource Group to which the dedicated hsm belongs.

name - The name of the dedicated HSM.

Returns:

the specified Azure dedicated HSM.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorException - 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<DedicatedHsmInner> getByResourceGroupWithResponse(String resourceGroupName,
                                                                                    String name,
                                                                                    com.azure.core.util.Context context)

Gets the specified Azure dedicated HSM.

Parameters:

resourceGroupName - The name of the Resource Group to which the dedicated hsm belongs.

name - The name of the dedicated HSM.

context - The context to associate with this operation.

Returns:

the specified Azure dedicated HSM along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorException - 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<DedicatedHsmInner> listByResourceGroup(String resourceGroupName)

The List operation gets information about the dedicated hsms associated with the subscription and within the specified resource group.

Parameters:

resourceGroupName - The name of the Resource Group to which the dedicated HSM belongs.

Returns:

list of dedicated HSMs as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorException - 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<DedicatedHsmInner> listByResourceGroup(String resourceGroupName,
                                                                              Integer top,
                                                                              com.azure.core.util.Context context)

The List operation gets information about the dedicated hsms associated with the subscription and within the specified resource group.

Parameters:

resourceGroupName - The name of the Resource Group to which the dedicated HSM belongs.

top - Maximum number of results to return.

context - The context to associate with this operation.

Returns:

list of dedicated HSMs as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorException - 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<DedicatedHsmInner> list()

The List operation gets information about the dedicated HSMs associated with the subscription.

Returns:

list of dedicated HSMs as paginated response with PagedIterable.

Throws:

ErrorException - 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<DedicatedHsmInner> list(Integer top,
                                                               com.azure.core.util.Context context)

The List operation gets information about the dedicated HSMs associated with the subscription.

Parameters:

top - Maximum number of results to return.

context - The context to associate with this operation.

Returns:

list of dedicated HSMs as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listOutboundNetworkDependenciesEndpoints

com.azure.core.http.rest.PagedIterable<OutboundEnvironmentEndpointInner> listOutboundNetworkDependenciesEndpoints(String resourceGroupName,
                                                                                                                  String name)

Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified dedicated hsm resource. The operation returns properties of each egress endpoint.

Parameters:

resourceGroupName - The name of the Resource Group to which the dedicated hsm belongs.

name - The name of the dedicated HSM.

Returns:

a list of egress endpoints (network endpoints of all outbound dependencies) in the specified dedicated hsm resource as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listOutboundNetworkDependenciesEndpoints

com.azure.core.http.rest.PagedIterable<OutboundEnvironmentEndpointInner> listOutboundNetworkDependenciesEndpoints(String resourceGroupName,
                                                                                                                  String name,
                                                                                                                  com.azure.core.util.Context context)

Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified dedicated hsm resource. The operation returns properties of each egress endpoint.

Parameters:

resourceGroupName - The name of the Resource Group to which the dedicated hsm belongs.

name - The name of the dedicated HSM.

context - The context to associate with this operation.

Returns:

a list of egress endpoints (network endpoints of all outbound dependencies) in the specified dedicated hsm resource as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.