Package com.azure.resourcemanager.keyvault.fluent

Interface KeysClient

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

  • Method Details

    • createIfNotExistWithResponseAsync

      Mono<com.azure.core.http.rest.Response<KeyInner>> createIfNotExistWithResponseAsync(String resourceGroupName, String vaultName, String keyName, KeyCreateParameters 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 which contains the specified key vault.
      vaultName - The name of the key vault which contains the key to be created.
      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<KeyInner> createIfNotExistAsync(String resourceGroupName, String vaultName, String keyName, KeyCreateParameters 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 which contains the specified key vault.
      vaultName - The name of the key vault which contains the key to be created.
      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<KeyInner> createIfNotExistWithResponse(String resourceGroupName, String vaultName, String keyName, KeyCreateParameters 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 which contains the specified key vault.
      vaultName - The name of the key vault which contains the key to be created.
      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

      KeyInner createIfNotExist(String resourceGroupName, String vaultName, String keyName, KeyCreateParameters 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 which contains the specified key vault.
      vaultName - The name of the key vault which contains the key to be created.
      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<KeyInner>> getWithResponseAsync(String resourceGroupName, String vaultName, String keyName)
      Gets the current version of the specified key from the specified key vault.
      Parameters:
      resourceGroupName - The name of the resource group which contains the specified key vault.
      vaultName - The name of the vault which contains the key to be retrieved.
      keyName - The name of the key to be retrieved.
      Returns:
      the current version of the specified key from the specified key vault 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<KeyInner> getAsync(String resourceGroupName, String vaultName, String keyName)
      Gets the current version of the specified key from the specified key vault.
      Parameters:
      resourceGroupName - The name of the resource group which contains the specified key vault.
      vaultName - The name of the vault which contains the key to be retrieved.
      keyName - The name of the key to be retrieved.
      Returns:
      the current version of the specified key from the specified key vault 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<KeyInner> getWithResponse(String resourceGroupName, String vaultName, String keyName, com.azure.core.util.Context context)
      Gets the current version of the specified key from the specified key vault.
      Parameters:
      resourceGroupName - The name of the resource group which contains the specified key vault.
      vaultName - The name of the vault which contains the key to be retrieved.
      keyName - The name of the key to be retrieved.
      context - The context to associate with this operation.
      Returns:
      the current version of the specified key from the specified key vault 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

      KeyInner get(String resourceGroupName, String vaultName, String keyName)
      Gets the current version of the specified key from the specified key vault.
      Parameters:
      resourceGroupName - The name of the resource group which contains the specified key vault.
      vaultName - The name of the vault which contains the key to be retrieved.
      keyName - The name of the key to be retrieved.
      Returns:
      the current version of the specified key from the specified key vault.
      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<KeyInner> listAsync(String resourceGroupName, String vaultName)
      Lists the keys in the specified key vault.
      Parameters:
      resourceGroupName - The name of the resource group which contains the specified key vault.
      vaultName - The name of the vault which contains the keys to be retrieved.
      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<KeyInner> list(String resourceGroupName, String vaultName)
      Lists the keys in the specified key vault.
      Parameters:
      resourceGroupName - The name of the resource group which contains the specified key vault.
      vaultName - The name of the vault which contains the keys to be retrieved.
      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<KeyInner> list(String resourceGroupName, String vaultName, com.azure.core.util.Context context)
      Lists the keys in the specified key vault.
      Parameters:
      resourceGroupName - The name of the resource group which contains the specified key vault.
      vaultName - The name of the vault which contains the keys to be retrieved.
      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<KeyInner>> getVersionWithResponseAsync(String resourceGroupName, String vaultName, String keyName, String keyVersion)
      Gets the specified version of the specified key in the specified key vault.
      Parameters:
      resourceGroupName - The name of the resource group which contains the specified key vault.
      vaultName - The name of the vault which contains the key version to be retrieved.
      keyName - The name of the key version to be retrieved.
      keyVersion - The version of the key to be retrieved.
      Returns:
      the specified version of the specified key in the specified key vault 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<KeyInner> getVersionAsync(String resourceGroupName, String vaultName, String keyName, String keyVersion)
      Gets the specified version of the specified key in the specified key vault.
      Parameters:
      resourceGroupName - The name of the resource group which contains the specified key vault.
      vaultName - The name of the vault which contains the key version to be retrieved.
      keyName - The name of the key version to be retrieved.
      keyVersion - The version of the key to be retrieved.
      Returns:
      the specified version of the specified key in the specified key vault 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<KeyInner> getVersionWithResponse(String resourceGroupName, String vaultName, String keyName, String keyVersion, com.azure.core.util.Context context)
      Gets the specified version of the specified key in the specified key vault.
      Parameters:
      resourceGroupName - The name of the resource group which contains the specified key vault.
      vaultName - The name of the vault which contains the key version to be retrieved.
      keyName - The name of the key version to be retrieved.
      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 key vault 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

      KeyInner getVersion(String resourceGroupName, String vaultName, String keyName, String keyVersion)
      Gets the specified version of the specified key in the specified key vault.
      Parameters:
      resourceGroupName - The name of the resource group which contains the specified key vault.
      vaultName - The name of the vault which contains the key version to be retrieved.
      keyName - The name of the key version to be retrieved.
      keyVersion - The version of the key to be retrieved.
      Returns:
      the specified version of the specified key in the specified key vault.
      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<KeyInner> listVersionsAsync(String resourceGroupName, String vaultName, String keyName)
      Lists the versions of the specified key in the specified key vault.
      Parameters:
      resourceGroupName - The name of the resource group which contains the specified key vault.
      vaultName - The name of the vault which contains the key versions to be retrieved.
      keyName - The name of the key versions to be retrieved.
      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<KeyInner> listVersions(String resourceGroupName, String vaultName, String keyName)
      Lists the versions of the specified key in the specified key vault.
      Parameters:
      resourceGroupName - The name of the resource group which contains the specified key vault.
      vaultName - The name of the vault which contains the key versions to be retrieved.
      keyName - The name of the key versions to be retrieved.
      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<KeyInner> listVersions(String resourceGroupName, String vaultName, String keyName, com.azure.core.util.Context context)
      Lists the versions of the specified key in the specified key vault.
      Parameters:
      resourceGroupName - The name of the resource group which contains the specified key vault.
      vaultName - The name of the vault which contains the key versions to be retrieved.
      keyName - The name of the key versions to be retrieved.
      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.