Skip to content

Commit

Permalink
Fix Az.keyVault XML Comments (#18446)
Browse files Browse the repository at this point in the history
* Fix Az.keyVault XML Comments

* Fix Az.keyVault XML Comments

* Fix merge conflict marker

Co-authored-by: Ziyue Zheng <v-ziyzhe@microsoft.com>
  • Loading branch information
v-yuzhichen and ziyuezh576 authored Jun 21, 2022
1 parent 84dd807 commit 67fe7ae
Show file tree
Hide file tree
Showing 9 changed files with 17 additions and 5 deletions.
2 changes: 2 additions & 0 deletions src/KeyVault/KeyVault/Commands/RBAC/RbacCmdletBase.cs
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ internal static class ParameterSet
/// and assign them back in the role assignment object.
/// </summary>
/// <param name="assignment"></param>
/// <param name="hsmName"></param>
/// <param name="scope"></param>
protected void GetAssignmentDetails(PSKeyVaultRoleAssignment assignment, string hsmName, string scope)
{
// get all role definition
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ namespace Microsoft.Azure.Commands.KeyVault
{
/// <summary>
/// Add network rule
/// NOTE: Define VaultName & ResourceGroupName in this class instead of base one because TAB order for input.
/// NOTE: Define VaultName &amp; ResourceGroupName in this class instead of base one because TAB order for input.
/// </summary>
[Cmdlet("Add", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "KeyVaultNetworkRule",SupportsShouldProcess = true,DefaultParameterSetName = ByVaultNameParameterSet)]
[OutputType(typeof(PSKeyVault))]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ namespace Microsoft.Azure.Commands.KeyVault
{
/// <summary>
/// Remove network rule
/// NOTE: Define VaultName & ResourceGroupName in this class instead of base one because TAB order for input.
/// NOTE: Define VaultName &amp; ResourceGroupName in this class instead of base one because TAB order for input.
/// </summary>
[Cmdlet("Remove", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "KeyVaultNetworkRule",DefaultParameterSetName = ByVaultNameParameterSet,SupportsShouldProcess = true)]
[OutputType(typeof(PSKeyVault))]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ namespace Microsoft.Azure.Commands.KeyVault
{
/// <summary>
/// Update network rule set
/// NOTE: Define VaultName & ResourceGroupName in this class instead of base one because TAB order for input.
/// NOTE: Define VaultName &amp; ResourceGroupName in this class instead of base one because TAB order for input.
/// </summary>
[Cmdlet("Update", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "KeyVaultNetworkRuleSet",DefaultParameterSetName = ByVaultNameParameterSet,SupportsShouldProcess = true)]
[OutputType(typeof(PSKeyVault))]
Expand Down
2 changes: 1 addition & 1 deletion src/KeyVault/KeyVault/Helpers/ODataHelper.cs
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ internal static class ODataHelper
/// Format an ODataQuery filter expression to string.
/// </summary>
/// <remarks>
/// This method uses <see cref="Rest.Azure.OData.ODataQuery" /> class for the underlying parsing and serialization of the filter string.
/// This method uses <see cref="Rest.Azure.OData.ODataQuery{T}" /> class for the underlying parsing and serialization of the filter string.
/// It supports limited operations in the implementation of filter.
/// For string comparison, use `==` instead of `String.Equals()`.
/// </remarks>
Expand Down
2 changes: 1 addition & 1 deletion src/KeyVault/KeyVault/Models/Key/PSDeletedKeyVaultKey.cs
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ internal PSDeletedKeyVaultKey(DeletedKey deletedKey, VaultUriHelper vaultUriHelp
KeySize = JwkHelper.ConvertToRSAKey(Key)?.KeySize;
Attributes = new PSKeyVaultKeyAttributes(
deletedKey.Properties.Enabled,
/// see https://docs.microsoft.com/en-us/dotnet/standard/datetime/converting-between-datetime-and-offset#conversions-from-datetimeoffset-to-datetime
// see https://docs.microsoft.com/en-us/dotnet/standard/datetime/converting-between-datetime-and-offset#conversions-from-datetimeoffset-to-datetime
deletedKey.Properties.ExpiresOn?.UtcDateTime, // time returned by key vault are UTC
deletedKey.Properties.NotBefore?.UtcDateTime,
deletedKey.KeyType.ToString(),
Expand Down
5 changes: 5 additions & 0 deletions src/KeyVault/KeyVault/Models/VaultManagementClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ private IKeyVaultManagementClient KeyVaultManagementClient
/// </summary>
/// <param name="parameters">vault creation parameters</param>
/// <param name="graphClient">the active directory client</param>
/// <param name="networkRuleSet">the network rule set of the vault</param>
/// <returns></returns>
public PSKeyVault CreateNewVault(VaultCreationOrUpdateParameters parameters, IMicrosoftGraphClient graphClient = null, PSKeyVaultNetworkRuleSet networkRuleSet = null)
{
Expand Down Expand Up @@ -220,6 +221,10 @@ public PSKeyVault UpdateVault(
/// <param name="updatedEnabledForDeployment">enabled for deployment</param>
/// <param name="updatedEnabledForTemplateDeployment">enabled for template deployment</param>
/// <param name="updatedEnabledForDiskEncryption">enabled for disk encryption</param>
/// <param name="updatedSoftDeleteSwitch">enabled for soft delete</param>
/// <param name="updatedPurgeProtectionSwitch">enabled for purge protection</param>
/// <param name="updatedRbacAuthorization">enabled for rbac authorization</param>
/// <param name="softDeleteRetentionInDays">soft delete retention period (days)</param>
/// <param name="updatedNetworkAcls">updated network rule set</param>
/// <param name="graphClient">the active directory client</param>
/// <returns>the updated vault</returns>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ public SecurityDomainClient(IAuthenticationFactory authenticationFactory, IAzure
/// <param name="hsmName">Name of the HSM</param>
/// <param name="certificates">Certificates used to encrypt the security domain data</param>
/// <param name="quorum">Specify how many keys are required to decrypt the data</param>
/// <param name="cancellationToken"></param>
/// <returns>Encrypted HSM security domain data in string</returns>
public string DownloadSecurityDomain(string hsmName, IEnumerable<X509Certificate2> certificates, int quorum, CancellationToken cancellationToken)
{
Expand Down Expand Up @@ -275,6 +276,7 @@ private bool ValidateSecurityDomainData(string securityDomainData)
/// This key is used to encrypt SD data before uploading to the HSM where SD is going to be restored.
/// </summary>
/// <param name="hsmName"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
public X509Certificate2 DownloadSecurityDomainExchangeKey(string hsmName, CancellationToken cancellationToken)
{
Expand Down Expand Up @@ -508,6 +510,7 @@ public SecurityDomainRestoreData EncryptForRestore(PlaintextList plaintextList,
/// </summary>
/// <param name="hsmName"></param>
/// <param name="securityDomainData">Encrypted by exchange key</param>
/// <param name="cancellationToken"></param>
public void RestoreSecurityDomain(string hsmName, SecurityDomainRestoreData securityDomainData, CancellationToken cancellationToken)
{
string securityDomain = JsonConvert.SerializeObject(new SecurityDomainWrapper
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -489,6 +489,8 @@ public void RemoveHsmRoleAssignment(string hsmName, string scope, string roleAss
/// <summary>
/// Remove a custom role definition from an HSM.
/// </summary>
/// <param name="hsmName"></param>
/// <param name="scope"></param>
/// <param name="name">Name of the role. A GUID.</param>
public void RemoveHsmRoleDefinition(string hsmName, string scope, string name)
{
Expand Down

0 comments on commit 67fe7ae

Please sign in to comment.