Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Javadoc of premium SDK for azure-resourcemanager-keyvault #43603

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@

--add-opens com.azure.core/com.azure.core.implementation.util=ALL-UNNAMED
</javaModulesSurefireArgLine>
<doclintMissingInclusion>-</doclintMissingInclusion>
</properties>

<developers>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,15 +94,23 @@ 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);
}
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);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,31 @@
@Fluent
public interface AccessPolicy extends ChildResource<Vault>, HasInnerModel<AccessPolicyEntry> {
/**
* 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();

/**************************************************************
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,34 +29,68 @@
/** An immutable client-side representation of an Azure Key Vault key. */
@Fluent
public interface Key extends Indexable, HasInnerModel<KeyProperties>, HasId, HasName, Updatable<Key.Update> {
/** @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<JsonWebKey> 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<String, String> 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<Key> 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<Key> 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<byte[]> backupAsync();

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,18 @@
public interface ManagedHsm extends GroupableResource<KeyVaultManager, ManagedHsmInner>, Refreshable<ManagedHsm>,
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();

/**
Expand All @@ -33,27 +41,59 @@ public interface ManagedHsm extends GroupableResource<KeyVaultManager, ManagedHs
*/
List<String> 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();
}
Original file line number Diff line number Diff line change
Expand Up @@ -20,39 +20,75 @@
/** An immutable client-side representation of an Azure Key Vault secret. */
@Fluent
public interface Secret extends Indexable, HasInnerModel<SecretProperties>, HasId, HasName, Updatable<Secret.Update> {
/** @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<String> 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<String, String> 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<Secret> 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<Secret> listVersionsAsync();

/** Container interface for all the definitions. */
Expand Down
Loading
Loading