Share via

KeysClient Interface

  • Reference
Package:
com.azure.resourcemanager.keyvault.fluent
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-keyvault:2.44.0

public interface KeysClient

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

Method Summary

Modifier and Type Method and Description
abstract KeyInner createIfNotExist(String resourceGroupName, String vaultName, String keyName, KeyCreateParameters parameters)

Creates the first version of a new key if it does not exist.
abstract Mono<KeyInner> createIfNotExistAsync(String resourceGroupName, String vaultName, String keyName, KeyCreateParameters parameters)

Creates the first version of a new key if it does not exist.
abstract Response<KeyInner> createIfNotExistWithResponse(String resourceGroupName, String vaultName, String keyName, KeyCreateParameters parameters, Context context)

Creates the first version of a new key if it does not exist.
abstract Mono<Response<KeyInner>> createIfNotExistWithResponseAsync(String resourceGroupName, String vaultName, String keyName, KeyCreateParameters parameters)

Creates the first version of a new key if it does not exist.
abstract KeyInner get(String resourceGroupName, String vaultName, String keyName)

Gets the current version of the specified key from the specified key vault.
abstract Mono<KeyInner> getAsync(String resourceGroupName, String vaultName, String keyName)

Gets the current version of the specified key from the specified key vault.
abstract KeyInner getVersion(String resourceGroupName, String vaultName, String keyName, String keyVersion)

Gets the specified version of the specified key in the specified key vault.
abstract Mono<KeyInner> getVersionAsync(String resourceGroupName, String vaultName, String keyName, String keyVersion)

Gets the specified version of the specified key in the specified key vault.
abstract Response<KeyInner> getVersionWithResponse(String resourceGroupName, String vaultName, String keyName, String keyVersion, Context context)

Gets the specified version of the specified key in the specified key vault.
abstract Mono<Response<KeyInner>> getVersionWithResponseAsync(String resourceGroupName, String vaultName, String keyName, String keyVersion)

Gets the specified version of the specified key in the specified key vault.
abstract Response<KeyInner> getWithResponse(String resourceGroupName, String vaultName, String keyName, Context context)

Gets the current version of the specified key from the specified key vault.
abstract Mono<Response<KeyInner>> getWithResponseAsync(String resourceGroupName, String vaultName, String keyName)

Gets the current version of the specified key from the specified key vault.
abstract PagedIterable<KeyInner> list(String resourceGroupName, String vaultName)

Lists the keys in the specified key vault.
abstract PagedIterable<KeyInner> list(String resourceGroupName, String vaultName, Context context)

Lists the keys in the specified key vault.
abstract PagedFlux<KeyInner> listAsync(String resourceGroupName, String vaultName)

Lists the keys in the specified key vault.
abstract PagedIterable<KeyInner> listVersions(String resourceGroupName, String vaultName, String keyName)

Lists the versions of the specified key in the specified key vault.
abstract PagedIterable<KeyInner> listVersions(String resourceGroupName, String vaultName, String keyName, Context context)

Lists the versions of the specified key in the specified key vault.
abstract PagedFlux<KeyInner> listVersionsAsync(String resourceGroupName, String vaultName, String keyName)

Lists the versions of the specified key in the specified key vault.

Method Details

createIfNotExist

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

createIfNotExistAsync

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

createIfNotExistWithResponse

public abstract Response createIfNotExistWithResponse(String resourceGroupName, String vaultName, String keyName, KeyCreateParameters parameters, 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<T>.

createIfNotExistWithResponseAsync

public abstract Mono> 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<T> on successful completion of Mono.

get

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

getAsync

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

getVersion

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

getVersionAsync

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

getVersionWithResponse

public abstract Response getVersionWithResponse(String resourceGroupName, String vaultName, String keyName, String keyVersion, 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<T>.

getVersionWithResponseAsync

public abstract Mono> 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<T> on successful completion of Mono.

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String vaultName, String keyName, 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<T>.

getWithResponseAsync

public abstract Mono> 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<T> on successful completion of Mono.

list

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

list

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

listAsync

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

listVersions

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

listVersions

public abstract PagedIterable listVersions(String resourceGroupName, String vaultName, String keyName, 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<T>.

listVersionsAsync

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

Applies to