Skip to content

Commit 6cf75e1

Browse files
authored
Updated the description for the expiry parameter of key vault key (#23939)
* Update AddAzureKeyVaultKey.cs * Update UpdateAzureKeyVaultKey.cs * Update Add-AzKeyVaultKey.md * Update Update-AzKeyVaultKey.md * Update src/KeyVault/KeyVault/help/Add-AzKeyVaultKey.md
1 parent 947b1e2 commit 6cf75e1

File tree

4 files changed

+5
-7
lines changed

4 files changed

+5
-7
lines changed

src/KeyVault/KeyVault/Commands/Key/AddAzureKeyVaultKey.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ public class AddAzureKeyVaultKey : KeyVaultCmdletBase
252252
/// Key expires time in UTC time
253253
/// </summary>
254254
[Parameter(Mandatory = false,
255-
HelpMessage = "Specifies the expiration time of the key in UTC. If not specified, key will not expire.")]
255+
HelpMessage = "Specifies the expiration time of the key in UTC, as a DateTime object, for the key that this cmdlet adds. If not specified, key will not expire. To obtain a DateTime object, use the Get-Date cmdlet. For more information, type Get-Help Get-Date. Please notice that expirys is ignored for Key Exchange Key used in BYOK process.")]
256256
public DateTime? Expires { get; set; }
257257

258258
/// <summary>
@@ -652,4 +652,4 @@ private string GetDefaultCVMPolicy()
652652
return defaultCVMPolicy;
653653
}
654654
}
655-
}
655+
}

src/KeyVault/KeyVault/Commands/Key/UpdateAzureKeyVaultKey.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ public class UpdateAzureKeyVaultKey : KeyVaultCmdletBase
109109
/// Key expires time in UTC time
110110
/// </summary>
111111
[Parameter(Mandatory = false,
112-
HelpMessage = "The expiration time of a key in UTC time. If not specified, the existing expiration time of the key remains unchanged.")]
112+
HelpMessage = "The expiration time of a key in UTC time. If not specified, the existing expiration time of the key remains unchanged. Please notice that expirys is ignored for Key Exchange Key used in BYOK process.")]
113113
public DateTime? Expires { get; set; }
114114

115115
/// <summary>

src/KeyVault/KeyVault/help/Add-AzKeyVaultKey.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -502,10 +502,7 @@ Accept wildcard characters: False
502502
```
503503
504504
### -Expires
505-
Specifies the expiration time, as a **DateTime** object, for the key that this cmdlet adds. This
506-
parameter uses Coordinated Universal Time (UTC). To obtain a **DateTime** object, use the
507-
**Get-Date** cmdlet. For more information, type `Get-Help Get-Date`. If you do not specify this
508-
parameter, the key does not expire.
505+
Specifies the expiration time of the key in UTC, as a **DateTime** object, for the key that this cmdlet adds. If not specified, key will not expire. To obtain a **DateTime** object, use the **Get-Date** cmdlet. For more information, type `Get-Help Get-Date`. Please notice that expirys is ignored for Key Exchange Key used in BYOK process.
509506

510507
```yaml
511508
Type: System.Nullable`1[System.DateTime]

src/KeyVault/KeyVault/help/Update-AzKeyVaultKey.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,7 @@ Accept wildcard characters: False
126126
### -Expires
127127
The expiration time of a key in UTC time.
128128
If not specified, the existing expiration time of the key remains unchanged.
129+
Please notice that expirys is ignored for Key Exchange Key used in BYOK process.
129130
130131
```yaml
131132
Type: System.Nullable`1[System.DateTime]

0 commit comments

Comments
 (0)