Share via

ManagedHsmKeysClient Interface

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

public interface ManagedHsmKeysClient

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

Method Summary

Modifier and Type Method and Description
abstract ManagedHsmKeyInner createIfNotExist(String resourceGroupName, String name, String keyName, ManagedHsmKeyCreateParameters parameters)

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

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

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

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

Gets the current version of the specified key from the specified managed HSM.
abstract Mono<ManagedHsmKeyInner> getAsync(String resourceGroupName, String name, String keyName)

Gets the current version of the specified key from the specified managed HSM.
abstract ManagedHsmKeyInner getVersion(String resourceGroupName, String name, String keyName, String keyVersion)

Gets the specified version of the specified key in the specified managed HSM.
abstract Mono<ManagedHsmKeyInner> getVersionAsync(String resourceGroupName, String name, String keyName, String keyVersion)

Gets the specified version of the specified key in the specified managed HSM.
abstract Response<ManagedHsmKeyInner> getVersionWithResponse(String resourceGroupName, String name, String keyName, String keyVersion, Context context)

Gets the specified version of the specified key in the specified managed HSM.
abstract Mono<Response<ManagedHsmKeyInner>> getVersionWithResponseAsync(String resourceGroupName, String name, String keyName, String keyVersion)

Gets the specified version of the specified key in the specified managed HSM.
abstract Response<ManagedHsmKeyInner> getWithResponse(String resourceGroupName, String name, String keyName, Context context)

Gets the current version of the specified key from the specified managed HSM.
abstract Mono<Response<ManagedHsmKeyInner>> getWithResponseAsync(String resourceGroupName, String name, String keyName)

Gets the current version of the specified key from the specified managed HSM.
abstract PagedIterable<ManagedHsmKeyInner> list(String resourceGroupName, String name)

Lists the keys in the specified managed HSM.
abstract PagedIterable<ManagedHsmKeyInner> list(String resourceGroupName, String name, Context context)

Lists the keys in the specified managed HSM.
abstract PagedFlux<ManagedHsmKeyInner> listAsync(String resourceGroupName, String name)

Lists the keys in the specified managed HSM.
abstract PagedIterable<ManagedHsmKeyInner> listVersions(String resourceGroupName, String name, String keyName)

Lists the versions of the specified key in the specified managed HSM.
abstract PagedIterable<ManagedHsmKeyInner> listVersions(String resourceGroupName, String name, String keyName, Context context)

Lists the versions of the specified key in the specified managed HSM.
abstract PagedFlux<ManagedHsmKeyInner> listVersionsAsync(String resourceGroupName, String name, String keyName)

Lists the versions of the specified key in the specified managed HSM.

Method Details

createIfNotExist

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

createIfNotExistAsync

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

createIfNotExistWithResponse

public abstract Response createIfNotExistWithResponse(String resourceGroupName, String name, String keyName, ManagedHsmKeyCreateParameters 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. 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<T>.

createIfNotExistWithResponseAsync

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

get

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

getAsync

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

getVersion

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

getVersionAsync

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

getVersionWithResponse

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

getVersionWithResponseAsync

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

getWithResponse

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

getWithResponseAsync

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

list

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

list

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

listAsync

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

listVersions

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

listVersions

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

listVersionsAsync

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

Applies to