Skip to content

Commit a96e435

Browse files
v-hongli1v-hongli1
authored
Update Javadoc of premium SDK for azure-resourcemanager-keyvault (#43603)
1 parent 289b556 commit a96e435

File tree

7 files changed

+224
-42
lines changed

7 files changed

+224
-42
lines changed

‎sdk/resourcemanager/azure-resourcemanager-keyvault/pom.xml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@
4646

4747
--add-opens com.azure.core/com.azure.core.implementation.util=ALL-UNNAMED
4848
</javaModulesSurefireArgLine>
49-
<doclintMissingInclusion>-</doclintMissingInclusion>
5049
</properties>
5150

5251
<developers>

‎sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/KeyVaultManager.java‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,15 +94,23 @@ private KeyVaultManager(final HttpPipeline httpPipeline, AzureProfile profile) {
9494
this.tenantId = profile.getTenantId();
9595
}
9696

97-
/** @return the KeyVault account management API entry point */
97+
/**
98+
* Gets the KeyVault account management API entry point.
99+
*
100+
* @return the KeyVault account management API entry point
101+
*/
98102
public Vaults vaults() {
99103
if (vaults == null) {
100104
vaults = new VaultsImpl(this, authorizationManager, tenantId);
101105
}
102106
return vaults;
103107
}
104108

105-
/** @return the Managed Hardware Security Module management API entry point */
109+
/**
110+
* Gets the Managed Hardware Security Module management API entry point.
111+
*
112+
* @return the Managed Hardware Security Module management API entry point
113+
*/
106114
public ManagedHsms managedHsms() {
107115
if (managedHsms == null) {
108116
managedHsms = new ManagedHsmsImpl(this, tenantId);

‎sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/models/AccessPolicy.java‎

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,31 @@
1717
@Fluent
1818
public interface AccessPolicy extends ChildResource<Vault>, HasInnerModel<AccessPolicyEntry> {
1919
/**
20+
* Gets the Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
21+
*
2022
* @return The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
2123
*/
2224
String tenantId();
2325

24-
/** @return The object ID of a user or service principal in the Azure Active Directory tenant for the vault. */
26+
/**
27+
* Gets the object ID of a user or service principal in the Azure Active Directory tenant for the vault.
28+
*
29+
* @return The object ID of a user or service principal in the Azure Active Directory tenant for the vault.
30+
*/
2531
String objectId();
2632

27-
/** @return Application ID of the client making request on behalf of a principal. */
33+
/**
34+
* Gets application ID of the client making request on behalf of a principal.
35+
*
36+
* @return Application ID of the client making request on behalf of a principal.
37+
*/
2838
String applicationId();
2939

30-
/** @return Permissions the identity has for keys and secrets. */
40+
/**
41+
* Gets permissions the identity has for keys and secrets.
42+
*
43+
* @return Permissions the identity has for keys and secrets.
44+
*/
3145
Permissions permissions();
3246

3347
/**************************************************************

‎sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/models/Key.java‎

Lines changed: 42 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,34 +29,68 @@
2929
/** An immutable client-side representation of an Azure Key Vault key. */
3030
@Fluent
3131
public interface Key extends Indexable, HasInnerModel<KeyProperties>, HasId, HasName, Updatable<Key.Update> {
32-
/** @return the Json web key. */
32+
/**
33+
* Gets the Json web key.
34+
*
35+
* @return the Json web key.
36+
*/
3337
JsonWebKey getJsonWebKey();
3438

35-
/** @return the Json web key. */
39+
/**
40+
* Gets the Json web key.
41+
*
42+
* @return the Json web key.
43+
*/
3644
Mono<JsonWebKey> getJsonWebKeyAsync();
3745

38-
/** @return the key management attributes. */
46+
/**
47+
* Gets the key management attributes.
48+
*
49+
* @return the key management attributes.
50+
*/
3951
KeyProperties attributes();
4052

41-
/** @return application specific metadata in the form of key-value pairs. */
53+
/**
54+
* Gets application specific metadata in the form of key-value pairs.
55+
*
56+
* @return application specific metadata in the form of key-value pairs.
57+
*/
4258
Map<String, String> tags();
4359

4460
/**
61+
* Checks whether the key's lifetime is managed by key vault.
62+
*
4563
* @return true if the key's lifetime is managed by key vault. If this is a key backing a certificate, then managed
4664
* will be true.
4765
*/
4866
boolean managed();
4967

50-
/** @return a list of individual key versions with the same key name */
68+
/**
69+
* Gets a list of individual key versions with the same key name.
70+
*
71+
* @return a list of individual key versions with the same key name
72+
*/
5173
PagedIterable<Key> listVersions();
5274

53-
/** @return a list of individual key versions with the same key name */
75+
/**
76+
* Gets a list of individual key versions with the same key name.
77+
*
78+
* @return a list of individual key versions with the same key name
79+
*/
5480
PagedFlux<Key> listVersionsAsync();
5581

56-
/** @return a backup of the specified key be downloaded to the client */
82+
/**
83+
* GEts a backup of the specified key be downloaded to the client.
84+
*
85+
* @return a backup of the specified key be downloaded to the client
86+
*/
5787
byte[] backup();
5888

59-
/** @return a backup of the specified key be downloaded to the client */
89+
/**
90+
* Gets a backup of the specified key be downloaded to the client.
91+
*
92+
* @return a backup of the specified key be downloaded to the client
93+
*/
6094
Mono<byte[]> backupAsync();
6195

6296
/**

‎sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/models/ManagedHsm.java‎

Lines changed: 50 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,18 @@
1919
public interface ManagedHsm extends GroupableResource<KeyVaultManager, ManagedHsmInner>, Refreshable<ManagedHsm>,
2020
SupportsListingPrivateLinkResource, SupportsUpdatingPrivateEndpointConnection {
2121

22-
/** @return the AAD tenant ID that should be used for authenticating requests to the managed HSM */
22+
/**
23+
* Gets the AAD tenant ID that should be used for authenticating requests to the managed HSM.
24+
*
25+
* @return the AAD tenant ID that should be used for authenticating requests to the managed HSM
26+
*/
2327
String tenantId();
2428

25-
/** @return Managed HSM SKU */
29+
/**
30+
* Gets managed HSM SKU.
31+
*
32+
* @return Managed HSM SKU
33+
*/
2634
ManagedHsmSku sku();
2735

2836
/**
@@ -33,27 +41,59 @@ public interface ManagedHsm extends GroupableResource<KeyVaultManager, ManagedHs
3341
*/
3442
List<String> initialAdminObjectIds();
3543

36-
/** @return the URI of the managed hsm pool for performing operations on keys */
44+
/**
45+
* Gets the URI of the managed hsm pool for performing operations on keys.
46+
*
47+
* @return the URI of the managed hsm pool for performing operations on keys
48+
*/
3749
String hsmUri();
3850

39-
/** @return whether the 'soft delete' functionality is enabled for this managed HSM */
51+
/**
52+
* Checks whether the 'soft delete' functionality is enabled for this managed HSM.
53+
*
54+
* @return whether the 'soft delete' functionality is enabled for this managed HSM
55+
*/
4056
boolean isSoftDeleteEnabled();
4157

42-
/** @return softDelete data retention days. It accepts value between 7 and 90 (both included) */
58+
/**
59+
* Gets softDelete data retention days.
60+
*
61+
* @return softDelete data retention days. It accepts value between 7 and 90 (both included)
62+
*/
4363
Integer softDeleteRetentionInDays();
4464

45-
/** @return whether protection against purge is enabled for this managed HSM */
65+
/**
66+
* Checks whether protection against purge is enabled for this managed HSM.
67+
*
68+
* @return whether protection against purge is enabled for this managed HSM
69+
*/
4670
boolean isPurgeProtectionEnabled();
4771

48-
/** @return rules governing the accessibility of the key vault from specific network locations */
72+
/**
73+
* Gets rules governing the accessibility of the key vault from specific network locations.
74+
*
75+
* @return rules governing the accessibility of the key vault from specific network locations
76+
*/
4977
MhsmNetworkRuleSet networkRuleSet();
5078

51-
/** @return the Key Vault key API entry point */
79+
/**
80+
* Gets the Key Vault key API entry point.
81+
*
82+
* @return the Key Vault key API entry point
83+
*/
5284
Keys keys();
5385

54-
/** @return the scheduled purge date in UTC */
86+
/**
87+
* Gets the scheduled purge date in UTC.
88+
*
89+
* @return the scheduled purge date in UTC
90+
*/
5591
OffsetDateTime scheduledPurgeDate();
5692

57-
/** @return whether data plane traffic coming from public networks is allowed while private endpoint is enabled */
93+
/**
94+
* Checks whether data plane traffic coming from public networks is allowed while private endpoint is enabled.
95+
*
96+
* @return whether data plane traffic coming from public networks is allowed while private endpoint is enabled
97+
*/
5898
PublicNetworkAccess publicNetworkAccess();
5999
}

‎sdk/resourcemanager/azure-resourcemanager-keyvault/src/main/java/com/azure/resourcemanager/keyvault/models/Secret.java‎

Lines changed: 44 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,39 +20,75 @@
2020
/** An immutable client-side representation of an Azure Key Vault secret. */
2121
@Fluent
2222
public interface Secret extends Indexable, HasInnerModel<SecretProperties>, HasId, HasName, Updatable<Secret.Update> {
23-
/** @return the secret value when the secret is enabled */
23+
/**
24+
* Gets the secret value when the secret is enabled.
25+
*
26+
* @return the secret value when the secret is enabled
27+
*/
2428
String getValue();
2529

26-
/** @return the secret value when the secret is enabled */
30+
/**
31+
* Gets the secret value when the secret is enabled.
32+
*
33+
* @return the secret value when the secret is enabled
34+
*/
2735
Mono<String> getValueAsync();
2836

29-
/** @return the secret management attributes */
37+
/**
38+
* Gets the secret management attributes.
39+
*
40+
* @return the secret management attributes
41+
*/
3042
SecretProperties attributes();
3143

32-
/** @return application specific metadata in the form of key-value pairs */
44+
/**
45+
* Gets application specific metadata in the form of key-value pairs.
46+
*
47+
* @return application specific metadata in the form of key-value pairs
48+
*/
3349
Map<String, String> tags();
3450

35-
/** @return type of the secret value such as a password */
51+
/**
52+
* Gets type of the secret value such as a password.
53+
*
54+
* @return type of the secret value such as a password
55+
*/
3656
String contentType();
3757

38-
/** @return the corresponding key backing the KV certificate if this is a secret backing a KV certificate */
58+
/**
59+
* Gets the corresponding key backing the KV certificate if this is a secret backing a KV certificate.
60+
*
61+
* @return the corresponding key backing the KV certificate if this is a secret backing a KV certificate
62+
*/
3963
String kid();
4064

4165
/**
66+
* Checks whether the secret's lifetime is managed by key vault.
67+
*
4268
* @return true if the secret's lifetime is managed by key vault. If this is a key backing a certificate, then
4369
* managed will be true
4470
*/
4571
boolean managed();
4672

4773
/**
74+
* Checks whether secret is enabled.
75+
*
4876
* @return whether secret is enabled.
4977
*/
5078
boolean enabled();
5179

52-
/** @return a list of individual secret versions with the same secret name */
80+
/**
81+
* Gets a list of individual secret versions with the same secret name.
82+
*
83+
* @return a list of individual secret versions with the same secret name
84+
*/
5385
PagedIterable<Secret> listVersions();
5486

55-
/** @return a list of individual secret versions with the same secret name */
87+
/**
88+
* Gets a list of individual secret versions with the same secret name.
89+
*
90+
* @return a list of individual secret versions with the same secret name
91+
*/
5692
PagedFlux<Secret> listVersionsAsync();
5793

5894
/** Container interface for all the definitions. */

0 commit comments

Comments
 (0)