Share via

SecretsClient Interface

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

public interface SecretsClient

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

Method Summary

Modifier and Type Method and Description
abstract SecretInner createOrUpdate(String resourceGroupName, String vaultName, String secretName, SecretCreateOrUpdateParameters parameters)

Create or update a secret in a key vault in the specified subscription.
abstract Mono<SecretInner> createOrUpdateAsync(String resourceGroupName, String vaultName, String secretName, SecretCreateOrUpdateParameters parameters)

Create or update a secret in a key vault in the specified subscription.
abstract Response<SecretInner> createOrUpdateWithResponse(String resourceGroupName, String vaultName, String secretName, SecretCreateOrUpdateParameters parameters, Context context)

Create or update a secret in a key vault in the specified subscription.
abstract Mono<Response<SecretInner>> createOrUpdateWithResponseAsync(String resourceGroupName, String vaultName, String secretName, SecretCreateOrUpdateParameters parameters)

Create or update a secret in a key vault in the specified subscription.
abstract SecretInner get(String resourceGroupName, String vaultName, String secretName)

Gets the specified secret.
abstract Mono<SecretInner> getAsync(String resourceGroupName, String vaultName, String secretName)

Gets the specified secret.
abstract Response<SecretInner> getWithResponse(String resourceGroupName, String vaultName, String secretName, Context context)

Gets the specified secret.
abstract Mono<Response<SecretInner>> getWithResponseAsync(String resourceGroupName, String vaultName, String secretName)

Gets the specified secret.
abstract PagedIterable<SecretInner> list(String resourceGroupName, String vaultName)

The List operation gets information about the secrets in a vault.
abstract PagedIterable<SecretInner> list(String resourceGroupName, String vaultName, Integer top, Context context)

The List operation gets information about the secrets in a vault.
abstract PagedFlux<SecretInner> listAsync(String resourceGroupName, String vaultName)

The List operation gets information about the secrets in a vault.
abstract PagedFlux<SecretInner> listAsync(String resourceGroupName, String vaultName, Integer top)

The List operation gets information about the secrets in a vault.
abstract SecretInner update(String resourceGroupName, String vaultName, String secretName, SecretPatchParameters parameters)

Update a secret in the specified subscription.
abstract Mono<SecretInner> updateAsync(String resourceGroupName, String vaultName, String secretName, SecretPatchParameters parameters)

Update a secret in the specified subscription.
abstract Response<SecretInner> updateWithResponse(String resourceGroupName, String vaultName, String secretName, SecretPatchParameters parameters, Context context)

Update a secret in the specified subscription.
abstract Mono<Response<SecretInner>> updateWithResponseAsync(String resourceGroupName, String vaultName, String secretName, SecretPatchParameters parameters)

Update a secret in the specified subscription.

Method Details

createOrUpdate

public abstract SecretInner createOrUpdate(String resourceGroupName, String vaultName, String secretName, SecretCreateOrUpdateParameters parameters)

Create or update a secret in a key vault in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

Parameters:

resourceGroupName - The name of the Resource Group to which the vault belongs.
vaultName - Name of the vault.
secretName - Name of the secret. 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 - Parameters to create or update the secret.

Returns:

resource information with extended details.

createOrUpdateAsync

public abstract Mono createOrUpdateAsync(String resourceGroupName, String vaultName, String secretName, SecretCreateOrUpdateParameters parameters)

Create or update a secret in a key vault in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

Parameters:

resourceGroupName - The name of the Resource Group to which the vault belongs.
vaultName - Name of the vault.
secretName - Name of the secret. 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 - Parameters to create or update the secret.

Returns:

resource information with extended details on successful completion of Mono.

createOrUpdateWithResponse

public abstract Response createOrUpdateWithResponse(String resourceGroupName, String vaultName, String secretName, SecretCreateOrUpdateParameters parameters, Context context)

Create or update a secret in a key vault in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

Parameters:

resourceGroupName - The name of the Resource Group to which the vault belongs.
vaultName - Name of the vault.
secretName - Name of the secret. 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 - Parameters to create or update the secret.
context - The context to associate with this operation.

Returns:

resource information with extended details along with Response<T>.

createOrUpdateWithResponseAsync

public abstract Mono> createOrUpdateWithResponseAsync(String resourceGroupName, String vaultName, String secretName, SecretCreateOrUpdateParameters parameters)

Create or update a secret in a key vault in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

Parameters:

resourceGroupName - The name of the Resource Group to which the vault belongs.
vaultName - Name of the vault.
secretName - Name of the secret. 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 - Parameters to create or update the secret.

Returns:

resource information with extended details along with Response<T> on successful completion of Mono.

get

public abstract SecretInner get(String resourceGroupName, String vaultName, String secretName)

Gets the specified secret. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

Parameters:

resourceGroupName - The name of the Resource Group to which the vault belongs.
vaultName - The name of the vault.
secretName - The name of the secret.

Returns:

the specified secret.

getAsync

public abstract Mono getAsync(String resourceGroupName, String vaultName, String secretName)

Gets the specified secret. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

Parameters:

resourceGroupName - The name of the Resource Group to which the vault belongs.
vaultName - The name of the vault.
secretName - The name of the secret.

Returns:

the specified secret on successful completion of Mono.

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String vaultName, String secretName, Context context)

Gets the specified secret. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

Parameters:

resourceGroupName - The name of the Resource Group to which the vault belongs.
vaultName - The name of the vault.
secretName - The name of the secret.
context - The context to associate with this operation.

Returns:

the specified secret along with Response<T>.

getWithResponseAsync

public abstract Mono> getWithResponseAsync(String resourceGroupName, String vaultName, String secretName)

Gets the specified secret. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

Parameters:

resourceGroupName - The name of the Resource Group to which the vault belongs.
vaultName - The name of the vault.
secretName - The name of the secret.

Returns:

the specified secret along with Response<T> on successful completion of Mono.

list

public abstract PagedIterable list(String resourceGroupName, String vaultName)

The List operation gets information about the secrets in a vault. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

Parameters:

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

Returns:

list of secrets as paginated response with PagedIterable<T>.

list

public abstract PagedIterable list(String resourceGroupName, String vaultName, Integer top, Context context)

The List operation gets information about the secrets in a vault. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

Parameters:

resourceGroupName - The name of the Resource Group to which the vault belongs.
vaultName - The name of the vault.
top - Maximum number of results to return.
context - The context to associate with this operation.

Returns:

list of secrets as paginated response with PagedIterable<T>.

listAsync

public abstract PagedFlux listAsync(String resourceGroupName, String vaultName)

The List operation gets information about the secrets in a vault. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

Parameters:

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

Returns:

list of secrets as paginated response with PagedFlux<T>.

listAsync

public abstract PagedFlux listAsync(String resourceGroupName, String vaultName, Integer top)

The List operation gets information about the secrets in a vault. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

Parameters:

resourceGroupName - The name of the Resource Group to which the vault belongs.
vaultName - The name of the vault.
top - Maximum number of results to return.

Returns:

list of secrets as paginated response with PagedFlux<T>.

update

public abstract SecretInner update(String resourceGroupName, String vaultName, String secretName, SecretPatchParameters parameters)

Update a secret in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

Parameters:

resourceGroupName - The name of the Resource Group to which the vault belongs.
vaultName - Name of the vault.
secretName - Name of the secret.
parameters - Parameters to patch the secret.

Returns:

resource information with extended details.

updateAsync

public abstract Mono updateAsync(String resourceGroupName, String vaultName, String secretName, SecretPatchParameters parameters)

Update a secret in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

Parameters:

resourceGroupName - The name of the Resource Group to which the vault belongs.
vaultName - Name of the vault.
secretName - Name of the secret.
parameters - Parameters to patch the secret.

Returns:

resource information with extended details on successful completion of Mono.

updateWithResponse

public abstract Response updateWithResponse(String resourceGroupName, String vaultName, String secretName, SecretPatchParameters parameters, Context context)

Update a secret in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

Parameters:

resourceGroupName - The name of the Resource Group to which the vault belongs.
vaultName - Name of the vault.
secretName - Name of the secret.
parameters - Parameters to patch the secret.
context - The context to associate with this operation.

Returns:

resource information with extended details along with Response<T>.

updateWithResponseAsync

public abstract Mono> updateWithResponseAsync(String resourceGroupName, String vaultName, String secretName, SecretPatchParameters parameters)

Update a secret in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

Parameters:

resourceGroupName - The name of the Resource Group to which the vault belongs.
vaultName - Name of the vault.
secretName - Name of the secret.
parameters - Parameters to patch the secret.

Returns:

resource information with extended details along with Response<T> on successful completion of Mono.

Applies to