Module resty.azure.api.secrets

Module for interacting with Azure Key Vault secrets API.

Functions

delete (secret_name, secret_version) Deletes a secret from the Key Vault.
get (secret_name, secret_version) Retrieves a secret from the Key Vault.
new (parent_client, vault_uri) Constructor for creating a new secrets object.
purge (secret_name, secret_version) Purges a secret by name and version.
set (secret_name, secret_value) Sets a secret in the Key Vault.
update (secret_name, secret_version, secret_value) Updates a secret in the Key Vault.


Functions

delete (secret_name, secret_version)
Deletes a secret from the Key Vault.

Parameters:

  • secret_name The name of the secret.
  • secret_version The version of the secret.

Returns:

    The deleted secret object.
get (secret_name, secret_version)
Retrieves a secret from the Key Vault.

Parameters:

  • secret_name The name of the secret.
  • secret_version The version of the secret.

Returns:

    The secret value.
new (parent_client, vault_uri)
Constructor for creating a new secrets object.

Parameters:

  • parent_client The parent client object.
  • vault_uri The URI of the Key Vault.

Returns:

    A new secrets object.
purge (secret_name, secret_version)
Purges a secret by name and version.

Parameters:

  • secret_name The name of the secret to purge.
  • secret_version The version of the secret to purge.

Returns:

    The result of the delete_resource method.
set (secret_name, secret_value)
Sets a secret in the Key Vault.

Parameters:

  • secret_name The name of the secret.
  • secret_value The value of the secret.

Returns:

    The updated secret object.
update (secret_name, secret_version, secret_value)
Updates a secret in the Key Vault.

Parameters:

  • secret_name The name of the secret.
  • secret_version The version of the secret.
  • secret_value The new value of the secret.

Returns:

    The updated secret object.
generated by LDoc 1.5.0 Last updated 2024-03-29 13:25:29