azure-security-keyvault-secrets
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Azure::Security::KeyVault::Secrets::SecretProperties Struct Referencefinal

The Secret attributes managed by the KeyVault service. More...

#include <keyvault_secret_properties.hpp>

Public Member Functions

 SecretProperties ()=default
 Construct a new secret Properties object. More...
 
 SecretProperties (std::string const &name)
 Construct a new secret Properties object. More...
 

Static Public Member Functions

static SecretProperties CreateFromURL (std::string const &url)
 Construct a new secret Properties object. More...
 

Public Attributes

Azure::Nullable< bool > Enabled
 Indicate whether the secret is enabled and useable for cryptographic operations. More...
 
Azure::Nullable< Azure::DateTime > NotBefore
 Indicate when the secret will be valid and can be used for cryptographic operations. More...
 
Azure::Nullable< Azure::DateTime > ExpiresOn
 Indicate when the secret will expire and cannot be used for cryptographic operations. More...
 
Azure::Nullable< Azure::DateTime > CreatedOn
 Indicate when the secret was created. More...
 
Azure::Nullable< Azure::DateTime > UpdatedOn
 Indicate when the secret was updated. More...
 
Azure::Nullable< int64_t > RecoverableDays
 The number of days a secret is retained before being deleted for a soft delete-enabled Key Vault. More...
 
Azure::Nullable< std::string > RecoveryLevel
 The recovery level currently in effect for secrets in the Key Vault. More...
 
Azure::Nullable< std::string > ContentType
 The content type of the secret. More...
 
Azure::Nullable< std::string > KeyId
 If this is a secret backing a KV certificate, then this field specifies the corresponding key backing the KV certificate. More...
 
std::unordered_map< std::string, std::string > Tags
 Application specific metadata in the form of key-value pairs. More...
 
bool Managed
 True if the secret's lifetime is managed by key vault. If this is a secret backing a certificate, then managed will be true. More...
 
std::string Id
 The secret id. More...
 
std::string Name
 The name of the secret. More...
 
std::string VaultUrl
 The vault url of the secret. More...
 
std::string Version
 The version of the secret. More...
 

Detailed Description

Constructor & Destructor Documentation

◆ SecretProperties() [1/2]

Azure::Security::KeyVault::Secrets::SecretProperties::SecretProperties ( )
default

◆ SecretProperties() [2/2]

Azure::Security::KeyVault::Secrets::SecretProperties::SecretProperties ( std::string const &  name)
inline

Member Function Documentation

◆ CreateFromURL()

SecretProperties SecretProperties::CreateFromURL ( std::string const &  url)
static

Member Data Documentation

◆ ContentType

Azure::Nullable<std::string> Azure::Security::KeyVault::Secrets::SecretProperties::ContentType

◆ CreatedOn

Azure::Nullable<Azure::DateTime> Azure::Security::KeyVault::Secrets::SecretProperties::CreatedOn

◆ Enabled

Azure::Nullable<bool> Azure::Security::KeyVault::Secrets::SecretProperties::Enabled

◆ ExpiresOn

Azure::Nullable<Azure::DateTime> Azure::Security::KeyVault::Secrets::SecretProperties::ExpiresOn

◆ Id

std::string Azure::Security::KeyVault::Secrets::SecretProperties::Id

◆ KeyId

Azure::Nullable<std::string> Azure::Security::KeyVault::Secrets::SecretProperties::KeyId

◆ Managed

bool Azure::Security::KeyVault::Secrets::SecretProperties::Managed

◆ Name

std::string Azure::Security::KeyVault::Secrets::SecretProperties::Name

◆ NotBefore

Azure::Nullable<Azure::DateTime> Azure::Security::KeyVault::Secrets::SecretProperties::NotBefore

◆ RecoverableDays

Azure::Nullable<int64_t> Azure::Security::KeyVault::Secrets::SecretProperties::RecoverableDays

◆ RecoveryLevel

Azure::Nullable<std::string> Azure::Security::KeyVault::Secrets::SecretProperties::RecoveryLevel
Remarks
If Purgeable, the secret can be permanently deleted by an authorized user; otherwise, only the service can purge the secret at the end of the retention interval.

◆ Tags

std::unordered_map<std::string, std::string> Azure::Security::KeyVault::Secrets::SecretProperties::Tags

◆ UpdatedOn

Azure::Nullable<Azure::DateTime> Azure::Security::KeyVault::Secrets::SecretProperties::UpdatedOn

◆ VaultUrl

std::string Azure::Security::KeyVault::Secrets::SecretProperties::VaultUrl

◆ Version

std::string Azure::Security::KeyVault::Secrets::SecretProperties::Version

The documentation for this struct was generated from the following files: