diff --git a/sdk/resourcemanager/azure-resourcemanager-keyvault/pom.xml b/sdk/resourcemanager/azure-resourcemanager-keyvault/pom.xml index 7755d4bde15c..7e968ef9c046 100644 --- a/sdk/resourcemanager/azure-resourcemanager-keyvault/pom.xml +++ b/sdk/resourcemanager/azure-resourcemanager-keyvault/pom.xml @@ -46,7 +46,6 @@ --add-opens com.azure.core/com.azure.core.implementation.util=ALL-UNNAMED - - diff --git a/sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/KeyVaultManager.java b/sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/KeyVaultManager.java index 47d73b1ef5f4..ee596aeaeb38 100644 --- a/sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/KeyVaultManager.java +++ b/sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/KeyVaultManager.java @@ -94,7 +94,11 @@ private KeyVaultManager(final HttpPipeline httpPipeline, AzureProfile profile) { this.tenantId = profile.getTenantId(); } - /** @return the KeyVault account management API entry point */ + /** + * Gets the KeyVault account management API entry point. + * + * @return the KeyVault account management API entry point + */ public Vaults vaults() { if (vaults == null) { vaults = new VaultsImpl(this, authorizationManager, tenantId); @@ -102,7 +106,11 @@ public Vaults vaults() { return vaults; } - /** @return the Managed Hardware Security Module management API entry point */ + /** + * Gets the Managed Hardware Security Module management API entry point. + * + * @return the Managed Hardware Security Module management API entry point + */ public ManagedHsms managedHsms() { if (managedHsms == null) { managedHsms = new ManagedHsmsImpl(this, tenantId); diff --git a/sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/models/AccessPolicy.java b/sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/models/AccessPolicy.java index cb3606953b28..cc16ca40f748 100644 --- a/sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/models/AccessPolicy.java +++ b/sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/models/AccessPolicy.java @@ -17,17 +17,31 @@ @Fluent public interface AccessPolicy extends ChildResource, HasInnerModel { /** + * Gets the Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. + * * @return The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. */ String tenantId(); - /** @return The object ID of a user or service principal in the Azure Active Directory tenant for the vault. */ + /** + * Gets the object ID of a user or service principal in the Azure Active Directory tenant for the vault. + * + * @return The object ID of a user or service principal in the Azure Active Directory tenant for the vault. + */ String objectId(); - /** @return Application ID of the client making request on behalf of a principal. */ + /** + * Gets application ID of the client making request on behalf of a principal. + * + * @return Application ID of the client making request on behalf of a principal. + */ String applicationId(); - /** @return Permissions the identity has for keys and secrets. */ + /** + * Gets permissions the identity has for keys and secrets. + * + * @return Permissions the identity has for keys and secrets. + */ Permissions permissions(); /************************************************************** diff --git a/sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/models/Key.java b/sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/models/Key.java index 6ab04bda9214..2ab3657f7738 100644 --- a/sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/models/Key.java +++ b/sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/models/Key.java @@ -29,34 +29,68 @@ /** An immutable client-side representation of an Azure Key Vault key. */ @Fluent public interface Key extends Indexable, HasInnerModel, HasId, HasName, Updatable { - /** @return the Json web key. */ + /** + * Gets the Json web key. + * + * @return the Json web key. + */ JsonWebKey getJsonWebKey(); - /** @return the Json web key. */ + /** + * Gets the Json web key. + * + * @return the Json web key. + */ Mono getJsonWebKeyAsync(); - /** @return the key management attributes. */ + /** + * Gets the key management attributes. + * + * @return the key management attributes. + */ KeyProperties attributes(); - /** @return application specific metadata in the form of key-value pairs. */ + /** + * Gets application specific metadata in the form of key-value pairs. + * + * @return application specific metadata in the form of key-value pairs. + */ Map tags(); /** + * Checks whether the key's lifetime is managed by key vault. + * * @return true if the key's lifetime is managed by key vault. If this is a key backing a certificate, then managed * will be true. */ boolean managed(); - /** @return a list of individual key versions with the same key name */ + /** + * Gets a list of individual key versions with the same key name. + * + * @return a list of individual key versions with the same key name + */ PagedIterable listVersions(); - /** @return a list of individual key versions with the same key name */ + /** + * Gets a list of individual key versions with the same key name. + * + * @return a list of individual key versions with the same key name + */ PagedFlux listVersionsAsync(); - /** @return a backup of the specified key be downloaded to the client */ + /** + * GEts a backup of the specified key be downloaded to the client. + * + * @return a backup of the specified key be downloaded to the client + */ byte[] backup(); - /** @return a backup of the specified key be downloaded to the client */ + /** + * Gets a backup of the specified key be downloaded to the client. + * + * @return a backup of the specified key be downloaded to the client + */ Mono backupAsync(); /** diff --git a/sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/models/ManagedHsm.java b/sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/models/ManagedHsm.java index 2953b778f00c..4c680b9055c4 100644 --- a/sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/models/ManagedHsm.java +++ b/sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/models/ManagedHsm.java @@ -19,10 +19,18 @@ public interface ManagedHsm extends GroupableResource, Refreshable, SupportsListingPrivateLinkResource, SupportsUpdatingPrivateEndpointConnection { - /** @return the AAD tenant ID that should be used for authenticating requests to the managed HSM */ + /** + * Gets the AAD tenant ID that should be used for authenticating requests to the managed HSM. + * + * @return the AAD tenant ID that should be used for authenticating requests to the managed HSM + */ String tenantId(); - /** @return Managed HSM SKU */ + /** + * Gets managed HSM SKU. + * + * @return Managed HSM SKU + */ ManagedHsmSku sku(); /** @@ -33,27 +41,59 @@ public interface ManagedHsm extends GroupableResource initialAdminObjectIds(); - /** @return the URI of the managed hsm pool for performing operations on keys */ + /** + * Gets the URI of the managed hsm pool for performing operations on keys. + * + * @return the URI of the managed hsm pool for performing operations on keys + */ String hsmUri(); - /** @return whether the 'soft delete' functionality is enabled for this managed HSM */ + /** + * Checks whether the 'soft delete' functionality is enabled for this managed HSM. + * + * @return whether the 'soft delete' functionality is enabled for this managed HSM + */ boolean isSoftDeleteEnabled(); - /** @return softDelete data retention days. It accepts value between 7 and 90 (both included) */ + /** + * Gets softDelete data retention days. + * + * @return softDelete data retention days. It accepts value between 7 and 90 (both included) + */ Integer softDeleteRetentionInDays(); - /** @return whether protection against purge is enabled for this managed HSM */ + /** + * Checks whether protection against purge is enabled for this managed HSM. + * + * @return whether protection against purge is enabled for this managed HSM + */ boolean isPurgeProtectionEnabled(); - /** @return rules governing the accessibility of the key vault from specific network locations */ + /** + * Gets rules governing the accessibility of the key vault from specific network locations. + * + * @return rules governing the accessibility of the key vault from specific network locations + */ MhsmNetworkRuleSet networkRuleSet(); - /** @return the Key Vault key API entry point */ + /** + * Gets the Key Vault key API entry point. + * + * @return the Key Vault key API entry point + */ Keys keys(); - /** @return the scheduled purge date in UTC */ + /** + * Gets the scheduled purge date in UTC. + * + * @return the scheduled purge date in UTC + */ OffsetDateTime scheduledPurgeDate(); - /** @return whether data plane traffic coming from public networks is allowed while private endpoint is enabled */ + /** + * Checks whether data plane traffic coming from public networks is allowed while private endpoint is enabled. + * + * @return whether data plane traffic coming from public networks is allowed while private endpoint is enabled + */ PublicNetworkAccess publicNetworkAccess(); } diff --git a/sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/models/Secret.java b/sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/models/Secret.java index 86d1b3e4e8bc..473cf1b5e015 100644 --- a/sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/models/Secret.java +++ b/sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/models/Secret.java @@ -20,39 +20,75 @@ /** An immutable client-side representation of an Azure Key Vault secret. */ @Fluent public interface Secret extends Indexable, HasInnerModel, HasId, HasName, Updatable { - /** @return the secret value when the secret is enabled */ + /** + * Gets the secret value when the secret is enabled. + * + * @return the secret value when the secret is enabled + */ String getValue(); - /** @return the secret value when the secret is enabled */ + /** + * Gets the secret value when the secret is enabled. + * + * @return the secret value when the secret is enabled + */ Mono getValueAsync(); - /** @return the secret management attributes */ + /** + * Gets the secret management attributes. + * + * @return the secret management attributes + */ SecretProperties attributes(); - /** @return application specific metadata in the form of key-value pairs */ + /** + * Gets application specific metadata in the form of key-value pairs. + * + * @return application specific metadata in the form of key-value pairs + */ Map tags(); - /** @return type of the secret value such as a password */ + /** + * Gets type of the secret value such as a password. + * + * @return type of the secret value such as a password + */ String contentType(); - /** @return the corresponding key backing the KV certificate if this is a secret backing a KV certificate */ + /** + * Gets the corresponding key backing the KV certificate if this is a secret backing a KV certificate. + * + * @return the corresponding key backing the KV certificate if this is a secret backing a KV certificate + */ String kid(); /** + * Checks whether the secret's lifetime is managed by key vault. + * * @return true if the secret's lifetime is managed by key vault. If this is a key backing a certificate, then * managed will be true */ boolean managed(); /** + * Checks whether secret is enabled. + * * @return whether secret is enabled. */ boolean enabled(); - /** @return a list of individual secret versions with the same secret name */ + /** + * Gets a list of individual secret versions with the same secret name. + * + * @return a list of individual secret versions with the same secret name + */ PagedIterable listVersions(); - /** @return a list of individual secret versions with the same secret name */ + /** + * Gets a list of individual secret versions with the same secret name. + * + * @return a list of individual secret versions with the same secret name + */ PagedFlux listVersionsAsync(); /** Container interface for all the definitions. */ diff --git a/sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/models/Vault.java b/sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/models/Vault.java index dfc33acb75db..1e2d2860f65a 100644 --- a/sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/models/Vault.java +++ b/sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/models/Vault.java @@ -23,39 +23,73 @@ public interface Vault extends GroupableResource, Refreshable, Updatable, SupportsListingPrivateLinkResource, SupportsUpdatingPrivateEndpointConnection { - /** @return an authenticated Key Vault secret client */ + /** + * Gets an authenticated Key Vault secret client. + * + * @return an authenticated Key Vault secret client + */ SecretAsyncClient secretClient(); - /** @return an authenticated Key Vault key client */ + /** + * Gets an authenticated Key Vault key client. + * + * @return an authenticated Key Vault key client + */ KeyAsyncClient keyClient(); - /** @return an authenticated Key Vault rest client */ + /** + * Gets an authenticated Key Vault rest client. + * + * @return an authenticated Key Vault rest client + */ HttpPipeline vaultHttpPipeline(); - /** @return the Key Vault key API entry point */ + /** + * Gets the Key Vault key API entry point. + * + * @return the Key Vault key API entry point + */ Keys keys(); - /** @return the Key Vault secret API entry point */ + /** + * Gets the Key Vault secret API entry point. + * + * @return the Key Vault secret API entry point + */ Secrets secrets(); - /** @return the URI of the vault for performing operations on keys and secrets. */ + /** + * Gets the URI of the vault for performing operations on keys and secrets. + * + * @return the URI of the vault for performing operations on keys and secrets. + */ String vaultUri(); /** + * Gets the Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. + * * @return the Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. */ String tenantId(); - /** @return SKU details. */ + /** + * Gets SKU details. + * + * @return SKU details. + */ Sku sku(); /** + * Gets an array of 0 to 16 identities that have access to the key vault. + * * @return an array of 0 to 16 identities that have access to the key vault. All identities in the array must use * the same tenant ID as the key vault's tenant ID. */ List accessPolicies(); /** + * Checks whether role based access control (RBAC) for authorization of data access is enabled. + * * @return whether role based access control (RBAC) for authorization of data access is enabled. */ boolean roleBasedAccessControlEnabled(); @@ -68,21 +102,38 @@ public interface Vault extends GroupableResource, R PublicNetworkAccess publicNetworkAccess(); /** + * Checks whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key + * vault. + * * @return whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key * vault. */ boolean enabledForDeployment(); - /** @return whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. */ + /** + * Checks whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. + * + * @return whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. + */ boolean enabledForDiskEncryption(); - /** @return whether Azure Resource Manager is permitted to retrieve secrets from the key vault. */ + /** + * Checks whether Azure Resource Manager is permitted to retrieve secrets from the key vault. + * + * @return whether Azure Resource Manager is permitted to retrieve secrets from the key vault. + */ boolean enabledForTemplateDeployment(); - /** @return whether soft delete is enabled for this key vault. */ + /** + * Gets whether soft delete is enabled for this key vault. + * + * @return whether soft delete is enabled for this key vault. + */ boolean softDeleteEnabled(); /** + * Checks whether purge protection is enabled for this key vault. + * * @return whether purge protection is enabled for this key vault. Purge protection can only be enabled if soft * delete is enabled. */