Package com.azure.resourcemanager.keyvault.fluent

Interface ManagedHsmKeysClient

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

  • Method Details

    • createIfNotExistWithResponseAsync

      Mono<com.azure.core.http.rest.Response<ManagedHsmKeyInner>> createIfNotExistWithResponseAsync(String resourceGroupName, String name, String keyName, ManagedHsmKeyCreateParameters parameters)
      Creates the first version of a new key if it does not exist. If it already exists, then the existing key is returned without any write operations being performed. This API does not create subsequent versions, and does not update existing keys.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      name - The name of the Managed HSM Pool within the specified resource group.
      keyName - The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.
      parameters - The parameters used to create the specified key.
      Returns:
      the key resource along with Response on successful completion of Mono.
      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.

    • createIfNotExistAsync

      Mono<ManagedHsmKeyInner> createIfNotExistAsync(String resourceGroupName, String name, String keyName, ManagedHsmKeyCreateParameters parameters)
      Creates the first version of a new key if it does not exist. If it already exists, then the existing key is returned without any write operations being performed. This API does not create subsequent versions, and does not update existing keys.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      name - The name of the Managed HSM Pool within the specified resource group.
      keyName - The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.
      parameters - The parameters used to create the specified key.
      Returns:
      the key resource on successful completion of Mono.
      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.

    • createIfNotExistWithResponse

      com.azure.core.http.rest.Response<ManagedHsmKeyInner> createIfNotExistWithResponse(String resourceGroupName, String name, String keyName, ManagedHsmKeyCreateParameters parameters, com.azure.core.util.Context context)
      Creates the first version of a new key if it does not exist. If it already exists, then the existing key is returned without any write operations being performed. This API does not create subsequent versions, and does not update existing keys.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      name - The name of the Managed HSM Pool within the specified resource group.
      keyName - The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.
      parameters - The parameters used to create the specified key.
      context - The context to associate with this operation.
      Returns:
      the key 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.

    • createIfNotExist

      ManagedHsmKeyInner createIfNotExist(String resourceGroupName, String name, String keyName, ManagedHsmKeyCreateParameters parameters)
      Creates the first version of a new key if it does not exist. If it already exists, then the existing key is returned without any write operations being performed. This API does not create subsequent versions, and does not update existing keys.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      name - The name of the Managed HSM Pool within the specified resource group.
      keyName - The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.
      parameters - The parameters used to create the specified key.
      Returns:
      the key 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.

    • getWithResponseAsync

      Mono<com.azure.core.http.rest.Response<ManagedHsmKeyInner>> getWithResponseAsync(String resourceGroupName, String name, String keyName)
      Gets the current version of the specified key from the specified managed HSM.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      name - The name of the Managed HSM Pool within the specified resource group.
      keyName - The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.
      Returns:
      the current version of the specified key from the specified managed HSM along with Response on successful completion of Mono.
      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.

    • getAsync

      Mono<ManagedHsmKeyInner> getAsync(String resourceGroupName, String name, String keyName)
      Gets the current version of the specified key from the specified managed HSM.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      name - The name of the Managed HSM Pool within the specified resource group.
      keyName - The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.
      Returns:
      the current version of the specified key from the specified managed HSM on successful completion of Mono.
      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.

    • getWithResponse

      com.azure.core.http.rest.Response<ManagedHsmKeyInner> getWithResponse(String resourceGroupName, String name, String keyName, com.azure.core.util.Context context)
      Gets the current version of the specified key from the specified managed HSM.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      name - The name of the Managed HSM Pool within the specified resource group.
      keyName - The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.
      context - The context to associate with this operation.
      Returns:
      the current version of the specified key from the specified managed HSM 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.

    • get

      ManagedHsmKeyInner get(String resourceGroupName, String name, String keyName)
      Gets the current version of the specified key from the specified managed HSM.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      name - The name of the Managed HSM Pool within the specified resource group.
      keyName - The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.
      Returns:
      the current version of the specified key from the specified managed HSM.
      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.

    • listAsync

      com.azure.core.http.rest.PagedFlux<ManagedHsmKeyInner> listAsync(String resourceGroupName, String name)
      Lists the keys in the specified managed HSM.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      name - The name of the Managed HSM Pool within the specified resource group.
      Returns:
      the page of keys as paginated response with PagedFlux.
      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<ManagedHsmKeyInner> list(String resourceGroupName, String name)
      Lists the keys in the specified managed HSM.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      name - The name of the Managed HSM Pool within the specified resource group.
      Returns:
      the page of keys 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.

    • list

      com.azure.core.http.rest.PagedIterable<ManagedHsmKeyInner> list(String resourceGroupName, String name, com.azure.core.util.Context context)
      Lists the keys in the specified managed HSM.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      name - The name of the Managed HSM Pool within the specified resource group.
      context - The context to associate with this operation.
      Returns:
      the page of keys 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.

    • getVersionWithResponseAsync

      Mono<com.azure.core.http.rest.Response<ManagedHsmKeyInner>> getVersionWithResponseAsync(String resourceGroupName, String name, String keyName, String keyVersion)
      Gets the specified version of the specified key in the specified managed HSM.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      name - The name of the Managed HSM Pool within the specified resource group.
      keyName - The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.
      keyVersion - The version of the key to be retrieved.
      Returns:
      the specified version of the specified key in the specified managed HSM along with Response on successful completion of Mono.
      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.

    • getVersionAsync

      Mono<ManagedHsmKeyInner> getVersionAsync(String resourceGroupName, String name, String keyName, String keyVersion)
      Gets the specified version of the specified key in the specified managed HSM.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      name - The name of the Managed HSM Pool within the specified resource group.
      keyName - The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.
      keyVersion - The version of the key to be retrieved.
      Returns:
      the specified version of the specified key in the specified managed HSM on successful completion of Mono.
      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.

    • getVersionWithResponse

      com.azure.core.http.rest.Response<ManagedHsmKeyInner> getVersionWithResponse(String resourceGroupName, String name, String keyName, String keyVersion, com.azure.core.util.Context context)
      Gets the specified version of the specified key in the specified managed HSM.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      name - The name of the Managed HSM Pool within the specified resource group.
      keyName - The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.
      keyVersion - The version of the key to be retrieved.
      context - The context to associate with this operation.
      Returns:
      the specified version of the specified key in the specified managed HSM 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.

    • getVersion

      ManagedHsmKeyInner getVersion(String resourceGroupName, String name, String keyName, String keyVersion)
      Gets the specified version of the specified key in the specified managed HSM.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      name - The name of the Managed HSM Pool within the specified resource group.
      keyName - The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.
      keyVersion - The version of the key to be retrieved.
      Returns:
      the specified version of the specified key in the specified managed HSM.
      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.

    • listVersionsAsync

      com.azure.core.http.rest.PagedFlux<ManagedHsmKeyInner> listVersionsAsync(String resourceGroupName, String name, String keyName)
      Lists the versions of the specified key in the specified managed HSM.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      name - The name of the Managed HSM Pool within the specified resource group.
      keyName - The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.
      Returns:
      the page of keys as paginated response with PagedFlux.
      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.

    • listVersions

      com.azure.core.http.rest.PagedIterable<ManagedHsmKeyInner> listVersions(String resourceGroupName, String name, String keyName)
      Lists the versions of the specified key in the specified managed HSM.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      name - The name of the Managed HSM Pool within the specified resource group.
      keyName - The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.
      Returns:
      the page of keys 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.

    • listVersions

      com.azure.core.http.rest.PagedIterable<ManagedHsmKeyInner> listVersions(String resourceGroupName, String name, String keyName, com.azure.core.util.Context context)
      Lists the versions of the specified key in the specified managed HSM.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      name - The name of the Managed HSM Pool within the specified resource group.
      keyName - The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.
      context - The context to associate with this operation.
      Returns:
      the page of keys 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.