Module azure.keyvault
ballerinax/azure.keyvault Ballerina library
1.6.1
Overview
The Azure Key Vault API v7.0 connector(https://azure.microsoft.com/en-us/services/key-vault/) OpenAPI specification.
The Key Vault client performs cryptographic key operations and vault operations against the Key Vault service.
Key Features
- Programmatic access to create and manage resources via REST API
- Manage user accounts and profiles
- Secure authentication with API key or OAuth support
Prerequisites
- Create an Azure account
- Create an Azure Key Vault account
- Obtain tokens
- Use this guide to obtain the credentials which are needed to create the <ACCESS_TOKEN>
Quickstart
To use the Azure ey Vault connector in your Ballerina application, update the .bal file as follows:
Step 1 - Import connector
First, import the ballerinax/azure.keyvault module into the Ballerina project.
import ballerinax/azure.keyvault;
Step 2 - Create a new connector instance
You can now make the connection configuration using the access token.
keyvault:ConnectionConfig connectionConfig = { auth : { token: token } }; keyvault:Client baseClient = check new Client(connectionConfig, serviceUrl = "{vaultBaseUrl}");
Step 3 - Invoke connector operation
- List certificates
public function main() { keyvault:CertificateListResult|error cert = baseClient->getCertificates("7.0"); if (cert is keyvault:CertificateListResult) { log:printInfo(cert.toJsonString()); } else { test:assertFail(msg = cert.message()); } }
- Use
bal runcommand to compile and run the Ballerina program
Clients
azure.keyvault: Client
Isolated
This is a generated connector from Azure Key Vault API v7.0 OpenAPI specification. The Key Vault client performs cryptographic key operations and vault operations against the Key Vault service.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Create an Azure Key Vault account and obtain OAuth tokens following this guide.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string - URL of the target service
getCertificates
Isolated FunctionRemote Function
function getCertificates(string apiVersion, int? maxresults, boolean? includePending) returns CertificateListResult|errorList certificates in a specified key vault
Parameters
- apiVersion string - Client API version.
- maxresults int? (default ()) - Maximum number of results to return in a page. If not specified the service will return up to 25 results.
- includePending boolean? (default ()) - Specifies whether to include certificates which are not completely provisioned.
Return Type
- CertificateListResult|error - A response message containing a list of certificates along with a link to the next page of certificates.
getCertificateContacts
Isolated FunctionRemote Function
Lists the certificate contacts for a specified key vault.
Parameters
- apiVersion string - Client API version.
setCertificateContacts
Isolated FunctionRemote Function
Sets the certificate contacts for the specified key vault.
Parameters
- apiVersion string - Client API version.
- payload Contacts - The contacts for the key vault certificate.
deleteCertificateContacts
Isolated FunctionRemote Function
Deletes the certificate contacts for a specified key vault.
Parameters
- apiVersion string - Client API version.
getCertificateIssuers
Isolated FunctionRemote Function
function getCertificateIssuers(string apiVersion, int? maxresults) returns CertificateIssuerListResult|errorList certificate issuers for a specified key vault.
Parameters
- apiVersion string - Client API version.
- maxresults int? (default ()) - Maximum number of results to return in a page. If not specified the service will return up to 25 results.
Return Type
- CertificateIssuerListResult|error - A response message containing a list of certificate issuers in a key vault along with a link to the next page of certificate issuers.
getCertificateIssuer
Isolated FunctionRemote Function
function getCertificateIssuer(string issuerName, string apiVersion) returns IssuerBundle|errorLists the specified certificate issuer.
Return Type
- IssuerBundle|error - The issuer for the key vault certificate.
setCertificateIssuer
Isolated FunctionRemote Function
function setCertificateIssuer(string issuerName, string apiVersion, CertificateIssuerSetParameters payload) returns IssuerBundle|errorSets the specified certificate issuer.
Parameters
- issuerName string - The name of the issuer.
- apiVersion string - Client API version.
- payload CertificateIssuerSetParameters - Certificate issuer set parameter.
Return Type
- IssuerBundle|error - The issuer for the key vault certificate.
deleteCertificateIssuer
Isolated FunctionRemote Function
function deleteCertificateIssuer(string issuerName, string apiVersion) returns IssuerBundle|errorDeletes the specified certificate issuer.
Return Type
- IssuerBundle|error - The issuer for the key vault certificate.
updateCertificateIssuer
Isolated FunctionRemote Function
function updateCertificateIssuer(string issuerName, string apiVersion, CertificateIssuerUpdateParameters payload) returns IssuerBundle|errorUpdates the specified certificate issuer.
Parameters
- issuerName string - The name of the issuer.
- apiVersion string - Client API version.
- payload CertificateIssuerUpdateParameters - Certificate issuer update parameter.
Return Type
- IssuerBundle|error - The issuer for the key vault certificate.
restoreCertificate
Isolated FunctionRemote Function
function restoreCertificate(string apiVersion, CertificateRestoreParameters payload) returns CertificateBundle|errorRestores a backed up certificate to a vault.
Parameters
- apiVersion string - Client API version.
- payload CertificateRestoreParameters - The parameters to restore the certificate.
Return Type
- CertificateBundle|error - Restored certificate bundle in the vault.
deleteCertificate
Isolated FunctionRemote Function
function deleteCertificate(string certificateName, string apiVersion) returns DeletedCertificateBundle|errorDeletes a certificate from a specified key vault.
Parameters
- certificateName string - The name of the certificate.
- apiVersion string - Client API version.
Return Type
- DeletedCertificateBundle|error - The deleted certificate.
backupCertificate
Isolated FunctionRemote Function
function backupCertificate(string certificateName, string apiVersion) returns BackupCertificateResult|errorBacks up the specified certificate.
Parameters
- certificateName string - The name of the certificate.
- apiVersion string - Client API version.
Return Type
- BackupCertificateResult|error - The backup blob containing the backed up certificate.
createCertificate
Isolated FunctionRemote Function
function createCertificate(string certificateName, string apiVersion, CertificateCreateParameters payload) returns CertificateOperation|errorCreates a new certificate.
Parameters
- certificateName string - The name of the certificate.
- apiVersion string - Client API version.
- payload CertificateCreateParameters - The parameters to create a certificate.
Return Type
- CertificateOperation|error - Created certificate bundle.
importCertificate
Isolated FunctionRemote Function
function importCertificate(string certificateName, string apiVersion, CertificateImportParameters payload) returns CertificateBundle|errorImports a certificate into a specified key vault.
Parameters
- certificateName string - The name of the certificate.
- apiVersion string - Client API version.
- payload CertificateImportParameters - The parameters to import the certificate.
Return Type
- CertificateBundle|error - Imported certificate bundle to the vault.
getCertificateOperation
Isolated FunctionRemote Function
function getCertificateOperation(string certificateName, string apiVersion) returns CertificateOperation|errorGets the creation operation of a certificate.
Parameters
- certificateName string - The name of the certificate.
- apiVersion string - Client API version.
Return Type
- CertificateOperation|error - The certificate operation response.
deleteCertificateOperation
Isolated FunctionRemote Function
function deleteCertificateOperation(string certificateName, string apiVersion) returns CertificateOperation|errorDeletes the creation operation for a specific certificate.
Parameters
- certificateName string - The name of the certificate.
- apiVersion string - Client API version.
Return Type
- CertificateOperation|error - A message containing the certificate operation response.
updateCertificateOperation
Isolated FunctionRemote Function
function updateCertificateOperation(string certificateName, string apiVersion, CertificateOperationUpdateParameter payload) returns CertificateOperation|errorUpdates a certificate operation.
Parameters
- certificateName string - The name of the certificate.
- apiVersion string - Client API version.
- payload CertificateOperationUpdateParameter - The certificate operation response.
Return Type
- CertificateOperation|error - A message containing the certificate operation response.
mergeCertificate
Isolated FunctionRemote Function
function mergeCertificate(string certificateName, string apiVersion, CertificateMergeParameters payload) returns CertificateBundle|errorMerges a certificate or a certificate chain with a key pair existing on the server.
Parameters
- certificateName string - The name of the certificate.
- apiVersion string - Client API version.
- payload CertificateMergeParameters - The parameters to merge certificate.
Return Type
- CertificateBundle|error - Merged certificate bundle to the vault.
getCertificatePolicy
Isolated FunctionRemote Function
function getCertificatePolicy(string certificateName, string apiVersion) returns CertificatePolicy|errorLists the policy for a certificate.
Parameters
- certificateName string - The name of the certificate in a given key vault.
- apiVersion string - Client API version.
Return Type
- CertificatePolicy|error - The certificate policy.
updateCertificatePolicy
Isolated FunctionRemote Function
function updateCertificatePolicy(string certificateName, string apiVersion, CertificatePolicy payload) returns CertificatePolicy|errorUpdates the policy for a certificate.
Parameters
- certificateName string - The name of the certificate in the given vault.
- apiVersion string - Client API version.
- payload CertificatePolicy - The policy for the certificate.
Return Type
- CertificatePolicy|error - The certificate policy
getCertificateVersions
Isolated FunctionRemote Function
function getCertificateVersions(string certificateName, string apiVersion, int? maxresults) returns CertificateListResult|errorList the versions of a certificate.
Parameters
- certificateName string - The name of the certificate.
- apiVersion string - Client API version.
- maxresults int? (default ()) - Maximum number of results to return in a page. If not specified the service will return up to 25 results.
Return Type
- CertificateListResult|error - A response message containing a list of certificates in the key vault along with a link to the next page of keys.
getCertificate
Isolated FunctionRemote Function
function getCertificate(string certificateName, string certificateVersion, string apiVersion) returns CertificateBundle|errorGets information about a certificate.
Parameters
- certificateName string - The name of the certificate in the given vault.
- certificateVersion string - The version of the certificate.
- apiVersion string - Client API version.
Return Type
- CertificateBundle|error - The retrieved certificate.
updateCertificate
Isolated FunctionRemote Function
function updateCertificate(string certificateName, string certificateVersion, string apiVersion, CertificateUpdateParameters payload) returns CertificateBundle|errorUpdates the specified attributes associated with the given certificate.
Parameters
- certificateName string - The name of the certificate in the given key vault.
- certificateVersion string - The version of the certificate.
- apiVersion string - Client API version.
- payload CertificateUpdateParameters - The parameters for certificate update.
Return Type
- CertificateBundle|error - The updated certificate.
getDeletedCertificates
Isolated FunctionRemote Function
function getDeletedCertificates(string apiVersion, int? maxresults, boolean? includePending) returns DeletedCertificateListResult|errorLists the deleted certificates in the specified vault currently available for recovery.
Parameters
- apiVersion string - Client API version.
- maxresults int? (default ()) - Maximum number of results to return in a page. If not specified the service will return up to 25 results.
- includePending boolean? (default ()) - Specifies whether to include certificates which are not completely provisioned.
Return Type
- DeletedCertificateListResult|error - A response message containing a list of deleted certificates in the vault along with a link to the next page of deleted certificates
getDeletedCertificate
Isolated FunctionRemote Function
function getDeletedCertificate(string certificateName, string apiVersion) returns DeletedCertificateBundle|errorRetrieves information about the specified deleted certificate.
Parameters
- certificateName string - The name of the certificate
- apiVersion string - Client API version.
Return Type
- DeletedCertificateBundle|error - A Certificate bundle of the certificate and its attributes
purgeDeletedCertificate
Isolated FunctionRemote Function
Permanently deletes the specified deleted certificate.
Parameters
- certificateName string - The name of the certificate
- apiVersion string - Client API version.
recoverDeletedCertificate
Isolated FunctionRemote Function
function recoverDeletedCertificate(string certificateName, string apiVersion) returns CertificateBundle|errorRecovers the deleted certificate back to its current version under /certificates.
Parameters
- certificateName string - The name of the deleted certificate
- apiVersion string - Client API version.
Return Type
- CertificateBundle|error - A Certificate bundle of the original certificate and its attributes
getDeletedKeys
Isolated FunctionRemote Function
function getDeletedKeys(string apiVersion, int? maxresults) returns DeletedKeyListResult|errorLists the deleted keys in the specified vault.
Parameters
- apiVersion string - Client API version.
- maxresults int? (default ()) - Maximum number of results to return in a page. If not specified the service will return up to 25 results.
Return Type
- DeletedKeyListResult|error - A response message containing a list of deleted keys in the vault along with a link to the next page of deleted keys.
getDeletedKey
Isolated FunctionRemote Function
function getDeletedKey(string keyName, string apiVersion) returns DeletedKeyBundle|errorGets the public part of a deleted key.
Return Type
- DeletedKeyBundle|error - A DeletedKeyBundle consisting of a WebKey plus its Attributes and deletion information.
purgeDeletedKey
Isolated FunctionRemote Function
Permanently deletes the specified key.
recoverDeletedKey
Isolated FunctionRemote Function
Recovers the deleted key to its latest version.
getDeletedSecrets
Isolated FunctionRemote Function
function getDeletedSecrets(string apiVersion, int? maxresults) returns DeletedSecretListResult|errorLists deleted secrets for the specified vault.
Parameters
- apiVersion string - Client API version.
- maxresults int? (default ()) - Maximum number of results to return in a page. If not specified the service will return up to 25 results.
Return Type
- DeletedSecretListResult|error - A response message containing a list of deleted secrets in the vault, along with a link to the next page of deleted secrets.
getDeletedSecret
Isolated FunctionRemote Function
function getDeletedSecret(string secretName, string apiVersion) returns DeletedSecretBundle|errorGets the specified deleted secret.
Return Type
- DeletedSecretBundle|error - A secret bundle of the secret and its attributes.
purgeDeletedSecret
Isolated FunctionRemote Function
Permanently deletes the specified secret.
recoverDeletedSecret
Isolated FunctionRemote Function
function recoverDeletedSecret(string secretName, string apiVersion) returns SecretBundle|errorRecovers the deleted secret to the latest version.
Parameters
- secretName string - The name of the deleted secret.
- apiVersion string - Client API version.
Return Type
- SecretBundle|error - A Secret bundle of the original secret and its attributes.
getDeletedStorageAccounts
Isolated FunctionRemote Function
function getDeletedStorageAccounts(string apiVersion, int? maxresults) returns DeletedStorageListResult|errorLists deleted storage accounts for the specified vault.
Parameters
- apiVersion string - Client API version.
- maxresults int? (default ()) - Maximum number of results to return in a page. If not specified the service will return up to 25 results.
Return Type
- DeletedStorageListResult|error - A response message containing a list of deleted storage accounts in the vault, along with a link to the next page of deleted storage accounts.
getDeletedStorageAccount
Isolated FunctionRemote Function
function getDeletedStorageAccount(string storageAccountName, string apiVersion) returns DeletedStorageBundle|errorGets the specified deleted storage account.
Parameters
- storageAccountName string - The name of the storage account.
- apiVersion string - Client API version.
Return Type
- DeletedStorageBundle|error - The deleted storage account and information on when it will be purged, and how to recover the deleted storage account.
purgeDeletedStorageAccount
Isolated FunctionRemote Function
function purgeDeletedStorageAccount(string storageAccountName, string apiVersion) returns Response|errorPermanently deletes the specified storage account.
Parameters
- storageAccountName string - The name of the storage account.
- apiVersion string - Client API version.
recoverDeletedStorageAccount
Isolated FunctionRemote Function
function recoverDeletedStorageAccount(string storageAccountName, string apiVersion) returns StorageBundle|errorRecovers the deleted storage account.
Parameters
- storageAccountName string - The name of the storage account.
- apiVersion string - Client API version.
Return Type
- StorageBundle|error - A storage bundle of the original storage account and its attributes.
getDeletedSasDefinitions
Isolated FunctionRemote Function
function getDeletedSasDefinitions(string storageAccountName, string apiVersion, int? maxresults) returns DeletedSasDefinitionListResult|errorLists deleted SAS definitions for the specified vault and storage account.
Parameters
- storageAccountName string - The name of the storage account.
- apiVersion string - Client API version.
- maxresults int? (default ()) - Maximum number of results to return in a page. If not specified the service will return up to 25 results.
Return Type
- DeletedSasDefinitionListResult|error - A response message containing a list of deleted SAS definitions for the storage account, along with a link to the next page of deleted SAS definitions.
getDeletedSasDefinition
Isolated FunctionRemote Function
function getDeletedSasDefinition(string storageAccountName, string sasDefinitionName, string apiVersion) returns DeletedSasDefinitionBundle|errorGets the specified deleted sas definition.
Parameters
- storageAccountName string - The name of the storage account.
- sasDefinitionName string - The name of the SAS definition.
- apiVersion string - Client API version.
Return Type
- DeletedSasDefinitionBundle|error - The deleted SAS definition and information on when the it will be purged, and how to recover the deleted SAS definition.
recoverDeletedSasDefinition
Isolated FunctionRemote Function
function recoverDeletedSasDefinition(string storageAccountName, string sasDefinitionName, string apiVersion) returns SasDefinitionBundle|errorRecovers the deleted SAS definition.
Parameters
- storageAccountName string - The name of the storage account.
- sasDefinitionName string - The name of the SAS definition.
- apiVersion string - Client API version.
Return Type
- SasDefinitionBundle|error - A SAS definition bundle of the original SAS definition and its attributes.
getKeys
Isolated FunctionRemote Function
function getKeys(string apiVersion, int? maxresults) returns KeyListResult|errorList keys in the specified vault.
Parameters
- apiVersion string - Client API version.
- maxresults int? (default ()) - Maximum number of results to return in a page. If not specified the service will return up to 25 results.
Return Type
- KeyListResult|error - A response message containing a list of keys in the vault along with a link to the next page of keys.
restoreKey
Isolated FunctionRemote Function
function restoreKey(string apiVersion, KeyRestoreParameters payload) returns KeyBundle|errorRestores a backed up key to a vault.
Parameters
- apiVersion string - Client API version.
- payload KeyRestoreParameters - The parameters to restore the key.
importKey
Isolated FunctionRemote Function
function importKey(string keyName, string apiVersion, KeyImportParameters payload) returns KeyBundle|errorImports an externally created key, stores it, and returns key parameters and attributes to the client.
Parameters
- keyName string - Name for the imported key.
- apiVersion string - Client API version.
- payload KeyImportParameters - The parameters to import a key.
deleteKey
Isolated FunctionRemote Function
function deleteKey(string keyName, string apiVersion) returns DeletedKeyBundle|errorDeletes a key of any type from storage in Azure Key Vault.
Return Type
- DeletedKeyBundle|error - The public part of the deleted key and deletion information on when the key will be purged.
backupKey
Isolated FunctionRemote Function
function backupKey(string keyName, string apiVersion) returns BackupKeyResult|errorRequests that a backup of the specified key be downloaded to the client.
Return Type
- BackupKeyResult|error - The backup blob containing the backed up key.
createKey
Isolated FunctionRemote Function
function createKey(string keyName, string apiVersion, KeyCreateParameters payload) returns KeyBundle|errorCreates a new key, stores it, then returns key parameters and attributes to the client.
Parameters
- keyName string - The name for the new key. The system will generate the version name for the new key.
- apiVersion string - Client API version.
- payload KeyCreateParameters - The parameters to create a key.
getKeyVersions
Isolated FunctionRemote Function
function getKeyVersions(string keyName, string apiVersion, int? maxresults) returns KeyListResult|errorRetrieves a list of individual key versions with the same key name.
Parameters
- keyName string - The name of the key.
- apiVersion string - Client API version.
- maxresults int? (default ()) - Maximum number of results to return in a page. If not specified the service will return up to 25 results.
Return Type
- KeyListResult|error - A response message containing a list of keys along with a link to the next page of keys.
getKey
Isolated FunctionRemote Function
Gets the public part of a stored key.
Parameters
- keyName string - The name of the key to get.
- keyVersion string - Adding the version parameter retrieves a specific version of a key.
- apiVersion string - Client API version.
updateKey
Isolated FunctionRemote Function
function updateKey(string keyName, string keyVersion, string apiVersion, KeyUpdateParameters payload) returns KeyBundle|errorThe update key operation changes specified attributes of a stored key and can be applied to any key type and key version stored in Azure Key Vault.
Parameters
- keyName string - The name of key to update.
- keyVersion string - The version of the key to update.
- apiVersion string - Client API version.
- payload KeyUpdateParameters - The parameters of the key to update.
decrypt
Isolated FunctionRemote Function
function decrypt(string keyName, string keyVersion, string apiVersion, KeyOperationsParameters payload) returns KeyOperationResult|errorDecrypts a single block of encrypted data.
Parameters
- keyName string - The name of the key.
- keyVersion string - The version of the key.
- apiVersion string - Client API version.
- payload KeyOperationsParameters - The parameters for the decryption operation.
Return Type
- KeyOperationResult|error - The decryption result.
encrypt
Isolated FunctionRemote Function
function encrypt(string keyName, string keyVersion, string apiVersion, KeyOperationsParameters payload) returns KeyOperationResult|errorEncrypts an arbitrary sequence of bytes using an encryption key that is stored in a key vault.
Parameters
- keyName string - The name of the key.
- keyVersion string - The version of the key.
- apiVersion string - Client API version.
- payload KeyOperationsParameters - The parameters for the encryption operation.
Return Type
- KeyOperationResult|error - The encryption result.
sign
Isolated FunctionRemote Function
function sign(string keyName, string keyVersion, string apiVersion, KeySignParameters payload) returns KeyOperationResult|errorCreates a signature from a digest using the specified key.
Parameters
- keyName string - The name of the key.
- keyVersion string - The version of the key.
- apiVersion string - Client API version.
- payload KeySignParameters - The parameters for the signing operation.
Return Type
- KeyOperationResult|error - The signature value.
unwrapKey
Isolated FunctionRemote Function
function unwrapKey(string keyName, string keyVersion, string apiVersion, KeyOperationsParameters payload) returns KeyOperationResult|errorUnwraps a symmetric key using the specified key that was initially used for wrapping that key.
Parameters
- keyName string - The name of the key.
- keyVersion string - The version of the key.
- apiVersion string - Client API version.
- payload KeyOperationsParameters - The parameters for the key operation.
Return Type
- KeyOperationResult|error - The unwrapped symmetric key.
verify
Isolated FunctionRemote Function
function verify(string keyName, string keyVersion, string apiVersion, KeyVerifyParameters payload) returns KeyVerifyResult|errorVerifies a signature using a specified key.
Parameters
- keyName string - The name of the key.
- keyVersion string - The version of the key.
- apiVersion string - Client API version.
- payload KeyVerifyParameters - The parameters for verify operations.
Return Type
- KeyVerifyResult|error - The verification result.
wrapKey
Isolated FunctionRemote Function
function wrapKey(string keyName, string keyVersion, string apiVersion, KeyOperationsParameters payload) returns KeyOperationResult|errorWraps a symmetric key using a specified key.
Parameters
- keyName string - The name of the key.
- keyVersion string - The version of the key.
- apiVersion string - Client API version.
- payload KeyOperationsParameters - The parameters for wrap operation.
Return Type
- KeyOperationResult|error - The wrapped symmetric key.
getSecrets
Isolated FunctionRemote Function
function getSecrets(string apiVersion, int? maxresults) returns SecretListResult|errorList secrets in a specified key vault.
Parameters
- apiVersion string - Client API version.
- maxresults int? (default ()) - Maximum number of results to return in a page. If not specified, the service will return up to 25 results.
Return Type
- SecretListResult|error - A response message containing a list of secrets in the vault along with a link to the next page of secrets.
restoreSecret
Isolated FunctionRemote Function
function restoreSecret(string apiVersion, SecretRestoreParameters payload) returns SecretBundle|errorRestores a backed up secret to a vault.
Parameters
- apiVersion string - Client API version.
- payload SecretRestoreParameters - The parameters to restore the secret.
Return Type
- SecretBundle|error - Restored secret bundle in the vault.
setSecret
Isolated FunctionRemote Function
function setSecret(string secretName, string apiVersion, SecretSetParameters payload) returns SecretBundle|errorSets a secret in a specified key vault.
Parameters
- secretName string - The name of the secret.
- apiVersion string - Client API version.
- payload SecretSetParameters - The parameters for setting the secret.
Return Type
- SecretBundle|error - A secret bundle containing the result of the set secret request.
deleteSecret
Isolated FunctionRemote Function
function deleteSecret(string secretName, string apiVersion) returns DeletedSecretBundle|errorDeletes a secret from a specified key vault.
Return Type
- DeletedSecretBundle|error - The deleted secret and information on when the secret will be deleted, and how to recover the deleted secret.
backupSecret
Isolated FunctionRemote Function
function backupSecret(string secretName, string apiVersion) returns BackupSecretResult|errorBacks up the specified secret.
Return Type
- BackupSecretResult|error - The backup blob containing the backed up secret.
getSecretVersions
Isolated FunctionRemote Function
function getSecretVersions(string secretName, string apiVersion, int? maxresults) returns SecretListResult|errorList all versions of the specified secret.
Parameters
- secretName string - The name of the secret.
- apiVersion string - Client API version.
- maxresults int? (default ()) - Maximum number of results to return in a page. If not specified, the service will return up to 25 results.
Return Type
- SecretListResult|error - A response message containing a list of secrets along with a link to the next page of secrets.
getSecret
Isolated FunctionRemote Function
function getSecret(string secretName, string secretVersion, string apiVersion) returns SecretBundle|errorGet a specified secret from a given key vault.
Parameters
- secretName string - The name of the secret.
- secretVersion string - The version of the secret.
- apiVersion string - Client API version.
Return Type
- SecretBundle|error - The retrieved secret.
updateSecret
Isolated FunctionRemote Function
function updateSecret(string secretName, string secretVersion, string apiVersion, SecretUpdateParameters payload) returns SecretBundle|errorUpdates the attributes associated with a specified secret in a given key vault.
Parameters
- secretName string - The name of the secret.
- secretVersion string - The version of the secret.
- apiVersion string - Client API version.
- payload SecretUpdateParameters - The parameters for update secret operation.
Return Type
- SecretBundle|error - The updated secret.
getStorageAccounts
Isolated FunctionRemote Function
function getStorageAccounts(string apiVersion, int? maxresults) returns StorageListResult|errorList storage accounts managed by the specified key vault. This operation requires the storage/list permission.
Parameters
- apiVersion string - Client API version.
- maxresults int? (default ()) - Maximum number of results to return in a page. If not specified the service will return up to 25 results.
Return Type
- StorageListResult|error - A response message containing a list of storage accounts along with a link to the next page of storage accounts.
restoreStorageAccount
Isolated FunctionRemote Function
function restoreStorageAccount(string apiVersion, StorageRestoreParameters payload) returns StorageBundle|errorRestores a backed up storage account to a vault.
Parameters
- apiVersion string - Client API version.
- payload StorageRestoreParameters - The parameters to restore the storage account.
Return Type
- StorageBundle|error - Restored storage account bundle in the vault.
getStorageAccount
Isolated FunctionRemote Function
function getStorageAccount(string storageAccountName, string apiVersion) returns StorageBundle|errorGets information about a specified storage account. This operation requires the storage/get permission.
Parameters
- storageAccountName string - The name of the storage account.
- apiVersion string - Client API version.
Return Type
- StorageBundle|error - The retrieved storage account.
setStorageAccount
Isolated FunctionRemote Function
function setStorageAccount(string storageAccountName, string apiVersion, StorageAccountCreateParameters payload) returns StorageBundle|errorCreates or updates a new storage account. This operation requires the storage/set permission.
Parameters
- storageAccountName string - The name of the storage account.
- apiVersion string - Client API version.
- payload StorageAccountCreateParameters - The parameters to create a storage account.
Return Type
- StorageBundle|error - The created storage account.
deleteStorageAccount
Isolated FunctionRemote Function
function deleteStorageAccount(string storageAccountName, string apiVersion) returns DeletedStorageBundle|errorDeletes a storage account. This operation requires the storage/delete permission.
Parameters
- storageAccountName string - The name of the storage account.
- apiVersion string - Client API version.
Return Type
- DeletedStorageBundle|error - The deleted storage account and information on when the storage account will be deleted, and how to recover the deleted storage account.
updateStorageAccount
Isolated FunctionRemote Function
function updateStorageAccount(string storageAccountName, string apiVersion, StorageAccountUpdateParameters payload) returns StorageBundle|errorUpdates the specified attributes associated with the given storage account. This operation requires the storage/set/update permission.
Parameters
- storageAccountName string - The name of the storage account.
- apiVersion string - Client API version.
- payload StorageAccountUpdateParameters - The parameters to update a storage account.
Return Type
- StorageBundle|error - The updated storage account.
backupStorageAccount
Isolated FunctionRemote Function
function backupStorageAccount(string storageAccountName, string apiVersion) returns BackupStorageResult|errorBacks up the specified storage account.
Parameters
- storageAccountName string - The name of the storage account.
- apiVersion string - Client API version.
Return Type
- BackupStorageResult|error - The backup blob containing the backed up storage account.
regenerateStorageAccountKey
Isolated FunctionRemote Function
function regenerateStorageAccountKey(string storageAccountName, string apiVersion, StorageAccountRegenerteKeyParameters payload) returns StorageBundle|errorRegenerates the specified key value for the given storage account. This operation requires the storage/regeneratekey permission.
Parameters
- storageAccountName string - The name of the storage account.
- apiVersion string - Client API version.
- payload StorageAccountRegenerteKeyParameters - The parameters to regenerate storage account key.
Return Type
- StorageBundle|error - The updated storage account.
getSasDefinitions
Isolated FunctionRemote Function
function getSasDefinitions(string storageAccountName, string apiVersion, int? maxresults) returns SasDefinitionListResult|errorList storage SAS definitions for the given storage account. This operation requires the storage/listsas permission.
Parameters
- storageAccountName string - The name of the storage account.
- apiVersion string - Client API version.
- maxresults int? (default ()) - Maximum number of results to return in a page. If not specified the service will return up to 25 results.
Return Type
- SasDefinitionListResult|error - A response message containing a list of SAS definitions along with a link to the next page of SAS definitions.
getSasDefinition
Isolated FunctionRemote Function
function getSasDefinition(string storageAccountName, string sasDefinitionName, string apiVersion) returns SasDefinitionBundle|errorGets information about a SAS definition for the specified storage account. This operation requires the storage/getsas permission.
Parameters
- storageAccountName string - The name of the storage account.
- sasDefinitionName string - The name of the SAS definition.
- apiVersion string - Client API version.
Return Type
- SasDefinitionBundle|error - The retrieved SAS definition.
setSasDefinition
Isolated FunctionRemote Function
function setSasDefinition(string storageAccountName, string sasDefinitionName, string apiVersion, SasDefinitionCreateParameters payload) returns SasDefinitionBundle|errorCreates or updates a new SAS definition for the specified storage account. This operation requires the storage/setsas permission.
Parameters
- storageAccountName string - The name of the storage account.
- sasDefinitionName string - The name of the SAS definition.
- apiVersion string - Client API version.
- payload SasDefinitionCreateParameters - The parameters to create a SAS definition.
Return Type
- SasDefinitionBundle|error - The created SAS definition.
deleteSasDefinition
Isolated FunctionRemote Function
function deleteSasDefinition(string storageAccountName, string sasDefinitionName, string apiVersion) returns DeletedSasDefinitionBundle|errorDeletes a SAS definition from a specified storage account. This operation requires the storage/deletesas permission.
Parameters
- storageAccountName string - The name of the storage account.
- sasDefinitionName string - The name of the SAS definition.
- apiVersion string - Client API version.
Return Type
- DeletedSasDefinitionBundle|error - The deleted SAS definition and information on when the SAS definition will be deleted, and how to recover the deleted SAS definition.
updateSasDefinition
Isolated FunctionRemote Function
function updateSasDefinition(string storageAccountName, string sasDefinitionName, string apiVersion, SasDefinitionUpdateParameters payload) returns SasDefinitionBundle|errorUpdates the specified attributes associated with the given SAS definition. This operation requires the storage/setsas permission.
Parameters
- storageAccountName string - The name of the storage account.
- sasDefinitionName string - The name of the SAS definition.
- apiVersion string - Client API version.
- payload SasDefinitionUpdateParameters - The parameters to update a SAS definition.
Return Type
- SasDefinitionBundle|error - The updated SAS definition.
Records
azure.keyvault: Action
The action that will be executed.
Fields
- action_type? string - The type of the action.
azure.keyvault: AdministratorDetails
Details of the organization administrator of the certificate issuer.
Fields
- email? string - Email address.
- first_name? string - First name.
- last_name? string - Last name.
- phone? string - Phone number.
azure.keyvault: Attributes
The object attributes managed by the KeyVault service.
Fields
- created? int - Creation time in UTC.
- enabled? boolean - Determines whether the object is enabled.
- exp? int - Expiry date in UTC.
- nbf? int - Not before date in UTC.
- updated? int - Last updated time in UTC.
azure.keyvault: BackupCertificateResult
The backup certificate result, containing the backup blob.
Fields
- value? string - The backup blob containing the backed up certificate.
azure.keyvault: BackupKeyResult
The backup key result, containing the backup blob.
Fields
- value? string - The backup blob containing the backed up key.
azure.keyvault: BackupSecretResult
The backup secret result, containing the backup blob.
Fields
- value? string - The backup blob containing the backed up secret.
azure.keyvault: BackupStorageResult
The backup storage result, containing the backup blob.
Fields
- value? string - The backup blob containing the backed up storage account.
azure.keyvault: CertificateBundle
A certificate bundle consists of a certificate (X509) plus its attributes.
Fields
- attributes? CertificateAttributes - The certificate management attributes.
- cer? string - CER contents of x509 certificate.
- contentType? string - The content type of the secret.
- id? string - The certificate id.
- kid? string - The key id.
- policy? CertificatePolicy - Management policy for a certificate.
- sid? string - The secret id.
- x5t? string - Thumbprint of the certificate.
azure.keyvault: CertificateCreateParameters
The certificate create parameters.
Fields
- attributes? CertificateAttributes - The certificate management attributes.
- policy? CertificatePolicy - Management policy for a certificate.
azure.keyvault: CertificateImportParameters
The certificate import parameters.
Fields
- attributes? CertificateAttributes - The certificate management attributes.
- policy? CertificatePolicy - Management policy for a certificate.
- pwd? string - If the private key in base64EncodedCertificate is encrypted, the password used for encryption.
- value string - Base64 encoded representation of the certificate object to import. This certificate needs to contain the private key.
azure.keyvault: CertificateIssuerItem
The certificate issuer item containing certificate issuer metadata.
Fields
- id? string - Certificate Identifier.
- provider? string - The issuer provider.
azure.keyvault: CertificateIssuerListResult
The certificate issuer list result.
Fields
- nextLink? string? - The URL to get the next set of certificate issuers.
- value? CertificateIssuerItem[] - A response message containing a list of certificate issuers in the key vault along with a link to the next page of certificate issuers.
azure.keyvault: CertificateIssuerSetParameters
The certificate issuer set parameters.
Fields
- attributes? IssuerAttributes - The attributes of an issuer managed by the Key Vault service.
- credentials? IssuerCredentials - The credentials to be used for the certificate issuer.
- org_details? OrganizationDetails - Details of the organization of the certificate issuer.
- provider string - The issuer provider.
azure.keyvault: CertificateIssuerUpdateParameters
The certificate issuer update parameters.
Fields
- attributes? IssuerAttributes - The attributes of an issuer managed by the Key Vault service.
- credentials? IssuerCredentials - The credentials to be used for the certificate issuer.
- org_details? OrganizationDetails - Details of the organization of the certificate issuer.
- provider? string - The issuer provider.
azure.keyvault: CertificateItem
The certificate item containing certificate metadata.
Fields
- attributes? CertificateAttributes - The certificate management attributes.
- id? string - Certificate identifier.
- x5t? string - Thumbprint of the certificate.
azure.keyvault: CertificateListResult
The certificate list result.
Fields
- nextLink? string? - The URL to get the next set of certificates.
- value? CertificateItem[] - A response message containing a list of certificates in the key vault along with a link to the next page of certificates.
azure.keyvault: CertificateMergeParameters
The certificate merge parameters
Fields
- attributes? CertificateAttributes - The certificate management attributes.
- x5c string[] - The certificate or the certificate chain to merge.
azure.keyvault: CertificateOperation
A certificate operation is returned in case of asynchronous requests.
Fields
- cancellation_requested? boolean - Indicates if cancellation was requested on the certificate operation.
- csr? string - The certificate signing request (CSR) that is being used in the certificate operation.
- 'error? Error - The key vault server error.
- id? string - The certificate id.
- issuer? IssuerParameters - Parameters for the issuer of the X509 component of a certificate.
- request_id? string - Identifier for the certificate operation.
- status? string - Status of the certificate operation.
- status_details? string - The status details of the certificate operation.
- target? string - Location which contains the result of the certificate operation.
azure.keyvault: CertificateOperationUpdateParameter
The certificate operation update parameters.
Fields
- cancellation_requested boolean - Indicates if cancellation was requested on the certificate operation.
azure.keyvault: CertificatePolicy
Management policy for a certificate.
Fields
- attributes? CertificateAttributes - The certificate management attributes.
- id? string - The certificate id.
- issuer? IssuerParameters - Parameters for the issuer of the X509 component of a certificate.
- key_props? KeyProperties - Properties of the key pair backing a certificate.
- lifetime_actions? LifetimeAction[] - Actions that will be performed by Key Vault over the lifetime of a certificate.
- secret_props? SecretProperties - Properties of the key backing a certificate.
- x509_props? X509CertificateProperties - Properties of the X509 component of a certificate.
azure.keyvault: CertificateRestoreParameters
The certificate restore parameters.
Fields
- value string - The backup blob associated with a certificate bundle.
azure.keyvault: CertificateUpdateParameters
The certificate update parameters.
Fields
- attributes? CertificateAttributes - The certificate management attributes.
- policy? CertificatePolicy - Management policy for a certificate.
azure.keyvault: ClientHttp1Settings
Closed record
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy? ProxyConfig - Proxy server related options
azure.keyvault: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_1_1) - The HTTP version understood by the client
- http1Settings? ClientHttp1Settings - Configurations related to HTTP/1.x protocol
- http2Settings? ClientHttp2Settings - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache? CacheConfig - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- responseLimits? ResponseLimitConfigs - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
azure.keyvault: Contact
The contact information for the vault certificates.
Fields
- email? string - Email address.
- name? string - Name.
- phone? string - Phone number.
azure.keyvault: Contacts
The contacts for the vault certificates.
Fields
- contacts? Contact[] - The contact list for the vault certificates.
- id? string - Identifier for the contacts collection.
azure.keyvault: DeletedCertificateListResult
A list of certificates that have been deleted in this vault.
Fields
- nextLink? string? - The URL to get the next set of deleted certificates.
- value? DeletedCertificateItem[] - A response message containing a list of deleted certificates in the vault along with a link to the next page of deleted certificates
azure.keyvault: DeletedKeyListResult
A list of keys that have been deleted in this vault.
Fields
- nextLink? string? - The URL to get the next set of deleted keys.
- value? DeletedKeyItem[] - A response message containing a list of deleted keys in the vault along with a link to the next page of deleted keys
azure.keyvault: DeletedSasDefinitionListResult
The deleted SAS definition list result
Fields
- nextLink? string? - The URL to get the next set of deleted SAS definitions.
- value? DeletedSasDefinitionItem[] - A response message containing a list of the deleted SAS definitions in the vault along with a link to the next page of deleted sas definitions
azure.keyvault: DeletedSecretListResult
The deleted secret list result
Fields
- nextLink? string? - The URL to get the next set of deleted secrets.
- value? DeletedSecretItem[] - A response message containing a list of the deleted secrets in the vault along with a link to the next page of deleted secrets
azure.keyvault: DeletedStorageListResult
The deleted storage account list result
Fields
- nextLink? string? - The URL to get the next set of deleted storage accounts.
- value? DeletedStorageAccountItem[] - A response message containing a list of the deleted storage accounts in the vault along with a link to the next page of deleted storage accounts
azure.keyvault: Error
The key vault server error.
Fields
- code? string - The error code.
- innererror? Error - The key vault server error.
- message? string - The error message.
azure.keyvault: IssuerAttributes
The attributes of an issuer managed by the Key Vault service.
Fields
- created? int - Creation time in UTC.
- enabled? boolean - Determines whether the issuer is enabled.
- updated? int - Last updated time in UTC.
azure.keyvault: IssuerBundle
The issuer for Key Vault certificate.
Fields
- attributes? IssuerAttributes - The attributes of an issuer managed by the Key Vault service.
- credentials? IssuerCredentials - The credentials to be used for the certificate issuer.
- id? string - Identifier for the issuer object.
- org_details? OrganizationDetails - Details of the organization of the certificate issuer.
- provider? string - The issuer provider.
azure.keyvault: IssuerCredentials
The credentials to be used for the certificate issuer.
Fields
- account_id? string - The user name/account name/account id.
- pwd? string - The password/secret/account key.
azure.keyvault: IssuerParameters
Parameters for the issuer of the X509 component of a certificate.
Fields
- cert_transparency? boolean - Indicates if the certificates generated under this policy should be published to certificate transparency logs.
- cty? string - Certificate type as supported by the provider (optional); for example 'OV-SSL', 'EV-SSL'
- name? string - Name of the referenced issuer object or reserved names; for example, 'Self' or 'Unknown'.
azure.keyvault: JsonWebKey
As of http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
Fields
- crv? string - Elliptic curve name. For valid values, see JsonWebKeyCurveName.
- d? string - RSA private exponent, or the D component of an EC private key.
- dp? string - RSA private key parameter.
- dq? string - RSA private key parameter.
- e? string - RSA public exponent.
- k? string - Symmetric key.
- key_hsm? string - HSM Token, used with 'Bring Your Own Key'.
- key_ops? string[] - Supported key operations.
- kid? string - Key identifier.
- kty? string - JsonWebKey Key Type (kty), as defined in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
- n? string - RSA modulus.
- p? string - RSA secret prime.
- q? string - RSA secret prime, with p < q.
- qi? string - RSA private key parameter.
- x? string - X component of an EC public key.
- y? string - Y component of an EC public key.
azure.keyvault: KeyBundle
A KeyBundle consisting of a WebKey plus its attributes.
Fields
- attributes? KeyAttributes - The attributes of a key managed by the key vault service.
- 'key? JsonWebKey - As of http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
- managed? boolean - True if the key's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true.
azure.keyvault: KeyCreateParameters
The key create parameters.
Fields
- attributes? KeyAttributes - The attributes of a key managed by the key vault service.
- crv? string - Elliptic curve name. For valid values, see JsonWebKeyCurveName.
- key_ops? string[] - JSON web key operations. For more information, see JsonWebKeyOperation.
- key_size? int - The key size in bits. For example: 2048, 3072, or 4096 for RSA.
- kty string - The type of key to create. For valid values, see JsonWebKeyType.
azure.keyvault: KeyImportParameters
The key import parameters.
Fields
- Hsm? boolean - Whether to import as a hardware key (HSM) or software key.
- attributes? KeyAttributes - The attributes of a key managed by the key vault service.
- 'key JsonWebKey - As of http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
azure.keyvault: KeyItem
The key item containing key metadata.
Fields
- attributes? KeyAttributes - The attributes of a key managed by the key vault service.
- kid? string - Key identifier.
- managed? boolean - True if the key's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true.
azure.keyvault: KeyListResult
The key list result.
Fields
- nextLink? string? - The URL to get the next set of keys.
- value? KeyItem[] - A response message containing a list of keys in the key vault along with a link to the next page of keys.
azure.keyvault: KeyOperationResult
The key operation result.
Fields
- kid? string - Key identifier
- value? string - The Base64 representation of the operation result.
azure.keyvault: KeyOperationsParameters
The key operations parameters.
Fields
- alg string - Algorithm identifier
- value string - The Base64 value of encrypted data.
azure.keyvault: KeyProperties
Properties of the key pair backing a certificate.
Fields
- crv? string - Elliptic curve name. For valid values, see JsonWebKeyCurveName.
- exportable? boolean - Indicates if the private key can be exported.
- key_size? int - The key size in bits. For example: 2048, 3072, or 4096 for RSA.
- kty? string - The type of key pair to be used for the certificate.
- reuse_key? boolean - Indicates if the same key pair will be used on certificate renewal.
azure.keyvault: KeyRestoreParameters
The key restore parameters.
Fields
- value string - The backup blob associated with a key bundle.
azure.keyvault: KeySignParameters
The key operations parameters.
Fields
- alg string - The signing/verification algorithm identifier. For more information on possible algorithm types, see JsonWebKeySignatureAlgorithm.
- value string - The Base64 representation of the digest.
azure.keyvault: KeyUpdateParameters
The key update parameters.
Fields
- attributes? KeyAttributes - The attributes of a key managed by the key vault service.
- key_ops? string[] - Json web key operations. For more information on possible key operations, see JsonWebKeyOperation.
azure.keyvault: KeyVaultError
The key vault error exception.
Fields
- 'error? Error - The key vault server error.
azure.keyvault: KeyVerifyParameters
The key verify parameters.
Fields
- alg string - The signing/verification algorithm. For more information on possible algorithm types, see JsonWebKeySignatureAlgorithm.
- digest string - The digest used for signing.
- value string - The signature to be verified.
azure.keyvault: KeyVerifyResult
The key verify result.
Fields
- value? boolean - True if the signature is verified, otherwise false.
azure.keyvault: LifetimeAction
Action and its trigger that will be performed by Key Vault over the lifetime of a certificate.
Fields
- action? Action - The action that will be executed.
- trigger? Trigger - A condition to be satisfied for an action to be executed.
azure.keyvault: OrganizationDetails
Details of the organization of the certificate issuer.
Fields
- admin_details? AdministratorDetails[] - Details of the organization administrator.
- id? string - Id of the organization.
azure.keyvault: PendingCertificateSigningRequestResult
The pending certificate signing request result.
Fields
- value? string - The pending certificate signing request as Base64 encoded string.
azure.keyvault: ProxyConfig
Closed record
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
azure.keyvault: SasDefinitionAttributes
The SAS definition management attributes.
Fields
- created? int - Creation time in UTC.
- enabled? boolean - the enabled state of the object.
- recoveryLevel? string - Reflects the deletion recovery level currently in effect for SAS definitions in the current vault. If it contains 'Purgeable' the SAS definition can be permanently deleted by a privileged user; otherwise, only the system can purge the SAS definition, at the end of the retention interval.
- updated? int - Last updated time in UTC.
azure.keyvault: SasDefinitionBundle
A SAS definition bundle consists of key vault SAS definition details plus its attributes.
Fields
- attributes? SasDefinitionAttributes - The SAS definition management attributes.
- id? string - The SAS definition id.
- sasType? string - The type of SAS token the SAS definition will create.
- sid? string - Storage account SAS definition secret id.
- templateUri? string - The SAS definition token template signed with an arbitrary key. Tokens created according to the SAS definition will have the same properties as the template.
- validityPeriod? string - The validity period of SAS tokens created according to the SAS definition.
azure.keyvault: SasDefinitionCreateParameters
The SAS definition create parameters.
Fields
- attributes? SasDefinitionAttributes - The SAS definition management attributes.
- sasType string - The type of SAS token the SAS definition will create.
- templateUri string - The SAS definition token template signed with an arbitrary key. Tokens created according to the SAS definition will have the same properties as the template.
- validityPeriod string - The validity period of SAS tokens created according to the SAS definition.
azure.keyvault: SasDefinitionItem
The SAS definition item containing storage SAS definition metadata.
Fields
- attributes? SasDefinitionAttributes - The SAS definition management attributes.
- id? string - The storage SAS identifier.
- sid? string - The storage account SAS definition secret id.
azure.keyvault: SasDefinitionListResult
The storage account SAS definition list result.
Fields
- nextLink? string? - The URL to get the next set of SAS definitions.
- value? SasDefinitionItem[] - A response message containing a list of SAS definitions along with a link to the next page of SAS definitions.
azure.keyvault: SasDefinitionUpdateParameters
The SAS definition update parameters.
Fields
- attributes? SasDefinitionAttributes - The SAS definition management attributes.
- sasType? string - The type of SAS token the SAS definition will create.
- templateUri? string - The SAS definition token template signed with an arbitrary key. Tokens created according to the SAS definition will have the same properties as the template.
- validityPeriod? string - The validity period of SAS tokens created according to the SAS definition.
azure.keyvault: SecretBundle
A secret consisting of a value, id and its attributes.
Fields
- attributes? SecretAttributes - The secret management attributes.
- contentType? string - The content type of the secret.
- id? string - The secret id.
- kid? string - If this is a secret backing a KV certificate, then this field specifies the corresponding key backing the KV certificate.
- managed? boolean - True if the secret's lifetime is managed by key vault. If this is a secret backing a certificate, then managed will be true.
- value? string - The secret value.
azure.keyvault: SecretItem
The secret item containing secret metadata.
Fields
- attributes? SecretAttributes - The secret management attributes.
- contentType? string - Type of the secret value such as a password.
- id? string - Secret identifier.
- managed? boolean - True if the secret's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true.
azure.keyvault: SecretListResult
The secret list result.
Fields
- nextLink? string? - The URL to get the next set of secrets.
- value? SecretItem[] - A response message containing a list of secrets in the key vault along with a link to the next page of secrets.
azure.keyvault: SecretProperties
Properties of the key backing a certificate.
Fields
- contentType? string - The media type (MIME type).
azure.keyvault: SecretRestoreParameters
The secret restore parameters.
Fields
- value string - The backup blob associated with a secret bundle.
azure.keyvault: SecretSetParameters
The secret set parameters.
Fields
- attributes? SecretAttributes - The secret management attributes.
- contentType? string - Type of the secret value such as a password.
- value string - The value of the secret.
azure.keyvault: SecretUpdateParameters
The secret update parameters.
Fields
- attributes? SecretAttributes - The secret management attributes.
- contentType? string - Type of the secret value such as a password.
azure.keyvault: StorageAccountAttributes
The storage account management attributes.
Fields
- created? int - Creation time in UTC.
- enabled? boolean - the enabled state of the object.
- recoveryLevel? string - Reflects the deletion recovery level currently in effect for storage accounts in the current vault. If it contains 'Purgeable' the storage account can be permanently deleted by a privileged user; otherwise, only the system can purge the storage account, at the end of the retention interval.
- updated? int - Last updated time in UTC.
azure.keyvault: StorageAccountCreateParameters
The storage account create parameters.
Fields
- activeKeyName string - Current active storage account key name.
- attributes? StorageAccountAttributes - The storage account management attributes.
- autoRegenerateKey boolean - whether keyvault should manage the storage account for the user.
- regenerationPeriod? string - The key regeneration time duration specified in ISO-8601 format.
- resourceId string - Storage account resource id.
azure.keyvault: StorageAccountItem
The storage account item containing storage account metadata.
Fields
- attributes? StorageAccountAttributes - The storage account management attributes.
- id? string - Storage identifier.
- resourceId? string - Storage account resource Id.
azure.keyvault: StorageAccountRegenerteKeyParameters
The storage account key regenerate parameters.
Fields
- keyName string - The storage account key name.
azure.keyvault: StorageAccountUpdateParameters
The storage account update parameters.
Fields
- activeKeyName? string - The current active storage account key name.
- attributes? StorageAccountAttributes - The storage account management attributes.
- autoRegenerateKey? boolean - whether keyvault should manage the storage account for the user.
- regenerationPeriod? string - The key regeneration time duration specified in ISO-8601 format.
azure.keyvault: StorageBundle
A Storage account bundle consists of key vault storage account details plus its attributes.
Fields
- activeKeyName? string - The current active storage account key name.
- attributes? StorageAccountAttributes - The storage account management attributes.
- autoRegenerateKey? boolean - whether keyvault should manage the storage account for the user.
- id? string - The storage account id.
- regenerationPeriod? string - The key regeneration time duration specified in ISO-8601 format.
- resourceId? string - The storage account resource id.
azure.keyvault: StorageListResult
The storage accounts list result.
Fields
- nextLink? string? - The URL to get the next set of storage accounts.
- value? StorageAccountItem[] - A response message containing a list of storage accounts in the key vault along with a link to the next page of storage accounts.
azure.keyvault: StorageRestoreParameters
The secret restore parameters.
Fields
- value string - The backup blob associated with a storage account.
azure.keyvault: SubjectAlternativeNames
The subject alternate names of a X509 object.
Fields
- dns_names? string[] - Domain names.
- emails? string[] - Email addresses.
- upns? string[] - User principal names.
azure.keyvault: Trigger
A condition to be satisfied for an action to be executed.
Fields
- days_before_expiry? int - Days before expiry to attempt renewal. Value should be between 1 and validity_in_months multiplied by 27. If validity_in_months is 36, then value should be between 1 and 972 (36 * 27).
- lifetime_percentage? int - Percentage of lifetime at which to trigger. Value should be between 1 and 99.
azure.keyvault: X509CertificateProperties
Properties of the X509 component of a certificate.
Fields
- ekus? string[] - The enhanced key usage.
- key_usage? string[] - List of key usages.
- sans? SubjectAlternativeNames - The subject alternate names of a X509 object.
- subject? string - The subject name. Should be a valid X509 distinguished Name.
- validity_months? int - The duration that the certificate is valid in months.
Simple name reference types
azure.keyvault: DeletedSecretBundle
DeletedSecretBundle
A Deleted Secret consisting of its previous id, attributes and its tags, as well as information on when it will be purged.
azure.keyvault: DeletedSasDefinitionBundle
DeletedSasDefinitionBundle
A deleted SAS definition bundle consisting of its previous id, attributes and its tags, as well as information on when it will be purged.
azure.keyvault: DeletedKeyBundle
DeletedKeyBundle
A DeletedKeyBundle consisting of a WebKey plus its Attributes and deletion info
azure.keyvault: DeletedSasDefinitionItem
DeletedSasDefinitionItem
The deleted SAS definition item containing metadata about the deleted SAS definition.
azure.keyvault: DeletedCertificateItem
DeletedCertificateItem
The deleted certificate item containing metadata about the deleted certificate.
azure.keyvault: DeletedKeyItem
DeletedKeyItem
The deleted key item containing the deleted key metadata and information about deletion.
azure.keyvault: DeletedCertificateBundle
DeletedCertificateBundle
A Deleted Certificate consisting of its previous id, attributes and its tags, as well as information on when it will be purged.
azure.keyvault: DeletedStorageAccountItem
DeletedStorageAccountItem
The deleted storage account item containing metadata about the deleted storage account.
azure.keyvault: CertificateAttributes
CertificateAttributes
The certificate management attributes.
azure.keyvault: KeyAttributes
KeyAttributes
The attributes of a key managed by the key vault service.
azure.keyvault: DeletedSecretItem
DeletedSecretItem
The deleted secret item containing metadata about the deleted secret.
azure.keyvault: DeletedStorageBundle
DeletedStorageBundle
A deleted storage account bundle consisting of its previous id, attributes and its tags, as well as information on when it will be purged.
azure.keyvault: SecretAttributes
SecretAttributes
The secret management attributes.