Interface SecretsClient
public interface SecretsClient
An instance of this class provides access to all the operations defined in SecretsClient.
-
Method Summary
Modifier and TypeMethodDescriptioncreateOrUpdate(String resourceGroupName, String vaultName, String secretName, SecretCreateOrUpdateParameters parameters) Create or update a secret in a key vault in the specified subscription.createOrUpdateAsync(String resourceGroupName, String vaultName, String secretName, SecretCreateOrUpdateParameters parameters) Create or update a secret in a key vault in the specified subscription.com.azure.core.http.rest.Response<SecretInner> createOrUpdateWithResponse(String resourceGroupName, String vaultName, String secretName, SecretCreateOrUpdateParameters parameters, com.azure.core.util.Context context) Create or update a secret in a key vault in the specified subscription.Mono<com.azure.core.http.rest.Response<SecretInner>> createOrUpdateWithResponseAsync(String resourceGroupName, String vaultName, String secretName, SecretCreateOrUpdateParameters parameters) Create or update a secret in a key vault in the specified subscription.Gets the specified secret.Gets the specified secret.com.azure.core.http.rest.Response<SecretInner> getWithResponse(String resourceGroupName, String vaultName, String secretName, com.azure.core.util.Context context) Gets the specified secret.Mono<com.azure.core.http.rest.Response<SecretInner>> getWithResponseAsync(String resourceGroupName, String vaultName, String secretName) Gets the specified secret.com.azure.core.http.rest.PagedIterable<SecretInner> The List operation gets information about the secrets in a vault.com.azure.core.http.rest.PagedIterable<SecretInner> The List operation gets information about the secrets in a vault.com.azure.core.http.rest.PagedFlux<SecretInner> The List operation gets information about the secrets in a vault.com.azure.core.http.rest.PagedFlux<SecretInner> The List operation gets information about the secrets in a vault.update(String resourceGroupName, String vaultName, String secretName, SecretPatchParameters parameters) Update a secret in the specified subscription.updateAsync(String resourceGroupName, String vaultName, String secretName, SecretPatchParameters parameters) Update a secret in the specified subscription.com.azure.core.http.rest.Response<SecretInner> updateWithResponse(String resourceGroupName, String vaultName, String secretName, SecretPatchParameters parameters, com.azure.core.util.Context context) Update a secret in the specified subscription.Mono<com.azure.core.http.rest.Response<SecretInner>> updateWithResponseAsync(String resourceGroupName, String vaultName, String secretName, SecretPatchParameters parameters) Update a secret in the specified subscription.
-
Method Details
-
createOrUpdateWithResponseAsync
Mono<com.azure.core.http.rest.Response<SecretInner>> 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
Responseon successful completion ofMono. - 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.
-
createOrUpdateAsync
Mono<SecretInner> 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. - 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.
-
createOrUpdateWithResponse
com.azure.core.http.rest.Response<SecretInner> createOrUpdateWithResponse(String resourceGroupName, String vaultName, String secretName, SecretCreateOrUpdateParameters parameters, com.azure.core.util.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. - 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.
-
createOrUpdate
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.
- 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.
-
updateWithResponseAsync
Mono<com.azure.core.http.rest.Response<SecretInner>> 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
Responseon successful completion ofMono. - 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.
-
updateAsync
Mono<SecretInner> 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. - 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.
-
updateWithResponse
com.azure.core.http.rest.Response<SecretInner> updateWithResponse(String resourceGroupName, String vaultName, String secretName, SecretPatchParameters parameters, com.azure.core.util.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. - 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.
-
update
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.
- 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<SecretInner>> 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
Responseon successful completion ofMono. - 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
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. - 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<SecretInner> getWithResponse(String resourceGroupName, String vaultName, String secretName, com.azure.core.util.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. - 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
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.
- 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<SecretInner> 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. - 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<SecretInner> 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. - 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<SecretInner> 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. - 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<SecretInner> list(String resourceGroupName, String vaultName, Integer top, com.azure.core.util.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. - 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.
-